From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Tue, 21 Jul 2015 11:11:56 +0000 (+0200)
Subject: [mc] Add comments on ObjectInformation
X-Git-Tag: v3_12~438^2~25
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/c97f1a13223584e3b45abe570a840c30df38c6e9?hp=773cbe7c3a92faef15e6533eed36910a32dd1df1;ds=sidebyside

[mc] Add comments on ObjectInformation
---

diff --git a/src/mc/mc_object_info.h b/src/mc/mc_object_info.h
index 5e431eca31..b175daf92c 100644
--- a/src/mc/mc_object_info.h
+++ b/src/mc/mc_object_info.h
@@ -140,9 +140,28 @@ struct FunctionIndexEntry {
   mc_frame_t function;
 };
 
+/** Information about an (ELF) executable/sharedobject
+ *
+ *  This contain sall the information we have at runtime about an
+ *  executable/shared object in the target (modelchecked) process:
+ *  - where it is located in the virtual address space;
+ *  - where are located it's different memory mapping in the the
+ *    virtual address space ;
+ *  - all the debugging (DWARF) information,
+ *    - location of the functions,
+ *    - types
+ *  - etc.
+ *
+ *  It is not copyable because we are taking pointers to Types/Frames.
+ *  We'd have to update/rebuild some data structures in order to copy
+ *  successfully.
+ */
+
 class ObjectInformation {
 public:
   ObjectInformation();
+
+  // Not copyable:
   ObjectInformation(ObjectInformation const&) = delete;
   ObjectInformation& operator=(ObjectInformation const&) = delete;