Changeset cd5047 for src/Patterns

Timestamp:

Jun 9, 2010, 2:30:10 PM (15 years ago)

Author:

Tillmann Crueger <crueger@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

112b09

Parents:

2c8934

Message:

Added Logging capabilities to Observer Framework

Location:

src/Patterns

Files:

• Cacheable.hpp (modified) (7 diffs)
• Observer.cpp (modified) (11 diffs)
• Observer.hpp (modified) (5 diffs)

src/Patterns/Cacheable.hpp

@@ -35 +35 @@
         return busy;
       }
+    virtual std::string getName()=0;
     protected:
       bool busy;
@@ -64 +65 @@
         // nothing to do when entering this
       }
+
+      virtual std::string getName(){
+        return "invalid";
+      }
     };
 
@@ -90 +95 @@
         State::busy = false;
       }
+
+      virtual std::string getName(){
+        return "valid";
+      }
     private:
       T content;
@@ -118 +127 @@
         // nothing to do when entering this state
       }
+
+      virtual std::string getName(){
+        return "destroyed";
+      }
     };
 
@@ -124 +137 @@
 
   public:
-    Cacheable(Observable *_owner, boost::function<T()> _recalcMethod);
+    Cacheable(Observable *_owner, boost::function<T()> _recalcMethod, std::string name);
     virtual ~Cacheable();
 
@@ -151 +164 @@
 
   template<typename T>
-  Cacheable<T>::Cacheable(Observable *_owner, boost::function<T()> _recalcMethod) :
+  Cacheable<T>::Cacheable(Observable *_owner, boost::function<T()> _recalcMethod, std::string name) :
+    Observer(name + "(Cached)"),
     owner(_owner),
     recalcMethod(_recalcMethod)
@@ -206 +220 @@
   void Cacheable<T>::switchState(state_ptr newState){
     ASSERT(!state->isBusy(),"LOOP DETECTED: Cacheable state switched while recalculating.\nDid the recalculation trigger the Observable?");
+#ifdef LOG_OBSERVER
+    observerLog().addMessage() << "## Cacheable " << observerLog().getName(this) << " changed state (" << state->getName()
+                               << "->" << newState->getName() << ")" << std::endl;
+#endif
     state = newState;
     state->enter();

src/Patterns/Observer.cpp

@@ -12 +12 @@
 
 #include "Helpers/Assert.hpp"
+#include "Helpers/MemDebug.hpp"
 
 using namespace std;
@@ -43 +44 @@
   // if no entry for this observable is found, an new one is created
   // by the STL and initialized to 0 (see STL documentation)
+#ifdef LOG_OBSERVER
+  observerLog().addMessage(depth[publisher]) << ">> Locking " << observerLog().getName(publisher) << endl;
+#endif
   depth[publisher]++;
 }
@@ -60 +64 @@
   // if zero is reached all observed blocks are done and we can
   // start to notify our observers
-  if(--(depth[publisher])){}
+  --depth[publisher];
+#ifdef LOG_OBSERVER
+  observerLog().addMessage(depth[publisher]) << "<< Unlocking " << observerLog().getName(publisher) << endl;
+#endif
+  if(depth[publisher]){}
   else{
     publisher->notifyAll();
@@ -123 +131 @@
       callees_t::iterator iter;
       for(iter=callees.begin();iter!=callees.end();++iter){
+#ifdef LOG_OBSERVER
+        observerLog().addMessage() << "-> Sending update from " << observerLog().getName(this)
+                                   << " to " << observerLog().getName((*iter).second)
+                                   << " (priority=" << (*iter).first << ")"<< endl;
+#endif
         (*iter).second->update(this);
       }
@@ -165 +178 @@
     // we do not need to publish all the changes at each time we are called
     if(depth.find(this)==depth.end()) {
+#ifdef LOG_OBSERVER
+      observerLog().addMessage() << "-* Update from " << observerLog().getName(publisher)
+                                 << " propagated by " << observerLog().getName(this) << endl;
+#endif
       notifyAll();
+    }
+    else{
+#ifdef LOG_OBSERVER
+      observerLog().addMessage() << "-| Update from " <<  observerLog().getName(publisher)
+                                 << " not propagated by " << observerLog().getName(this) << endl;
+#endif
     }
   }
