src/mc/inspect/mc_dwarf.cpp

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