src/mc/mc_dwarf.cpp

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