Allow separate stacks registration through services operation
[anna.git] / source / core / oam / Module.cpp
index 84991e5..2fa403e 100644 (file)
@@ -1,53 +1,26 @@
-// ANNA - Anna is Not 'N' Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// https://bitbucket.org/testillano/anna
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-//     * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//     * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//     * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-//          cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore                                                         //
+//                                                                                                //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
+//                                                                                                //
+// See project site at http://redmine.teslayout.com/projects/anna-suite                           //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
 
 
 // Local
 #include <anna/core/oam/Module.hpp>
 #include <anna/core/functions.hpp>
 #include <anna/core/oam/Configuration.hpp>
+#include <anna/core/oam/CounterScope.hpp>
+#include <anna/core/oam/CounterRecorder.hpp>
 
 #include <anna/core/tracing/Logger.hpp>
 #include <anna/core/tracing/TraceWriter.hpp>
 #include <anna/core/tracing/TraceMethod.hpp>
 #include <anna/core/functions.hpp>
 #include <anna/xml/xml.hpp>
-#include <anna/core/oam/CounterManager.hpp>
 
 // Standard
-#include <stdarg.h>
+#include <cstdarg>
 
 
 #define UNDEFINED_EVENT_DESCRIPTION "<undefined>"
 //----------------------------------------------------------------------- Module
 //******************************************************************************
 
+//------------------------------------------------------------------------------
+//-------------------------------------------------------------- Module::~Module
+//------------------------------------------------------------------------------
+anna::oam::Module::~Module() {
+  for(scope_iterator scope_it = scope_begin(); scope_it != scope_end(); scope_it++)
+    delete (scope(scope_it));
+}
+
+
 //------------------------------------------------------------------------------
 //----------------------------------------------------------- Module::getScope()
 //------------------------------------------------------------------------------
@@ -247,13 +229,14 @@ void anna::oam::Module::initializeCounterScope(const int & scopeId, const std::s
   LOGMETHOD(anna::TraceMethod tttm("anna::oam::Module", "initializeCounterScope", ANNA_FILE_LOCATION));
 
   // Order of use:
-  if(a_counters.size() != 0)  // any counter have been registered
-    throw anna::RuntimeException("After use of counter registration can't initialize more scope ids!. Do initializations firstly", ANNA_FILE_LOCATION);
+  // https://redmine.teslayout.com/issues/48
+  //if(a_counters.size() != 0)  // any counter have been registered
+  //  throw anna::RuntimeException("After use of counter registration can't initialize more scope ids!. Do initializations firstly", ANNA_FILE_LOCATION);
 
   // Scope range: 0 - 99
-  if(scopeId < 0 || scopeId >= anna::oam::CounterManager::MaxScope) {
+  if(scopeId < 0 || scopeId >= MaxScope) {
     std::string msg = "Scope Id must be in range [0 - ";
-    msg += anna::functions::asString(anna::oam::CounterManager::MaxScope - 1); // 99
+    msg += anna::functions::asString(MaxScope - 1); // 99
     msg += "]";
     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
   }
@@ -274,8 +257,8 @@ void anna::oam::Module::initializeCounterScope(const int & scopeId, const std::s
   anna::Logger::warning("This is not the first initialized scope. Perhaps you should provide specific description better than general module name ...", ANNA_FILE_LOCATION);
   }
   );
-  const char * c_description = (missingScopeDescription ? getClassName() : description.c_str());
-  a_active_counter_scope = &(anna::oam::CounterManager::instantiate().create(scopeId, c_description, true /* reuses */));
+  const char * c_description = (missingScopeDescription ? getName() : description.c_str());
+  a_active_counter_scope = new CounterScope(scopeId, c_description);
   a_scopes[scopeId] = a_active_counter_scope;
 }
 
