src/mc/inspect/mc_dwarf.cpp

   1 /* Copyright (c) 2008-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/simgrid/util.hpp"
   7 #include "xbt/log.h"
   8 #include "xbt/string.hpp"
   9 #include "xbt/sysdep.h"
  10 #include <simgrid/config.h>
  11
  12 #include "src/mc/inspect/ObjectInformation.hpp"
  13 #include "src/mc/inspect/Variable.hpp"
  14 #include "src/mc/inspect/mc_dwarf.hpp"
  15 #include "src/mc/mc_private.hpp"
  16 #include "src/mc/remote/RemoteSimulation.hpp"
  17
  18 #include <algorithm>
  19 #include <array>
  20 #include <cinttypes>
  21 #include <cstdint>
  22 #include <cstdlib>
  23 #include <fcntl.h>
  24 #include <memory>
  25 #include <unordered_map>
  26 #include <utility>
  27
  28 #include <boost/range/algorithm.hpp>
  29
  30 #include <elfutils/libdw.h>
  31
  32 #include <boost/algorithm/string/predicate.hpp>
  33
  34 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing");
  35
  36 /** @brief The default DW_TAG_lower_bound for a given DW_AT_language.
  37  *
  38  *  The default for a given language is defined in the DWARF spec.
  39  *
  40  *  @param language constant as defined by the DWARf spec
  41  */
  42 static uint64_t MC_dwarf_default_lower_bound(int lang);
  43
  44 /** @brief Computes the the element_count of a DW_TAG_enumeration_type DIE
  45  *
  46  * This is the number of elements in a given array dimension.
  47  *
  48  * A reference of the compilation unit (DW_TAG_compile_unit) is
  49  * needed because the default lower bound (when there is no DW_AT_lower_bound)
  50  * depends of the language of the compilation unit (DW_AT_language).
  51  *
  52  * @param die  DIE for the DW_TAG_enumeration_type or DW_TAG_subrange_type
  53  * @param unit DIE of the DW_TAG_compile_unit
  54  */
  55 static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die* die, Dwarf_Die* unit);
  56
  57 /** @brief Computes the number of elements of a given DW_TAG_array_type.
  58  *
  59  * @param die DIE for the DW_TAG_array_type
  60  */
  61 static uint64_t MC_dwarf_array_element_count(Dwarf_Die* die, Dwarf_Die* unit);
  62
  63 /** @brief Process a DIE
  64  *
  65  *  @param info the resulting object for the library/binary file (output)
  66  *  @param die  the current DIE
  67  *  @param unit the DIE of the compile unit of the current DIE
  68  *  @param frame containing frame if any
  69  */
  70 static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
  71                                 simgrid::mc::Frame* frame, const char* ns);
  72
  73 /** @brief Process a type DIE
  74  */
  75 static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
  76                                      simgrid::mc::Frame* frame, const char* ns);
  77
  78 /** @brief Calls MC_dwarf_handle_die on all children of the given die
  79  *
  80  *  @param info the resulting object for the library/binary file (output)
  81  *  @param die  the current DIE
  82  *  @param unit the DIE of the compile unit of the current DIE
  83  *  @param frame containing frame if any
  84  */
  85 static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
  86                                      simgrid::mc::Frame* frame, const char* ns);
  87
  88 /** @brief Handle a variable (DW_TAG_variable or other)
  89  *
  90  *  @param info the resulting object for the library/binary file (output)
  91  *  @param die  the current DIE
  92  *  @param unit the DIE of the compile unit of the current DIE
  93  *  @param frame containing frame if any
  94  */
  95 static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, const Dwarf_Die* unit,
  96                                          simgrid::mc::Frame* frame, const char* ns);
  97
  98 /** @brief Get the DW_TAG_type of the DIE
  99  *
 100  *  @param die DIE
 101  *  @return DW_TAG_type attribute as a new string (nullptr if none)
 102  */
 103 static std::uint64_t MC_dwarf_at_type(Dwarf_Die* die);
 104
 105 namespace simgrid {
 106 namespace dwarf {
 107
 108 enum class TagClass { Unknown, Type, Subprogram, Variable, Scope, Namespace };
 109
 110 /*** Class of forms defined in the DWARF standard */
 111 enum class FormClass {
 112   Unknown,
 113   Address, // Location in the program's address space
 114   Block,   // Arbitrary block of bytes
 115   Constant,
 116   String,
 117   Flag,      // Boolean value
 118   Reference, // Reference to another DIE
 119   ExprLoc,   // DWARF expression/location description
 120   LinePtr,
 121   LocListPtr,
 122   MacPtr,
 123   RangeListPtr
 124 };
 125
 126 static TagClass classify_tag(int tag)
 127 {
 128   static const std::unordered_map<int, TagClass> map = {
 129       {DW_TAG_array_type, TagClass::Type},            {DW_TAG_class_type, TagClass::Type},
 130       {DW_TAG_enumeration_type, TagClass::Type},      {DW_TAG_typedef, TagClass::Type},
 131       {DW_TAG_pointer_type, TagClass::Type},          {DW_TAG_reference_type, TagClass::Type},
 132       {DW_TAG_rvalue_reference_type, TagClass::Type}, {DW_TAG_string_type, TagClass::Type},
 133       {DW_TAG_structure_type, TagClass::Type},        {DW_TAG_subroutine_type, TagClass::Type},
 134       {DW_TAG_union_type, TagClass::Type},            {DW_TAG_ptr_to_member_type, TagClass::Type},
 135       {DW_TAG_set_type, TagClass::Type},              {DW_TAG_subrange_type, TagClass::Type},
 136       {DW_TAG_base_type, TagClass::Type},             {DW_TAG_const_type, TagClass::Type},
 137       {DW_TAG_file_type, TagClass::Type},             {DW_TAG_packed_type, TagClass::Type},
 138       {DW_TAG_volatile_type, TagClass::Type},         {DW_TAG_restrict_type, TagClass::Type},
 139       {DW_TAG_interface_type, TagClass::Type},        {DW_TAG_unspecified_type, TagClass::Type},
 140       {DW_TAG_shared_type, TagClass::Type},
 141
 142       {DW_TAG_subprogram, TagClass::Subprogram},
 143
 144       {DW_TAG_variable, TagClass::Variable},          {DW_TAG_formal_parameter, TagClass::Variable},
 145
 146       {DW_TAG_lexical_block, TagClass::Scope},        {DW_TAG_try_block, TagClass::Scope},
 147       {DW_TAG_catch_block, TagClass::Scope},          {DW_TAG_inlined_subroutine, TagClass::Scope},
 148       {DW_TAG_with_stmt, TagClass::Scope},
 149
 150       {DW_TAG_namespace, TagClass::Namespace}};
 151
 152   auto res = map.find(tag);
 153   return res != map.end() ? res->second : TagClass::Unknown;
 154 }
 155
 156 /** @brief Find the DWARF data class for a given DWARF data form
 157  *
 158  *  This mapping is defined in the DWARF spec.
 159  *
 160  *  @param form The form (values taken from the DWARF spec)
 161  *  @return An internal representation for the corresponding class
 162  * */
 163 static FormClass classify_form(int form)
 164 {
 165   static const std::unordered_map<int, FormClass> map = {
 166       {DW_FORM_addr, FormClass::Address},
 167
 168       {DW_FORM_block2, FormClass::Block},       {DW_FORM_block4, FormClass::Block},
 169       {DW_FORM_block, FormClass::Block},        {DW_FORM_block1, FormClass::Block},
 170
 171       {DW_FORM_data1, FormClass::Constant},     {DW_FORM_data2, FormClass::Constant},
 172       {DW_FORM_data4, FormClass::Constant},     {DW_FORM_data8, FormClass::Constant},
 173       {DW_FORM_udata, FormClass::Constant},     {DW_FORM_sdata, FormClass::Constant},
 174
 175       {DW_FORM_string, FormClass::String},      {DW_FORM_strp, FormClass::String},
 176
 177       {DW_FORM_ref_addr, FormClass::Reference}, {DW_FORM_ref1, FormClass::Reference},
 178       {DW_FORM_ref2, FormClass::Reference},     {DW_FORM_ref4, FormClass::Reference},
 179       {DW_FORM_ref8, FormClass::Reference},     {DW_FORM_ref_udata, FormClass::Reference},
 180
 181       {DW_FORM_flag, FormClass::Flag},          {DW_FORM_flag_present, FormClass::Flag},
 182
 183       {DW_FORM_exprloc, FormClass::ExprLoc}
 184
 185       // TODO sec offset
 186       // TODO indirect
 187   };
 188
 189   auto res = map.find(form);
 190   return res != map.end() ? res->second : FormClass::Unknown;
 191 }
 192
 193 /** @brief Get the name of the tag of a given DIE
 194  *
 195  *  @param die DIE
 196  *  @return name of the tag of this DIE
 197  */
 198 inline XBT_PRIVATE const char* tagname(Dwarf_Die* die)
 199 {
 200   return tagname(dwarf_tag(die));
 201 }
 202
 203 } // namespace dwarf
 204 } // namespace simgrid
 205
 206 // ***** Attributes
 207
 208 /** @brief Get an attribute of a given DIE as a string
 209  *
 210  *  @param die       the DIE
 211  *  @param attribute attribute
 212  *  @return value of the given attribute of the given DIE
 213  */
 214 static const char* MC_dwarf_attr_integrate_string(Dwarf_Die* die, int attribute)
 215 {
 216   Dwarf_Attribute attr;
 217   if (not dwarf_attr_integrate(die, attribute, &attr))
 218     return nullptr;
 219   else
 220     return dwarf_formstring(&attr);
 221 }
 222
 223 static Dwarf_Off MC_dwarf_attr_dieoffset(Dwarf_Die* die, int attribute)
 224 {
 225   Dwarf_Attribute attr;
 226   if (dwarf_hasattr_integrate(die, attribute) == 0)
 227     return 0;
 228   dwarf_attr_integrate(die, attribute, &attr);
 229   Dwarf_Die subtype_die;
 230   xbt_assert(dwarf_formref_die(&attr, &subtype_die) != nullptr, "Could not find DIE");
 231   return dwarf_dieoffset(&subtype_die);
 232 }
 233
 234 static Dwarf_Off MC_dwarf_attr_integrate_dieoffset(Dwarf_Die* die, int attribute)
 235 {
 236   Dwarf_Attribute attr;
 237   if (dwarf_hasattr_integrate(die, attribute) == 0)
 238     return 0;
 239   dwarf_attr_integrate(die, DW_AT_type, &attr);
 240   Dwarf_Die subtype_die;
 241   xbt_assert(dwarf_formref_die(&attr, &subtype_die) != nullptr, "Could not find DIE");
 242   return dwarf_dieoffset(&subtype_die);
 243 }
 244
 245 /** @brief Find the type/subtype (DW_AT_type) for a DIE
 246  *
 247  *  @param die the DIE
 248  *  @return DW_AT_type reference as a global offset in hexadecimal (or nullptr)
 249  */
 250 static std::uint64_t MC_dwarf_at_type(Dwarf_Die* die)
 251 {
 252   return MC_dwarf_attr_integrate_dieoffset(die, DW_AT_type);
 253 }
 254
 255 static uint64_t MC_dwarf_attr_integrate_addr(Dwarf_Die* die, int attribute)
 256 {
 257   Dwarf_Attribute attr;
 258   if (dwarf_attr_integrate(die, attribute, &attr) == nullptr)
 259     return 0;
 260   Dwarf_Addr value;
 261   if (dwarf_formaddr(&attr, &value) == 0)
 262     return (uint64_t)value;
 263   else
 264     return 0;
 265 }
 266
 267 static uint64_t MC_dwarf_attr_integrate_uint(Dwarf_Die* die, int attribute, uint64_t default_value)
 268 {
 269   Dwarf_Attribute attr;
 270   if (dwarf_attr_integrate(die, attribute, &attr) == nullptr)
 271     return default_value;
 272   Dwarf_Word value;
 273   return dwarf_formudata(dwarf_attr_integrate(die, attribute, &attr), &value) == 0 ? (uint64_t)value : default_value;
 274 }
 275
 276 static bool MC_dwarf_attr_flag(Dwarf_Die* die, int attribute, bool integrate)
 277 {
 278   Dwarf_Attribute attr;
 279   if ((integrate ? dwarf_attr_integrate(die, attribute, &attr) : dwarf_attr(die, attribute, &attr)) == nullptr)
 280     return false;
 281
 282   bool result;
 283   xbt_assert(not dwarf_formflag(&attr, &result), "Unexpected form for attribute %s",
 284              simgrid::dwarf::attrname(attribute));
 285   return result;
 286 }
 287
 288 /** @brief Find the default lower bound for a given language
 289  *
 290  *  The default lower bound of an array (when DW_TAG_lower_bound
 291  *  is missing) depends on the language of the compilation unit.
 292  *
 293  *  @param lang Language of the compilation unit (values defined in the DWARF spec)
 294  *  @return     Default lower bound of an array in this compilation unit
 295  * */
 296 static uint64_t MC_dwarf_default_lower_bound(int lang)
 297 {
 298   const std::unordered_map<int, unsigned> map = {
 299       {DW_LANG_C, 0},           {DW_LANG_C89, 0},            {DW_LANG_C99, 0},            {DW_LANG_C11, 0},
 300       {DW_LANG_C_plus_plus, 0}, {DW_LANG_C_plus_plus_11, 0}, {DW_LANG_C_plus_plus_14, 0}, {DW_LANG_D, 0},
 301       {DW_LANG_Java, 0},        {DW_LANG_ObjC, 0},           {DW_LANG_ObjC_plus_plus, 0}, {DW_LANG_Python, 0},
 302       {DW_LANG_UPC, 0},
 303
 304       {DW_LANG_Ada83, 1},       {DW_LANG_Ada95, 1},          {DW_LANG_Fortran77, 1},      {DW_LANG_Fortran90, 1},
 305       {DW_LANG_Fortran95, 1},   {DW_LANG_Fortran03, 1},      {DW_LANG_Fortran08, 1},      {DW_LANG_Modula2, 1},
 306       {DW_LANG_Pascal83, 1},    {DW_LANG_PL1, 1},            {DW_LANG_Cobol74, 1},        {DW_LANG_Cobol85, 1}};
 307
 308   auto res = map.find(lang);
 309   xbt_assert(res != map.end(), "No default DW_TAG_lower_bound for language %i and none given", lang);
 310   return res->second;
 311 }
 312
 313 /** @brief Finds the number of elements in a DW_TAG_subrange_type or DW_TAG_enumeration_type DIE
 314  *
 315  *  @param die  the DIE
 316  *  @param unit DIE of the compilation unit
 317  *  @return     number of elements in the range
 318  * */
 319 static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die* die, Dwarf_Die* unit)
 320 {
 321   xbt_assert(dwarf_tag(die) == DW_TAG_enumeration_type || dwarf_tag(die) == DW_TAG_subrange_type,
 322              "MC_dwarf_subrange_element_count called with DIE of type %s", simgrid::dwarf::tagname(die));
 323
 324   // Use DW_TAG_count if present:
 325   if (dwarf_hasattr_integrate(die, DW_AT_count))
 326     return MC_dwarf_attr_integrate_uint(die, DW_AT_count, 0);
 327   // Otherwise compute DW_TAG_upper_bound-DW_TAG_lower_bound + 1:
 328
 329   if (not dwarf_hasattr_integrate(die, DW_AT_upper_bound))
 330     // This is not really 0, but the code expects this (we do not know):
 331     return 0;
 332
 333   uint64_t upper_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_upper_bound, static_cast<uint64_t>(-1));
 334
 335   uint64_t lower_bound = 0;
 336   if (dwarf_hasattr_integrate(die, DW_AT_lower_bound))
 337     lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, static_cast<uint64_t>(-1));
 338   else
 339     lower_bound = MC_dwarf_default_lower_bound(dwarf_srclang(unit));
 340   return upper_bound - lower_bound + 1;
 341 }
 342
 343 /** @brief Finds the number of elements in an array type (DW_TAG_array_type)
 344  *
 345  *  The compilation unit might be needed because the default lower
 346  *  bound depends on the language of the compilation unit.
 347  *
 348  *  @param die the DIE of the DW_TAG_array_type
 349  *  @param unit the DIE of the compilation unit
 350  *  @return number of elements in this array type
 351  * */
 352 static uint64_t MC_dwarf_array_element_count(Dwarf_Die* die, Dwarf_Die* unit)
 353 {
 354   xbt_assert(dwarf_tag(die) == DW_TAG_array_type, "MC_dwarf_array_element_count called with DIE of type %s",
 355              simgrid::dwarf::tagname(die));
 356
 357   int result = 1;
 358   Dwarf_Die child;
 359   for (int res = dwarf_child(die, &child); res == 0; res = dwarf_siblingof(&child, &child)) {
 360     int child_tag = dwarf_tag(&child);
 361     if (child_tag == DW_TAG_subrange_type || child_tag == DW_TAG_enumeration_type)
 362       result *= MC_dwarf_subrange_element_count(&child, unit);
 363   }
 364   return result;
 365 }
 366
 367 // ***** Variable
 368
 369 /** Sort the variable by name and address.
 370  *
 371  *  We could use boost::container::flat_set instead.
 372  */
 373 static bool MC_compare_variable(simgrid::mc::Variable const& a, simgrid::mc::Variable const& b)
 374 {
 375   int cmp = a.name.compare(b.name);
 376   if (cmp < 0)
 377     return true;
 378   else if (cmp > 0)
 379     return false;
 380   else
 381     return a.address < b.address;
 382 }
 383
 384 // ***** simgrid::mc::Type*
 385
 386 /** @brief Initialize the location of a member of a type
 387  * (DW_AT_data_member_location of a DW_TAG_member).
 388  *
 389  *  @param  type   a type (struct, class)
 390  *  @param  member the member of the type
 391  *  @param  child  DIE of the member (DW_TAG_member)
 392  */
 393 static void MC_dwarf_fill_member_location(const simgrid::mc::Type* type, simgrid::mc::Member* member, Dwarf_Die* child)
 394 {
 395   xbt_assert(not dwarf_hasattr(child, DW_AT_data_bit_offset), "Can't groke DW_AT_data_bit_offset.");
 396
 397   if (not dwarf_hasattr_integrate(child, DW_AT_data_member_location)) {
 398     if (type->type == DW_TAG_union_type)
 399       return;
 400     xbt_die("Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%" PRIx64 ">%s",
 401             member->name.c_str(), (uint64_t)type->id, type->name.c_str());
 402   }
 403
 404   Dwarf_Attribute attr;
 405   dwarf_attr_integrate(child, DW_AT_data_member_location, &attr);
 406   int form                             = dwarf_whatform(&attr);
 407   simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form);
 408   switch (form_class) {
 409     case simgrid::dwarf::FormClass::ExprLoc:
 410     case simgrid::dwarf::FormClass::Block:
 411       // Location expression:
 412       {
 413         Dwarf_Op* expr;
 414         size_t len;
 415         xbt_assert(not dwarf_getlocation(&attr, &expr, &len),
 416                    "Could not read location expression DW_AT_data_member_location in DW_TAG_member %s of type <%" PRIx64
 417                    ">%s",
 418                    MC_dwarf_attr_integrate_string(child, DW_AT_name), (uint64_t)type->id, type->name.c_str());
 419         member->location_expression = simgrid::dwarf::DwarfExpression(expr, expr + len);
 420         break;
 421       }
 422     case simgrid::dwarf::FormClass::Constant:
 423       // Offset from the base address of the object:
 424       {
 425         Dwarf_Word offset;
 426         xbt_assert(not dwarf_formudata(&attr, &offset), "Cannot get %s location <%" PRIx64 ">%s",
 427                    MC_dwarf_attr_integrate_string(child, DW_AT_name), (uint64_t)type->id, type->name.c_str());
 428         member->offset(offset);
 429         break;
 430       }
 431
 432     default:
 433       // includes FormClass::LocListPtr (reference to a location list: TODO) and FormClass::Reference (it's supposed to
 434       // be possible in DWARF2 but I couldn't find its semantic in the spec)
 435       xbt_die("Can't handle form class (%d) / form 0x%x as DW_AT_member_location", (int)form_class, (unsigned)form);
 436   }
 437 }
 438
 439 /** @brief Populate the list of members of a type
 440  *
 441  *  @param info ELF object containing the type DIE
 442  *  @param die  DIE of the type
 443  *  @param unit DIE of the compilation unit containing the type DIE
 444  *  @param type the type
 445  */
 446 static void MC_dwarf_add_members(const simgrid::mc::ObjectInformation* /*info*/, Dwarf_Die* die,
 447                                  const Dwarf_Die* /*unit*/, simgrid::mc::Type* type)
 448 {
 449   Dwarf_Die child;
 450   xbt_assert(type->members.empty());
 451   for (int res = dwarf_child(die, &child); res == 0; res = dwarf_siblingof(&child, &child)) {
 452     int tag = dwarf_tag(&child);
 453     if (tag == DW_TAG_member || tag == DW_TAG_inheritance) {
 454       // Skip declarations:
 455       if (MC_dwarf_attr_flag(&child, DW_AT_declaration, false))
 456         continue;
 457
 458       // Skip compile time constants:
 459       if (dwarf_hasattr(&child, DW_AT_const_value))
 460         continue;
 461
 462       // TODO, we should use another type (because is is not a type but a member)
 463       simgrid::mc::Member member;
 464       if (tag == DW_TAG_inheritance)
 465         member.flags |= simgrid::mc::Member::INHERITANCE_FLAG;
 466
 467       const char* name = MC_dwarf_attr_integrate_string(&child, DW_AT_name);
 468       if (name)
 469         member.name = name;
 470       // Those base names are used by GCC and clang for virtual table pointers
 471       // respectively ("__vptr$ClassName", "__vptr.ClassName"):
 472       if (boost::algorithm::starts_with(member.name, "__vptr$") ||
 473           boost::algorithm::starts_with(member.name, "__vptr."))
 474         member.flags |= simgrid::mc::Member::VIRTUAL_POINTER_FLAG;
 475       // A cleaner solution would be to check against the type:
 476       // ---
 477       // tag: DW_TAG_member
 478       // name: "_vptr$Foo"
 479       // type:
 480       //   # Type for a pointer to a vtable
 481       //   tag: DW_TAG_pointer_type
 482       //   type:
 483       //     # Type for a vtable:
 484       //     tag: DW_TAG_pointer_type
 485       //     name: "__vtbl_ptr_type"
 486       //     type:
 487       //       tag: DW_TAG_subroutine_type
 488       //       type:
 489       //         tag: DW_TAG_base_type
 490       //         name: "int"
 491       // ---
 492
 493       member.byte_size = MC_dwarf_attr_integrate_uint(&child, DW_AT_byte_size, 0);
 494       member.type_id   = MC_dwarf_at_type(&child);
 495
 496       xbt_assert(not dwarf_hasattr(&child, DW_AT_data_bit_offset), "Can't groke DW_AT_data_bit_offset.");
 497
 498       MC_dwarf_fill_member_location(type, &member, &child);
 499
 500       xbt_assert(member.type_id, "Missing type for member %s of <%" PRIx64 ">%s", member.name.c_str(),
 501                  (uint64_t)type->id, type->name.c_str());
 502
 503       type->members.push_back(std::move(member));
 504     }
 505   }
 506 }
 507
 508 /** @brief Create a MC type object from a DIE
 509  *
 510  *  @param info current object info object
 511  *  @param die DIE (for a given type)
 512  *  @param unit compilation unit of the current DIE
 513  *  @return MC representation of the type
 514  */
 515 static simgrid::mc::Type MC_dwarf_die_to_type(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 516                                               simgrid::mc::Frame* frame, const char* ns)
 517 {
 518   simgrid::mc::Type type;
 519   type.type          = dwarf_tag(die);
 520   type.name          = std::string();
 521   type.element_count = -1;
 522
 523   // Global Offset
 524   type.id = dwarf_dieoffset(die);
 525
 526   const char* prefix = "";
 527   switch (type.type) {
 528     case DW_TAG_structure_type:
 529       prefix = "struct ";
 530       break;
 531     case DW_TAG_union_type:
 532       prefix = "union ";
 533       break;
 534     case DW_TAG_class_type:
 535       prefix = "class ";
 536       break;
 537     default:
 538       prefix = "";
 539   }
 540
 541   const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 542   if (name != nullptr) {
 543     if (ns)
 544       type.name = simgrid::xbt::string_printf("%s%s::%s", prefix, ns, name);
 545     else
 546       type.name = simgrid::xbt::string_printf("%s%s", prefix, name);
 547   }
 548
 549   type.type_id = MC_dwarf_at_type(die);
 550
 551   // Some compilers do not emit DW_AT_byte_size for pointer_type,
 552   // so we fill this. We currently assume that the model-checked process is in
 553   // the same architecture..
 554   if (type.type == DW_TAG_pointer_type)
 555     type.byte_size = sizeof(void*);
 556
 557   // Computation of the byte_size
 558   if (dwarf_hasattr_integrate(die, DW_AT_byte_size))
 559     type.byte_size = MC_dwarf_attr_integrate_uint(die, DW_AT_byte_size, 0);
 560   else if (type.type == DW_TAG_array_type || type.type == DW_TAG_structure_type || type.type == DW_TAG_class_type) {
 561     Dwarf_Word size;
 562     if (dwarf_aggregate_size(die, &size) == 0)
 563       type.byte_size = size;
 564   }
 565
 566   switch (type.type) {
 567     case DW_TAG_array_type:
 568       type.element_count = MC_dwarf_array_element_count(die, unit);
 569       // TODO, handle DW_byte_stride and (not) DW_bit_stride
 570       break;
 571
 572     case DW_TAG_pointer_type:
 573     case DW_TAG_reference_type:
 574     case DW_TAG_rvalue_reference_type:
 575       break;
 576
 577     case DW_TAG_structure_type:
 578     case DW_TAG_union_type:
 579     case DW_TAG_class_type:
 580       MC_dwarf_add_members(info, die, unit, &type);
 581       MC_dwarf_handle_children(info, die, unit, frame,
 582                                ns ? simgrid::xbt::string_printf("%s::%s", ns, name).c_str() : type.name.c_str());
 583       break;
 584
 585     default:
 586       XBT_DEBUG("Unhandled type: %d (%s)", type.type, simgrid::dwarf::tagname(type.type));
 587       break;
 588   }
 589
 590   return type;
 591 }
 592
 593 static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 594                                      simgrid::mc::Frame* frame, const char* ns)
 595 {
 596   simgrid::mc::Type type = MC_dwarf_die_to_type(info, die, unit, frame, ns);
 597   auto& t                = (info->types[type.id] = std::move(type));
 598   if (not t.name.empty() && type.byte_size != 0)
 599     info->full_types_by_name[t.name] = &t;
 600 }
 601
 602 static int mc_anonymous_variable_index = 0;
 603
 604 static std::unique_ptr<simgrid::mc::Variable> MC_die_to_variable(simgrid::mc::ObjectInformation* info, Dwarf_Die* die,
 605                                                                  const Dwarf_Die* /*unit*/,
 606                                                                  const simgrid::mc::Frame* frame, const char* ns)
 607 {
 608   // Skip declarations:
 609   if (MC_dwarf_attr_flag(die, DW_AT_declaration, false))
 610     return nullptr;
 611
 612   // Skip compile time constants:
 613   if (dwarf_hasattr(die, DW_AT_const_value))
 614     return nullptr;
 615
 616   Dwarf_Attribute attr_location;
 617   if (dwarf_attr(die, DW_AT_location, &attr_location) == nullptr)
 618     // No location: do not add it ?
 619     return nullptr;
 620
 621   auto variable         = std::make_unique<simgrid::mc::Variable>();
 622   variable->id          = dwarf_dieoffset(die);
 623   variable->global      = frame == nullptr; // Can be override base on DW_AT_location
 624   variable->object_info = info;
 625
 626   const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 627   if (name)
 628     variable->name = name;
 629   variable->type_id = MC_dwarf_at_type(die);
 630
 631   int form = dwarf_whatform(&attr_location);
 632   simgrid::dwarf::FormClass form_class;
 633   if (form == DW_FORM_sec_offset)
 634     form_class = simgrid::dwarf::FormClass::Constant;
 635   else
 636     form_class = simgrid::dwarf::classify_form(form);
 637   switch (form_class) {
 638     case simgrid::dwarf::FormClass::ExprLoc:
 639     case simgrid::dwarf::FormClass::Block:
 640       // Location expression:
 641       {
 642         Dwarf_Op* expr;
 643         size_t len;
 644         xbt_assert(not dwarf_getlocation(&attr_location, &expr, &len),
 645                    "Could not read location expression in DW_AT_location "
 646                    "of variable <%" PRIx64 ">%s",
 647                    (uint64_t)variable->id, variable->name.c_str());
 648
 649         if (len == 1 && expr[0].atom == DW_OP_addr) {
 650           variable->global  = true;
 651           auto offset       = static_cast<uintptr_t>(expr[0].number);
 652           auto base         = reinterpret_cast<uintptr_t>(info->base_address());
 653           variable->address = reinterpret_cast<void*>(base + offset);
 654         } else
 655           variable->location_list = {
 656               simgrid::dwarf::LocationListEntry(simgrid::dwarf::DwarfExpression(expr, expr + len))};
 657
 658         break;
 659       }
 660
 661     case simgrid::dwarf::FormClass::LocListPtr:
 662     case simgrid::dwarf::FormClass::Constant:
 663       // Reference to location list:
 664       variable->location_list = simgrid::dwarf::location_list(*info, attr_location);
 665       break;
 666
 667     default:
 668       xbt_die("Unexpected form 0x%x (%i), class 0x%x (%i) list for location in <%" PRIx64 ">%s", (unsigned)form, form,
 669               (unsigned)form_class, (int)form_class, (uint64_t)variable->id, variable->name.c_str());
 670   }
 671
 672   // Handle start_scope:
 673   if (dwarf_hasattr(die, DW_AT_start_scope)) {
 674     Dwarf_Attribute attr;
 675     dwarf_attr(die, DW_AT_start_scope, &attr);
 676     form       = dwarf_whatform(&attr);
 677     form_class = simgrid::dwarf::classify_form(form);
 678     if (form_class == simgrid::dwarf::FormClass::Constant) {
 679       Dwarf_Word value;
 680       variable->start_scope = dwarf_formudata(&attr, &value) == 0 ? (size_t)value : 0;
 681     } else {
 682       // TODO: FormClass::RangeListPtr
 683       xbt_die("Unhandled form 0x%x, class 0x%X for DW_AT_start_scope of variable %s", (unsigned)form,
 684               (unsigned)form_class, name == nullptr ? "?" : name);
 685     }
 686   }
 687
 688   if (ns && variable->global)
 689     variable->name = std::string(ns) + "::" + variable->name;
 690
 691   // The current code needs a variable name,
 692   // generate a fake one:
 693   if (variable->name.empty()) {
 694     variable->name = "@anonymous#" + std::to_string(mc_anonymous_variable_index);
 695     mc_anonymous_variable_index++;
 696   }
 697   return variable;
 698 }
 699
 700 static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, const Dwarf_Die* unit,
 701                                          simgrid::mc::Frame* frame, const char* ns)
 702 {
 703   std::unique_ptr<simgrid::mc::Variable> variable = MC_die_to_variable(info, die, unit, frame, ns);
 704   if (not variable)
 705     return;
 706   // Those arrays are sorted later:
 707   if (variable->global)
 708     info->global_variables.push_back(std::move(*variable));
 709   else if (frame != nullptr)
 710     frame->variables.push_back(std::move(*variable));
 711   else
 712     xbt_die("No frame for this local variable");
 713 }
 714
 715 static void MC_dwarf_handle_scope_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 716                                       simgrid::mc::Frame* parent_frame, const char* ns)
 717 {
 718   // TODO, handle DW_TAG_type/DW_TAG_location for DW_TAG_with_stmt
 719   int tag                        = dwarf_tag(die);
 720   simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag);
 721
 722   // (Template) Subprogram declaration:
 723   if (klass == simgrid::dwarf::TagClass::Subprogram && MC_dwarf_attr_flag(die, DW_AT_declaration, false))
 724     return;
 725
 726   if (klass == simgrid::dwarf::TagClass::Scope)
 727     xbt_assert(parent_frame, "No parent scope for this scope");
 728
 729   simgrid::mc::Frame frame;
 730   frame.tag         = tag;
 731   frame.id          = dwarf_dieoffset(die);
 732   frame.object_info = info;
 733
 734   if (klass == simgrid::dwarf::TagClass::Subprogram) {
 735     const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 736     if (name && ns)
 737       frame.name = std::string(ns) + "::" + name;
 738     else if (name)
 739       frame.name = name;
 740   }
 741
 742   frame.abstract_origin_id = MC_dwarf_attr_dieoffset(die, DW_AT_abstract_origin);
 743
 744   // This is the base address for DWARF addresses.
 745   // Relocated addresses are offset from this base address.
 746   // See DWARF4 spec 7.5
 747   auto base = reinterpret_cast<std::uint64_t>(info->base_address());
 748
 749   // TODO, support DW_AT_ranges
 750   uint64_t low_pc     = MC_dwarf_attr_integrate_addr(die, DW_AT_low_pc);
 751   frame.range.begin() = low_pc ? base + low_pc : 0;
 752   if (low_pc) {
 753     // DW_AT_high_pc:
 754     Dwarf_Attribute attr;
 755     xbt_assert(dwarf_attr_integrate(die, DW_AT_high_pc, &attr), "Missing DW_AT_high_pc matching with DW_AT_low_pc");
 756
 757     Dwarf_Sword offset;
 758     Dwarf_Addr high_pc;
 759
 760     switch (simgrid::dwarf::classify_form(dwarf_whatform(&attr))) {
 761       // DW_AT_high_pc if an offset from the low_pc:
 762       case simgrid::dwarf::FormClass::Constant:
 763
 764         xbt_assert(dwarf_formsdata(&attr, &offset) == 0, "Could not read constant");
 765         frame.range.end() = frame.range.begin() + offset;
 766         break;
 767
 768         // DW_AT_high_pc is a relocatable address:
 769       case simgrid::dwarf::FormClass::Address:
 770         xbt_assert(dwarf_formaddr(&attr, &high_pc) == 0, "Could not read address");
 771         frame.range.end() = base + high_pc;
 772         break;
 773
 774       default:
 775         xbt_die("Unexpected class for DW_AT_high_pc");
 776     }
 777   }
 778
 779   if (klass == simgrid::dwarf::TagClass::Subprogram) {
 780     Dwarf_Attribute attr_frame_base;
 781     if (dwarf_attr_integrate(die, DW_AT_frame_base, &attr_frame_base))
 782       frame.frame_base_location = simgrid::dwarf::location_list(*info, attr_frame_base);
 783   }
 784
 785   // Handle children:
 786   MC_dwarf_handle_children(info, die, unit, &frame, ns);
 787
 788   // We sort them in order to have an (somewhat) efficient by name
 789   // lookup:
 790   boost::range::sort(frame.variables, MC_compare_variable);
 791
 792   // Register it:
 793   if (klass == simgrid::dwarf::TagClass::Subprogram)
 794     info->subprograms[frame.id] = std::move(frame);
 795   else if (klass == simgrid::dwarf::TagClass::Scope)
 796     parent_frame->scopes.push_back(std::move(frame));
 797 }
 798
 799 static void mc_dwarf_handle_namespace_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 800                                           simgrid::mc::Frame* frame, const char* ns)
 801 {
 802   const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 803   xbt_assert(not frame, "Unexpected namespace in a subprogram");
 804   char* new_ns = ns == nullptr ? xbt_strdup(name) : bprintf("%s::%s", ns, name);
 805   MC_dwarf_handle_children(info, die, unit, frame, new_ns);
 806   xbt_free(new_ns);
 807 }
 808
 809 static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 810                                      simgrid::mc::Frame* frame, const char* ns)
 811 {
 812   // For each child DIE:
 813   Dwarf_Die child;
 814   for (int res = dwarf_child(die, &child); res == 0; res = dwarf_siblingof(&child, &child))
 815     MC_dwarf_handle_die(info, &child, unit, frame, ns);
 816 }
 817
 818 static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 819                                 simgrid::mc::Frame* frame, const char* ns)
 820 {
 821   int tag                        = dwarf_tag(die);
 822   simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag);
 823   switch (klass) {
 824     // Type:
 825     case simgrid::dwarf::TagClass::Type:
 826       MC_dwarf_handle_type_die(info, die, unit, frame, ns);
 827       break;
 828
 829       // Subprogram or scope:
 830     case simgrid::dwarf::TagClass::Subprogram:
 831     case simgrid::dwarf::TagClass::Scope:
 832       MC_dwarf_handle_scope_die(info, die, unit, frame, ns);
 833       return;
 834
 835       // Variable:
 836     case simgrid::dwarf::TagClass::Variable:
 837       MC_dwarf_handle_variable_die(info, die, unit, frame, ns);
 838       break;
 839
 840     case simgrid::dwarf::TagClass::Namespace:
 841       mc_dwarf_handle_namespace_die(info, die, unit, frame, ns);
 842       break;
 843
 844     default:
 845       break;
 846   }
 847 }
 848
 849 static Elf64_Half get_type(Elf* elf)
 850 {
 851   const Elf64_Ehdr* ehdr64 = elf64_getehdr(elf);
 852   if (ehdr64)
 853     return ehdr64->e_type;
 854   const Elf32_Ehdr* ehdr32 = elf32_getehdr(elf);
 855   if (ehdr32)
 856     return ehdr32->e_type;
 857   xbt_die("Could not get ELF heeader");
 858 }
 859
 860 static void read_dwarf_info(simgrid::mc::ObjectInformation* info, Dwarf* dwarf)
 861 {
 862   // For each compilation unit:
 863   Dwarf_Off offset      = 0;
 864   Dwarf_Off next_offset = 0;
 865   size_t length;
 866
 867   while (dwarf_nextcu(dwarf, offset, &next_offset, &length, nullptr, nullptr, nullptr) == 0) {
 868     Dwarf_Die unit_die;
 869     if (dwarf_offdie(dwarf, offset + length, &unit_die) != nullptr)
 870       MC_dwarf_handle_children(info, &unit_die, &unit_die, nullptr, nullptr);
 871     offset = next_offset;
 872   }
 873 }
 874
 875 /** Get the build-id (NT_GNU_BUILD_ID) from the ELF file
 876  *
 877  *  This build-id may is used to locate an external debug (DWARF) file
 878  *  for this ELF file.
 879  *
 880  *  @param  elf libelf handle for an ELF file
 881  *  @return build-id for this ELF file (or an empty vector if none is found)
 882  */
 883 static std::vector<char> get_build_id(Elf* elf)
 884 {
 885 #ifdef __linux
 886   // Summary: the GNU build ID is stored in a ("GNU, NT_GNU_BUILD_ID) note
 887   // found in a PT_NOTE entry in the program header table.
 888
 889   size_t phnum;
 890   xbt_assert(elf_getphdrnum(elf, &phnum) == 0, "Could not read program headers");
 891
 892   // Iterate over the program headers and find the PT_NOTE ones:
 893   for (size_t i = 0; i < phnum; ++i) {
 894     GElf_Phdr phdr_temp;
 895     const GElf_Phdr* phdr = gelf_getphdr(elf, i, &phdr_temp);
 896     if (phdr->p_type != PT_NOTE)
 897       continue;
 898
 899     Elf_Data* data = elf_getdata_rawchunk(elf, phdr->p_offset, phdr->p_filesz, ELF_T_NHDR);
 900
 901     // Iterate over the notes and find the NT_GNU_BUILD_ID one:
 902     size_t pos = 0;
 903     while (pos < data->d_size) {
 904       GElf_Nhdr nhdr;
 905       // Location of the name within Elf_Data:
 906       size_t name_pos;
 907       size_t desc_pos;
 908       pos = gelf_getnote(data, pos, &nhdr, &name_pos, &desc_pos);
 909       // A build ID note is identified by the pair ("GNU", NT_GNU_BUILD_ID)
 910       // (a namespace and a type within this namespace):
 911       if (nhdr.n_type == NT_GNU_BUILD_ID && nhdr.n_namesz == sizeof("GNU") &&
 912           memcmp((char*)data->d_buf + name_pos, "GNU", sizeof("GNU")) == 0) {
 913         XBT_DEBUG("Found GNU/NT_GNU_BUILD_ID note");
 914         char* start = (char*)data->d_buf + desc_pos;
 915         char* end   = start + nhdr.n_descsz;
 916         return std::vector<char>(start, end);
 917       }
 918     }
 919   }
 920 #endif
 921   return std::vector<char>();
 922 }
 923
 924 /** Binary data to hexadecimal */
 925 static inline std::array<char, 2> to_hex(std::uint8_t byte)
 926 {
 927   constexpr std::array<char, 16> hexdigits{
 928       {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'}};
 929   // Horrid double braces!
 930   // Apparently, this is needed in C++11 (not in C++14).
 931   return {{hexdigits[byte >> 4], hexdigits[byte & 0xF]}};
 932 }
 933
 934 /** Binary data to hexadecimal */
 935 static std::string to_hex(const char* data, std::size_t count)
 936 {
 937   std::string res;
 938   res.resize(2 * count);
 939   for (std::size_t i = 0; i < count; i++)
 940     std::copy_n(cbegin(to_hex(data[i])), 2, &res[2 * i]);
 941   return res;
 942 }
 943
 944 /** Binary data to hexadecimal */
 945 static std::string to_hex(std::vector<char> const& data)
 946 {
 947   return to_hex(data.data(), data.size());
 948 }
 949
 950 /** Base directories for external debug files */
 951 static constexpr auto debug_paths = {
 952     "/usr/lib/debug/",
 953     "/usr/local/lib/debug/",
 954 };
 955
 956 /** Locate an external debug file from the NT_GNU_BUILD_ID
 957  *
 958  *  This is one of the mechanisms used for
 959  *  [separate debug files](https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html).
 960  */
 961 // Example:
 962 // /usr/lib/debug/.build-id/0b/dc77f1c29aea2b14ff5acd9a19ab3175ffdeae.debug
 963 static std::string find_by_build_id(std::vector<char> id)
 964 {
 965   std::string filename;
 966   std::string hex = to_hex(id);
 967   for (const char* const& debug_path : debug_paths) {
 968     // Example:
 969     filename = std::string(debug_path) + ".build-id/" + to_hex(id.data(), 1) + '/' +
 970                to_hex(id.data() + 1, id.size() - 1) + ".debug";
 971     XBT_DEBUG("Checking debug file: %s", filename.c_str());
 972     if (access(filename.c_str(), F_OK) == 0) {
 973       XBT_DEBUG("Found debug file: %s\n", hex.c_str());
 974       return filename;
 975     }
 976   }
 977   XBT_DEBUG("No debug info found for build ID %s\n", hex.data());
 978   return std::string();
 979 }
 980
 981 /** @brief Populate the debugging information of the given ELF object
 982  *
 983  *  Read the DWARf information of the EFFL object and populate the
 984  *  lists of types, variables, functions.
 985  */
 986 static void MC_load_dwarf(simgrid::mc::ObjectInformation* info)
 987 {
 988   xbt_assert(elf_version(EV_CURRENT) != EV_NONE, "libelf initialization error");
 989
 990   // Open the ELF file:
 991   int fd = open(info->file_name.c_str(), O_RDONLY);
 992   xbt_assert(fd >= 0, "Could not open file %s", info->file_name.c_str());
 993   Elf* elf = elf_begin(fd, ELF_C_READ, nullptr);
 994   xbt_assert(elf != nullptr, "Not an ELF file");
 995   Elf_Kind kind = elf_kind(elf);
 996   xbt_assert(kind == ELF_K_ELF, "Not an ELF file");
 997
 998   // Remember if this is a `ET_EXEC` (fixed location) or `ET_DYN`:
 999   Elf64_Half type = get_type(elf);
1000   if (type == ET_EXEC)
1001     info->flags |= simgrid::mc::ObjectInformation::Executable;
1002
1003   // Read DWARF debug information in the file:
1004   Dwarf* dwarf = dwarf_begin_elf(elf, DWARF_C_READ, nullptr);
1005   if (dwarf != nullptr) {
1006     read_dwarf_info(info, dwarf);
1007     dwarf_end(dwarf);
1008     elf_end(elf);
1009     close(fd);
1010     return;
1011   }
1012   dwarf_end(dwarf);
1013
1014   // If there was no DWARF in the file, try to find it in a separate file.
1015   // Different methods might be used to store the DWARF information:
1016   //  * GNU NT_GNU_BUILD_ID
1017   //  * .gnu_debuglink
1018   // See https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
1019   // for reference of what we are doing.
1020
1021   // Try with NT_GNU_BUILD_ID: we find the build ID in the ELF file and then
1022   // use this ID to find the file in some known locations in the filesystem.
1023   std::vector<char> build_id = get_build_id(elf);
1024   if (not build_id.empty()) {
1025     elf_end(elf);
1026     close(fd);
1027
1028     // Find the debug file using the build id:
1029     std::string debug_file = find_by_build_id(build_id);
1030     xbt_assert(not debug_file.empty(),
1031                "Missing debug info for %s with build-id %s\n"
1032                "You might want to install the suitable debugging package.\n",
1033                info->file_name.c_str(), to_hex(build_id).c_str());
1034
1035     // Load the DWARF info from this file:
1036     XBT_DEBUG("Load DWARF for %s from %s", info->file_name.c_str(), debug_file.c_str());
1037     fd = open(debug_file.c_str(), O_RDONLY);
1038     xbt_assert(fd >= 0, "Could not open file %s", debug_file.c_str());
1039     dwarf = dwarf_begin(fd, DWARF_C_READ);
1040     xbt_assert(dwarf != nullptr, "No DWARF info in %s for %s", debug_file.c_str(), info->file_name.c_str());
1041     read_dwarf_info(info, dwarf);
1042     dwarf_end(dwarf);
1043     close(fd);
1044     return;
1045   }
1046
1047   // TODO, try to find DWARF info using .gnu_debuglink.
1048
1049   elf_end(elf);
1050   close(fd);
1051   xbt_die("Debugging information not found for %s\n"
1052           "Try recompiling with -g\n",
1053           info->file_name.c_str());
1054 }
1055
1056 // ***** Functions index
1057
1058 static void MC_make_functions_index(simgrid::mc::ObjectInformation* info)
1059 {
1060   info->functions_index.clear();
1061
1062   for (auto& e : info->subprograms) {
1063     if (e.second.range.begin() == 0)
1064       continue;
1065     simgrid::mc::FunctionIndexEntry entry;
1066     entry.low_pc   = (void*)e.second.range.begin();
1067     entry.function = &e.second;
1068     info->functions_index.push_back(entry);
1069   }
1070
1071   info->functions_index.shrink_to_fit();
1072
1073   // Sort the array by low_pc:
1074   boost::range::sort(info->functions_index,
1075                      [](simgrid::mc::FunctionIndexEntry const& a, simgrid::mc::FunctionIndexEntry const& b) {
1076                        return a.low_pc < b.low_pc;
1077                      });
1078 }
1079
1080 static void MC_post_process_variables(simgrid::mc::ObjectInformation* info)
1081 {
1082   // Someone needs this to be sorted but who?
1083   boost::range::sort(info->global_variables, MC_compare_variable);
1084
1085   for (simgrid::mc::Variable& variable : info->global_variables)
1086     if (variable.type_id)
1087       variable.type = simgrid::util::find_map_ptr(info->types, variable.type_id);
1088 }
1089
1090 static void mc_post_process_scope(simgrid::mc::ObjectInformation* info, simgrid::mc::Frame* scope)
1091 {
1092   if (scope->tag == DW_TAG_inlined_subroutine) {
1093     // Attach correct namespaced name in inlined subroutine:
1094     auto i = info->subprograms.find(scope->abstract_origin_id);
1095     xbt_assert(i != info->subprograms.end(), "Could not lookup abstract origin %" PRIx64,
1096                (std::uint64_t)scope->abstract_origin_id);
1097     scope->name = i->second.name;
1098   }
1099
1100   // Direct:
1101   for (simgrid::mc::Variable& variable : scope->variables)
1102     if (variable.type_id)
1103       variable.type = simgrid::util::find_map_ptr(info->types, variable.type_id);
1104
1105   // Recursive post-processing of nested-scopes:
1106   for (simgrid::mc::Frame& nested_scope : scope->scopes)
1107     mc_post_process_scope(info, &nested_scope);
1108 }
1109
1110 static simgrid::mc::Type* MC_resolve_type(simgrid::mc::ObjectInformation* info, unsigned type_id)
1111 {
1112   if (not type_id)
1113     return nullptr;
1114   simgrid::mc::Type* type = simgrid::util::find_map_ptr(info->types, type_id);
1115   if (type == nullptr)
1116     return nullptr;
1117
1118   // We already have the information on the type:
1119   if (type->byte_size != 0)
1120     return type;
1121
1122   // Don't have a name, we can't find a more complete version:
1123   if (type->name.empty())
1124     return type;
1125
1126   // Try to find a more complete description of the type:
1127   // We need to fix in order to support C++.
1128   simgrid::mc::Type** subtype = simgrid::util::find_map_ptr(info->full_types_by_name, type->name);
1129   if (subtype)
1130     type = *subtype;
1131   return type;
1132 }
1133
1134 static void MC_post_process_types(simgrid::mc::ObjectInformation* info)
1135 {
1136   // Lookup "subtype" field:
1137   for (auto& i : info->types) {
1138     i.second.subtype = MC_resolve_type(info, i.second.type_id);
1139     for (simgrid::mc::Member& member : i.second.members)
1140       member.type = MC_resolve_type(info, member.type_id);
1141   }
1142 }
1143
1144 namespace simgrid {
1145 namespace mc {
1146
1147 /** @brief Finds information about a given shared object/executable */
1148 std::shared_ptr<ObjectInformation> createObjectInformation(std::vector<xbt::VmMap> const& maps, const char* name)
1149 {
1150   auto result       = std::make_shared<ObjectInformation>();
1151   result->file_name = name;
1152   simgrid::mc::find_object_address(maps, result.get());
1153   MC_load_dwarf(result.get());
1154   MC_post_process_variables(result.get());
1155   MC_post_process_types(result.get());
1156   for (auto& entry : result.get()->subprograms)
1157     mc_post_process_scope(result.get(), &entry.second);
1158   MC_make_functions_index(result.get());
1159   return result;
1160 }
1161
1162 /*************************************************************************/
1163
1164 void postProcessObjectInformation(const RemoteSimulation* process, ObjectInformation* info)
1165 {
1166   for (auto& t : info->types) {
1167     Type* type    = &(t.second);
1168     Type* subtype = type;
1169     while (subtype->type == DW_TAG_typedef || subtype->type == DW_TAG_volatile_type ||
1170            subtype->type == DW_TAG_const_type)
1171       if (subtype->subtype)
1172         subtype = subtype->subtype;
1173       else
1174         break;
1175
1176     // Resolve full_type:
1177     if (not subtype->name.empty() && subtype->byte_size == 0)
1178       for (auto const& object_info : process->object_infos) {
1179         auto i = object_info->full_types_by_name.find(subtype->name);
1180         if (i != object_info->full_types_by_name.end() && not i->second->name.empty() && i->second->byte_size) {
1181           type->full_type = i->second;
1182           break;
1183         }
1184       }
1185     else
1186       type->full_type = subtype;
1187   }
1188 }
1189
1190 } // namespace mc
1191 } // namespace simgrid
1192
1193 namespace simgrid {
1194 namespace dwarf {
1195
1196 /** Convert a DWARF register into a libunwind register
1197  *
1198  *  DWARF and libunwind does not use the same convention for numbering the
1199  *  registers on some architectures. The function makes the necessary
1200  *  conversion.
1201  */
1202 int dwarf_register_to_libunwind(int dwarf_register)
1203 {
1204 #if defined(__x86_64__)
1205   // It seems for this arch, DWARF and libunwind agree in the numbering:
1206   return dwarf_register;
1207 #elif defined(__i386__)
1208   // Couldn't find the authoritative source of information for this.
1209   // This is inspired from http://source.winehq.org/source/dlls/dbghelp/cpu_i386.c#L517.
1210   constexpr std::array<int, 24> regs{
1211       {/*  0 */ UNW_X86_EAX, /*  1 */ UNW_X86_ECX,    /*  2 */ UNW_X86_EDX, /*  3 */ UNW_X86_EBX,
1212        /*  4 */ UNW_X86_ESP, /*  5 */ UNW_X86_EBP,    /*  6 */ UNW_X86_ESI, /*  7 */ UNW_X86_EDI,
1213        /*  8 */ UNW_X86_EIP, /*  9 */ UNW_X86_EFLAGS, /* 10 */ UNW_X86_CS,  /* 11 */ UNW_X86_SS,
1214        /* 12 */ UNW_X86_DS,  /* 13 */ UNW_X86_ES,     /* 14 */ UNW_X86_FS,  /* 15 */ UNW_X86_GS,
1215        /* 16 */ UNW_X86_ST0, /* 17 */ UNW_X86_ST1,    /* 18 */ UNW_X86_ST2, /* 19 */ UNW_X86_ST3,
1216        /* 20 */ UNW_X86_ST4, /* 21 */ UNW_X86_ST5,    /* 22 */ UNW_X86_ST6, /* 23 */ UNW_X86_ST7}};
1217   return regs.at(dwarf_register);
1218 #else
1219 #error This architecture is not supported yet for DWARF expression evaluation.
1220 #endif
1221 }
1222
1223 } // namespace dwarf
1224 } // namespace simgrid