Changeset d79639 for src

Timestamp:

Apr 29, 2010, 2:38:29 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:

1f7864

Parents:

8cbb97

Message:

Improved comments for the memory tracker

Location:

src/Helpers

Files:

• MemDebug.cpp (modified) (10 diffs)
• MemDebug.hpp (modified) (2 diffs)

src/Helpers/MemDebug.cpp

@@ -12 +12 @@
 
 namespace Memory {
+
+  // This struct is added before each memory chunk
+  // and contains tracking information. Anything used
+  // to track memory cannot use any dynamic memory, so
+  // we have to resort to classic C-idioms here.
+  // This struct also contains pointers to the next
+  // an previous chunks to allow fast traversion of
+  // all allocated memory blocks
   struct entry_t {
+    // we seperate the tracking info from the rest
+    // A checksum will be calculated for this part of
+    // the struct, so the information in here should
+    // not change during the lifetime of the memory
     struct info_t {
-      char file[256];
+      enum {length = 64};
+      char file[length];
       int line;
       size_t nbytes;
@@ -26 +39 @@
   };
 
+  // start and end of the doubly-linked list
   entry_t *begin=0;
   entry_t *end=0;
 
+  // current amount of allocated memory
   size_t state = 0;
+  // maximum amount of allocated memory
   size_t max = 0;
-
+  // number of allocations that have been done so far
+  unsigned int allocs = 0;
+
+
+  // this sets the alignment of the returned memory block
+  // malloc guarantees an alignment at the 8 byte border,
+  // so we just do the same
   const int alignment = 8;
 
+  // calculates a simple checksum for the info block
+  // the checksum is used to find memory corruptions
   inline char calcChecksum(entry_t::info_t *info){
     char *buffer = (char*)info;
@@ -43 +67 @@
   }
 
+  // gets the next alignet point which is greater than nbytes
+  // this function is only called a fixed number of times, so
+  // there is no need to optimize
   inline size_t doAlign(size_t nbytes){
     int nonaligned = nbytes % alignment;
@@ -53 +80 @@
   }
 
+  // Output some state information
   void getState(){
     cout << "Maximum allocated Memory: " << max << " bytes" << endl;
     cout << "Currently allocated Memory: " << state <<" bytes" << endl;
-
+    cout << allocs << " allocated chunks total" << endl;
+
+    // simple traversal of the chunk list
     for(entry_t *pos=begin;pos;pos=pos->next){
       cout << "\nChunk of " << pos->info.nbytes << " bytes" << " still available" << endl;
@@ -63 +93 @@
   }
 
+  // Deletes an entry from the linked list
   void deleteEntry(entry_t *entry){
     if(entry->isIgnored)
       return;
+
     if(entry->prev){
       entry->prev->next = entry->next;
     }
     else{
+      // this node was the beginning of the list
       begin = entry->next;
     }
@@ -77 +110 @@
     }
     else{
+      // this node was the end of the list
       end = entry->prev;
     }
@@ -84 +118 @@
 
   void _ignore(void *ptr){
+    // just deletes the node from the list, but leaves the info intact
     static const size_t entrySpace = Memory::doAlign(sizeof(Memory::entry_t));
     entry_t *entry = (Memory::entry_t*)((char*)ptr-entrySpace);
@@ -92 +127 @@
 void *operator new(size_t nbytes,const char* file, int line) throw(std::bad_alloc) {
 
+  // to avoid allocations of 0 bytes if someone screws up
+  // allocation with 0 byte size are undefined behavior, so we are
+  // free to handle it this way
   if(!nbytes) {
     nbytes = 1;
   }
 
+  // get the size of the entry, including alignment
   static const size_t entrySpace = Memory::doAlign(sizeof(Memory::entry_t));
 
   void *res;
   if(!(res=malloc(entrySpace + nbytes))){
+    // new must throw, when space is low
     throw std::bad_alloc();
   }
 
+  // we got the space, so update the global info
   Memory::state += nbytes;
   if(Memory::state>Memory::max){
     Memory::max = Memory::state;
   }
-
+  Memory::allocs++;
+
+  // build the entry in front of the space
   Memory::entry_t *entry = (Memory::entry_t*) res;
   entry->info.nbytes = nbytes;
   entry->info.isUsed = true;
-  strncpy(entry->info.file,file,256);
+  strncpy(entry->info.file,file,Memory::entry_t::info_t::length);
   entry->info.file[255] = '\0';
   entry->info.line=line;
+  // the space starts behind the info
   entry->info.location = (char*)res + entrySpace;
 
-  entry->next=0;
-  entry->prev=Memory::end;
+  // add the entry at the end of the list
+  entry->next=0;            // the created block is last in the list
+  entry->prev=Memory::end;  // the created block is last in the list
   if(!Memory::begin){
+    // the list was empty... start a new one
     Memory::begin=entry;
   }
   else {
+    // other blocks present... we can add to the last one
     Memory::end->next=entry;
   }
   Memory::end=entry;
 
+  // get the checksum...
   entry->checksum = Memory::calcChecksum(&entry->info);
+  // this will be set to true, when the block is removed from
+  // the list for any reason
   entry->isIgnored = false;
 
+  // ok, space is prepared... the user can have it.
+  // the rest (constructor, deleting when something is thrown etc)
+  // is handled automatically
   return entry->info.location;
 }
 
 void *operator new(size_t nbytes) throw(std::bad_alloc) {
+  // Just forward to the other operator, when we do not know from
+  // where the allocation came
   return operator new(nbytes,"Unknown",0);
 }
 
 void *operator new[] (size_t nbytes,const char* file, int line) throw(std::bad_alloc) {
+  // The difference between new and new[] is just for compiler bookkeeping.
   return operator new(nbytes,file,line);
 }
 
 void *operator new[] (size_t nbytes) throw(std::bad_alloc) {
+  // Forward again
   return operator new[] (nbytes,"Unknown",0);
 }
 
 void operator delete(void *ptr) throw() {
+  // get the size for the entry, including alignment
   static const size_t entrySpace = Memory::doAlign(sizeof(Memory::entry_t));
 
+  // get the position for the entry from the pointer the user gave us
   Memory::entry_t *entry = (Memory::entry_t*)((char*)ptr-entrySpace);
 
+  // let's see if the checksum is still matching
   if(Memory::calcChecksum(&entry->info)!=entry->checksum){
     cout << "Possible memory corruption detected!" << endl;
@@ -156 +216 @@
   }
 
+  // this will destroy the checksum, so double deletes are caught
   entry->info.isUsed = false;
   Memory::deleteEntry(entry);
 
+  // delete the space reserved by malloc
   free((char*)ptr-entrySpace);
 }
 
+// operator that is called when the constructor throws
+// do not call manually
 void operator delete(void *ptr,const char*, int) throw() {
   operator delete(ptr);
@@ -167 +231 @@
 
 void operator delete[](void *ptr){
+  // again difference between delete and delete[] is just in compiler bookkeeping
   operator delete(ptr);
 }
 
+// and another operator that can be called when a constructor throws
 void operator delete[](void *ptr,const char*, int) throw(){
   operator delete(ptr);

src/Helpers/MemDebug.hpp

@@ -9 +9 @@
 #define MEMDEBUG_HPP_
 
+/**
+ * @file
+ * This module allows easy automatic memory tracking. Link this module to replace the
+ * operators new, new[], delete and delete[] with custom versions that add tracking
+ * information to allocated blocks.
+ *
+ * All tracking is done in O(1) for new and delete operators. Summaries for the
+ * used memory take O(N), where N is the number of currently allocated memory chunks.
+ *
+ * To use full tracking including file name and line number include this file in
+ * your sourcefiles.
+ */
+
 namespace Memory {
+
+  /**
+   * Displays a short summary of the memory state.
+   */
   void getState();
 
   void _ignore(void*);
 
+  /**
+   * Use this to disable memory for a certain pointer on the heap.
+   * This is useful for pointers which should live over the run of the
+   * program, and which are deleted automatically at the end. Usually these
+   * pointers should be wrapped inside some kind of smart pointer to
+   * ensure destruction at the end.
+   */
   template <typename T>
   T *ignore(T* ptr){
@@ -26 +50 @@
 void operator delete[] (void *ptr,const char*, int) throw();
 
-
+/**
+ * This macro replaces all occurences of the keyword new with a replaced
+ * version that allows tracking.
+ */
 #define new new(__FILE__,__LINE__)