@@ -408,7 +391,7 @@ void anna::oam::Module::alarmEvent(bool activation, const int & type, va_list ar
 //------------------------------------------------------------------------------
 //------------------------------------------------------ Module::activateAlarm()
 //------------------------------------------------------------------------------
-void anna::oam::Module::activateAlarm(const int & type, ...) const throw(anna::RuntimeException) {
+void anna::oam::Module::activateAlarm(int type, ...) const throw(anna::RuntimeException) {
 //   LOGMETHOD(anna::TraceMethod tttm("anna::oam::Module", "activateAlarm", ANNA_FILE_LOCATION));
 
   // Checkings
@@ -416,7 +399,7 @@ void anna::oam::Module::activateAlarm(const int & type, ...) const throw(anna::R
     LOGDEBUG
     (
       std::string msg = "Alarm activation ignored over module '";
-      msg += getClassName();
+      msg += getName();
       msg += "': alarms are disabled";
       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
     );
@@ -434,7 +417,7 @@ void anna::oam::Module::activateAlarm(const int & type, ...) const throw(anna::R
 //------------------------------------------------------------------------------
 //-------------------------------------------------------- Module::cancelAlarm()
 //------------------------------------------------------------------------------
-void anna::oam::Module::cancelAlarm(const int & type, ...) const throw(anna::RuntimeException) {
+void anna::oam::Module::cancelAlarm(int type, ...) const throw(anna::RuntimeException) {
 //   LOGMETHOD(anna::TraceMethod tttm("anna::oam::Module", "cancelAlarm", ANNA_FILE_LOCATION));
 
   // Checkings
@@ -442,7 +425,7 @@ void anna::oam::Module::cancelAlarm(const int & type, ...) const throw(anna::Run
     LOGDEBUG
     (
       std::string msg = "Alarm cancellation ignored over module '";
-      msg += getClassName();
+      msg += getName();
       msg += "': alarms are disabled";
       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
     );
@@ -468,7 +451,7 @@ void anna::oam::Module::count(const int & type, const int & amount) throw(anna::
     LOGDEBUG
     (
       std::string msg = "Count operation ignored over module '";
-      msg += getClassName();
+      msg += getName();
       msg += "': counters are disabled";
       anna::Logger::debug(msg, ANNA_FILE_LOCATION);
     );
@@ -493,13 +476,77 @@ int anna::oam::Module::resetCounters(const int & scopeId) throw() {
 }
 
 
+//------------------------------------------------------------------------------
+//------------------------------------- Module::RecordingGuard::RecordingGuard()
+//------------------------------------------------------------------------------
+anna::oam::Module::RecordingGuard::RecordingGuard(anna::oam::Module* module) :
+  a_module(module) {
+  module->a_counterRecording = true;
+}
+
+
+//------------------------------------------------------------------------------
+//------------------------------------ Module::RecordingGuard::~RecordingGuard()
+//------------------------------------------------------------------------------
+anna::oam::Module::RecordingGuard::~RecordingGuard() {
+  a_module->a_counterRecording = false;
+}
+
+
+//------------------------------------------------------------------------------
+//----------------------------------------------------- Module::recordCounters()
+//------------------------------------------------------------------------------
+void anna::oam::Module::recordCounters() throw(anna::RuntimeException) {
+  LOGMETHOD(anna::TraceMethod tttm("anna::oam::Module", "recordCounters", ANNA_FILE_LOCATION));
+
+  if(a_counterRecorder == NULL)
+    throw RuntimeException("anna::oam::Module has no counter recorder associated", ANNA_FILE_LOCATION);
+
+  LOGDEBUG(
+    std::string msg("Recording counters | ");
+    msg += a_counterRecorder->asString();
+    anna::Logger::write(Logger::Debug, msg, ANNA_FILE_LOCATION)
+  );
+  RecordingGuard guard(this);
+
+  a_counterRecorder->open();
+  CounterScope* cscope = NULL;
+
+  try {
+    for(scope_iterator scope_it = scope_begin(); scope_it != scope_end(); scope_it++) {
+      cscope = scope(scope_it);
+      if(cscope == NULL) continue;
+
+      Guard csGuard(cscope, "oam::CounterScope from oam::Module::record");
+
+      for(int icounter = 0; icounter < CounterScope::MaxCounter; icounter ++) {
+        Counter* counter = cscope->a_counters [icounter];
+
+        if(counter == NULL)
+          continue;
+
+        if(counter->getValue() == 0)
+          continue;
+
+        a_counterRecorder->apply(*counter);
+        counter->reset();
+      }
+    }
+
+    a_counterRecorder->close();
+  } catch(anna::RuntimeException&) {
+    a_counterRecorder->close();
+    throw;
+  }
+}
+
 //------------------------------------------------------------------------------
 //----------------------------------------------------------- Module::asString()
 //------------------------------------------------------------------------------
 std::string anna::oam::Module::asString(void) const throw() {
   std::string trace;
   trace = "Module name: '";
-  trace += getClassName();
+  trace += getName();
   trace += "'";
   trace += "\n\nCOUNTERS"; trace += "\n--------";
   trace += "\nScoped counters "; trace += a_counters_enabled ? "Enabled" : "Disabled";
@@ -515,14 +562,25 @@ std::string anna::oam::Module::asString(void) const throw() {
 
     for(const_counter_iterator cnt_it = counter_begin(); cnt_it != counter_end(); cnt_it++) {
       ptrCounterData = (counter_data_t *) & ((*cnt_it).second);
+
+      // Counter registered ?
+      int offset = ptrCounterData->Offset;
+      unsigned long long int accValue = 0ULL;
+      try {
+        const anna::oam::CounterScope *csAux = scope(scope_it);
+        accValue = csAux->getAccValue(offset);
+      } catch(anna::RuntimeException &ex) {
+        ex.trace();
+        continue;
+      }
+
       // Counter:
       trace += "\n\tType: "; trace += anna::functions::asString((*cnt_it).first);
       trace += " | Description: '"; trace += ptrCounterData->Description; trace += "'";
-      int offset = ptrCounterData->Offset;
       int realId = (1000 * scopeId) + offset;
       trace += " | ScopeId/Offset: "; trace += anna::functions::asString(scopeId); trace += "/"; trace += anna::functions::asString(offset);
       trace += " | RealId: "; trace += anna::functions::asString(realId);
-      unsigned long long int accValue = scope(scope_it)->getAccValue(offset);
+      accValue = scope(scope_it)->getAccValue(offset);
 
       if(accValue != 0ULL) {
         trace += " | AccumulatedAmount: ";
@@ -560,7 +618,7 @@ std::string anna::oam::Module::asString(void) const throw() {
 //------------------------------------------------------------------------------
 anna::xml::Node* anna::oam::Module::asXML(anna::xml::Node* parent) const throw() {
   anna::xml::Node* result = parent->createChild("oam.Module");
-  result->createAttribute("Name", getClassName());
+  result->createAttribute("Name", getName());
   result->createAttribute("Counters", a_counters_enabled ? "Enabled" : "Disabled");
   anna::xml::Node* registeredCounterScopes = result->createChild("RegisteredCounterScopes");
 
@@ -576,16 +634,26 @@ anna::xml::Node* anna::oam::Module::asXML(anna::xml::Node* parent) const throw()
 
     for(const_counter_iterator cnt_it = counter_begin(); cnt_it != counter_end(); cnt_it++) {
       ptrCounterData = (counter_data_t *) & ((*cnt_it).second);
+
+      // Counter registered ?
+      int offset = ptrCounterData->Offset;
+      unsigned long long int accValue = 0ULL;
+      try {
+        const anna::oam::CounterScope *csAux = scope(scope_it);
+        accValue = csAux->getAccValue(offset);
+      } catch(anna::RuntimeException &ex) {
+        ex.trace();
+        continue;
+      }
+
       // Counter:
       anna::xml::Node* counter = registeredCounters->createChild("Counter");
       counter->createAttribute("Type", anna::functions::asString((*cnt_it).first));
       counter->createAttribute("Description", ptrCounterData->Description);
-      int offset = ptrCounterData->Offset;
       int realId = (1000 * scopeId) + offset;
       counter->createAttribute("ScopeId", anna::functions::asString(scopeId));
       counter->createAttribute("Offset", anna::functions::asString(offset));
       counter->createAttribute("RealId", anna::functions::asString(realId));
-      unsigned long long int accValue = scope(scope_it)->getAccValue(offset);
 
       if(accValue != 0ULL)
         counter->createAttribute("AccumulatedAmount", anna::functions::asString("%llu", accValue));