@@ -177 +200 @@
 void Observable::signOn(Observer *target,int priority) {
   ASSERT(priority>=-20 && priority<=+20, "Priority out of range [-20:+20] when signing on Observer");
+#ifdef LOG_OBSERVER
+  observerLog().addMessage() << "@@ Signing on " << observerLog().getName(target) << " to " << observerLog().getName(this) << endl;
+#endif
   bool res = false;
   callees_t &callees = callTable[this];
@@ -194 +220 @@
 void Observable::signOff(Observer *target) {
   ASSERT(callTable.count(this),"SignOff called for an Observable without Observers.");
+#ifdef LOG_OBSERVER
+  observerLog().addMessage() << "** Signing off " << observerLog().getName(target) << " from " << observerLog().getName(this) << endl;
+#endif
   callees_t &callees = callTable[this];
 
@@ -238 +267 @@
 /** Constructor for class Observable.
  */
-Observable::Observable()
-{}
+Observable::Observable(string name) :
+  Observer(Observer::BaseConstructor())
+{
+#ifdef LOG_OBSERVER
+  observerLog().addName(this,name);
+  observerLog().addMessage() << "++ Creating Observable " << observerLog().getName(this) << endl;
+#endif
+}
 
 /** Destructor for class Observable.
@@ -246 +281 @@
 Observable::~Observable()
 {
+#ifdef LOG_OBSERVER
+  observerLog().addMessage() << "-- Destroying Observable " << observerLog().getName(this) << endl;
+#endif
   if(callTable.count(this)) {
     // delete all entries for this observable
@@ -259 +297 @@
 /** Constructor for class Observer.
  */
-Observer::Observer()
-{}
+Observer::Observer(string name)
+{
+#ifdef LOG_OBSERVER
+  observerLog().addName(this,name);
+  observerLog().addMessage() << "++ Creating Observer " << observerLog().getName(this) << endl;
+#endif
+}
+
+/**
+ * Base Constructor for class Observer
+ *
+ * only called from Observable Constructor
+ */
+Observer::Observer(Observer::BaseConstructor){
+#ifdef LOG_OBSERVER
+  observerLog().addObservable(this);
+#endif
+}
 
 /** Destructor for class Observer.
  */
 Observer::~Observer()
-{}
+{
+#ifdef LOG_OBSERVER
+  if(!observerLog().isObservable(this)){
+    observerLog().addMessage() << "-- Destroying Observer " << observerLog().getName(this) << endl;
+  }
+#endif
+}
 
 /**
@@ -296 +356 @@
   }
 }
+
+#ifdef LOG_OBSERVER
+
+/************************* Methods to do logging of the Observer Mechanism *********/
+
+// The log needs to exist fairly early, so we make it construct on first use,
+// and never destroy it
+ObserverLog &observerLog(){
+  // yes, this memory is never freed... we need it around for the whole programm,
+  // so no freeing is possible
+  static ObserverLog *theLog = Memory::ignore(new ObserverLog());
+  return *theLog;
+}
+
+
+ObserverLog::ObserverLog() :
+  count (0)
+{}
+
+ObserverLog::~ObserverLog(){}
+
+string ObserverLog::getLog(){return log.str();}
+
+std::string ObserverLog::getName(void* obj){
+  return names[obj];
+}
+
+bool ObserverLog::isObservable(void* obj){
+  return observables.count(obj);
+}
+
+void ObserverLog::addName(void* obj , string name){
+  stringstream sstr;
+  sstr << name << "_" << count++;
+  names[obj] = sstr.str();
+}
+
+void ObserverLog::addObservable(void* obj){
+  observables.insert(obj);
+}
+
+void ObserverLog::deleteName(void* obj){
+  names.erase(obj);
+}
+
+void ObserverLog::deleteObservable(void* obj){
+  observables.erase(obj);
+}
+
+stringstream &ObserverLog::addMessage(int depth){
+  for(int i=depth;i--;)
+    log << "  ";
+  return log;
+}
+
+#endif

src/Patterns/Observer.hpp

@@ -11 +11 @@
 #include <map>
 #include <set>
+#include <string>
+#include <sstream>
 
 /**
@@ -28 +30 @@
  */
 
+// Deactivate any logging when we are not in debug mode
+#ifdef NDEBUG
+#undef LOG_OBSERVER
+#endif
+
 class Observable;
 class Notification;
@@ -58 +65 @@
   template<class> friend class ObservedIterator;
 
-public:
-  Observer();
+  // indicates the constructor called from Observables
+  struct BaseConstructor{};
+
+public:
+  Observer(BaseConstructor);
+  Observer(std::string);
   virtual ~Observer();
 
@@ -91 +102 @@
 class Observable : public Observer {
 public:
-  Observable();
+  Observable(std::string _name);
   virtual ~Observable();
 
@@ -192 +203 @@
 };
 
+#ifdef LOG_OBSERVER
+
+/**
+ * This class is used to log the working of the observer mechanism
+ *
+ * TODO: make this conditional dependent on compiler Flag.
+ */
+class ObserverLog{
+  friend class Observable;
+  friend class Observer;
+  template <typename> friend class Cacheable;
+public:
+  ObserverLog();
+  ~ObserverLog();
+  std::string getLog();                        // get everything that has been logged
+  std::string getName(void*);                  // get the name of an actor
+  bool isObservable(void*);
+private:
+  int count;                                   // number to reference each actor in this framework
+  std::map<void*,std::string> names;           // List of names assigned to actors
+  std::set<void*> observables;                 // List of pointers to Observables. Needed to distinguish Observers and Observables
+  void addName(void*, std::string);            // Assign a name to an Actor
+  void addObservable(void*);
+  void deleteName(void*);                      // delete the name of an Actor
+  void deleteObservable(void*);
+  std::stringstream &addMessage(int depth=0);  // Add a Message to the logging
+  std::stringstream log;                       // The internal log object
+};
+
+ObserverLog &observerLog();
+
+#endif
+
 // extra macro is necessary to work with __LINE__
 #define PASTE(a,b) PASTE_HELPER(a,b)