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/RemoteProcess.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 #include <elfutils/version.h>
  32
  33 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing");
  34
  35 /** @brief The default DW_TAG_lower_bound for a given DW_AT_language.
  36  *
  37  *  The default for a given language is defined in the DWARF spec.
  38  *
  39  *  @param language constant as defined by the DWARf spec
  40  */
  41 static uint64_t MC_dwarf_default_lower_bound(int lang);
  42
  43 /** @brief Computes the the element_count of a DW_TAG_enumeration_type DIE
  44  *
  45  * This is the number of elements in a given array dimension.
  46  *
  47  * A reference of the compilation unit (DW_TAG_compile_unit) is
  48  * needed because the default lower bound (when there is no DW_AT_lower_bound)
  49  * depends of the language of the compilation unit (DW_AT_language).
  50  *
  51  * @param die  DIE for the DW_TAG_enumeration_type or DW_TAG_subrange_type
  52  * @param unit DIE of the DW_TAG_compile_unit
  53  */
  54 static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die* die, Dwarf_Die* unit);
  55
  56 /** @brief Computes the number of elements of a given DW_TAG_array_type.
  57  *
  58  * @param die DIE for the DW_TAG_array_type
  59  */
  60 static uint64_t MC_dwarf_array_element_count(Dwarf_Die* die, Dwarf_Die* unit);
  61
  62 /** @brief Process a DIE
  63  *
  64  *  @param info the resulting object for the library/binary file (output)
  65  *  @param die  the current DIE
  66  *  @param unit the DIE of the compile unit of the current DIE
  67  *  @param frame containing frame if any
  68  */
  69 static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
  70                                 simgrid::mc::Frame* frame, const char* ns);
  71
  72 /** @brief Process a type DIE
  73  */
  74 static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
  75                                      simgrid::mc::Frame* frame, const char* ns);
  76
  77 /** @brief Calls MC_dwarf_handle_die on all children of the given die
  78  *
  79  *  @param info the resulting object for the library/binary file (output)
  80  *  @param die  the current DIE
  81  *  @param unit the DIE of the compile unit of the current DIE
  82  *  @param frame containing frame if any
  83  */
  84 static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
  85                                      simgrid::mc::Frame* frame, const char* ns);
  86
  87 /** @brief Handle a variable (DW_TAG_variable or other)
  88  *
  89  *  @param info the resulting object for the library/binary file (output)
  90  *  @param die  the current DIE
  91  *  @param unit the DIE of the compile unit of the current DIE
  92  *  @param frame containing frame if any
  93  */
  94 static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, const Dwarf_Die* unit,
  95                                          simgrid::mc::Frame* frame, const char* ns);
  96
  97 /** @brief Get the DW_TAG_type of the DIE
  98  *
  99  *  @param die DIE
 100  *  @return DW_TAG_type attribute as a new string (nullptr if none)
 101  */
 102 static std::uint64_t MC_dwarf_at_type(Dwarf_Die* die);
 103
 104 namespace simgrid {
 105 namespace dwarf {
 106
 107 enum class TagClass { Unknown, Type, Subprogram, Variable, Scope, Namespace };
 108
 109 /*** Class of forms defined in the DWARF standard */
 110 enum class FormClass {
 111   Unknown,
 112   Address, // Location in the program's address space
 113   Block,   // Arbitrary block of bytes
 114   Constant,
 115   String,
 116   Flag,      // Boolean value
 117   Reference, // Reference to another DIE
 118   ExprLoc,   // DWARF expression/location description
 119   LinePtr,
 120   LocListPtr,
 121   MacPtr,
 122   RangeListPtr
 123 };
 124
 125 static TagClass classify_tag(int tag)
 126 {
 127   static const std::unordered_map<int, TagClass> map = {
 128       {DW_TAG_array_type, TagClass::Type},            {DW_TAG_class_type, TagClass::Type},
 129       {DW_TAG_enumeration_type, TagClass::Type},      {DW_TAG_typedef, TagClass::Type},
 130       {DW_TAG_pointer_type, TagClass::Type},          {DW_TAG_reference_type, TagClass::Type},
 131       {DW_TAG_rvalue_reference_type, TagClass::Type}, {DW_TAG_string_type, TagClass::Type},
 132       {DW_TAG_structure_type, TagClass::Type},        {DW_TAG_subroutine_type, TagClass::Type},
 133       {DW_TAG_union_type, TagClass::Type},            {DW_TAG_ptr_to_member_type, TagClass::Type},
 134       {DW_TAG_set_type, TagClass::Type},              {DW_TAG_subrange_type, TagClass::Type},
 135       {DW_TAG_base_type, TagClass::Type},             {DW_TAG_const_type, TagClass::Type},
 136       {DW_TAG_file_type, TagClass::Type},             {DW_TAG_packed_type, TagClass::Type},
 137       {DW_TAG_volatile_type, TagClass::Type},         {DW_TAG_restrict_type, TagClass::Type},
 138       {DW_TAG_interface_type, TagClass::Type},        {DW_TAG_unspecified_type, TagClass::Type},
 139       {DW_TAG_shared_type, TagClass::Type},
 140
 141       {DW_TAG_subprogram, TagClass::Subprogram},
 142
 143       {DW_TAG_variable, TagClass::Variable},          {DW_TAG_formal_parameter, TagClass::Variable},
 144
 145       {DW_TAG_lexical_block, TagClass::Scope},        {DW_TAG_try_block, TagClass::Scope},
 146       {DW_TAG_catch_block, TagClass::Scope},          {DW_TAG_inlined_subroutine, TagClass::Scope},
 147       {DW_TAG_with_stmt, TagClass::Scope},
 148
 149       {DW_TAG_namespace, TagClass::Namespace}};
 150
 151   auto res = map.find(tag);
 152   return res != map.end() ? res->second : TagClass::Unknown;
 153 }
 154
 155 /** @brief Find the DWARF data class for a given DWARF data form
 156  *
 157  *  This mapping is defined in the DWARF spec.
 158  *
 159  *  @param form The form (values taken from the DWARF spec)
 160  *  @return An internal representation for the corresponding class
 161  * */
 162 static FormClass classify_form(int form)
 163 {
 164   static const std::unordered_map<int, FormClass> map = {
 165       {DW_FORM_addr, FormClass::Address},
 166
 167       {DW_FORM_block2, FormClass::Block},           {DW_FORM_block4, FormClass::Block},
 168       {DW_FORM_block, FormClass::Block},            {DW_FORM_block1, FormClass::Block},
 169
 170       {DW_FORM_data1, FormClass::Constant},         {DW_FORM_data2, FormClass::Constant},
 171       {DW_FORM_data4, FormClass::Constant},         {DW_FORM_data8, FormClass::Constant},
 172       {DW_FORM_udata, FormClass::Constant},         {DW_FORM_sdata, FormClass::Constant},
 173 #if _ELFUTILS_PREREQ(0, 171)
 174       {DW_FORM_implicit_const, FormClass::Constant},
 175 #endif
 176
 177       {DW_FORM_string, FormClass::String},          {DW_FORM_strp, FormClass::String},
 178
 179       {DW_FORM_ref_addr, FormClass::Reference},     {DW_FORM_ref1, FormClass::Reference},
 180       {DW_FORM_ref2, FormClass::Reference},         {DW_FORM_ref4, FormClass::Reference},
 181       {DW_FORM_ref8, FormClass::Reference},         {DW_FORM_ref_udata, FormClass::Reference},
 182
 183       {DW_FORM_flag, FormClass::Flag},              {DW_FORM_flag_present, FormClass::Flag},
 184
 185       {DW_FORM_exprloc, FormClass::ExprLoc}
 186
 187       // TODO sec offset
 188       // TODO indirect
 189   };
 190
 191   auto res = map.find(form);
 192   return res != map.end() ? res->second : FormClass::Unknown;
 193 }
 194
 195 /** @brief Get the name of the tag of a given DIE
 196  *
 197  *  @param die DIE
 198  *  @return name of the tag of this DIE
 199  */
 200 inline XBT_PRIVATE const char* tagname(Dwarf_Die* die)
 201 {
 202   return tagname(dwarf_tag(die));
 203 }
 204
 205 } // namespace dwarf
 206 } // namespace simgrid
 207
 208 // ***** Attributes
 209
 210 /** @brief Get an attribute of a given DIE as a string
 211  *
 212  *  @param die       the DIE
 213  *  @param attribute attribute
 214  *  @return value of the given attribute of the given DIE
 215  */
 216 static const char* MC_dwarf_attr_integrate_string(Dwarf_Die* die, int attribute)
 217 {
 218   Dwarf_Attribute attr;
 219   if (not dwarf_attr_integrate(die, attribute, &attr))
 220     return nullptr;
 221   else
 222     return dwarf_formstring(&attr);
 223 }
 224
 225 static Dwarf_Off MC_dwarf_attr_dieoffset(Dwarf_Die* die, int attribute)
 226 {
 227   Dwarf_Attribute attr;
 228   if (dwarf_hasattr_integrate(die, attribute) == 0)
 229     return 0;
 230   dwarf_attr_integrate(die, attribute, &attr);
 231   Dwarf_Die subtype_die;
 232   xbt_assert(dwarf_formref_die(&attr, &subtype_die) != nullptr, "Could not find DIE");
 233   return dwarf_dieoffset(&subtype_die);
 234 }
 235
 236 static Dwarf_Off MC_dwarf_attr_integrate_dieoffset(Dwarf_Die* die, int attribute)
 237 {
 238   Dwarf_Attribute attr;
 239   if (dwarf_hasattr_integrate(die, attribute) == 0)
 240     return 0;
 241   dwarf_attr_integrate(die, DW_AT_type, &attr);
 242   Dwarf_Die subtype_die;
 243   xbt_assert(dwarf_formref_die(&attr, &subtype_die) != nullptr, "Could not find DIE");
 244   return dwarf_dieoffset(&subtype_die);
 245 }
 246
 247 /** @brief Find the type/subtype (DW_AT_type) for a DIE
 248  *
 249  *  @param die the DIE
 250  *  @return DW_AT_type reference as a global offset in hexadecimal (or nullptr)
 251  */
 252 static std::uint64_t MC_dwarf_at_type(Dwarf_Die* die)
 253 {
 254   return MC_dwarf_attr_integrate_dieoffset(die, DW_AT_type);
 255 }
 256
 257 static uint64_t MC_dwarf_attr_integrate_addr(Dwarf_Die* die, int attribute)
 258 {
 259   Dwarf_Attribute attr;
 260   if (dwarf_attr_integrate(die, attribute, &attr) == nullptr)
 261     return 0;
 262   Dwarf_Addr value;
 263   if (dwarf_formaddr(&attr, &value) == 0)
 264     return (uint64_t)value;
 265   else
 266     return 0;
 267 }
 268
 269 static uint64_t MC_dwarf_attr_integrate_uint(Dwarf_Die* die, int attribute, uint64_t default_value)
 270 {
 271   Dwarf_Attribute attr;
 272   if (dwarf_attr_integrate(die, attribute, &attr) == nullptr)
 273     return default_value;
 274   Dwarf_Word value;
 275   return dwarf_formudata(dwarf_attr_integrate(die, attribute, &attr), &value) == 0 ? (uint64_t)value : default_value;
 276 }
 277
 278 static bool MC_dwarf_attr_flag(Dwarf_Die* die, int attribute, bool integrate)
 279 {
 280   Dwarf_Attribute attr;
 281   if ((integrate ? dwarf_attr_integrate(die, attribute, &attr) : dwarf_attr(die, attribute, &attr)) == nullptr)
 282     return false;
 283
 284   bool result;
 285   xbt_assert(not dwarf_formflag(&attr, &result), "Unexpected form for attribute %s",
 286              simgrid::dwarf::attrname(attribute));
 287   return result;
 288 }
 289
 290 /** @brief Find the default lower bound for a given language
 291  *
 292  *  The default lower bound of an array (when DW_TAG_lower_bound
 293  *  is missing) depends on the language of the compilation unit.
 294  *
 295  *  @param lang Language of the compilation unit (values defined in the DWARF spec)
 296  *  @return     Default lower bound of an array in this compilation unit
 297  * */
 298 static uint64_t MC_dwarf_default_lower_bound(int lang)
 299 {
 300   const std::unordered_map<int, unsigned> map = {
 301       {DW_LANG_C, 0},           {DW_LANG_C89, 0},            {DW_LANG_C99, 0},            {DW_LANG_C11, 0},
 302       {DW_LANG_C_plus_plus, 0}, {DW_LANG_C_plus_plus_11, 0}, {DW_LANG_C_plus_plus_14, 0}, {DW_LANG_D, 0},
 303       {DW_LANG_Java, 0},        {DW_LANG_ObjC, 0},           {DW_LANG_ObjC_plus_plus, 0}, {DW_LANG_Python, 0},
 304       {DW_LANG_UPC, 0},
 305
 306       {DW_LANG_Ada83, 1},       {DW_LANG_Ada95, 1},          {DW_LANG_Fortran77, 1},      {DW_LANG_Fortran90, 1},
 307       {DW_LANG_Fortran95, 1},   {DW_LANG_Fortran03, 1},      {DW_LANG_Fortran08, 1},      {DW_LANG_Modula2, 1},
 308       {DW_LANG_Pascal83, 1},    {DW_LANG_PL1, 1},            {DW_LANG_Cobol74, 1},        {DW_LANG_Cobol85, 1}};
 309
 310   auto res = map.find(lang);
 311   xbt_assert(res != map.end(), "No default DW_TAG_lower_bound for language %i and none given", lang);
 312   return res->second;
 313 }
 314
 315 /** @brief Finds the number of elements in a DW_TAG_subrange_type or DW_TAG_enumeration_type DIE
 316  *
 317  *  @param die  the DIE
 318  *  @param unit DIE of the compilation unit
 319  *  @return     number of elements in the range
 320  * */
 321 static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die* die, Dwarf_Die* unit)
 322 {
 323   xbt_assert(dwarf_tag(die) == DW_TAG_enumeration_type || dwarf_tag(die) == DW_TAG_subrange_type,
 324              "MC_dwarf_subrange_element_count called with DIE of type %s", simgrid::dwarf::tagname(die));
 325
 326   // Use DW_TAG_count if present:
 327   if (dwarf_hasattr_integrate(die, DW_AT_count))
 328     return MC_dwarf_attr_integrate_uint(die, DW_AT_count, 0);
 329   // Otherwise compute DW_TAG_upper_bound-DW_TAG_lower_bound + 1:
 330
 331   if (not dwarf_hasattr_integrate(die, DW_AT_upper_bound))
 332     // This is not really 0, but the code expects this (we do not know):
 333     return 0;
 334
 335   uint64_t upper_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_upper_bound, static_cast<uint64_t>(-1));
 336
 337   uint64_t lower_bound = 0;
 338   if (dwarf_hasattr_integrate(die, DW_AT_lower_bound))
 339     lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, static_cast<uint64_t>(-1));
 340   else
 341     lower_bound = MC_dwarf_default_lower_bound(dwarf_srclang(unit));
 342   return upper_bound - lower_bound + 1;
 343 }
 344
 345 /** @brief Finds the number of elements in an array type (DW_TAG_array_type)
 346  *
 347  *  The compilation unit might be needed because the default lower
 348  *  bound depends on the language of the compilation unit.
 349  *
 350  *  @param die the DIE of the DW_TAG_array_type
 351  *  @param unit the DIE of the compilation unit
 352  *  @return number of elements in this array type
 353  * */
 354 static uint64_t MC_dwarf_array_element_count(Dwarf_Die* die, Dwarf_Die* unit)
 355 {
 356   xbt_assert(dwarf_tag(die) == DW_TAG_array_type, "MC_dwarf_array_element_count called with DIE of type %s",
 357              simgrid::dwarf::tagname(die));
 358
 359   int result = 1;
 360   Dwarf_Die child;
 361   for (int res = dwarf_child(die, &child); res == 0; res = dwarf_siblingof(&child, &child)) {
 362     int child_tag = dwarf_tag(&child);
 363     if (child_tag == DW_TAG_subrange_type || child_tag == DW_TAG_enumeration_type)
 364       result *= MC_dwarf_subrange_element_count(&child, unit);
 365   }
 366   return result;
 367 }
 368
 369 // ***** Variable
 370
 371 /** Sort the variable by name and address.
 372  *
 373  *  We could use boost::container::flat_set instead.
 374  */
 375 static bool MC_compare_variable(simgrid::mc::Variable const& a, simgrid::mc::Variable const& b)
 376 {
 377   int cmp = a.name.compare(b.name);
 378   if (cmp < 0)
 379     return true;
 380   else if (cmp > 0)
 381     return false;
 382   else
 383     return a.address < b.address;
 384 }
 385
 386 // ***** simgrid::mc::Type*
 387
 388 /** @brief Initialize the location of a member of a type
 389  * (DW_AT_data_member_location of a DW_TAG_member).
 390  *
 391  *  @param  type   a type (struct, class)
 392  *  @param  member the member of the type
 393  *  @param  child  DIE of the member (DW_TAG_member)
 394  */
 395 static void MC_dwarf_fill_member_location(const simgrid::mc::Type* type, simgrid::mc::Member* member, Dwarf_Die* child)
 396 {
 397   xbt_assert(not dwarf_hasattr(child, DW_AT_data_bit_offset), "Can't groke DW_AT_data_bit_offset.");
 398
 399   if (not dwarf_hasattr_integrate(child, DW_AT_data_member_location)) {
 400     xbt_assert(type->type == DW_TAG_union_type,
 401                "Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%" PRIx64 ">%s",
 402                member->name.c_str(), (uint64_t)type->id, type->name.c_str());
 403     return;
 404   }
 405
 406   Dwarf_Attribute attr;
 407   dwarf_attr_integrate(child, DW_AT_data_member_location, &attr);
 408   int form                             = dwarf_whatform(&attr);
 409   simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form);
 410   switch (form_class) {
 411     case simgrid::dwarf::FormClass::ExprLoc:
 412     case simgrid::dwarf::FormClass::Block:
 413       // Location expression:
 414       {
 415         Dwarf_Op* expr;
 416         size_t len;
 417         xbt_assert(not dwarf_getlocation(&attr, &expr, &len),
 418                    "Could not read location expression DW_AT_data_member_location in DW_TAG_member %s of type <%" PRIx64
 419                    ">%s",
 420                    MC_dwarf_attr_integrate_string(child, DW_AT_name), (uint64_t)type->id, type->name.c_str());
 421         member->location_expression = simgrid::dwarf::DwarfExpression(expr, expr + len);
 422         break;
 423       }
 424     case simgrid::dwarf::FormClass::Constant:
 425       // Offset from the base address of the object:
 426       {
 427         Dwarf_Word offset;
 428         xbt_assert(not dwarf_formudata(&attr, &offset), "Cannot get %s location <%" PRIx64 ">%s",
 429                    MC_dwarf_attr_integrate_string(child, DW_AT_name), (uint64_t)type->id, type->name.c_str());
 430         member->offset(offset);
 431         break;
 432       }
 433
 434     default:
 435       // includes FormClass::LocListPtr (reference to a location list: TODO) and FormClass::Reference (it's supposed to
 436       // be possible in DWARF2 but I couldn't find its semantic in the spec)
 437       xbt_die("Can't handle form class (%d) / form 0x%x as DW_AT_member_location", (int)form_class, (unsigned)form);
 438   }
 439 }
 440
 441 /** @brief Populate the list of members of a type
 442  *
 443  *  @param info ELF object containing the type DIE
 444  *  @param die  DIE of the type
 445  *  @param unit DIE of the compilation unit containing the type DIE
 446  *  @param type the type
 447  */
 448 static void MC_dwarf_add_members(const simgrid::mc::ObjectInformation* /*info*/, Dwarf_Die* die,
 449                                  const Dwarf_Die* /*unit*/, simgrid::mc::Type* type)
 450 {
 451   Dwarf_Die child;
 452   xbt_assert(type->members.empty());
 453   for (int res = dwarf_child(die, &child); res == 0; res = dwarf_siblingof(&child, &child)) {
 454     int tag = dwarf_tag(&child);
 455     if (tag == DW_TAG_member || tag == DW_TAG_inheritance) {
 456       // Skip declarations:
 457       if (MC_dwarf_attr_flag(&child, DW_AT_declaration, false))
 458         continue;
 459
 460       // Skip compile time constants:
 461       if (dwarf_hasattr(&child, DW_AT_const_value))
 462         continue;
 463
 464       // TODO, we should use another type (because is is not a type but a member)
 465       simgrid::mc::Member member;
 466       if (tag == DW_TAG_inheritance)
 467         member.flags |= simgrid::mc::Member::INHERITANCE_FLAG;
 468
 469       const char* name = MC_dwarf_attr_integrate_string(&child, DW_AT_name);
 470       if (name)
 471         member.name = name;
 472       // Those base names are used by GCC and clang for virtual table pointers
 473       // respectively ("__vptr$ClassName", "__vptr.ClassName"):
 474       if (member.name.rfind("__vptr$", 0) == 0 || member.name.rfind("__vptr.", 0) == 0)
 475         member.flags |= simgrid::mc::Member::VIRTUAL_POINTER_FLAG;
 476       // A cleaner solution would be to check against the type:
 477       // ---
 478       // tag: DW_TAG_member
 479       // name: "_vptr$Foo"
 480       // type:
 481       //   # Type for a pointer to a vtable
 482       //   tag: DW_TAG_pointer_type
 483       //   type:
 484       //     # Type for a vtable:
 485       //     tag: DW_TAG_pointer_type
 486       //     name: "__vtbl_ptr_type"
 487       //     type:
 488       //       tag: DW_TAG_subroutine_type
 489       //       type:
 490       //         tag: DW_TAG_base_type
 491       //         name: "int"
 492       // ---
 493
 494       member.byte_size = MC_dwarf_attr_integrate_uint(&child, DW_AT_byte_size, 0);
 495       member.type_id   = MC_dwarf_at_type(&child);
 496
 497       xbt_assert(not dwarf_hasattr(&child, DW_AT_data_bit_offset), "Can't groke DW_AT_data_bit_offset.");
 498
 499       MC_dwarf_fill_member_location(type, &member, &child);
 500
 501       xbt_assert(member.type_id, "Missing type for member %s of <%" PRIx64 ">%s", member.name.c_str(),
 502                  (uint64_t)type->id, type->name.c_str());
 503
 504       type->members.push_back(std::move(member));
 505     }
 506   }
 507 }
 508
 509 /** @brief Create a MC type object from a DIE
 510  *
 511  *  @param info current object info object
 512  *  @param die DIE (for a given type)
 513  *  @param unit compilation unit of the current DIE
 514  *  @return MC representation of the type
 515  */
 516 static simgrid::mc::Type MC_dwarf_die_to_type(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 517                                               simgrid::mc::Frame* frame, const char* ns)
 518 {
 519   simgrid::mc::Type type;
 520   type.type          = dwarf_tag(die);
 521   type.name          = std::string();
 522   type.element_count = -1;
 523
 524   // Global Offset
 525   type.id = dwarf_dieoffset(die);
 526
 527   const char* prefix = "";
 528   switch (type.type) {
 529     case DW_TAG_structure_type:
 530       prefix = "struct ";
 531       break;
 532     case DW_TAG_union_type:
 533       prefix = "union ";
 534       break;
 535     case DW_TAG_class_type:
 536       prefix = "class ";
 537       break;
 538     default:
 539       prefix = "";
 540   }
 541
 542   const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 543   if (name != nullptr) {
 544     if (ns)
 545       type.name = simgrid::xbt::string_printf("%s%s::%s", prefix, ns, name);
 546     else
 547       type.name = simgrid::xbt::string_printf("%s%s", prefix, name);
 548   }
 549
 550   type.type_id = MC_dwarf_at_type(die);
 551
 552   // Some compilers do not emit DW_AT_byte_size for pointer_type,
 553   // so we fill this. We currently assume that the model-checked process is in
 554   // the same architecture..
 555   if (type.type == DW_TAG_pointer_type)
 556     type.byte_size = sizeof(void*);
 557
 558   // Computation of the byte_size
 559   if (dwarf_hasattr_integrate(die, DW_AT_byte_size))
 560     type.byte_size = MC_dwarf_attr_integrate_uint(die, DW_AT_byte_size, 0);
 561   else if (type.type == DW_TAG_array_type || type.type == DW_TAG_structure_type || type.type == DW_TAG_class_type) {
 562     Dwarf_Word size;
 563     if (dwarf_aggregate_size(die, &size) == 0)
 564       type.byte_size = size;
 565   }
 566
 567   switch (type.type) {
 568     case DW_TAG_array_type:
 569       type.element_count = MC_dwarf_array_element_count(die, unit);
 570       // TODO, handle DW_byte_stride and (not) DW_bit_stride
 571       break;
 572
 573     case DW_TAG_pointer_type:
 574     case DW_TAG_reference_type:
 575     case DW_TAG_rvalue_reference_type:
 576       break;
 577
 578     case DW_TAG_structure_type:
 579     case DW_TAG_union_type:
 580     case DW_TAG_class_type:
 581       MC_dwarf_add_members(info, die, unit, &type);
 582       MC_dwarf_handle_children(info, die, unit, frame,
 583                                ns ? simgrid::xbt::string_printf("%s::%s", ns, name).c_str() : type.name.c_str());
 584       break;
 585
 586     default:
 587       XBT_DEBUG("Unhandled type: %d (%s)", type.type, simgrid::dwarf::tagname(type.type));
 588       break;
 589   }
 590
 591   return type;
 592 }
 593
 594 static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 595                                      simgrid::mc::Frame* frame, const char* ns)
 596 {
 597   simgrid::mc::Type type = MC_dwarf_die_to_type(info, die, unit, frame, ns);
 598   auto& t                = (info->types[type.id] = std::move(type));
 599   if (not t.name.empty() && type.byte_size != 0)
 600     info->full_types_by_name[t.name] = &t;
 601 }
 602
 603 static std::unique_ptr<simgrid::mc::Variable> MC_die_to_variable(simgrid::mc::ObjectInformation* info, Dwarf_Die* die,
 604                                                                  const Dwarf_Die* /*unit*/,
 605                                                                  const simgrid::mc::Frame* frame, const char* ns)
 606 {
 607   // Skip declarations:
 608   if (MC_dwarf_attr_flag(die, DW_AT_declaration, false))
 609     return nullptr;
 610
 611   // Skip compile time constants:
 612   if (dwarf_hasattr(die, DW_AT_const_value))
 613     return nullptr;
 614
 615   Dwarf_Attribute attr_location;
 616   if (dwarf_attr(die, DW_AT_location, &attr_location) == nullptr)
 617     // No location: do not add it ?
 618     return nullptr;
 619
 620   auto variable         = std::make_unique<simgrid::mc::Variable>();
 621   variable->id          = dwarf_dieoffset(die);
 622   variable->global      = frame == nullptr; // Can be override base on DW_AT_location
 623   variable->object_info = info;
 624
 625   const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 626   if (name)
 627     variable->name = name;
 628   variable->type_id = MC_dwarf_at_type(die);
 629
 630   int form = dwarf_whatform(&attr_location);
 631   simgrid::dwarf::FormClass form_class;
 632   if (form == DW_FORM_sec_offset)
 633     form_class = simgrid::dwarf::FormClass::Constant;
 634   else
 635     form_class = simgrid::dwarf::classify_form(form);
 636   switch (form_class) {
 637     case simgrid::dwarf::FormClass::ExprLoc:
 638     case simgrid::dwarf::FormClass::Block:
 639       // Location expression:
 640       {
 641         Dwarf_Op* expr;
 642         size_t len;
 643         xbt_assert(not dwarf_getlocation(&attr_location, &expr, &len),
 644                    "Could not read location expression in DW_AT_location "
 645                    "of variable <%" PRIx64 ">%s",
 646                    (uint64_t)variable->id, variable->name.c_str());
 647
 648         if (len == 1 && expr[0].atom == DW_OP_addr) {
 649           variable->global  = true;
 650           auto offset       = static_cast<uintptr_t>(expr[0].number);
 651           auto base         = reinterpret_cast<uintptr_t>(info->base_address());
 652           variable->address = reinterpret_cast<void*>(base + offset);
 653         } else
 654           variable->location_list = {
 655               simgrid::dwarf::LocationListEntry(simgrid::dwarf::DwarfExpression(expr, expr + len))};
 656
 657         break;
 658       }
 659
 660     case simgrid::dwarf::FormClass::LocListPtr:
 661     case simgrid::dwarf::FormClass::Constant:
 662       // Reference to location list:
 663       variable->location_list = simgrid::dwarf::location_list(*info, attr_location);
 664       break;
 665
 666     default:
 667       xbt_die("Unexpected form 0x%x (%i), class 0x%x (%i) list for location in <%" PRIx64 ">%s", (unsigned)form, form,
 668               (unsigned)form_class, (int)form_class, (uint64_t)variable->id, variable->name.c_str());
 669   }
 670
 671   // Handle start_scope:
 672   if (dwarf_hasattr(die, DW_AT_start_scope)) {
 673     Dwarf_Attribute attr;
 674     dwarf_attr(die, DW_AT_start_scope, &attr);
 675     form       = dwarf_whatform(&attr);
 676     form_class = simgrid::dwarf::classify_form(form);
 677     if (form_class == simgrid::dwarf::FormClass::Constant) {
 678       Dwarf_Word value;
 679       variable->start_scope = dwarf_formudata(&attr, &value) == 0 ? (size_t)value : 0;
 680     } else {
 681       // TODO: FormClass::RangeListPtr
 682       xbt_die("Unhandled form 0x%x, class 0x%X for DW_AT_start_scope of variable %s", (unsigned)form,
 683               (unsigned)form_class, name == nullptr ? "?" : name);
 684     }
 685   }
 686
 687   if (ns && variable->global)
 688     variable->name = std::string(ns) + "::" + variable->name;
 689
 690   // The current code needs a variable name,
 691   // generate a fake one:
 692   static int mc_anonymous_variable_index = 0;
 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 && elf_kind(elf) == ELF_K_ELF, "%s is not an ELF file", info->file_name.c_str());
 995
 996   // Remember if this is a `ET_EXEC` (fixed location) or `ET_DYN`:
 997   Elf64_Half type = get_type(elf);
 998   if (type == ET_EXEC)
 999     info->flags |= simgrid::mc::ObjectInformation::Executable;
