src/mc/mc_object_info.h

   1 /* Copyright (c) 2007-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 /** file
   8  *  Debug information for the MC.
   9  */
  10
  11 #ifndef SIMGRID_MC_OBJECT_INFO_H
  12 #define SIMGRID_MC_OBJECT_INFO_H
  13
  14 #include <stdint.h>
  15 #include <stdbool.h>
  16
  17 #include <simgrid_config.h>
  18 #include <xbt/dict.h>
  19 #include <xbt/dynar.h>
  20
  21 #include "mc_forward.h"
  22 #include "mc_location.h"
  23 #include "mc_process.h"
  24 #include "../smpi/private.h"
  25
  26 // ***** Type
  27
  28 typedef int e_dw_type_type;
  29
  30 struct s_dw_type {
  31   s_dw_type();
  32   ~s_dw_type();
  33
  34   e_dw_type_type type;
  35   Dwarf_Off id; /* Offset in the section (in hexadecimal form) */
  36   char *name; /* Name of the type */
  37   int byte_size; /* Size in bytes */
  38   int element_count; /* Number of elements for array type */
  39   char *dw_type_id; /* DW_AT_type id */
  40   xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
  41   int is_pointer_type;
  42
  43   // Location (for members) is either of:
  44   struct s_mc_expression location;
  45   int offset;
  46
  47   dw_type_t subtype; // DW_AT_type
  48   dw_type_t full_type; // The same (but more complete) type
  49 };
  50
  51 XBT_INTERNAL void dw_variable_free(dw_variable_t v);
  52 XBT_INTERNAL void dw_variable_free_voidp(void *t);
  53
  54 // ***** Object info
  55
  56 /** Bit field of options */
  57 typedef int mc_object_info_flags;
  58 #define MC_OBJECT_INFO_NONE 0
  59 #define MC_OBJECT_INFO_EXECUTABLE 1
  60
  61 namespace simgrid {
  62 namespace mc {
  63
  64 class ObjectInformation {
  65 public:
  66   ObjectInformation();
  67   ~ObjectInformation();
  68   ObjectInformation(ObjectInformation const&) = delete;
  69   ObjectInformation& operator=(ObjectInformation const&) = delete;
  70
  71   mc_object_info_flags flags;
  72   char* file_name;
  73   const void* start;
  74   const void *end;
  75   char *start_exec;
  76   char *end_exec; // Executable segment
  77   char *start_rw;
  78   char *end_rw; // Read-write segment
  79   char *start_ro;
  80   char *end_ro; // read-only segment
  81   xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
  82   xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
  83   xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
  84   xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
  85
  86   // Here we sort the minimal information for an efficient (and cache-efficient)
  87   // lookup of a function given an instruction pointer.
  88   // The entries are sorted by low_pc and a binary search can be used to look them up.
  89   xbt_dynar_t functions_index;
  90
  91   bool executable() const
  92   {
  93     return this->flags & MC_OBJECT_INFO_EXECUTABLE;
  94   }
  95
  96   bool privatized() const
  97   {
  98     return this->executable() && smpi_privatize_global_variables;
  99   }
 100
 101   void* base_address() const;
 102
 103   dw_frame_t find_function(const void *ip) const;
 104   dw_variable_t find_variable(const char* name) const;
 105
 106 };
 107
 108 }
 109 }
 110
 111 XBT_INTERNAL std::shared_ptr<s_mc_object_info_t> MC_find_object_info(
 112   std::vector<simgrid::mc::VmMap> const& maps, const char* name, int executable);
 113 XBT_INTERNAL void MC_post_process_object_info(mc_process_t process, mc_object_info_t info);
 114
 115 XBT_INTERNAL void MC_dwarf_get_variables(mc_object_info_t info);
 116 XBT_INTERNAL void MC_dwarf_get_variables_libdw(mc_object_info_t info);
 117 XBT_INTERNAL const char* MC_dwarf_attrname(int attr);
 118 XBT_INTERNAL const char* MC_dwarf_tagname(int tag);
 119
 120 XBT_INTERNAL void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_address_space_t snapshot, int process_index);
 121
 122 struct s_dw_variable{
 123   Dwarf_Off dwarf_offset; /* Global offset of the field. */
 124   int global;
 125   char *name;
 126   char *type_origin;
 127   dw_type_t type;
 128
 129   // Use either of:
 130   s_mc_location_list_t locations;
 131   void* address;
 132
 133   size_t start_scope;
 134   mc_object_info_t object_info;
 135
 136 };
 137
 138 struct s_dw_frame{
 139   int tag;
 140   char *name;
 141   void *low_pc;
 142   void *high_pc;
 143   s_mc_location_list_t frame_base;
 144   xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
 145   unsigned long int id; /* DWARF offset of the subprogram */
 146   xbt_dynar_t /* <dw_frame_t> */ scopes;
 147   Dwarf_Off abstract_origin_id;
 148   mc_object_info_t object_info;
 149 };
 150
 151 struct s_mc_function_index_item {
 152   void* low_pc, *high_pc;
 153   dw_frame_t function;
 154 };
 155
 156 XBT_INTERNAL void mc_frame_free(dw_frame_t freme);
 157
 158 #endif