src/mc/inspect/mc_dwarf.cpp

   1 /* Copyright (c) 2008-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/simgrid/util.hpp"
   7 #include "xbt/log.h"
   8 #include "xbt/string.hpp"
   9 #include "xbt/sysdep.h"
  10 #include <simgrid/config.h>
  11
  12 #include "src/mc/inspect/ObjectInformation.hpp"
  13 #include "src/mc/inspect/Variable.hpp"
  14 #include "src/mc/inspect/mc_dwarf.hpp"
  15 #include "src/mc/mc_private.hpp"
  16 #include "src/mc/remote/RemoteSimulation.hpp"
  17
  18 #include <algorithm>
  19 #include <array>
  20 #include <cinttypes>
  21 #include <cstdint>
  22 #include <cstdlib>
  23 #include <fcntl.h>
  24 #include <memory>
  25 #include <utility>
  26
  27 #include <boost/range/algorithm.hpp>
  28
  29 #include <elfutils/libdw.h>
  30
  31 #include <boost/algorithm/string/predicate.hpp>
  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   switch (tag) {
 128     case DW_TAG_array_type:
 129     case DW_TAG_class_type:
 130     case DW_TAG_enumeration_type:
 131     case DW_TAG_typedef:
 132     case DW_TAG_pointer_type:
 133     case DW_TAG_reference_type:
 134     case DW_TAG_rvalue_reference_type:
 135     case DW_TAG_string_type:
 136     case DW_TAG_structure_type:
 137     case DW_TAG_subroutine_type:
 138     case DW_TAG_union_type:
 139     case DW_TAG_ptr_to_member_type:
 140     case DW_TAG_set_type:
 141     case DW_TAG_subrange_type:
 142     case DW_TAG_base_type:
 143     case DW_TAG_const_type:
 144     case DW_TAG_file_type:
 145     case DW_TAG_packed_type:
 146     case DW_TAG_volatile_type:
 147     case DW_TAG_restrict_type:
 148     case DW_TAG_interface_type:
 149     case DW_TAG_unspecified_type:
 150     case DW_TAG_shared_type:
 151       return TagClass::Type;
 152
 153     case DW_TAG_subprogram:
 154       return TagClass::Subprogram;
 155
 156     case DW_TAG_variable:
 157     case DW_TAG_formal_parameter:
 158       return TagClass::Variable;
 159
 160     case DW_TAG_lexical_block:
 161     case DW_TAG_try_block:
 162     case DW_TAG_catch_block:
 163     case DW_TAG_inlined_subroutine:
 164     case DW_TAG_with_stmt:
 165       return TagClass::Scope;
 166
 167     case DW_TAG_namespace:
 168       return TagClass::Namespace;
 169
 170     default:
 171       return TagClass::Unknown;
 172   }
 173 }
 174
 175 /** @brief Find the DWARF data class for a given DWARF data form
 176  *
 177  *  This mapping is defined in the DWARF spec.
 178  *
 179  *  @param form The form (values taken from the DWARF spec)
 180  *  @return An internal representation for the corresponding class
 181  * */
 182 static FormClass classify_form(int form)
 183 {
 184   switch (form) {
 185     case DW_FORM_addr:
 186       return FormClass::Address;
 187     case DW_FORM_block2:
 188     case DW_FORM_block4:
 189     case DW_FORM_block:
 190     case DW_FORM_block1:
 191       return FormClass::Block;
 192     case DW_FORM_data1:
 193     case DW_FORM_data2:
 194     case DW_FORM_data4:
 195     case DW_FORM_data8:
 196     case DW_FORM_udata:
 197     case DW_FORM_sdata:
 198       return FormClass::Constant;
 199     case DW_FORM_string:
 200     case DW_FORM_strp:
 201       return FormClass::String;
 202     case DW_FORM_ref_addr:
 203     case DW_FORM_ref1:
 204     case DW_FORM_ref2:
 205     case DW_FORM_ref4:
 206     case DW_FORM_ref8:
 207     case DW_FORM_ref_udata:
 208       return FormClass::Reference;
 209     case DW_FORM_flag:
 210     case DW_FORM_flag_present:
 211       return FormClass::Flag;
 212     case DW_FORM_exprloc:
 213       return FormClass::ExprLoc;
 214       // TODO sec offset
 215       // TODO indirect
 216     default:
 217       return FormClass::Unknown;
 218   }
 219 }
 220
 221 /** @brief Get the name of the tag of a given DIE
 222  *
 223  *  @param die DIE
 224  *  @return name of the tag of this DIE
 225  */
 226 inline XBT_PRIVATE const char* tagname(Dwarf_Die* die)
 227 {
 228   return tagname(dwarf_tag(die));
 229 }
 230
 231 } // namespace dwarf
 232 } // namespace simgrid
 233
 234 // ***** Attributes
 235
 236 /** @brief Get an attribute of a given DIE as a string
 237  *
 238  *  @param die       the DIE
 239  *  @param attribute attribute
 240  *  @return value of the given attribute of the given DIE
 241  */
 242 static const char* MC_dwarf_attr_integrate_string(Dwarf_Die* die, int attribute)
 243 {
 244   Dwarf_Attribute attr;
 245   if (not dwarf_attr_integrate(die, attribute, &attr))
 246     return nullptr;
 247   else
 248     return dwarf_formstring(&attr);
 249 }
 250
 251 static Dwarf_Off MC_dwarf_attr_dieoffset(Dwarf_Die* die, int attribute)
 252 {
 253   Dwarf_Attribute attr;
 254   if (dwarf_hasattr_integrate(die, attribute) == 0)
 255     return 0;
 256   dwarf_attr_integrate(die, attribute, &attr);
 257   Dwarf_Die subtype_die;
 258   xbt_assert(dwarf_formref_die(&attr, &subtype_die) != nullptr, "Could not find DIE");
 259   return dwarf_dieoffset(&subtype_die);
 260 }
 261
 262 static Dwarf_Off MC_dwarf_attr_integrate_dieoffset(Dwarf_Die* die, int attribute)
 263 {
 264   Dwarf_Attribute attr;
 265   if (dwarf_hasattr_integrate(die, attribute) == 0)
 266     return 0;
 267   dwarf_attr_integrate(die, DW_AT_type, &attr);
 268   Dwarf_Die subtype_die;
 269   xbt_assert(dwarf_formref_die(&attr, &subtype_die) != nullptr, "Could not find DIE");
 270   return dwarf_dieoffset(&subtype_die);
 271 }
 272
 273 /** @brief Find the type/subtype (DW_AT_type) for a DIE
 274  *
 275  *  @param die the DIE
 276  *  @return DW_AT_type reference as a global offset in hexadecimal (or nullptr)
 277  */
 278 static std::uint64_t MC_dwarf_at_type(Dwarf_Die* die)
 279 {
 280   return MC_dwarf_attr_integrate_dieoffset(die, DW_AT_type);
 281 }
 282
 283 static uint64_t MC_dwarf_attr_integrate_addr(Dwarf_Die* die, int attribute)
 284 {
 285   Dwarf_Attribute attr;
 286   if (dwarf_attr_integrate(die, attribute, &attr) == nullptr)
 287     return 0;
 288   Dwarf_Addr value;
 289   if (dwarf_formaddr(&attr, &value) == 0)
 290     return (uint64_t)value;
 291   else
 292     return 0;
 293 }
 294
 295 static uint64_t MC_dwarf_attr_integrate_uint(Dwarf_Die* die, int attribute, uint64_t default_value)
 296 {
 297   Dwarf_Attribute attr;
 298   if (dwarf_attr_integrate(die, attribute, &attr) == nullptr)
 299     return default_value;
 300   Dwarf_Word value;
 301   return dwarf_formudata(dwarf_attr_integrate(die, attribute, &attr), &value) == 0 ? (uint64_t)value : default_value;
 302 }
 303
 304 static bool MC_dwarf_attr_flag(Dwarf_Die* die, int attribute, bool integrate)
 305 {
 306   Dwarf_Attribute attr;
 307   if ((integrate ? dwarf_attr_integrate(die, attribute, &attr) : dwarf_attr(die, attribute, &attr)) == nullptr)
 308     return false;
 309
 310   bool result;
 311   xbt_assert(not dwarf_formflag(&attr, &result), "Unexpected form for attribute %s",
 312              simgrid::dwarf::attrname(attribute));
 313   return result;
 314 }
 315
 316 /** @brief Find the default lower bound for a given language
 317  *
 318  *  The default lower bound of an array (when DW_TAG_lower_bound
 319  *  is missing) depends on the language of the compilation unit.
 320  *
 321  *  @param lang Language of the compilation unit (values defined in the DWARF spec)
 322  *  @return     Default lower bound of an array in this compilation unit
 323  * */
 324 static uint64_t MC_dwarf_default_lower_bound(int lang)
 325 {
 326   switch (lang) {
 327     case DW_LANG_C:
 328     case DW_LANG_C89:
 329     case DW_LANG_C99:
 330     case DW_LANG_C_plus_plus:
 331     case DW_LANG_D:
 332     case DW_LANG_Java:
 333     case DW_LANG_ObjC:
 334     case DW_LANG_ObjC_plus_plus:
 335     case DW_LANG_Python:
 336     case DW_LANG_UPC:
 337       return 0;
 338     case DW_LANG_Ada83:
 339     case DW_LANG_Ada95:
 340     case DW_LANG_Fortran77:
 341     case DW_LANG_Fortran90:
 342     case DW_LANG_Fortran95:
 343     case DW_LANG_Modula2:
 344     case DW_LANG_Pascal83:
 345     case DW_LANG_PL1:
 346     case DW_LANG_Cobol74:
 347     case DW_LANG_Cobol85:
 348       return 1;
 349     default:
 350       xbt_die("No default DW_TAG_lower_bound for language %i and none given", lang);
 351       return 0;
 352   }
 353 }
 354
 355 /** @brief Finds the number of elements in a DW_TAG_subrange_type or DW_TAG_enumeration_type DIE
 356  *
 357  *  @param die  the DIE
 358  *  @param unit DIE of the compilation unit
 359  *  @return     number of elements in the range
 360  * */
 361 static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die* die, Dwarf_Die* unit)
 362 {
 363   xbt_assert(dwarf_tag(die) == DW_TAG_enumeration_type || dwarf_tag(die) == DW_TAG_subrange_type,
 364              "MC_dwarf_subrange_element_count called with DIE of type %s", simgrid::dwarf::tagname(die));
 365
 366   // Use DW_TAG_count if present:
 367   if (dwarf_hasattr_integrate(die, DW_AT_count))
 368     return MC_dwarf_attr_integrate_uint(die, DW_AT_count, 0);
 369   // Otherwise compute DW_TAG_upper_bound-DW_TAG_lower_bound + 1:
 370
 371   if (not dwarf_hasattr_integrate(die, DW_AT_upper_bound))
 372     // This is not really 0, but the code expects this (we do not know):
 373     return 0;
 374
 375   uint64_t upper_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_upper_bound, static_cast<uint64_t>(-1));
 376
 377   uint64_t lower_bound = 0;
 378   if (dwarf_hasattr_integrate(die, DW_AT_lower_bound))
 379     lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, static_cast<uint64_t>(-1));
 380   else
 381     lower_bound = MC_dwarf_default_lower_bound(dwarf_srclang(unit));
 382   return upper_bound - lower_bound + 1;
 383 }
 384
 385 /** @brief Finds the number of elements in an array type (DW_TAG_array_type)
 386  *
 387  *  The compilation unit might be needed because the default lower
 388  *  bound depends on the language of the compilation unit.
 389  *
 390  *  @param die the DIE of the DW_TAG_array_type
 391  *  @param unit the DIE of the compilation unit
 392  *  @return number of elements in this array type
 393  * */
 394 static uint64_t MC_dwarf_array_element_count(Dwarf_Die* die, Dwarf_Die* unit)
 395 {
 396   xbt_assert(dwarf_tag(die) == DW_TAG_array_type, "MC_dwarf_array_element_count called with DIE of type %s",
 397              simgrid::dwarf::tagname(die));
 398
 399   int result = 1;
 400   Dwarf_Die child;
 401   for (int res = dwarf_child(die, &child); res == 0; res = dwarf_siblingof(&child, &child)) {
 402     int child_tag = dwarf_tag(&child);
 403     if (child_tag == DW_TAG_subrange_type || child_tag == DW_TAG_enumeration_type)
 404       result *= MC_dwarf_subrange_element_count(&child, unit);
 405   }
 406   return result;
 407 }
 408
 409 // ***** Variable
 410
 411 /** Sort the variable by name and address.
 412  *
 413  *  We could use boost::container::flat_set instead.
 414  */
 415 static bool MC_compare_variable(simgrid::mc::Variable const& a, simgrid::mc::Variable const& b)
 416 {
 417   int cmp = a.name.compare(b.name);
 418   if (cmp < 0)
 419     return true;
 420   else if (cmp > 0)
 421     return false;
 422   else
 423     return a.address < b.address;
 424 }
 425
 426 // ***** simgrid::mc::Type*
 427
 428 /** @brief Initialize the location of a member of a type
 429  * (DW_AT_data_member_location of a DW_TAG_member).
 430  *
 431  *  @param  type   a type (struct, class)
 432  *  @param  member the member of the type
 433  *  @param  child  DIE of the member (DW_TAG_member)
 434  */
 435 static void MC_dwarf_fill_member_location(const simgrid::mc::Type* type, simgrid::mc::Member* member, Dwarf_Die* child)
 436 {
 437   xbt_assert(not dwarf_hasattr(child, DW_AT_data_bit_offset), "Can't groke DW_AT_data_bit_offset.");
 438
 439   if (not dwarf_hasattr_integrate(child, DW_AT_data_member_location)) {
 440     if (type->type == DW_TAG_union_type)
 441       return;
 442     xbt_die("Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%" PRIx64 ">%s",
 443             member->name.c_str(), (uint64_t)type->id, type->name.c_str());
 444   }
 445
 446   Dwarf_Attribute attr;
 447   dwarf_attr_integrate(child, DW_AT_data_member_location, &attr);
 448   int form                             = dwarf_whatform(&attr);
 449   simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form);
 450   switch (form_class) {
 451     case simgrid::dwarf::FormClass::ExprLoc:
 452     case simgrid::dwarf::FormClass::Block:
 453       // Location expression:
 454       {
 455         Dwarf_Op* expr;
 456         size_t len;
 457         xbt_assert(not dwarf_getlocation(&attr, &expr, &len),
 458                    "Could not read location expression DW_AT_data_member_location in DW_TAG_member %s of type <%" PRIx64
 459                    ">%s",
 460                    MC_dwarf_attr_integrate_string(child, DW_AT_name), (uint64_t)type->id, type->name.c_str());
 461         member->location_expression = simgrid::dwarf::DwarfExpression(expr, expr + len);
 462         break;
 463       }
 464     case simgrid::dwarf::FormClass::Constant:
 465       // Offset from the base address of the object:
 466       {
 467         Dwarf_Word offset;
 468         xbt_assert(not dwarf_formudata(&attr, &offset), "Cannot get %s location <%" PRIx64 ">%s",
 469                    MC_dwarf_attr_integrate_string(child, DW_AT_name), (uint64_t)type->id, type->name.c_str());
 470         member->offset(offset);
 471         break;
 472       }
 473
 474     default:
 475       // includes FormClass::LocListPtr (reference to a location list: TODO) and FormClass::Reference (it's supposed to
 476       // be possible in DWARF2 but I couldn't find its semantic in the spec)
 477       xbt_die("Can't handle form class (%d) / form 0x%x as DW_AT_member_location", (int)form_class, (unsigned)form);
 478   }
 479 }
 480
 481 /** @brief Populate the list of members of a type
 482  *
 483  *  @param info ELF object containing the type DIE
 484  *  @param die  DIE of the type
 485  *  @param unit DIE of the compilation unit containing the type DIE
 486  *  @param type the type
 487  */
 488 static void MC_dwarf_add_members(const simgrid::mc::ObjectInformation* /*info*/, Dwarf_Die* die,
 489                                  const Dwarf_Die* /*unit*/, simgrid::mc::Type* type)
 490 {
 491   Dwarf_Die child;
 492   xbt_assert(type->members.empty());
 493   for (int 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                                                                  const Dwarf_Die* /*unit*/,
 648                                                                  const simgrid::mc::Frame* frame, 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   auto variable         = std::make_unique<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           auto offset       = static_cast<uintptr_t>(expr[0].number);
 694           auto base         = reinterpret_cast<uintptr_t>(info->base_address());
 695           variable->address = reinterpret_cast<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, const 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   auto base = reinterpret_cast<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 ? 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   for (int res = dwarf_child(die, &child); res == 0; res = dwarf_siblingof(&child, &child))
 857     MC_dwarf_handle_die(info, &child, unit, frame, ns);
 858 }
 859
 860 static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, Dwarf_Die* unit,
 861                                 simgrid::mc::Frame* frame, const char* ns)
 862 {
 863   int tag                        = dwarf_tag(die);
 864   simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag);
 865   switch (klass) {
 866     // Type:
 867     case simgrid::dwarf::TagClass::Type:
 868       MC_dwarf_handle_type_die(info, die, unit, frame, ns);
 869       break;
 870
 871       // Subprogram or scope:
 872     case simgrid::dwarf::TagClass::Subprogram:
 873     case simgrid::dwarf::TagClass::Scope:
 874       MC_dwarf_handle_scope_die(info, die, unit, frame, ns);
 875       return;
 876
 877       // Variable:
 878     case simgrid::dwarf::TagClass::Variable:
 879       MC_dwarf_handle_variable_die(info, die, unit, frame, ns);
 880       break;
 881
 882     case simgrid::dwarf::TagClass::Namespace:
 883       mc_dwarf_handle_namespace_die(info, die, unit, frame, ns);
 884       break;
 885
 886     default:
 887       break;
 888   }
 889 }
 890
 891 static Elf64_Half get_type(Elf* elf)
 892 {
 893   const Elf64_Ehdr* ehdr64 = elf64_getehdr(elf);
 894   if (ehdr64)
 895     return ehdr64->e_type;
 896   const Elf32_Ehdr* ehdr32 = elf32_getehdr(elf);
 897   if (ehdr32)
 898     return ehdr32->e_type;
 899   xbt_die("Could not get ELF heeader");
 900 }
 901
 902 static void read_dwarf_info(simgrid::mc::ObjectInformation* info, Dwarf* dwarf)
 903 {
 904   // For each compilation unit:
 905   Dwarf_Off offset      = 0;
 906   Dwarf_Off next_offset = 0;
 907   size_t length;
 908
 909   while (dwarf_nextcu(dwarf, offset, &next_offset, &length, nullptr, nullptr, nullptr) == 0) {
 910     Dwarf_Die unit_die;
 911     if (dwarf_offdie(dwarf, offset + length, &unit_die) != nullptr)
 912       MC_dwarf_handle_children(info, &unit_die, &unit_die, nullptr, nullptr);
 913     offset = next_offset;
 914   }
 915 }
 916
 917 /** Get the build-id (NT_GNU_BUILD_ID) from the ELF file
 918  *
 919  *  This build-id may is used to locate an external debug (DWARF) file
 920  *  for this ELF file.
 921  *
 922  *  @param  elf libelf handle for an ELF file
 923  *  @return build-id for this ELF file (or an empty vector if none is found)
 924  */
 925 static std::vector<char> get_build_id(Elf* elf)
 926 {
 927 #ifdef __linux
 928   // Summary: the GNU build ID is stored in a ("GNU, NT_GNU_BUILD_ID) note
 929   // found in a PT_NOTE entry in the program header table.
 930
 931   size_t phnum;
 932   xbt_assert(elf_getphdrnum(elf, &phnum) == 0, "Could not read program headers");
 933
 934   // Iterate over the program headers and find the PT_NOTE ones:
 935   for (size_t i = 0; i < phnum; ++i) {
 936     GElf_Phdr phdr_temp;
 937     const GElf_Phdr* phdr = gelf_getphdr(elf, i, &phdr_temp);
 938     if (phdr->p_type != PT_NOTE)
 939       continue;
 940
 941     Elf_Data* data = elf_getdata_rawchunk(elf, phdr->p_offset, phdr->p_filesz, ELF_T_NHDR);
 942
 943     // Iterate over the notes and find the NT_GNU_BUILD_ID one:
 944     size_t pos = 0;
 945     while (pos < data->d_size) {
 946       GElf_Nhdr nhdr;
 947       // Location of the name within Elf_Data:
 948       size_t name_pos;
 949       size_t desc_pos;
 950       pos = gelf_getnote(data, pos, &nhdr, &name_pos, &desc_pos);
 951       // A build ID note is identified by the pair ("GNU", NT_GNU_BUILD_ID)
 952       // (a namespace and a type within this namespace):
 953       if (nhdr.n_type == NT_GNU_BUILD_ID && nhdr.n_namesz == sizeof("GNU") &&
 954           memcmp((char*)data->d_buf + name_pos, "GNU", sizeof("GNU")) == 0) {
 955         XBT_DEBUG("Found GNU/NT_GNU_BUILD_ID note");
 956         char* start = (char*)data->d_buf + desc_pos;
 957         char* end   = start + nhdr.n_descsz;
 958         return std::vector<char>(start, end);
 959       }
 960     }
 961   }
 962 #endif
 963   return std::vector<char>();
 964 }
 965
 966 /** Binary data to hexadecimal */
 967 static inline std::array<char, 2> to_hex(std::uint8_t byte)
 968 {
 969   constexpr std::array<char, 16> hexdigits{
 970       {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'}};
 971   // Horrid double braces!
 972   // Apparently, this is needed in C++11 (not in C++14).
 973   return {{hexdigits[byte >> 4], hexdigits[byte & 0xF]}};
 974 }
 975
 976 /** Binary data to hexadecimal */
 977 static std::string to_hex(const char* data, std::size_t count)
 978 {
 979   std::string res;
 980   res.resize(2 * count);
 981   for (std::size_t i = 0; i < count; i++)
 982     std::copy_n(cbegin(to_hex(data[i])), 2, &res[2 * i]);
 983   return res;
 984 }
 985
 986 /** Binary data to hexadecimal */
 987 static std::string to_hex(std::vector<char> const& data)
 988 {
 989   return to_hex(data.data(), data.size());
 990 }
 991
 992 /** Base directories for external debug files */
 993 static constexpr auto debug_paths = {
 994     "/usr/lib/debug/",
 995     "/usr/local/lib/debug/",
 996 };
 997
 998 /** Locate an external debug file from the NT_GNU_BUILD_ID
 999  *
1000  *  This is one of the mechanisms used for
1001  *  [separate debug files](https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html).
1002  */
1003 // Example:
1004 // /usr/lib/debug/.build-id/0b/dc77f1c29aea2b14ff5acd9a19ab3175ffdeae.debug
1005 static std::string find_by_build_id(std::vector<char> id)
1006 {
1007   std::string filename;
1008   std::string hex = to_hex(id);
1009   for (const char* const& debug_path : debug_paths) {
1010     // Example:
1011     filename = std::string(debug_path) + ".build-id/" + to_hex(id.data(), 1) + '/' +
1012                to_hex(id.data() + 1, id.size() - 1) + ".debug";
1013     XBT_DEBUG("Checking debug file: %s", filename.c_str());
1014     if (access(filename.c_str(), F_OK) == 0) {
1015       XBT_DEBUG("Found debug file: %s\n", hex.c_str());
1016       return filename;
1017     }
1018   }
1019   XBT_DEBUG("No debug info found for build ID %s\n", hex.data());
1020   return std::string();
1021 }
1022
1023 /** @brief Populate the debugging information of the given ELF object
1024  *
1025  *  Read the DWARf information of the EFFL object and populate the
1026  *  lists of types, variables, functions.
1027  */
1028 static void MC_load_dwarf(simgrid::mc::ObjectInformation* info)
1029 {
1030   xbt_assert(elf_version(EV_CURRENT) != EV_NONE, "libelf initialization error");
1031
1032   // Open the ELF file:
1033   int fd = open(info->file_name.c_str(), O_RDONLY);
1034   xbt_assert(fd >= 0, "Could not open file %s", info->file_name.c_str());
1035   Elf* elf = elf_begin(fd, ELF_C_READ, nullptr);
1036   xbt_assert(elf != nullptr, "Not an ELF file");
1037   Elf_Kind kind = elf_kind(elf);
1038   xbt_assert(kind == ELF_K_ELF, "Not an ELF file");
1039
1040   // Remember if this is a `ET_EXEC` (fixed location) or `ET_DYN`:
1041   Elf64_Half type = get_type(elf);
1042   if (type == ET_EXEC)
1043     info->flags |= simgrid::mc::ObjectInformation::Executable;
1044
1045   // Read DWARF debug information in the file:
1046   Dwarf* dwarf = dwarf_begin_elf(elf, DWARF_C_READ, nullptr);
1047   if (dwarf != nullptr) {
1048     read_dwarf_info(info, dwarf);
1049     dwarf_end(dwarf);
1050     elf_end(elf);
1051     close(fd);
1052     return;
1053   }
1054   dwarf_end(dwarf);
1055
1056   // If there was no DWARF in the file, try to find it in a separate file.
1057   // Different methods might be used to store the DWARF information:
1058   //  * GNU NT_GNU_BUILD_ID
1059   //  * .gnu_debuglink
1060   // See https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
1061   // for reference of what we are doing.
1062
1063   // Try with NT_GNU_BUILD_ID: we find the build ID in the ELF file and then
1064   // use this ID to find the file in some known locations in the filesystem.
1065   std::vector<char> build_id = get_build_id(elf);
1066   if (not build_id.empty()) {
1067     elf_end(elf);
1068     close(fd);
1069
1070     // Find the debug file using the build id:
1071     std::string debug_file = find_by_build_id(build_id);
1072     xbt_assert(not debug_file.empty(),
1073                "Missing debug info for %s with build-id %s\n"
1074                "You might want to install the suitable debugging package.\n",
1075                info->file_name.c_str(), to_hex(build_id).c_str());
1076
1077     // Load the DWARF info from this file:
1078     XBT_DEBUG("Load DWARF for %s from %s", info->file_name.c_str(), debug_file.c_str());
1079     fd = open(debug_file.c_str(), O_RDONLY);
1080     xbt_assert(fd >= 0, "Could not open file %s", debug_file.c_str());
1081     dwarf = dwarf_begin(fd, DWARF_C_READ);
1082     xbt_assert(dwarf != nullptr, "No DWARF info in %s for %s", debug_file.c_str(), info->file_name.c_str());
1083     read_dwarf_info(info, dwarf);
1084     dwarf_end(dwarf);
1085     close(fd);
1086     return;
1087   }
1088
1089   // TODO, try to find DWARF info using .gnu_debuglink.
1090
1091   elf_end(elf);
1092   close(fd);
1093   xbt_die("Debugging information not found for %s\n"
1094           "Try recompiling with -g\n",
1095           info->file_name.c_str());
1096 }
1097
1098 // ***** Functions index
1099
1100 static void MC_make_functions_index(simgrid::mc::ObjectInformation* info)
1101 {
1102   info->functions_index.clear();
1103
1104   for (auto& e : info->subprograms) {
1105     if (e.second.range.begin() == 0)
1106       continue;
1107     simgrid::mc::FunctionIndexEntry entry;
1108     entry.low_pc   = (void*)e.second.range.begin();
1109     entry.function = &e.second;
1110     info->functions_index.push_back(entry);
1111   }
1112
1113   info->functions_index.shrink_to_fit();
1114
1115   // Sort the array by low_pc:
1116   boost::range::sort(info->functions_index,
1117                      [](simgrid::mc::FunctionIndexEntry const& a, simgrid::mc::FunctionIndexEntry const& b) {
1118                        return a.low_pc < b.low_pc;
1119                      });
1120 }
1121
1122 static void MC_post_process_variables(simgrid::mc::ObjectInformation* info)
1123 {
1124   // Someone needs this to be sorted but who?
1125   boost::range::sort(info->global_variables, MC_compare_variable);
1126
1127   for (simgrid::mc::Variable& variable : info->global_variables)
1128     if (variable.type_id)
1129       variable.type = simgrid::util::find_map_ptr(info->types, variable.type_id);
1130 }
1131
1132 static void mc_post_process_scope(simgrid::mc::ObjectInformation* info, simgrid::mc::Frame* scope)
1133 {
1134   if (scope->tag == DW_TAG_inlined_subroutine) {
1135     // Attach correct namespaced name in inlined subroutine:
1136     auto i = info->subprograms.find(scope->abstract_origin_id);
1137     xbt_assert(i != info->subprograms.end(), "Could not lookup abstract origin %" PRIx64,
1138                (std::uint64_t)scope->abstract_origin_id);
1139     scope->name = i->second.name;
1140   }
1141
1142   // Direct:
1143   for (simgrid::mc::Variable& variable : scope->variables)
1144     if (variable.type_id)
1145       variable.type = simgrid::util::find_map_ptr(info->types, variable.type_id);
1146
1147   // Recursive post-processing of nested-scopes:
1148   for (simgrid::mc::Frame& nested_scope : scope->scopes)
1149     mc_post_process_scope(info, &nested_scope);
1150 }
1151
1152 static simgrid::mc::Type* MC_resolve_type(simgrid::mc::ObjectInformation* info, unsigned type_id)
1153 {
1154   if (not type_id)
1155     return nullptr;
1156   simgrid::mc::Type* type = simgrid::util::find_map_ptr(info->types, type_id);
1157   if (type == nullptr)
1158     return nullptr;
1159
1160   // We already have the information on the type:
1161   if (type->byte_size != 0)
1162     return type;
1163
1164   // Don't have a name, we can't find a more complete version:
1165   if (type->name.empty())
1166     return type;
1167
1168   // Try to find a more complete description of the type:
1169   // We need to fix in order to support C++.
1170   simgrid::mc::Type** subtype = simgrid::util::find_map_ptr(info->full_types_by_name, type->name);
1171   if (subtype)
1172     type = *subtype;
1173   return type;
1174 }
1175
1176 static void MC_post_process_types(simgrid::mc::ObjectInformation* info)
1177 {
1178   // Lookup "subtype" field:
1179   for (auto& i : info->types) {
1180     i.second.subtype = MC_resolve_type(info, i.second.type_id);
1181     for (simgrid::mc::Member& member : i.second.members)
1182       member.type = MC_resolve_type(info, member.type_id);
1183   }
1184 }
1185
1186 namespace simgrid {
1187 namespace mc {
1188
1189 /** @brief Finds information about a given shared object/executable */
1190 std::shared_ptr<ObjectInformation> createObjectInformation(std::vector<xbt::VmMap> const& maps, const char* name)
1191 {
1192   auto result       = std::make_shared<ObjectInformation>();
1193   result->file_name = name;
1194   simgrid::mc::find_object_address(maps, result.get());
1195   MC_load_dwarf(result.get());
1196   MC_post_process_variables(result.get());
1197   MC_post_process_types(result.get());
1198   for (auto& entry : result.get()->subprograms)
1199     mc_post_process_scope(result.get(), &entry.second);
1200   MC_make_functions_index(result.get());
1201   return result;
1202 }
1203
1204 /*************************************************************************/
1205
1206 void postProcessObjectInformation(const RemoteSimulation* process, ObjectInformation* info)
1207 {
1208   for (auto& t : info->types) {
1209     Type* type    = &(t.second);
1210     Type* subtype = type;
1211     while (subtype->type == DW_TAG_typedef || subtype->type == DW_TAG_volatile_type ||
1212            subtype->type == DW_TAG_const_type)
1213       if (subtype->subtype)
1214         subtype = subtype->subtype;
1215       else
1216         break;
1217
1218     // Resolve full_type:
1219     if (not subtype->name.empty() && subtype->byte_size == 0)
1220       for (auto const& object_info : process->object_infos) {
1221         auto i = object_info->full_types_by_name.find(subtype->name);
1222         if (i != object_info->full_types_by_name.end() && not i->second->name.empty() && i->second->byte_size) {
1223           type->full_type = i->second;
1224           break;
1225         }
1226       }
1227     else
1228       type->full_type = subtype;
1229   }
1230 }
1231
1232 } // namespace mc
1233 } // namespace simgrid
1234
1235 namespace simgrid {
1236 namespace dwarf {
1237
1238 /** Convert a DWARF register into a libunwind register
1239  *
1240  *  DWARF and libunwind does not use the same convention for numbering the
1241  *  registers on some architectures. The function makes the necessary
1242  *  conversion.
1243  */
1244 int dwarf_register_to_libunwind(int dwarf_register)
1245 {
1246 #if defined(__x86_64__)
1247   // It seems for this arch, DWARF and libunwind agree in the numbering:
1248   return dwarf_register;
1249 #elif defined(__i386__)
1250   // Couldn't find the authoritative source of information for this.
1251   // This is inspired from http://source.winehq.org/source/dlls/dbghelp/cpu_i386.c#L517.
1252   switch (dwarf_register) {
1253     case 0:
1254       return UNW_X86_EAX;
1255     case 1:
1256       return UNW_X86_ECX;
1257     case 2:
1258       return UNW_X86_EDX;
1259     case 3:
1260       return UNW_X86_EBX;
1261     case 4:
1262       return UNW_X86_ESP;
1263     case 5:
1264       return UNW_X86_EBP;
1265     case 6:
1266       return UNW_X86_ESI;
1267     case 7:
1268       return UNW_X86_EDI;
1269     case 8:
1270       return UNW_X86_EIP;
1271     case 9:
1272       return UNW_X86_EFLAGS;
1273     case 10:
1274       return UNW_X86_CS;
1275     case 11:
1276       return UNW_X86_SS;
1277     case 12:
1278       return UNW_X86_DS;
1279     case 13:
1280       return UNW_X86_ES;
1281     case 14:
1282       return UNW_X86_FS;
1283     case 15:
1284       return UNW_X86_GS;
1285     case 16:
1286       return UNW_X86_ST0;
1287     case 17:
1288       return UNW_X86_ST1;
1289     case 18:
1290       return UNW_X86_ST2;
1291     case 19:
1292       return UNW_X86_ST3;
1293     case 20:
1294       return UNW_X86_ST4;
1295     case 21:
1296       return UNW_X86_ST5;
1297     case 22:
1298       return UNW_X86_ST6;
1299     case 23:
1300       return UNW_X86_ST7;
1301     default:
1302       xbt_die("Bad/unknown register number.");
1303   }
1304 #else
1305 #error This architecture is not supported yet for DWARF expression evaluation.
1306 #endif
1307 }
1308
1309 } // namespace dwarf
1310 } // namespace simgrid