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 = MC_dwarf_attr_integrate_uint(die, DW_AT_upper_bound, static_cast<uint64_t>(-1));
 407
 408   uint64_t lower_bound = 0;
 409   if (dwarf_hasattr_integrate(die, DW_AT_lower_bound))
 410     lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, static_cast<uint64_t>(-1));
 411   else
 412     lower_bound = MC_dwarf_default_lower_bound(dwarf_srclang(unit));
 413   return upper_bound - lower_bound + 1;
 414 }
 415
 416 /** \brief Finds the number of elements in a array type (DW_TAG_array_type)
 417  *
 418  *  The compilation unit might be needed because the default lower
 419  *  bound depends on the language of the compilation unit.
 420  *
 421  *  \param die the DIE of the DW_TAG_array_type
 422  *  \param unit the DIE of the compilation unit
 423  *  \return number of elements in this array type
 424  * */
 425 static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit)
 426 {
 427   xbt_assert(dwarf_tag(die) == DW_TAG_array_type,
 428              "MC_dwarf_array_element_count called with DIE of type %s",
 429              simgrid::dwarf::tagname(die));
 430
 431   int result = 1;
 432   Dwarf_Die child;
 433   int res;
 434   for (res = dwarf_child(die, &child); res == 0;
 435        res = dwarf_siblingof(&child, &child)) {
 436     int child_tag = dwarf_tag(&child);
 437     if (child_tag == DW_TAG_subrange_type
 438         || child_tag == DW_TAG_enumeration_type)
 439       result *= MC_dwarf_subrange_element_count(&child, unit);
 440   }
 441   return result;
 442 }
 443
 444 // ***** Variable
 445
 446 /** Sort the variable by name and address.
 447  *
 448  *  We could use boost::container::flat_set instead.
 449  */
 450 static bool MC_compare_variable(
 451   simgrid::mc::Variable const& a, simgrid::mc::Variable const& b)
 452 {
 453   int cmp = strcmp(a.name.c_str(), b.name.c_str());
 454   if (cmp < 0)
 455     return true;
 456   else if (cmp > 0)
 457     return false;
 458   else
 459     return a.address < b.address;
 460 }
 461
 462 // ***** simgrid::mc::Type*
 463
 464 /** \brief Initialize the location of a member of a type
 465  * (DW_AT_data_member_location of a DW_TAG_member).
 466  *
 467  *  \param  type   a type (struct, class)
 468  *  \param  member the member of the type
 469  *  \param  child  DIE of the member (DW_TAG_member)
 470  */
 471 static void MC_dwarf_fill_member_location(
 472   simgrid::mc::Type* type, simgrid::mc::Member* member, Dwarf_Die * child)
 473 {
 474   if (dwarf_hasattr(child, DW_AT_data_bit_offset))
 475     xbt_die("Can't groke DW_AT_data_bit_offset.");
 476
 477   if (not dwarf_hasattr_integrate(child, DW_AT_data_member_location)) {
 478     if (type->type == DW_TAG_union_type)
 479       return;
 480     xbt_die
 481         ("Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%"
 482          PRIx64 ">%s", member->name.c_str(),
 483          (uint64_t) type->id, type->name.c_str());
 484   }
 485
 486   Dwarf_Attribute attr;
 487   dwarf_attr_integrate(child, DW_AT_data_member_location, &attr);
 488   int form = dwarf_whatform(&attr);
 489   simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form);
 490   switch (form_class) {
 491   case simgrid::dwarf::FormClass::ExprLoc:
 492   case simgrid::dwarf::FormClass::Block:
 493     // Location expression:
 494     {
 495       Dwarf_Op *expr;
 496       size_t len;
 497       if (dwarf_getlocation(&attr, &expr, &len))
 498         xbt_die
 499             ("Could not read location expression DW_AT_data_member_location in DW_TAG_member %s of type <%"
 500              PRIx64 ">%s", MC_dwarf_attr_integrate_string(child, DW_AT_name),
 501              (uint64_t) type->id, type->name.c_str());
 502       member->location_expression = simgrid::dwarf::DwarfExpression(expr, expr+len);
 503       break;
 504     }
 505   case simgrid::dwarf::FormClass::Constant:
 506     // Offset from the base address of the object:
 507     {
 508       Dwarf_Word offset;
 509       if (not dwarf_formudata(&attr, &offset))
 510         member->offset(offset);
 511       else
 512         xbt_die("Cannot get %s location <%" PRIx64 ">%s",
 513                 MC_dwarf_attr_integrate_string(child, DW_AT_name),
 514                 (uint64_t) type->id, type->name.c_str());
 515       break;
 516     }
 517
 518   default:
 519     // includes FormClass::LocListPtr (reference to a location list: TODO) and FormClass::Reference (it's supposed to be
 520     // possible in DWARF2 but I couldn't find its semantic in the spec)
 521     xbt_die("Can't handle form class (%d) / form 0x%x as DW_AT_member_location", (int)form_class, (unsigned)form);
 522   }
 523
 524 }
 525
 526 /** \brief Populate the list of members of a type
 527  *
 528  *  \param info ELF object containing the type DIE
 529  *  \param die  DIE of the type
 530  *  \param unit DIE of the compilation unit containing the type DIE
 531  *  \param type the type
 532  */
 533 static void MC_dwarf_add_members(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 534                                  Dwarf_Die * unit, simgrid::mc::Type* type)
 535 {
 536   int res;
 537   Dwarf_Die child;
 538   xbt_assert(type->members.empty());
 539   for (res = dwarf_child(die, &child); res == 0;
 540        res = dwarf_siblingof(&child, &child)) {
 541     int tag = dwarf_tag(&child);
 542     if (tag == DW_TAG_member || tag == DW_TAG_inheritance) {
 543
 544       // Skip declarations:
 545       if (MC_dwarf_attr_flag(&child, DW_AT_declaration, false))
 546         continue;
 547
 548       // Skip compile time constants:
 549       if (dwarf_hasattr(&child, DW_AT_const_value))
 550         continue;
 551
 552       // TODO, we should use another type (because is is not a type but a member)
 553       simgrid::mc::Member member;
 554       if (tag == DW_TAG_inheritance)
 555         member.flags |= simgrid::mc::Member::INHERITANCE_FLAG;
 556
 557       const char *name = MC_dwarf_attr_integrate_string(&child, DW_AT_name);
 558       if (name)
 559         member.name = name;
 560       // Those base names are used by GCC and clang for virtual table pointers
 561       // respectively ("__vptr$ClassName", "__vptr.ClassName"):
 562       if (boost::algorithm::starts_with(member.name, "__vptr$") ||
 563         boost::algorithm::starts_with(member.name, "__vptr."))
 564         member.flags |= simgrid::mc::Member::VIRTUAL_POINTER_FLAG;
 565       // A cleaner solution would be to check against the type:
 566       // ---
 567       // tag: DW_TAG_member
 568       // name: "_vptr$Foo"
 569       // type:
 570       //   # Type for a pointer to a vtable
 571       //   tag: DW_TAG_pointer_type
 572       //   type:
 573       //     # Type for a vtable:
 574       //     tag: DW_TAG_pointer_type
 575       //     name: "__vtbl_ptr_type"
 576       //     type:
 577       //       tag: DW_TAG_subroutine_type
 578       //       type:
 579       //         tag: DW_TAG_base_type
 580       //         name: "int"
 581       // ---
 582
 583       member.byte_size =
 584           MC_dwarf_attr_integrate_uint(&child, DW_AT_byte_size, 0);
 585       member.type_id = MC_dwarf_at_type(&child);
 586
 587       if (dwarf_hasattr(&child, DW_AT_data_bit_offset))
 588         xbt_die("Can't groke DW_AT_data_bit_offset.");
 589
 590       MC_dwarf_fill_member_location(type, &member, &child);
 591
 592       if (not member.type_id)
 593         xbt_die("Missing type for member %s of <%" PRIx64 ">%s",
 594                 member.name.c_str(),
 595                 (uint64_t) type->id, type->name.c_str());
 596
 597       type->members.push_back(std::move(member));
 598     }
 599   }
 600 }
 601
 602 /** \brief Create a MC type object from a DIE
 603  *
 604  *  \param info current object info object
 605  *  \param die DIE (for a given type)
 606  *  \param unit compilation unit of the current DIE
 607  *  \return MC representation of the type
 608  */
 609 static simgrid::mc::Type MC_dwarf_die_to_type(
 610   simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 611   Dwarf_Die * unit, simgrid::mc::Frame* frame,
 612   const char *ns)
 613 {
 614   simgrid::mc::Type type;
 615   type.type = dwarf_tag(die);
 616   type.name = std::string();
 617   type.element_count = -1;
 618
 619   // Global Offset
 620   type.id = dwarf_dieoffset(die);
 621
 622   const char *prefix = "";
 623   switch (type.type) {
 624   case DW_TAG_structure_type:
 625     prefix = "struct ";
 626     break;
 627   case DW_TAG_union_type:
 628     prefix = "union ";
 629     break;
 630   case DW_TAG_class_type:
 631     prefix = "class ";
 632     break;
 633   default:
 634     prefix = "";
 635   }
 636
 637   const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 638   if (name != nullptr) {
 639     if (ns)
 640       type.name = simgrid::xbt::string_printf("%s%s::%s", prefix, ns, name);
 641     else
 642       type.name = simgrid::xbt::string_printf("%s%s", prefix, name);
 643   }
 644
 645   type.type_id = MC_dwarf_at_type(die);
 646
 647   // Some compilers do not emit DW_AT_byte_size for pointer_type,
 648   // so we fill this. We currently assume that the model-checked process is in
 649   // the same architecture..
 650   if (type.type == DW_TAG_pointer_type)
 651     type.byte_size = sizeof(void*);
 652
 653   // Computation of the byte_size
 654   if (dwarf_hasattr_integrate(die, DW_AT_byte_size))
 655     type.byte_size = MC_dwarf_attr_integrate_uint(die, DW_AT_byte_size, 0);
 656   else if (type.type == DW_TAG_array_type
 657            || type.type == DW_TAG_structure_type
 658            || type.type == DW_TAG_class_type) {
 659     Dwarf_Word size;
 660     if (dwarf_aggregate_size(die, &size) == 0)
 661       type.byte_size = size;
 662   }
 663
 664   switch (type.type) {
 665   case DW_TAG_array_type:
 666     type.element_count = MC_dwarf_array_element_count(die, unit);
 667     // TODO, handle DW_byte_stride and (not) DW_bit_stride
 668     break;
 669
 670   case DW_TAG_pointer_type:
 671   case DW_TAG_reference_type:
 672   case DW_TAG_rvalue_reference_type:
 673     break;
 674
 675   case DW_TAG_structure_type:
 676   case DW_TAG_union_type:
 677   case DW_TAG_class_type:
 678     MC_dwarf_add_members(info, die, unit, &type);
 679     MC_dwarf_handle_children(info, die, unit, frame,
 680                              ns ? simgrid::xbt::string_printf("%s::%s", ns, name).c_str() : type.name.c_str());
 681     break;
 682
 683   default:
 684     XBT_DEBUG("Unhandled type: %d (%s)", type.type, simgrid::dwarf::tagname(type.type));
 685     break;
 686   }
 687
 688   return type;
 689 }
 690
 691 static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 692                                      Dwarf_Die * unit, simgrid::mc::Frame* frame,
 693                                      const char *ns)
 694 {
 695   simgrid::mc::Type type = MC_dwarf_die_to_type(info, die, unit, frame, ns);
 696   auto& t = (info->types[type.id] = std::move(type));
 697   if (not t.name.empty() && type.byte_size != 0)
 698     info->full_types_by_name[t.name] = &t;
 699 }
 700
 701 static int mc_anonymous_variable_index = 0;
 702
 703 static std::unique_ptr<simgrid::mc::Variable> MC_die_to_variable(
 704   simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 705   Dwarf_Die * unit, simgrid::mc::Frame* frame,
 706   const char *ns)
 707 {
 708   // Skip declarations:
 709   if (MC_dwarf_attr_flag(die, DW_AT_declaration, false))
 710     return nullptr;
 711
 712   // Skip compile time constants:
 713   if (dwarf_hasattr(die, DW_AT_const_value))
 714     return nullptr;
 715
 716   Dwarf_Attribute attr_location;
 717   if (dwarf_attr(die, DW_AT_location, &attr_location) == nullptr)
 718     // No location: do not add it ?
 719     return nullptr;
 720
 721   std::unique_ptr<simgrid::mc::Variable> variable =
 722     std::unique_ptr<simgrid::mc::Variable>(new simgrid::mc::Variable());
 723   variable->id = dwarf_dieoffset(die);
 724   variable->global = frame == nullptr;     // Can be override base on DW_AT_location
 725   variable->object_info = info;
 726
 727   const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 728   if (name)
 729     variable->name = name;
 730   variable->type_id = MC_dwarf_at_type(die);
 731
 732   int form = dwarf_whatform(&attr_location);
 733   simgrid::dwarf::FormClass form_class;
 734   if (form == DW_FORM_sec_offset)
 735     form_class = simgrid::dwarf::FormClass::Constant;
 736   else
 737     form_class = simgrid::dwarf::classify_form(form);
 738   switch (form_class) {
 739   case simgrid::dwarf::FormClass::ExprLoc:
 740   case simgrid::dwarf::FormClass::Block:
 741     // Location expression:
 742     {
 743       Dwarf_Op *expr;
 744       size_t len;
 745       if (dwarf_getlocation(&attr_location, &expr, &len)) {
 746         xbt_die(
 747           "Could not read location expression in DW_AT_location "
 748           "of variable <%" PRIx64 ">%s",
 749           (uint64_t) variable->id,
 750           variable->name.c_str());
 751       }
 752
 753       if (len == 1 && expr[0].atom == DW_OP_addr) {
 754         variable->global = true;
 755         uintptr_t offset = (uintptr_t) expr[0].number;
 756         uintptr_t base = (uintptr_t) info->base_address();
 757         variable->address = (void *) (base + offset);
 758       } else
 759         variable->location_list = {
 760             simgrid::dwarf::LocationListEntry(simgrid::dwarf::DwarfExpression(expr, expr + len))};
 761
 762       break;
 763     }
 764
 765   case simgrid::dwarf::FormClass::LocListPtr:
 766   case simgrid::dwarf::FormClass::Constant:
 767     // Reference to location list:
 768     variable->location_list = simgrid::dwarf::location_list(
 769       *info, attr_location);
 770     break;
 771
 772   default:
 773     xbt_die("Unexpected form 0x%x (%i), class 0x%x (%i) list for location in <%" PRIx64 ">%s", (unsigned)form, form,
 774             (unsigned)form_class, (int)form_class, (uint64_t)variable->id, variable->name.c_str());
 775   }
 776
 777   // Handle start_scope:
 778   if (dwarf_hasattr(die, DW_AT_start_scope)) {
 779     Dwarf_Attribute attr;
 780     dwarf_attr(die, DW_AT_start_scope, &attr);
 781     int form = dwarf_whatform(&attr);
 782     simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form);
 783     if (form_class == simgrid::dwarf::FormClass::Constant) {
 784       Dwarf_Word value;
 785       variable->start_scope = dwarf_formudata(&attr, &value) == 0 ? (size_t)value : 0;
 786     } else {
 787       // TODO: FormClass::RangeListPtr
 788       xbt_die("Unhandled form 0x%x, class 0x%X for DW_AT_start_scope of variable %s", (unsigned)form,
 789               (unsigned)form_class, name == nullptr ? "?" : name);
 790     }
 791   }
 792
 793   if (ns && variable->global)
 794     variable->name =
 795       std::string(ns) + "::" + variable->name;
 796
 797   // The current code needs a variable name,
 798   // generate a fake one:
 799   if (variable->name.empty()) {
 800     variable->name = "@anonymous#" + std::to_string(mc_anonymous_variable_index);
 801     mc_anonymous_variable_index++;
 802   }
 803   return variable;
 804 }
 805
 806 static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 807                                          Dwarf_Die * unit, simgrid::mc::Frame* frame,
 808                                          const char *ns)
 809 {
 810   std::unique_ptr<simgrid::mc::Variable> variable =
 811     MC_die_to_variable(info, die, unit, frame, ns);
 812   if (not variable)
 813     return;
 814   // Those arrays are sorted later:
 815   if (variable->global)
 816     info->global_variables.push_back(std::move(*variable));
 817   else if (frame != nullptr)
 818     frame->variables.push_back(std::move(*variable));
 819   else
 820     xbt_die("No frame for this local variable");
 821 }
 822
 823 static void MC_dwarf_handle_scope_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 824                                       Dwarf_Die * unit, simgrid::mc::Frame* parent_frame,
 825                                       const char *ns)
 826 {
 827   // TODO, handle DW_TAG_type/DW_TAG_location for DW_TAG_with_stmt
 828   int tag = dwarf_tag(die);
 829   simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag);
 830
 831   // (Template) Subprogram declaration:
 832   if (klass == simgrid::dwarf::TagClass::Subprogram
 833       && MC_dwarf_attr_flag(die, DW_AT_declaration, false))
 834     return;
 835
 836   if (klass == simgrid::dwarf::TagClass::Scope)
 837     xbt_assert(parent_frame, "No parent scope for this scope");
 838
 839   simgrid::mc::Frame frame;
 840   frame.tag = tag;
 841   frame.id = dwarf_dieoffset(die);
 842   frame.object_info = info;
 843
 844   if (klass == simgrid::dwarf::TagClass::Subprogram) {
 845     const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 846     if (name && ns)
 847       frame.name  = std::string(ns) + "::" + name;
 848     else if (name)
 849       frame.name = name;
 850   }
 851
 852   frame.abstract_origin_id =
 853     MC_dwarf_attr_dieoffset(die, DW_AT_abstract_origin);
 854
 855   // This is the base address for DWARF addresses.
 856   // Relocated addresses are offset from this base address.
 857   // See DWARF4 spec 7.5
 858   std::uint64_t base = (std::uint64_t) info->base_address();
 859
 860   // TODO, support DW_AT_ranges
 861   uint64_t low_pc = MC_dwarf_attr_integrate_addr(die, DW_AT_low_pc);
 862   frame.range.begin() = low_pc ? (std::uint64_t) base + low_pc : 0;
 863   if (low_pc) {
 864     // DW_AT_high_pc:
 865     Dwarf_Attribute attr;
 866     if (not dwarf_attr_integrate(die, DW_AT_high_pc, &attr))
 867       xbt_die("Missing DW_AT_high_pc matching with DW_AT_low_pc");
 868
 869     Dwarf_Sword offset;
 870     Dwarf_Addr high_pc;
 871
 872     switch (simgrid::dwarf::classify_form(dwarf_whatform(&attr))) {
 873
 874       // DW_AT_high_pc if an offset from the low_pc:
 875     case simgrid::dwarf::FormClass::Constant:
 876
 877       if (dwarf_formsdata(&attr, &offset) != 0)
 878         xbt_die("Could not read constant");
 879       frame.range.end() = frame.range.begin() + offset;
 880       break;
 881
 882       // DW_AT_high_pc is a relocatable address:
 883     case simgrid::dwarf::FormClass::Address:
 884       if (dwarf_formaddr(&attr, &high_pc) != 0)
 885         xbt_die("Could not read address");
 886       frame.range.end() = base + high_pc;
 887       break;
 888
 889     default:
 890       xbt_die("Unexpected class for DW_AT_high_pc");
 891
 892     }
 893   }
 894
 895   if (klass == simgrid::dwarf::TagClass::Subprogram) {
 896     Dwarf_Attribute attr_frame_base;
 897     if (dwarf_attr_integrate(die, DW_AT_frame_base, &attr_frame_base))
 898       frame.frame_base_location = simgrid::dwarf::location_list(*info,
 899                                   attr_frame_base);
 900   }
 901
 902   // Handle children:
 903   MC_dwarf_handle_children(info, die, unit, &frame, ns);
 904
 905   // We sort them in order to have an (somewhat) efficient by name
 906   // lookup:
 907   boost::range::sort(frame.variables, MC_compare_variable);
 908
 909   // Register it:
 910   if (klass == simgrid::dwarf::TagClass::Subprogram)
 911     info->subprograms[frame.id] = std::move(frame);
 912   else if (klass == simgrid::dwarf::TagClass::Scope)
 913     parent_frame->scopes.push_back(std::move(frame));
 914 }
 915
 916 static void mc_dwarf_handle_namespace_die(simgrid::mc::ObjectInformation* info,
 917                                           Dwarf_Die * die, Dwarf_Die * unit,
 918                                           simgrid::mc::Frame* frame,
 919                                           const char *ns)
 920 {
 921   const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 922   if (frame)
 923     xbt_die("Unexpected namespace in a subprogram");
 924   char *new_ns = ns == nullptr ? xbt_strdup(name)
 925       : bprintf("%s::%s", ns, name);
 926   MC_dwarf_handle_children(info, die, unit, frame, new_ns);
 927   xbt_free(new_ns);
 928 }
 929
 930 static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 931                                      Dwarf_Die * unit, simgrid::mc::Frame* frame,
 932                                      const char *ns)
 933 {
 934   // For each child DIE:
 935   Dwarf_Die child;
 936   int res;
 937   for (res = dwarf_child(die, &child); res == 0;
 938        res = dwarf_siblingof(&child, &child))
 939     MC_dwarf_handle_die(info, &child, unit, frame, ns);
 940 }
 941
 942 static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 943                                 Dwarf_Die * unit, simgrid::mc::Frame* frame,
 944                                 const char *ns)
 945 {
 946   int tag = dwarf_tag(die);
 947   simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag);
 948   switch (klass) {
 949
 950     // Type:
 951   case simgrid::dwarf::TagClass::Type:
 952     MC_dwarf_handle_type_die(info, die, unit, frame, ns);
 953     break;
 954
 955     // Subprogram or scope:
 956   case simgrid::dwarf::TagClass::Subprogram:
 957   case simgrid::dwarf::TagClass::Scope:
 958     MC_dwarf_handle_scope_die(info, die, unit, frame, ns);
 959     return;
 960
 961     // Variable:
 962   case simgrid::dwarf::TagClass::Variable:
 963     MC_dwarf_handle_variable_die(info, die, unit, frame, ns);
 964     break;
 965
 966   case simgrid::dwarf::TagClass::Namespace:
 967     mc_dwarf_handle_namespace_die(info, die, unit, frame, ns);
 968     break;
 969
 970   default:
 971     break;
 972
 973   }
 974 }
 975
 976 static
 977 Elf64_Half get_type(Elf* elf)
 978 {
 979   Elf64_Ehdr* ehdr64 = elf64_getehdr(elf);
 980   if (ehdr64)
 981     return ehdr64->e_type;
 982   Elf32_Ehdr* ehdr32 = elf32_getehdr(elf);
 983   if (ehdr32)
 984     return ehdr32->e_type;
 985   xbt_die("Could not get ELF heeader");
 986 }
 987
 988 static
 989 void read_dwarf_info(simgrid::mc::ObjectInformation* info, Dwarf* dwarf)
 990 {
 991   // For each compilation unit:
 992   Dwarf_Off offset = 0;
 993   Dwarf_Off next_offset = 0;
 994   size_t length;
 995
 996   while (dwarf_nextcu(dwarf, offset, &next_offset, &length, nullptr, nullptr, nullptr) ==
 997          0) {
 998     Dwarf_Die unit_die;
 999     if (dwarf_offdie(dwarf, offset + length, &unit_die) != nullptr)
1000       MC_dwarf_handle_children(info, &unit_die, &unit_die, nullptr, nullptr);
1001     offset = next_offset;
1002   }
1003 }
1004
1005 /** Get the build-id (NT_GNU_BUILD_ID) from the ELF file
1006  *
1007  *  This build-id may is used to locate an external debug (DWARF) file
1008  *  for this ELF file.
1009  *
1010  *  @param  elf libelf handle for an ELF file
1011  *  @return build-id for this ELF file (or an empty vector if none is found)
1012  */
1013 static
1014 std::vector<char> get_build_id(Elf* elf)
1015 {
1016 #ifdef __linux
1017   // Summary: the GNU build ID is stored in a ("GNU, NT_GNU_BUILD_ID) note
1018   // found in a PT_NOTE entry in the program header table.
1019
1020   size_t phnum;
1021   if (elf_getphdrnum (elf, &phnum) != 0)
1022     xbt_die("Could not read program headers");
1023
1024   // Iterate over the program headers and find the PT_NOTE ones:
1025   for (size_t i = 0; i < phnum; ++i) {
1026     GElf_Phdr phdr_temp;
1027     GElf_Phdr *phdr = gelf_getphdr(elf, i, &phdr_temp);
1028     if (phdr->p_type != PT_NOTE)
1029       continue;
1030
1031     Elf_Data* data = elf_getdata_rawchunk(elf, phdr->p_offset, phdr->p_filesz, ELF_T_NHDR);
1032
1033     // Iterate over the notes and find the NT_GNU_BUILD_ID one:
1034     size_t pos = 0;
1035     while (pos < data->d_size) {
1036       GElf_Nhdr nhdr;
1037       // Location of the name within Elf_Data:
1038       size_t name_pos;
1039       size_t desc_pos;
1040       pos = gelf_getnote(data, pos, &nhdr, &name_pos, &desc_pos);
1041       // A build ID note is identified by the pair ("GNU", NT_GNU_BUILD_ID)
1042       // (a namespace and a type within this namespace):
1043       if (nhdr.n_type == NT_GNU_BUILD_ID
1044           && nhdr.n_namesz == sizeof("GNU")
1045           && memcmp((char*) data->d_buf + name_pos, "GNU", sizeof("GNU")) == 0) {
1046         XBT_DEBUG("Found GNU/NT_GNU_BUILD_ID note");
1047         char* start = (char*) data->d_buf + desc_pos;
1048         char* end = (char*) start + nhdr.n_descsz;
1049         return std::vector<char>(start, end);
1050       }
1051     }
1052
1053   }
1054 #endif
1055   return std::vector<char>();
1056 }
1057
1058 static char hexdigits[16] = {
1059   '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
1060   'a', 'b', 'c', 'd', 'e', 'f'
1061 };
1062
1063 /** Binary data to hexadecimal */
1064 static inline
1065 std::array<char, 2> to_hex(std::uint8_t byte)
1066 {
1067   // Horrid double braces!
1068   // Apparently, this is needed in C++11 (not in C++14).
1069   return { { hexdigits[byte >> 4], hexdigits[byte & 0xF] } };
1070 }
1071
1072 /** Binary data to hexadecimal */
1073 static
1074 std::string to_hex(const char* data, std::size_t count)
1075 {
1076   std::string res;
1077   res.resize(2*count);
1078   for (std::size_t i = 0; i < count; i++) {
1079     std::array<char, 2> hex_byte = to_hex(data[i]);
1080     for (int j = 0; j < 2; ++j)
1081       res[2 * i + j] = hex_byte[j];
1082   }
1083   return res;
1084 }
1085
1086 /** Binary data to hexadecimal */
1087 static
1088 std::string to_hex(std::vector<char> const& data)
1089 {
1090   return to_hex(data.data(), data.size());
1091 }
1092
1093 /** Base directories for external debug files */
1094 static
1095 const char* debug_paths[] = {
1096   "/usr/lib/debug/",
1097   "/usr/local/lib/debug/",
1098 };
1099
1100 /** Locate an external debug file from the NT_GNU_BUILD_ID
1101  *
1102  *  This is one of the mechanisms used for
1103  *  [separate debug files](https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html).
1104  */
1105 // Example:
1106 // /usr/lib/debug/.build-id/0b/dc77f1c29aea2b14ff5acd9a19ab3175ffdeae.debug
1107 static
1108 std::string find_by_build_id(std::vector<char> id)
1109 {
1110   std::string filename;
1111   std::string hex = to_hex(id);
1112   for (const char* const& debug_path : debug_paths) {
1113     // Example:
1114     filename = std::string(debug_path) + ".build-id/"
1115       + to_hex(id.data(), 1) + '/'
1116       + to_hex(id.data() + 1, id.size() - 1) + ".debug";
1117     XBT_DEBUG("Checking debug file: %s", filename.c_str());
1118     if (access(filename.c_str(), F_OK) == 0) {
1119       XBT_DEBUG("Found debug file: %s\n", hex.c_str());
1120       return filename;
1121     }
1122   }
1123   XBT_DEBUG("Not debuf info found for build ID %s\n", hex.data());
1124   return std::string();
1125 }
1126
1127 /** \brief Populate the debugging informations of the given ELF object
1128  *
1129  *  Read the DWARf information of the EFFL object and populate the
1130  *  lists of types, variables, functions.
1131  */
1132 static
1133 void MC_load_dwarf(simgrid::mc::ObjectInformation* info)
1134 {
1135   if (elf_version(EV_CURRENT) == EV_NONE)
1136     xbt_die("libelf initialization error");
1137
1138   // Open the ELF file:
1139   int fd = open(info->file_name.c_str(), O_RDONLY);
1140   if (fd < 0)
1141     xbt_die("Could not open file %s", info->file_name.c_str());
1142   Elf* elf = elf_begin(fd, ELF_C_READ, nullptr);
1143   if (elf == nullptr)
1144     xbt_die("Not an ELF file");
1145   Elf_Kind kind = elf_kind(elf);
1146   if (kind != ELF_K_ELF)
1147     xbt_die("Not an ELF file");
1148
1149   // Remember if this is a `ET_EXEC` (fixed location) or `ET_DYN`:
1150   Elf64_Half type = get_type(elf);
1151   if (type == ET_EXEC)
1152     info->flags |= simgrid::mc::ObjectInformation::Executable;
1153
1154   // Read DWARF debug information in the file:
1155   Dwarf* dwarf = dwarf_begin_elf (elf, DWARF_C_READ, nullptr);
1156   if (dwarf != nullptr) {
1157     read_dwarf_info(info, dwarf);
1158     dwarf_end(dwarf);
1159     elf_end(elf);
1160     close(fd);
1161     return;
1162   }
1163   dwarf_end(dwarf);
1164
1165   // If there was no DWARF in the file, try to find it in a separate file.
1166   // Different methods might be used to store the DWARF informations:
1167   //  * GNU NT_GNU_BUILD_ID
1168   //  * .gnu_debuglink
1169   // See https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
1170   // for reference of what we are doing.
1171
1172   // Try with NT_GNU_BUILD_ID: we find the build ID in the ELF file and then
1173   // use this ID to find the file in some known locations in the filesystem.
1174   std::vector<char> build_id = get_build_id(elf);
1175   if (not build_id.empty()) {
1176     elf_end(elf);
1177     close(fd);
1178
1179     // Find the debug file using the build id:
1180     std::string debug_file = find_by_build_id(build_id);
1181     if (debug_file.empty()) {
1182       std::string hex = to_hex(build_id);
1183       xbt_die("Missing debug info for %s with build-id %s\n"
1184         "You might want to install the suitable debugging package.\n",
1185         info->file_name.c_str(), hex.c_str());
1186     }
1187
1188     // Load the DWARF info from this file:
1189     XBT_DEBUG("Load DWARF for %s from %s",
1190       info->file_name.c_str(), debug_file.c_str());
1191     fd = open(debug_file.c_str(), O_RDONLY);
1192     if (fd < 0)
1193       xbt_die("Could not open file %s", debug_file.c_str());
1194     Dwarf* dwarf = dwarf_begin(fd, DWARF_C_READ);
1195     if (dwarf == nullptr)
1196       xbt_die("No DWARF info in %s for %s",
1197         debug_file.c_str(), info->file_name.c_str());
1198     read_dwarf_info(info, dwarf);
1199     dwarf_end(dwarf);
1200     close(fd);
1201     return;
1202   }
1203
1204   // TODO, try to find DWARF info using .gnu_debuglink.
1205
1206   elf_end(elf);
1207   close(fd);
1208   xbt_die("Debugging information not found for %s\n"
1209     "Try recompiling with -g\n",
1210     info->file_name.c_str());
1211 }
1212
1213 // ***** Functions index
1214
1215 static void MC_make_functions_index(simgrid::mc::ObjectInformation* info)
1216 {
1217   info->functions_index.clear();
1218
1219   for (auto& e : info->subprograms) {
1220     if (e.second.range.begin() == 0)
1221       continue;
1222     simgrid::mc::FunctionIndexEntry entry;
1223     entry.low_pc = (void*) e.second.range.begin();
1224     entry.function = &e.second;
1225     info->functions_index.push_back(entry);
1226   }
1227
1228   info->functions_index.shrink_to_fit();
1229
1230   // Sort the array by low_pc:
1231   boost::range::sort(info->functions_index,
1232         [](simgrid::mc::FunctionIndexEntry const& a,
1233           simgrid::mc::FunctionIndexEntry const& b)
1234         {
1235           return a.low_pc < b.low_pc;
1236         });
1237 }
1238
1239 static void MC_post_process_variables(simgrid::mc::ObjectInformation* info)
1240 {
1241   // Someone needs this to be sorted but who?
1242   boost::range::sort(info->global_variables, MC_compare_variable);
1243
1244   for (simgrid::mc::Variable& variable : info->global_variables)
1245     if (variable.type_id)
1246       variable.type = simgrid::util::find_map_ptr(
1247         info->types, variable.type_id);
1248 }
1249
1250 static void mc_post_process_scope(simgrid::mc::ObjectInformation* info, simgrid::mc::Frame* scope)
1251 {
1252
1253   if (scope->tag == DW_TAG_inlined_subroutine) {
1254     // Attach correct namespaced name in inlined subroutine:
1255     auto i = info->subprograms.find(scope->abstract_origin_id);
1256     xbt_assert(i != info->subprograms.end(),
1257       "Could not lookup abstract origin %" PRIx64,
1258       (std::uint64_t) scope->abstract_origin_id);
1259     scope->name = i->second.name;
1260   }
1261
1262   // Direct:
1263   for (simgrid::mc::Variable& variable : scope->variables)
1264     if (variable.type_id)
1265       variable.type = simgrid::util::find_map_ptr(
1266         info->types, variable.type_id);
1267
1268   // Recursive post-processing of nested-scopes:
1269   for (simgrid::mc::Frame& nested_scope : scope->scopes)
1270     mc_post_process_scope(info, &nested_scope);
1271 }
1272
1273 static
1274 simgrid::mc::Type* MC_resolve_type(
1275   simgrid::mc::ObjectInformation* info, unsigned type_id)
1276 {
1277   if (not type_id)
1278     return nullptr;
1279   simgrid::mc::Type* type = simgrid::util::find_map_ptr(info->types, type_id);
1280   if (type == nullptr)
1281     return nullptr;
1282
1283   // We already have the information on the type:
1284   if (type->byte_size != 0)
1285     return type;
1286
1287   // Don't have a name, we can't find a more complete version:
1288   if (type->name.empty())
1289     return type;
1290
1291   // Try to find a more complete description of the type:
1292   // We need to fix in order to support C++.
1293   simgrid::mc::Type** subtype = simgrid::util::find_map_ptr(
1294     info->full_types_by_name, type->name);
1295   if (subtype)
1296     type = *subtype;
1297   return type;
1298 }
1299
1300 static void MC_post_process_types(simgrid::mc::ObjectInformation* info)
1301 {
1302   // Lookup "subtype" field:
1303   for (auto& i : info->types) {
1304     i.second.subtype = MC_resolve_type(info, i.second.type_id);
1305     for (simgrid::mc::Member& member : i.second.members)
1306       member.type = MC_resolve_type(info, member.type_id);
1307   }
1308 }
1309
1310 namespace simgrid {
1311 namespace mc {
1312
1313 /** \brief Finds informations about a given shared object/executable */
1314 std::shared_ptr<simgrid::mc::ObjectInformation> createObjectInformation(
1315   std::vector<simgrid::xbt::VmMap> const& maps, const char *name)
1316 {
1317   std::shared_ptr<simgrid::mc::ObjectInformation> result =
1318     std::make_shared<simgrid::mc::ObjectInformation>();
1319   result->file_name = name;
1320   simgrid::mc::find_object_address(maps, result.get());
1321   MC_load_dwarf(result.get());
1322   MC_post_process_variables(result.get());
1323   MC_post_process_types(result.get());
1324   for (auto& entry : result.get()->subprograms)
1325     mc_post_process_scope(result.get(), &entry.second);
1326   MC_make_functions_index(result.get());
1327   return result;
1328 }
1329
1330 /*************************************************************************/
1331
1332 void postProcessObjectInformation(simgrid::mc::RemoteClient* process, simgrid::mc::ObjectInformation* info)
1333 {
1334   for (auto& i : info->types) {
1335
1336     simgrid::mc::Type* type = &(i.second);
1337     simgrid::mc::Type* subtype = type;
1338     while (subtype->type == DW_TAG_typedef
1339         || subtype->type == DW_TAG_volatile_type
1340         || subtype->type == DW_TAG_const_type)
1341       if (subtype->subtype)
1342         subtype = subtype->subtype;
1343       else
1344         break;
1345
1346     // Resolve full_type:
1347     if (not subtype->name.empty() && subtype->byte_size == 0)
1348       for (auto const& object_info : process->object_infos) {
1349         auto i = object_info->full_types_by_name.find(subtype->name);
1350         if (i != object_info->full_types_by_name.end() && not i->second->name.empty() && i->second->byte_size) {
1351           type->full_type = i->second;
1352           break;
1353         }
1354       }
1355     else type->full_type = subtype;
1356
1357   }
1358 }
1359
1360 }
1361 }
1362
1363 namespace simgrid {
1364 namespace dwarf {
1365
1366 /** Convert a DWARF register into a libunwind register
1367  *
1368  *  DWARF and libunwind does not use the same convention for numbering the
1369  *  registers on some architectures. The function makes the necessary
1370  *  conversion.
1371  */
1372 int dwarf_register_to_libunwind(int dwarf_register)
1373 {
1374 #if defined(__x86_64__)
1375   // It seems for this arch, DWARF and libunwind agree in the numbering:
1376   return dwarf_register;
1377 #elif defined(__i386__)
1378   // Couldn't find the authoritative source of information for this.
1379   // This is inspired from http://source.winehq.org/source/dlls/dbghelp/cpu_i386.c#L517.
1380   switch (dwarf_register) {
1381   case 0:
1382     return UNW_X86_EAX;
1383   case 1:
1384     return UNW_X86_ECX;
1385   case 2:
1386     return UNW_X86_EDX;
1387   case 3:
1388     return UNW_X86_EBX;
1389   case 4:
1390     return UNW_X86_ESP;
1391   case 5:
1392     return UNW_X86_EBP;
1393   case 6:
1394     return UNW_X86_ESI;
1395   case 7:
1396     return UNW_X86_EDI;
1397   case 8:
1398     return UNW_X86_EIP;
1399   case 9:
1400     return UNW_X86_EFLAGS;
1401   case 10:
1402     return UNW_X86_CS;
1403   case 11:
1404     return UNW_X86_SS;
1405   case 12:
1406     return UNW_X86_DS;
1407   case 13:
1408     return UNW_X86_ES;
1409   case 14:
1410     return UNW_X86_FS;
1411   case 15:
1412     return UNW_X86_GS;
1413   case 16:
1414     return UNW_X86_ST0;
1415   case 17:
1416     return UNW_X86_ST1;
1417   case 18:
1418     return UNW_X86_ST2;
1419   case 19:
1420     return UNW_X86_ST3;
1421   case 20:
1422     return UNW_X86_ST4;
1423   case 21:
1424     return UNW_X86_ST5;
1425   case 22:
1426     return UNW_X86_ST6;
1427   case 23:
1428     return UNW_X86_ST7;
1429   default:
1430     xbt_die("Bad/unknown register number.");
1431   }
1432 #else
1433 #error This architecture is not supported yet for DWARF expression evaluation.
1434 #endif
1435 }
1436
1437 }
1438 }