src/mc/mc_dwarf.cpp

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