src/mc/mc_dwarf.cpp

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