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