Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Add comments on ObjectInformation
[simgrid.git] / src / mc / mc_object_info.h
index 9dbbf53..b175daf 100644 (file)
 #ifndef SIMGRID_MC_OBJECT_INFO_H
 #define SIMGRID_MC_OBJECT_INFO_H
 
-#include <stdint.h>
+#include <cstdint>
 
 #include <string>
+#include <vector>
+#include <unordered_map>
 
 #include <simgrid_config.h>
 #include <xbt/dict.h>
@@ -40,17 +42,18 @@ namespace mc {
 class Type {
 public:
   Type();
-  ~Type();
-  Type(Type const& type) = delete;
-  Type& operator=(Type const&) = delete;
+  Type(Type const& type) = default;
+  Type& operator=(Type const&) = default;
+  Type(Type&& type) = default;
+  Type& operator=(Type&&) = default;
 
   e_mc_type_type type;
   Dwarf_Off id; /* Offset in the section (in hexadecimal form) */
   std::string name; /* Name of the type */
   int byte_size; /* Size in bytes */
   int element_count; /* Number of elements for array type */
-  std::string dw_type_id; /* DW_AT_type id */
-  xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
+  std::uint64_t type_id; /* DW_AT_type id */
+  std::vector<Type> members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
   int is_pointer_type;
 
   // Location (for members) is either of:
@@ -94,15 +97,76 @@ typedef int mc_object_info_flags;
 namespace simgrid {
 namespace mc {
 
+class Variable {
+public:
+  Variable();
+
+  Dwarf_Off dwarf_offset; /* Global offset of the field. */
+  int global;
+  std::string name;
+  std::uint64_t type_id;
+  mc_type_t type;
+
+  // Use either of:
+  simgrid::mc::LocationList location_list;
+  void* address;
+
+  size_t start_scope;
+  mc_object_info_t object_info;
+};
+
+class Frame {
+public:
+  Frame();
+
+  int tag;
+  std::string name;
+  void *low_pc;
+  void *high_pc;
+  simgrid::mc::LocationList frame_base;
+  std::vector<Variable> variables;
+  unsigned long int id; /* DWARF offset of the subprogram */
+  std::vector<Frame> scopes;
+  Dwarf_Off abstract_origin_id;
+  mc_object_info_t object_info;
+};
+
+/** An entry in the functions index
+ *
+ *  See the code of ObjectInformation::find_function.
+ */
+struct FunctionIndexEntry {
+  void* low_pc;
+  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();
-  ~ObjectInformation();
+
+  // Not copyable:
   ObjectInformation(ObjectInformation const&) = delete;
   ObjectInformation& operator=(ObjectInformation const&) = delete;
 
   mc_object_info_flags flags;
-  char* file_name;
+  std::string file_name;
   const void* start;
   const void *end;
   char *start_exec;
@@ -111,15 +175,18 @@ public:
   char *end_rw; // Read-write segment
   char *start_ro;
   char *end_ro; // read-only segment
-  xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
-  xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
-  xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, mc_type_t>
-  xbt_dict_t full_types_by_name; // xbt_dict_t<name, mc_type_t> (full defined type only)
-
-  // Here we sort the minimal information for an efficient (and cache-efficient)
-  // lookup of a function given an instruction pointer.
-  // The entries are sorted by low_pc and a binary search can be used to look them up.
-  xbt_dynar_t functions_index;
+  std::unordered_map<std::uint64_t, simgrid::mc::Frame> subprograms;
+  // TODO, remove the mutable (to remove it we'll have to add a lot of const everywhere)
+  mutable std::vector<simgrid::mc::Variable> global_variables;
+  std::unordered_map<std::uint64_t, simgrid::mc::Type> types;
+  std::unordered_map<std::string, simgrid::mc::Type*> full_types_by_name;
+
+  /** Index of functions by IP
+   *
+   * The entries are sorted by low_pc and a binary search can be used to look
+   * them up. Should we used a binary tree instead?
+   */
+  std::vector<FunctionIndexEntry> functions_index;
 
   bool executable() const
   {
@@ -133,14 +200,16 @@ public:
 
   void* base_address() const;
 
-  dw_frame_t find_function(const void *ip) const;
-  dw_variable_t find_variable(const char* name) const;
+  mc_frame_t find_function(const void *ip) const;
+  // TODO, should be simgrid::mc::Variable*
+  simgrid::mc::Variable* find_variable(const char* name) const;
 
 };
 
 }
 }
 
+
 XBT_INTERNAL std::shared_ptr<s_mc_object_info_t> MC_find_object_info(
   std::vector<simgrid::mc::VmMap> const& maps, const char* name, int executable);
 XBT_INTERNAL void MC_post_process_object_info(mc_process_t process, mc_object_info_t info);
@@ -150,42 +219,8 @@ XBT_INTERNAL void MC_dwarf_get_variables_libdw(mc_object_info_t info);
 XBT_INTERNAL const char* MC_dwarf_attrname(int attr);
 XBT_INTERNAL const char* MC_dwarf_tagname(int tag);
 
-XBT_INTERNAL void* mc_member_resolve(const void* base, mc_type_t type, mc_type_t member, mc_address_space_t snapshot, int process_index);
-
-struct s_dw_variable{
-  Dwarf_Off dwarf_offset; /* Global offset of the field. */
-  int global;
-  char *name;
-  char *type_origin;
-  mc_type_t type;
-
-  // Use either of:
-  s_mc_location_list_t locations;
-  void* address;
-
-  size_t start_scope;
-  mc_object_info_t object_info;
-
-};
-
-struct s_dw_frame{
-  int tag;
-  char *name;
-  void *low_pc;
-  void *high_pc;
-  s_mc_location_list_t frame_base;
-  xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
-  unsigned long int id; /* DWARF offset of the subprogram */
-  xbt_dynar_t /* <dw_frame_t> */ scopes;
-  Dwarf_Off abstract_origin_id;
-  mc_object_info_t object_info;
-};
-
-struct s_mc_function_index_item {
-  void* low_pc, *high_pc;
-  dw_frame_t function;
-};
-
-XBT_INTERNAL void mc_frame_free(dw_frame_t freme);
+XBT_INTERNAL void* mc_member_resolve(
+  const void* base, mc_type_t type, mc_type_t member,
+  mc_address_space_t snapshot, int process_index);
 
 #endif