src/mc/inspect/mc_dwarf.cpp

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