1000
1001   // Read DWARF debug information in the file:
1002   Dwarf* dwarf = dwarf_begin_elf(elf, DWARF_C_READ, nullptr);
1003   if (dwarf != nullptr) {
1004     read_dwarf_info(info, dwarf);
1005     dwarf_end(dwarf);
1006     elf_end(elf);
1007     close(fd);
1008     return;
1009   }
1010   dwarf_end(dwarf);
1011
1012   // If there was no DWARF in the file, try to find it in a separate file.
1013   // Different methods might be used to store the DWARF information:
1014   //  * GNU NT_GNU_BUILD_ID
1015   //  * .gnu_debuglink
1016   // See https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
1017   // for reference of what we are doing.
1018
1019   // Try with NT_GNU_BUILD_ID: we find the build ID in the ELF file and then
1020   // use this ID to find the file in some known locations in the filesystem.
1021   std::vector<char> build_id = get_build_id(elf);
1022   if (not build_id.empty()) {
1023     elf_end(elf);
1024     close(fd);
1025
1026     // Find the debug file using the build id:
1027     std::string debug_file = find_by_build_id(build_id);
1028     xbt_assert(not debug_file.empty(),
1029                "Missing debug info for %s with build-id %s\n"
1030                "You might want to install the suitable debugging package.\n",
1031                info->file_name.c_str(), to_hex(build_id).c_str());
1032
1033     // Load the DWARF info from this file:
1034     XBT_DEBUG("Load DWARF for %s from %s", info->file_name.c_str(), debug_file.c_str());
1035     fd = open(debug_file.c_str(), O_RDONLY);
1036     xbt_assert(fd >= 0, "Could not open file %s", debug_file.c_str());
1037     dwarf = dwarf_begin(fd, DWARF_C_READ);
1038     xbt_assert(dwarf != nullptr, "No DWARF info in %s for %s", debug_file.c_str(), info->file_name.c_str());
1039     read_dwarf_info(info, dwarf);
1040     dwarf_end(dwarf);
1041     close(fd);
1042     return;
1043   }
1044
1045   // TODO, try to find DWARF info using .gnu_debuglink.
1046
1047   elf_end(elf);
1048   close(fd);
1049   xbt_die("Debugging information not found for %s\n"
1050           "Try recompiling with -g\n",
1051           info->file_name.c_str());
1052 }
1053
1054 // ***** Functions index
1055
1056 static void MC_make_functions_index(simgrid::mc::ObjectInformation* info)
1057 {
1058   info->functions_index.clear();
1059
1060   for (auto& e : info->subprograms) {
1061     if (e.second.range.begin() == 0)
1062       continue;
1063     simgrid::mc::FunctionIndexEntry entry;
1064     entry.low_pc   = (void*)e.second.range.begin();
1065     entry.function = &e.second;
1066     info->functions_index.push_back(entry);
1067   }
1068
1069   info->functions_index.shrink_to_fit();
1070
1071   // Sort the array by low_pc:
1072   boost::range::sort(info->functions_index,
1073                      [](simgrid::mc::FunctionIndexEntry const& a, simgrid::mc::FunctionIndexEntry const& b) {
1074                        return a.low_pc < b.low_pc;
1075                      });
1076 }
1077
1078 static void MC_post_process_variables(simgrid::mc::ObjectInformation* info)
1079 {
1080   // Someone needs this to be sorted but who?
1081   boost::range::sort(info->global_variables, MC_compare_variable);
1082
1083   for (simgrid::mc::Variable& variable : info->global_variables)
1084     if (variable.type_id)
1085       variable.type = simgrid::util::find_map_ptr(info->types, variable.type_id);
1086 }
1087
1088 static void mc_post_process_scope(simgrid::mc::ObjectInformation* info, simgrid::mc::Frame* scope)
1089 {
1090   if (scope->tag == DW_TAG_inlined_subroutine) {
1091     // Attach correct namespaced name in inlined subroutine:
1092     auto i = info->subprograms.find(scope->abstract_origin_id);
1093     xbt_assert(i != info->subprograms.end(), "Could not lookup abstract origin %" PRIx64,
1094                (std::uint64_t)scope->abstract_origin_id);
1095     scope->name = i->second.name;
1096   }
1097
1098   // Direct:
1099   for (simgrid::mc::Variable& variable : scope->variables)
1100     if (variable.type_id)
1101       variable.type = simgrid::util::find_map_ptr(info->types, variable.type_id);
1102
1103   // Recursive post-processing of nested-scopes:
1104   for (simgrid::mc::Frame& nested_scope : scope->scopes)
1105     mc_post_process_scope(info, &nested_scope);
1106 }
1107
1108 static simgrid::mc::Type* MC_resolve_type(simgrid::mc::ObjectInformation* info, unsigned type_id)
1109 {
1110   if (not type_id)
1111     return nullptr;
1112   simgrid::mc::Type* type = simgrid::util::find_map_ptr(info->types, type_id);
1113   if (type == nullptr)
1114     return nullptr;
1115
1116   // We already have the information on the type:
1117   if (type->byte_size != 0)
1118     return type;
1119
1120   // Don't have a name, we can't find a more complete version:
1121   if (type->name.empty())
1122     return type;
1123
1124   // Try to find a more complete description of the type:
1125   // We need to fix in order to support C++.
1126   simgrid::mc::Type** subtype = simgrid::util::find_map_ptr(info->full_types_by_name, type->name);
1127   if (subtype)
1128     type = *subtype;
1129   return type;
1130 }
1131
1132 static void MC_post_process_types(simgrid::mc::ObjectInformation* info)
1133 {
1134   // Lookup "subtype" field:
1135   for (auto& i : info->types) {
1136     i.second.subtype = MC_resolve_type(info, i.second.type_id);
1137     for (simgrid::mc::Member& member : i.second.members)
1138       member.type = MC_resolve_type(info, member.type_id);
1139   }
1140 }
1141
1142 namespace simgrid {
1143 namespace mc {
1144
1145 void ObjectInformation::ensure_dwarf_loaded()
1146 {
1147   if (dwarf_loaded)
1148     return;
1149   dwarf_loaded = true;
1150
1151   MC_load_dwarf(this);
1152   MC_post_process_variables(this);
1153   MC_post_process_types(this);
1154   for (auto& entry : this->subprograms)
1155     mc_post_process_scope(this, &entry.second);
1156   MC_make_functions_index(this);
1157 }
1158
1159 /** @brief Finds information about a given shared object/executable */
1160 std::shared_ptr<ObjectInformation> createObjectInformation(std::vector<xbt::VmMap> const& maps, const char* name)
1161 {
1162   auto result       = std::make_shared<ObjectInformation>();
1163   result->file_name = name;
1164   simgrid::mc::find_object_address(maps, result.get());
1165   return result;
1166 }
1167
1168 /*************************************************************************/
1169
1170 void postProcessObjectInformation(const RemoteProcess* process, ObjectInformation* info)
1171 {
1172   for (auto& t : info->types) {
1173     Type* type    = &(t.second);
1174     Type* subtype = type;
1175     while (subtype->type == DW_TAG_typedef || subtype->type == DW_TAG_volatile_type ||
1176            subtype->type == DW_TAG_const_type)
1177       if (subtype->subtype)
1178         subtype = subtype->subtype;
1179       else
1180         break;
1181
1182     // Resolve full_type:
1183     if (not subtype->name.empty() && subtype->byte_size == 0)
1184       for (auto const& object_info : process->object_infos) {
1185         auto i = object_info->full_types_by_name.find(subtype->name);
1186         if (i != object_info->full_types_by_name.end() && not i->second->name.empty() && i->second->byte_size) {
1187           type->full_type = i->second;
1188           break;
1189         }
1190       }
1191     else
1192       type->full_type = subtype;
1193   }
1194 }
1195
1196 } // namespace mc
1197 } // namespace simgrid
1198
1199 namespace simgrid {
1200 namespace dwarf {
1201
1202 /** Convert a DWARF register into a libunwind register
1203  *
1204  *  DWARF and libunwind does not use the same convention for numbering the
1205  *  registers on some architectures. The function makes the necessary
1206  *  conversion.
1207  */
1208 int dwarf_register_to_libunwind(int dwarf_register)
1209 {
1210 #if defined(__x86_64__)
1211   // It seems for this arch, DWARF and libunwind agree in the numbering:
1212   return dwarf_register;
1213 #elif defined(__i386__)
1214   // Couldn't find the authoritative source of information for this.
1215   // This is inspired from http://source.winehq.org/source/dlls/dbghelp/cpu_i386.c#L517.
1216   constexpr std::array<int, 24> regs{
1217       {/*  0 */ UNW_X86_EAX, /*  1 */ UNW_X86_ECX,    /*  2 */ UNW_X86_EDX, /*  3 */ UNW_X86_EBX,
1218        /*  4 */ UNW_X86_ESP, /*  5 */ UNW_X86_EBP,    /*  6 */ UNW_X86_ESI, /*  7 */ UNW_X86_EDI,
1219        /*  8 */ UNW_X86_EIP, /*  9 */ UNW_X86_EFLAGS, /* 10 */ UNW_X86_CS,  /* 11 */ UNW_X86_SS,
1220        /* 12 */ UNW_X86_DS,  /* 13 */ UNW_X86_ES,     /* 14 */ UNW_X86_FS,  /* 15 */ UNW_X86_GS,
1221        /* 16 */ UNW_X86_ST0, /* 17 */ UNW_X86_ST1,    /* 18 */ UNW_X86_ST2, /* 19 */ UNW_X86_ST3,
1222        /* 20 */ UNW_X86_ST4, /* 21 */ UNW_X86_ST5,    /* 22 */ UNW_X86_ST6, /* 23 */ UNW_X86_ST7}};
1223   return regs.at(dwarf_register);
1224 #else
1225 #error This architecture is not supported yet for DWARF expression evaluation.
1226 #endif
1227 }
1228
1229 } // namespace dwarf
1230 } // namespace simgrid