src/mc/inspect/mc_dwarf.cpp

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