X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/706dd4584b4002e0d948b81d103dd5c4b70db077..ad600f09bb72f0cdec347f4d9e13c8c62f505ff3:/src/mc/ObjectInformation.cpp

diff --git a/src/mc/ObjectInformation.cpp b/src/mc/ObjectInformation.cpp
index 59280f996f..7784c6a4c2 100644
--- a/src/mc/ObjectInformation.cpp
+++ b/src/mc/ObjectInformation.cpp
@@ -15,38 +15,26 @@
 namespace simgrid {
 namespace mc {
 
-ObjectInformation::ObjectInformation()
-{
-  this->flags = 0;
-  this->start = nullptr;
-  this->end = nullptr;
-  this->start_exec = nullptr;
-  this->end_exec = nullptr;
-  this->start_rw = nullptr;
-  this->end_rw = nullptr;
-  this->start_ro = nullptr;
-  this->end_ro = nullptr;
-}
+ObjectInformation::ObjectInformation() {}
 
-/** Find the DWARF offset for this ELF object
- *
- *  An offset is applied to address found in DWARF:
- *
- *  * for an executable object, addresses are virtual address
- *    (there is no offset) i.e.
- *    \f$\text{virtual address} = \{dwarf address}\f$;
+/* For an executable object, addresses are virtual address
+ * (there is no offset) i.e.
+ * \f$\text{virtual address} = \{dwarf address}\f$;
  *
- *  * for a shared object, the addreses are offset from the begining
- *    of the shared object (the base address of the mapped shared
- *    object must be used as offset
- *    i.e. \f$\text{virtual address} = \text{shared object base address}
+ * For a shared object, the addreses are offset from the begining
+ * of the shared object (the base address of the mapped shared
+ * object must be used as offset
+ * i.e. \f$\text{virtual address} = \text{shared object base address}
  *             + \text{dwarf address}\f$.
  */
 void *ObjectInformation::base_address() const
 {
+  // For an executable (more precisely for a ET_EXEC) the base it 0:
   if (this->executable())
     return nullptr;
 
+  // For an a shared-object (ET_DYN, including position-independant executables)
+  // the base address is its lowest address:
   void *result = this->start_exec;
   if (this->start_rw != nullptr && result > (void *) this->start_rw)
     result = this->start_rw;
@@ -55,12 +43,11 @@ void *ObjectInformation::base_address() const
   return result;
 }
 
-/* Find a function by instruction pointer */
 simgrid::mc::Frame* ObjectInformation::find_function(const void *ip) const
 {
   /* This is implemented by binary search on a sorted array.
    *
-   * We do quite a lot ot those so we want this to be cache efficient.
+   * We do quite a lot of those so we want this to be cache efficient.
    * We pack the only information we need in the index entries in order
    * to successfully do the binary search. We do not need the high_pc
    * during the binary search (only at the end) so it is not included
@@ -146,16 +133,16 @@ void ObjectInformation::remove_global_variable(const char* name)
   }
 }
 
-/** \brief Ignore a local variable in a scope
+/** Ignore a local variable in a scope
  *
  *  Ignore all instances of variables with a given name in
  *  any (possibly inlined) subprogram with a given namespaced
  *  name.
  *
- *  \param var_name        Name of the local variable (or parameter to ignore)
- *  \param subprogram_name Name of the subprogram to ignore (nullptr for any)
- *  \param subprogram      (possibly inlined) Subprogram of the scope
- *  \param scope           Current scope
+ *  @param var_name        Name of the local variable to ignore
+ *  @param subprogram_name Name of the subprogram to ignore (nullptr for any)
+ *  @param subprogram      (possibly inlined) Subprogram of the scope current scope
+ *  @param scope           Current scope
  */
 static void remove_local_variable(simgrid::mc::Frame& scope,
                             const char *var_name,