src/mc/mc_dwarf.cpp

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