Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] C++ location lists and expressions
[simgrid.git] / src / mc / mc_object_info.h
index 746a410..e7a5a1b 100644 (file)
@@ -1,4 +1,4 @@
-  /* Copyright (c) 2007-2014. The SimGrid Team.
+/* Copyright (c) 2007-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  *  Debug information for the MC.
  */
 
-#ifndef MC_OBJECT_INFO_H
-#define MC_OBJECT_INFO_H
+#ifndef SIMGRID_MC_OBJECT_INFO_H
+#define SIMGRID_MC_OBJECT_INFO_H
 
 #include <stdint.h>
 
+#include <string>
+
 #include <simgrid_config.h>
 #include <xbt/dict.h>
 #include <xbt/dynar.h>
 
+#include <elfutils/libdw.h>
+
 #include "mc_forward.h"
 #include "mc_location.h"
 #include "mc_process.h"
-
-SG_BEGIN_DECL();
+#include "../smpi/private.h"
 
 // ***** Type
 
-typedef int e_dw_type_type;
+typedef int e_mc_type_type;
+
+namespace simgrid {
+namespace mc {
 
-struct s_dw_type {
-  e_dw_type_type type;
+/** Represents a type in the program
+ *
+ *  It is currently used to represent members of structs and unions as well.
+ */
+class Type {
+public:
+  Type();
+  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) */
-  char *name; /* Name of the type */
+  std::string name; /* Name of the type */
   int byte_size; /* Size in bytes */
   int element_count; /* Number of elements for array type */
-  char *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::string 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:
-  struct s_mc_expression location;
-  int offset;
-
-  dw_type_t subtype; // DW_AT_type
-  dw_type_t full_type; // The same (but more complete) type
+  simgrid::mc::DwarfExpression location_expression;
+
+  mc_type_t subtype; // DW_AT_type
+  mc_type_t full_type; // The same (but more complete) type
+
+  bool has_offset_location() const
+  {
+    return location_expression.size() == 1 &&
+      location_expression[0].atom == DW_OP_plus_uconst;
+  }
+
+  // TODO, check if this shortcut is really necessary
+  int offset() const
+  {
+    xbt_assert(this->has_offset_location());
+    return this->location_expression[0].number;
+  }
+
+  void offset(int new_offset)
+  {
+    Dwarf_Op op;
+    op.atom = DW_OP_plus_uconst;
+    op.number = new_offset;
+    this->location_expression = { op };
+  }
 };
 
-void dw_type_free(dw_type_t t);
-void dw_variable_free(dw_variable_t v);
-void dw_variable_free_voidp(void *t);
+}
+}
 
 // ***** Object info
 
-enum mc_object_info_flags {
-  MC_OBJECT_INFO_NONE = 0,
-  MC_OBJECT_INFO_EXECUTABLE = 1
-};
+/** Bit field of options */
+typedef int mc_object_info_flags;
+#define MC_OBJECT_INFO_NONE 0
+#define MC_OBJECT_INFO_EXECUTABLE 1
+
+namespace simgrid {
+namespace mc {
+
+class ObjectInformation {
+public:
+  ObjectInformation();
+  ~ObjectInformation();
+  ObjectInformation(ObjectInformation const&) = delete;
+  ObjectInformation& operator=(ObjectInformation const&) = delete;
 
-struct s_mc_object_info {
-  enum mc_object_info_flags flags;
+  mc_object_info_flags flags;
   char* file_name;
-  char *start_exec, *end_exec; // Executable segment
-  char *start_rw, *end_rw; // Read-write segment
-  char *start_ro, *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, dw_type_t>
-  xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
+  const void* start;
+  const void *end;
+  char *start_exec;
+  char *end_exec; // Executable segment
+  char *start_rw;
+  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, mc_frame_t>
+  xbt_dynar_t global_variables; // xbt_dynar_t<mc_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;
-};
 
-/** Find the DWARF offset for this ELF object
- *
- *  An offset is applied to address found in DWARF:
- *
- *  <ul>
- *    <li>for an executable obejct, addresses are virtual address
- *        (there is no offset) i.e. \f$\text{virtual address} = \{dwarf address}\f$;</li>
- *    <li>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$.</li>
- *
- */
-void* MC_object_base_address(mc_object_info_t info);
+  bool executable() const
+  {
+    return this->flags & MC_OBJECT_INFO_EXECUTABLE;
+  }
+
+  bool privatized() const
+  {
+    return this->executable() && smpi_privatize_global_variables;
+  }
+
+  void* base_address() const;
+
+  mc_frame_t find_function(const void *ip) const;
+  mc_variable_t find_variable(const char* name) const;
+
+};
 
-mc_object_info_t MC_new_object_info(void);
-mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
-void MC_free_object_info(mc_object_info_t* p);
+}
+}
 
-dw_frame_t MC_file_object_info_find_function(mc_object_info_t info, void *ip);
+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);
 
-void MC_post_process_object_info(mc_process_t process, mc_object_info_t info);
+XBT_INTERNAL void MC_dwarf_get_variables(mc_object_info_t info);
+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);
 
-void MC_dwarf_get_variables(mc_object_info_t info);
-void MC_dwarf_get_variables_libdw(mc_object_info_t info);
-const char* MC_dwarf_attrname(int attr);
-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);
 
-// Not used:
-char* get_type_description(mc_object_info_t info, char *type_name);
+namespace simgrid {
+namespace mc {
 
-void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot, int process_index);
+class Variable {
+public:
+  Variable();
+  Variable(Variable const&) = delete;
+  Variable& operator=(Variable const&) = delete;
 
-struct s_dw_variable{
   Dwarf_Off dwarf_offset; /* Global offset of the field. */
   int global;
-  char *name;
-  char *type_origin;
-  dw_type_t type;
+  std::string name;
+  std::string type_id;
+  mc_type_t type;
 
   // Use either of:
-  s_mc_location_list_t locations;
+  simgrid::mc::LocationList location_list;
   void* address;
 
   size_t start_scope;
@@ -123,26 +177,33 @@ struct s_dw_variable{
 
 };
 
-struct s_dw_frame{
+class Frame {
+public:
+  Frame();
+  ~Frame();
+  Frame(Frame const&) = delete;
+  Frame& operator=(Frame&) = delete;
+
   int tag;
-  char *name;
+  std::string 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)*/
+  simgrid::mc::LocationList frame_base;
+  xbt_dynar_t /* <mc_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;
+  xbt_dynar_t /* <mc_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;
+  mc_frame_t function;
 };
 
-void mc_frame_free(dw_frame_t freme);
-
-SG_END_DECL()
-
 #endif