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 <algorithm>
  11 #include <memory>
  12
  13 #include <cstdlib>
  14 #define DW_LANG_Objc DW_LANG_ObjC       /* fix spelling error in older dwarf.h */
  15 #include <dwarf.h>
  16 #include <elfutils/libdw.h>
  17
  18 #include <simgrid_config.h>
  19 #include <simgrid/util.hpp>
  20 #include <xbt/log.h>
  21 #include <xbt/sysdep.h>
  22
  23 #include <simgrid/util.hpp>
  24
  25 #include "mc_object_info.h"
  26 #include "mc_private.h"
  27
  28 #include "mc/Process.hpp"
  29 #include "mc/ObjectInformation.hpp"
  30 #include "mc/Variable.hpp"
  31
  32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing");
  33
  34 /** \brief The default DW_TAG_lower_bound for a given DW_AT_language.
  35  *
  36  *  The default for a given language is defined in the DWARF spec.
  37  *
  38  *  \param language consant as defined by the DWARf spec
  39  */
  40 static uint64_t MC_dwarf_default_lower_bound(int lang);
  41
  42 /** \brief Computes the the element_count of a DW_TAG_enumeration_type DIE
  43  *
  44  * This is the number of elements in a given array dimension.
  45  *
  46  * A reference of the compilation unit (DW_TAG_compile_unit) is
  47  * needed because the default lower bound (when there is no DW_AT_lower_bound)
  48  * depends of the language of the compilation unit (DW_AT_language).
  49  *
  50  * \param die  DIE for the DW_TAG_enumeration_type or DW_TAG_subrange_type
  51  * \param unit DIE of the DW_TAG_compile_unit
  52  */
  53 static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die * die,
  54                                                 Dwarf_Die * unit);
  55
  56 /** \brief Computes the number of elements of a given DW_TAG_array_type.
  57  *
  58  * \param die DIE for the DW_TAG_array_type
  59  */
  60 static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit);
  61
  62 /** \brief Process a DIE
  63  *
  64  *  \param info the resulting object fot the library/binary file (output)
  65  *  \param die  the current DIE
  66  *  \param unit the DIE of the compile unit of the current DIE
  67  *  \param frame containg frame if any
  68  */
  69 static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
  70                                 Dwarf_Die * unit, simgrid::mc::Frame* frame,
  71                                 const char *ns);
  72
  73 /** \brief Process a type DIE
  74  */
  75 static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
  76                                      Dwarf_Die * unit, simgrid::mc::Frame* frame,
  77                                      const char *ns);
  78
  79 /** \brief Calls MC_dwarf_handle_die on all childrend of the given die
  80  *
  81  *  \param info the resulting object fot the library/binary file (output)
  82  *  \param die  the current DIE
  83  *  \param unit the DIE of the compile unit of the current DIE
  84  *  \param frame containg frame if any
  85  */
  86 static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
  87                                      Dwarf_Die * unit, simgrid::mc::Frame* frame,
  88                                      const char *ns);
  89
  90 /** \brief Handle a variable (DW_TAG_variable or other)
  91  *
  92  *  \param info the resulting object fot the library/binary file (output)
  93  *  \param die  the current DIE
  94  *  \param unit the DIE of the compile unit of the current DIE
  95  *  \param frame containg frame if any
  96  */
  97 static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
  98                                          Dwarf_Die * unit, simgrid::mc::Frame* frame,
  99                                          const char *ns);
 100
 101 /** \brief Get the DW_TAG_type of the DIE
 102  *
 103  *  \param die DIE
 104  *  \return DW_TAG_type attribute as a new string (NULL if none)
 105  */
 106 static std::uint64_t MC_dwarf_at_type(Dwarf_Die * die);
 107
 108 namespace simgrid {
 109 namespace dwarf {
 110
 111 enum class TagClass {
 112   Unknown,
 113   Type,
 114   Subprogram,
 115   Variable,
 116   Scope,
 117   Namespace
 118 };
 119
 120 /*** Class of forms defined in the DWARF standard */
 121 enum class FormClass {
 122   Unknown,
 123   Address,   // Location in the program's address space
 124   Block,     // Arbitrary block of bytes
 125   Constant,
 126   String,
 127   Flag,      // Boolean value
 128   Reference, // Reference to another DIE
 129   ExprLoc,   // DWARF expression/location description
 130   LinePtr,
 131   LocListPtr,
 132   MacPtr,
 133   RangeListPtr
 134 };
 135
 136 namespace {
 137
 138 TagClass classify_tag(int tag)
 139 {
 140   switch (tag) {
 141
 142   case DW_TAG_array_type:
 143   case DW_TAG_class_type:
 144   case DW_TAG_enumeration_type:
 145   case DW_TAG_typedef:
 146   case DW_TAG_pointer_type:
 147   case DW_TAG_reference_type:
 148   case DW_TAG_rvalue_reference_type:
 149   case DW_TAG_string_type:
 150   case DW_TAG_structure_type:
 151   case DW_TAG_subroutine_type:
 152   case DW_TAG_union_type:
 153   case DW_TAG_ptr_to_member_type:
 154   case DW_TAG_set_type:
 155   case DW_TAG_subrange_type:
 156   case DW_TAG_base_type:
 157   case DW_TAG_const_type:
 158   case DW_TAG_file_type:
 159   case DW_TAG_packed_type:
 160   case DW_TAG_volatile_type:
 161   case DW_TAG_restrict_type:
 162   case DW_TAG_interface_type:
 163   case DW_TAG_unspecified_type:
 164   case DW_TAG_shared_type:
 165     return TagClass::Type;
 166
 167   case DW_TAG_subprogram:
 168     return TagClass::Subprogram;
 169
 170   case DW_TAG_variable:
 171   case DW_TAG_formal_parameter:
 172     return TagClass::Variable;
 173
 174   case DW_TAG_lexical_block:
 175   case DW_TAG_try_block:
 176   case DW_TAG_catch_block:
 177   case DW_TAG_inlined_subroutine:
 178   case DW_TAG_with_stmt:
 179     return TagClass::Scope;
 180
 181   case DW_TAG_namespace:
 182     return TagClass::Namespace;
 183
 184   default:
 185     return TagClass::Unknown;
 186   }
 187 }
 188
 189 /** \brief Find the DWARF data class for a given DWARF data form
 190  *
 191  *  This mapping is defined in the DWARF spec.
 192  *
 193  *  \param form The form (values taken from the DWARF spec)
 194  *  \return An internal representation for the corresponding class
 195  * */
 196 FormClass classify_form(int form)
 197 {
 198   switch (form) {
 199   case DW_FORM_addr:
 200     return FormClass::Address;
 201   case DW_FORM_block2:
 202   case DW_FORM_block4:
 203   case DW_FORM_block:
 204   case DW_FORM_block1:
 205     return FormClass::Block;
 206   case DW_FORM_data1:
 207   case DW_FORM_data2:
 208   case DW_FORM_data4:
 209   case DW_FORM_data8:
 210   case DW_FORM_udata:
 211   case DW_FORM_sdata:
 212     return FormClass::Constant;
 213   case DW_FORM_string:
 214   case DW_FORM_strp:
 215     return FormClass::String;
 216   case DW_FORM_ref_addr:
 217   case DW_FORM_ref1:
 218   case DW_FORM_ref2:
 219   case DW_FORM_ref4:
 220   case DW_FORM_ref8:
 221   case DW_FORM_ref_udata:
 222     return FormClass::Reference;
 223   case DW_FORM_flag:
 224   case DW_FORM_flag_present:
 225     return FormClass::Flag;
 226   case DW_FORM_exprloc:
 227     return FormClass::ExprLoc;
 228     // TODO sec offset
 229     // TODO indirect
 230   default:
 231     return FormClass::Unknown;
 232   }
 233 }
 234
 235 }
 236 }
 237 }
 238
 239 /** \brief Get the name of the tag of a given DIE
 240  *
 241  *  \param die DIE
 242  *  \return name of the tag of this DIE
 243  */
 244 static inline const char *MC_dwarf_die_tagname(Dwarf_Die * die)
 245 {
 246   return MC_dwarf_tagname(dwarf_tag(die));
 247 }
 248
 249 // ***** Attributes
 250
 251 /** \brief Get an attribute of a given DIE as a string
 252  *
 253  *  \param die       the DIE
 254  *  \param attribute attribute
 255  *  \return value of the given attribute of the given DIE
 256  */
 257 static const char *MC_dwarf_attr_integrate_string(Dwarf_Die * die,
 258                                                   int attribute)
 259 {
 260   Dwarf_Attribute attr;
 261   if (!dwarf_attr_integrate(die, attribute, &attr)) {
 262     return NULL;
 263   } else {
 264     return dwarf_formstring(&attr);
 265   }
 266 }
 267
 268 /** \brief Get the linkage name of a DIE.
 269  *
 270  *  Use either DW_AT_linkage_name or DW_AT_MIPS_linkage_name.
 271  *  DW_AT_linkage_name is standardized since DWARF 4.
 272  *  Before this version of DWARF, the MIPS extensions
 273  *  DW_AT_MIPS_linkage_name is used (at least by GCC).
 274  *
 275  *  \param  the DIE
 276  *  \return linkage name of the given DIE (or NULL)
 277  * */
 278 static const char *MC_dwarf_at_linkage_name(Dwarf_Die * die)
 279 {
 280   const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_linkage_name);
 281   if (!name)
 282     name = MC_dwarf_attr_integrate_string(die, DW_AT_MIPS_linkage_name);
 283   return name;
 284 }
 285
 286 static Dwarf_Off MC_dwarf_attr_dieoffset(Dwarf_Die * die, int attribute)
 287 {
 288   Dwarf_Attribute attr;
 289   if (dwarf_hasattr_integrate(die, attribute) == 0)
 290     return 0;
 291   dwarf_attr_integrate(die, attribute, &attr);
 292   Dwarf_Die subtype_die;
 293   if (dwarf_formref_die(&attr, &subtype_die) == NULL)
 294     xbt_die("Could not find DIE");
 295   return dwarf_dieoffset(&subtype_die);
 296 }
 297
 298 static Dwarf_Off MC_dwarf_attr_integrate_dieoffset(Dwarf_Die * die,
 299                                                    int attribute)
 300 {
 301   Dwarf_Attribute attr;
 302   if (dwarf_hasattr_integrate(die, attribute) == 0)
 303     return 0;
 304   dwarf_attr_integrate(die, DW_AT_type, &attr);
 305   Dwarf_Die subtype_die;
 306   if (dwarf_formref_die(&attr, &subtype_die) == NULL)
 307     xbt_die("Could not find DIE");
 308   return dwarf_dieoffset(&subtype_die);
 309 }
 310
 311 /** \brief Find the type/subtype (DW_AT_type) for a DIE
 312  *
 313  *  \param dit the DIE
 314  *  \return DW_AT_type reference as a global offset in hexadecimal (or NULL)
 315  */
 316 static
 317 std::uint64_t MC_dwarf_at_type(Dwarf_Die * die)
 318 {
 319   return MC_dwarf_attr_integrate_dieoffset(die, DW_AT_type);
 320 }
 321
 322 static uint64_t MC_dwarf_attr_integrate_addr(Dwarf_Die * die, int attribute)
 323 {
 324   Dwarf_Attribute attr;
 325   if (dwarf_attr_integrate(die, attribute, &attr) == NULL)
 326     return 0;
 327   Dwarf_Addr value;
 328   if (dwarf_formaddr(&attr, &value) == 0)
 329     return (uint64_t) value;
 330   else
 331     return 0;
 332 }
 333
 334 static uint64_t MC_dwarf_attr_integrate_uint(Dwarf_Die * die, int attribute,
 335                                              uint64_t default_value)
 336 {
 337   Dwarf_Attribute attr;
 338   if (dwarf_attr_integrate(die, attribute, &attr) == NULL)
 339     return default_value;
 340   Dwarf_Word value;
 341   return dwarf_formudata(dwarf_attr_integrate(die, attribute, &attr),
 342                          &value) == 0 ? (uint64_t) value : default_value;
 343 }
 344
 345 static bool MC_dwarf_attr_flag(Dwarf_Die * die, int attribute, bool integrate)
 346 {
 347   Dwarf_Attribute attr;
 348   if ((integrate ? dwarf_attr_integrate(die, attribute, &attr)
 349        : dwarf_attr(die, attribute, &attr)) == 0)
 350     return false;
 351
 352   bool result;
 353   if (dwarf_formflag(&attr, &result))
 354     xbt_die("Unexpected form for attribute %s", MC_dwarf_attrname(attribute));
 355   return result;
 356 }
 357
 358 /** \brief Find the default lower bound for a given language
 359  *
 360  *  The default lower bound of an array (when DW_TAG_lower_bound
 361  *  is missing) depends on the language of the compilation unit.
 362  *
 363  *  \param lang Language of the compilation unit (values defined in the DWARF spec)
 364  *  \return     Default lower bound of an array in this compilation unit
 365  * */
 366 static uint64_t MC_dwarf_default_lower_bound(int lang)
 367 {
 368   switch (lang) {
 369   case DW_LANG_C:
 370   case DW_LANG_C89:
 371   case DW_LANG_C99:
 372   case DW_LANG_C_plus_plus:
 373   case DW_LANG_D:
 374   case DW_LANG_Java:
 375   case DW_LANG_ObjC:
 376   case DW_LANG_ObjC_plus_plus:
 377   case DW_LANG_Python:
 378   case DW_LANG_UPC:
 379     return 0;
 380   case DW_LANG_Ada83:
 381   case DW_LANG_Ada95:
 382   case DW_LANG_Fortran77:
 383   case DW_LANG_Fortran90:
 384   case DW_LANG_Fortran95:
 385   case DW_LANG_Modula2:
 386   case DW_LANG_Pascal83:
 387   case DW_LANG_PL1:
 388   case DW_LANG_Cobol74:
 389   case DW_LANG_Cobol85:
 390     return 1;
 391   default:
 392     xbt_die("No default DW_TAG_lower_bound for language %i and none given",
 393             lang);
 394     return 0;
 395   }
 396 }
 397
 398 /** \brief Finds the number of elements in a DW_TAG_subrange_type or DW_TAG_enumeration_type DIE
 399  *
 400  *  \param die  the DIE
 401  *  \param unit DIE of the compilation unit
 402  *  \return     number of elements in the range
 403  * */
 404 static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die * die,
 405                                                 Dwarf_Die * unit)
 406 {
 407   xbt_assert(dwarf_tag(die) == DW_TAG_enumeration_type
 408              || dwarf_tag(die) == DW_TAG_subrange_type,
 409              "MC_dwarf_subrange_element_count called with DIE of type %s",
 410              MC_dwarf_die_tagname(die));
 411
 412   // Use DW_TAG_count if present:
 413   if (dwarf_hasattr_integrate(die, DW_AT_count))
 414     return MC_dwarf_attr_integrate_uint(die, DW_AT_count, 0);
 415   // Otherwise compute DW_TAG_upper_bound-DW_TAG_lower_bound + 1:
 416
 417   if (!dwarf_hasattr_integrate(die, DW_AT_upper_bound))
 418     // This is not really 0, but the code expects this (we do not know):
 419     return 0;
 420
 421   uint64_t upper_bound =
 422       MC_dwarf_attr_integrate_uint(die, DW_AT_upper_bound, -1);
 423
 424   uint64_t lower_bound = 0;
 425   if (dwarf_hasattr_integrate(die, DW_AT_lower_bound))
 426     lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, -1);
 427   else
 428     lower_bound = MC_dwarf_default_lower_bound(dwarf_srclang(unit));
 429   return upper_bound - lower_bound + 1;
 430 }
 431
 432 /** \brief Finds the number of elements in a array type (DW_TAG_array_type)
 433  *
 434  *  The compilation unit might be needed because the default lower
 435  *  bound depends on the language of the compilation unit.
 436  *
 437  *  \param die the DIE of the DW_TAG_array_type
 438  *  \param unit the DIE of the compilation unit
 439  *  \return number of elements in this array type
 440  * */
 441 static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit)
 442 {
 443   xbt_assert(dwarf_tag(die) == DW_TAG_array_type,
 444              "MC_dwarf_array_element_count called with DIE of type %s",
 445              MC_dwarf_die_tagname(die));
 446
 447   int result = 1;
 448   Dwarf_Die child;
 449   int res;
 450   for (res = dwarf_child(die, &child); res == 0;
 451        res = dwarf_siblingof(&child, &child)) {
 452     int child_tag = dwarf_tag(&child);
 453     if (child_tag == DW_TAG_subrange_type
 454         || child_tag == DW_TAG_enumeration_type)
 455       result *= MC_dwarf_subrange_element_count(&child, unit);
 456   }
 457   return result;
 458 }
 459
 460 // ***** Variable
 461
 462 /** Sort the variable by name and address.
 463  *
 464  *  We could use boost::container::flat_set instead.
 465  */
 466 static bool MC_compare_variable(
 467   simgrid::mc::Variable const& a, simgrid::mc::Variable const& b)
 468 {
 469   int cmp = strcmp(a.name.c_str(), b.name.c_str());
 470   if (cmp < 0)
 471     return true;
 472   else if (cmp > 0)
 473     return false;
 474   else
 475     return a.address < b.address;
 476 }
 477
 478 // ***** simgrid::mc::Type*
 479
 480 /** \brief Initialize the location of a member of a type
 481  * (DW_AT_data_member_location of a DW_TAG_member).
 482  *
 483  *  \param  type   a type (struct, class)
 484  *  \param  member the member of the type
 485  *  \param  child  DIE of the member (DW_TAG_member)
 486  */
 487 static void MC_dwarf_fill_member_location(
 488   simgrid::mc::Type* type, simgrid::mc::Member* member, Dwarf_Die * child)
 489 {
 490   if (dwarf_hasattr(child, DW_AT_data_bit_offset))
 491     xbt_die("Can't groke DW_AT_data_bit_offset.");
 492
 493   if (!dwarf_hasattr_integrate(child, DW_AT_data_member_location)) {
 494     if (type->type == DW_TAG_union_type)
 495       return;
 496     xbt_die
 497         ("Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%"
 498          PRIx64 ">%s", member->name.c_str(),
 499          (uint64_t) type->id, type->name.c_str());
 500   }
 501
 502   Dwarf_Attribute attr;
 503   dwarf_attr_integrate(child, DW_AT_data_member_location, &attr);
 504   int form = dwarf_whatform(&attr);
 505   simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form);
 506   switch (form_class) {
 507   case simgrid::dwarf::FormClass::ExprLoc:
 508   case simgrid::dwarf::FormClass::Block:
 509     // Location expression:
 510     {
 511       Dwarf_Op *expr;
 512       size_t len;
 513       if (dwarf_getlocation(&attr, &expr, &len))
 514         xbt_die
 515             ("Could not read location expression DW_AT_data_member_location in DW_TAG_member %s of type <%"
 516              PRIx64 ">%s", MC_dwarf_attr_integrate_string(child, DW_AT_name),
 517              (uint64_t) type->id, type->name.c_str());
 518       member->location_expression = simgrid::mc::DwarfExpression(expr, expr+len);
 519       break;
 520     }
 521   case simgrid::dwarf::FormClass::Constant:
 522     // Offset from the base address of the object:
 523     {
 524       Dwarf_Word offset;
 525       if (!dwarf_formudata(&attr, &offset))
 526         member->offset(offset);
 527       else
 528         xbt_die("Cannot get %s location <%" PRIx64 ">%s",
 529                 MC_dwarf_attr_integrate_string(child, DW_AT_name),
 530                 (uint64_t) type->id, type->name.c_str());
 531       break;
 532     }
 533   case simgrid::dwarf::FormClass::LocListPtr:
 534     // Reference to a location list:
 535     // TODO
 536   case simgrid::dwarf::FormClass::Reference:
 537     // It's supposed to be possible in DWARF2 but I couldn't find its semantic
 538     // in the spec.
 539   default:
 540     xbt_die("Can't handle form class (%i) / form 0x%x as DW_AT_member_location",
 541             (int) form_class, form);
 542   }
 543
 544 }
 545
 546 /** \brief Populate the list of members of a type
 547  *
 548  *  \param info ELF object containing the type DIE
 549  *  \param die  DIE of the type
 550  *  \param unit DIE of the compilation unit containing the type DIE
 551  *  \param type the type
 552  */
 553 static void MC_dwarf_add_members(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 554                                  Dwarf_Die * unit, simgrid::mc::Type* type)
 555 {
 556   int res;
 557   Dwarf_Die child;
 558   xbt_assert(type->members.empty());
 559   for (res = dwarf_child(die, &child); res == 0;
 560        res = dwarf_siblingof(&child, &child)) {
 561     int tag = dwarf_tag(&child);
 562     if (tag == DW_TAG_member || tag == DW_TAG_inheritance) {
 563
 564       // Skip declarations:
 565       if (MC_dwarf_attr_flag(&child, DW_AT_declaration, false))
 566         continue;
 567
 568       // Skip compile time constants:
 569       if (dwarf_hasattr(&child, DW_AT_const_value))
 570         continue;
 571
 572       // TODO, we should use another type (because is is not a type but a member)
 573       simgrid::mc::Member member;
 574       member.inheritance = tag == DW_TAG_inheritance;
 575
 576       const char *name = MC_dwarf_attr_integrate_string(&child, DW_AT_name);
 577       if (name)
 578         member.name = name;
 579       member.byte_size =
 580           MC_dwarf_attr_integrate_uint(&child, DW_AT_byte_size, 0);
 581       member.type_id = MC_dwarf_at_type(&child);
 582
 583       if (dwarf_hasattr(&child, DW_AT_data_bit_offset))
 584         xbt_die("Can't groke DW_AT_data_bit_offset.");
 585
 586       MC_dwarf_fill_member_location(type, &member, &child);
 587
 588       if (!member.type_id)
 589         xbt_die("Missing type for member %s of <%" PRIx64 ">%s",
 590                 member.name.c_str(),
 591                 (uint64_t) type->id, type->name.c_str());
 592
 593       type->members.push_back(std::move(member));
 594     }
 595   }
 596 }
 597
 598 /** \brief Create a MC type object from a DIE
 599  *
 600  *  \param info current object info object
 601  *  \param DIE (for a given type);
 602  *  \param unit compilation unit of the current DIE
 603  *  \return MC representation of the type
 604  */
 605 static simgrid::mc::Type MC_dwarf_die_to_type(
 606   simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 607   Dwarf_Die * unit, simgrid::mc::Frame* frame,
 608   const char *ns)
 609 {
 610   simgrid::mc::Type type;
 611   type.type = dwarf_tag(die);
 612   type.name = std::string();
 613   type.element_count = -1;
 614
 615   // Global Offset
 616   type.id = dwarf_dieoffset(die);
 617
 618   const char *prefix = "";
 619   switch (type.type) {
 620   case DW_TAG_structure_type:
 621     prefix = "struct ";
 622     break;
 623   case DW_TAG_union_type:
 624     prefix = "union ";
 625     break;
 626   case DW_TAG_class_type:
 627     prefix = "class ";
 628     break;
 629   default:
 630     prefix = "";
 631   }
 632
 633   const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 634   if (name != NULL) {
 635     char* full_name = ns ? bprintf("%s%s::%s", prefix, ns, name) :
 636       bprintf("%s%s", prefix, name);
 637     type.name = std::string(full_name);
 638     free(full_name);
 639   }
 640
 641   type.type_id = MC_dwarf_at_type(die);
 642
 643   // Some compilers do not emit DW_AT_byte_size for pointer_type,
 644   // so we fill this. We currently assume that the model-checked process is in
 645   // the same architecture..
 646   if (type.type == DW_TAG_pointer_type)
 647     type.byte_size = sizeof(void*);
 648
 649   // Computation of the byte_size;
 650   if (dwarf_hasattr_integrate(die, DW_AT_byte_size))
 651     type.byte_size = MC_dwarf_attr_integrate_uint(die, DW_AT_byte_size, 0);
 652   else if (type.type == DW_TAG_array_type
 653            || type.type == DW_TAG_structure_type
 654            || type.type == DW_TAG_class_type) {
 655     Dwarf_Word size;
 656     if (dwarf_aggregate_size(die, &size) == 0)
 657       type.byte_size = size;
 658   }
 659
 660   switch (type.type) {
 661   case DW_TAG_array_type:
 662     type.element_count = MC_dwarf_array_element_count(die, unit);
 663     // TODO, handle DW_byte_stride and (not) DW_bit_stride
 664     break;
 665
 666   case DW_TAG_pointer_type:
 667   case DW_TAG_reference_type:
 668   case DW_TAG_rvalue_reference_type:
 669     type.is_pointer_type = 1;
 670     break;
 671
 672   case DW_TAG_structure_type:
 673   case DW_TAG_union_type:
 674   case DW_TAG_class_type:
 675     MC_dwarf_add_members(info, die, unit, &type);
 676     char *new_ns = ns == NULL ? xbt_strdup(type.name.c_str())
 677         : bprintf("%s::%s", ns, name);
 678     MC_dwarf_handle_children(info, die, unit, frame, new_ns);
 679     free(new_ns);
 680     break;
 681   }
 682
 683   return std::move(type);
 684 }
 685
 686 static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 687                                      Dwarf_Die * unit, simgrid::mc::Frame* frame,
 688                                      const char *ns)
 689 {
 690   simgrid::mc::Type type = MC_dwarf_die_to_type(info, die, unit, frame, ns);
 691   auto& t = (info->types[type.id] = std::move(type));
 692   if (!t.name.empty() && type.byte_size != 0)
 693     info->full_types_by_name[t.name] = &t;
 694 }
 695
 696 static int mc_anonymous_variable_index = 0;
 697
 698 static std::unique_ptr<simgrid::mc::Variable> MC_die_to_variable(
 699   simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 700   Dwarf_Die * unit, simgrid::mc::Frame* frame,
 701   const char *ns)
 702 {
 703   // Skip declarations:
 704   if (MC_dwarf_attr_flag(die, DW_AT_declaration, false))
 705     return nullptr;
 706
 707   // Skip compile time constants:
 708   if (dwarf_hasattr(die, DW_AT_const_value))
 709     return nullptr;
 710
 711   Dwarf_Attribute attr_location;
 712   if (dwarf_attr(die, DW_AT_location, &attr_location) == NULL)
 713     // No location: do not add it ?
 714     return nullptr;
 715
 716   std::unique_ptr<simgrid::mc::Variable> variable =
 717     std::unique_ptr<simgrid::mc::Variable>(new simgrid::mc::Variable());
 718   variable->dwarf_offset = dwarf_dieoffset(die);
 719   variable->global = frame == NULL;     // Can be override base on DW_AT_location
 720   variable->object_info = info;
 721
 722   const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 723   if (name)
 724     variable->name = name;
 725   variable->type_id = MC_dwarf_at_type(die);
 726
 727   int form = dwarf_whatform(&attr_location);
 728   simgrid::dwarf::FormClass form_class;
 729   if (form == DW_FORM_sec_offset)
 730     form_class = simgrid::dwarf::FormClass::Constant;
 731   else
 732     form_class = simgrid::dwarf::classify_form(form);
 733   switch (form_class) {
 734   case simgrid::dwarf::FormClass::ExprLoc:
 735   case simgrid::dwarf::FormClass::Block:
 736     // Location expression:
 737     {
 738       Dwarf_Op *expr;
 739       size_t len;
 740       if (dwarf_getlocation(&attr_location, &expr, &len)) {
 741         xbt_die(
 742           "Could not read location expression in DW_AT_location "
 743           "of variable <%" PRIx64 ">%s",
 744           (uint64_t) variable->dwarf_offset,
 745           variable->name.c_str());
 746       }
 747
 748       if (len == 1 && expr[0].atom == DW_OP_addr) {
 749         variable->global = 1;
 750         uintptr_t offset = (uintptr_t) expr[0].number;
 751         uintptr_t base = (uintptr_t) info->base_address();
 752         variable->address = (void *) (base + offset);
 753       } else {
 754         simgrid::mc::LocationListEntry entry;
 755         entry.expression = {expr, expr + len};
 756         variable->location_list = { std::move(entry) };
 757       }
 758
 759       break;
 760     }
 761
 762   case simgrid::dwarf::FormClass::LocListPtr:
 763   case simgrid::dwarf::FormClass::Constant:
 764     // Reference to location list:
 765     mc_dwarf_location_list_init(
 766       &variable->location_list, info, die,
 767       &attr_location);
 768     break;
 769
 770   default:
 771     xbt_die("Unexpected form 0x%x (%i), class 0x%x (%i) list for location "
 772             "in <%" PRIx64 ">%s",
 773             form, form, (int) form_class, (int) form_class,
 774             (uint64_t) variable->dwarf_offset,
 775             variable->name.c_str());
 776   }
 777
 778   // Handle start_scope:
 779   if (dwarf_hasattr(die, DW_AT_start_scope)) {
 780     Dwarf_Attribute attr;
 781     dwarf_attr(die, DW_AT_start_scope, &attr);
 782     int form = dwarf_whatform(&attr);
 783     simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form);
 784     switch (form_class) {
 785     case simgrid::dwarf::FormClass::Constant:
 786       {
 787         Dwarf_Word value;
 788         variable->start_scope =
 789             dwarf_formudata(&attr, &value) == 0 ? (size_t) value : 0;
 790         break;
 791       }
 792
 793     case simgrid::dwarf::FormClass::RangeListPtr:     // TODO
 794     default:
 795       xbt_die
 796           ("Unhandled form 0x%x, class 0x%X for DW_AT_start_scope of variable %s",
 797            form, (int) form_class, name == NULL ? "?" : name);
 798     }
 799   }
 800
 801   if (ns && variable->global)
 802     variable->name =
 803       std::string(ns) + "::" + variable->name;
 804
 805   // The current code needs a variable name,
 806   // generate a fake one:
 807   if (variable->name.empty())
 808     variable->name =
 809       "@anonymous#" + std::to_string(mc_anonymous_variable_index++);
 810
 811   return std::move(variable);
 812 }
 813
 814 static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 815                                          Dwarf_Die * unit, simgrid::mc::Frame* frame,
 816                                          const char *ns)
 817 {
 818   std::unique_ptr<simgrid::mc::Variable> variable =
 819     MC_die_to_variable(info, die, unit, frame, ns);
 820   if (!variable)
 821     return;
 822   // Those arrays are sorted later:
 823   else if (variable->global)
 824     info->global_variables.push_back(std::move(*variable));
 825   else if (frame != nullptr)
 826     frame->variables.push_back(std::move(*variable));
 827   else
 828     xbt_die("No frame for this local variable");
 829 }
 830
 831 static void MC_dwarf_handle_scope_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 832                                       Dwarf_Die * unit, simgrid::mc::Frame* parent_frame,
 833                                       const char *ns)
 834 {
 835   // TODO, handle DW_TAG_type/DW_TAG_location for DW_TAG_with_stmt
 836   int tag = dwarf_tag(die);
 837   simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag);
 838
 839   // (Template) Subprogram declaration:
 840   if (klass == simgrid::dwarf::TagClass::Subprogram
 841       && MC_dwarf_attr_flag(die, DW_AT_declaration, false))
 842     return;
 843
 844   if (klass == simgrid::dwarf::TagClass::Scope)
 845     xbt_assert(parent_frame, "No parent scope for this scope");
 846
 847   simgrid::mc::Frame frame;
 848
 849   frame.tag = tag;
 850   frame.id = dwarf_dieoffset(die);
 851   frame.object_info = info;
 852
 853   if (klass == simgrid::dwarf::TagClass::Subprogram) {
 854     const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 855     if(ns)
 856       frame.name  = std::string(ns) + "::" + name;
 857     else if (name)
 858       frame.name = name;
 859     else
 860       frame.name.clear();
 861   }
 862
 863   frame.abstract_origin_id =
 864     MC_dwarf_attr_dieoffset(die, DW_AT_abstract_origin);
 865
 866   // This is the base address for DWARF addresses.
 867   // Relocated addresses are offset from this base address.
 868   // See DWARF4 spec 7.5
 869   void *base = info->base_address();
 870
 871   // TODO, support DW_AT_ranges
 872   uint64_t low_pc = MC_dwarf_attr_integrate_addr(die, DW_AT_low_pc);
 873   frame.low_pc = low_pc ? ((char *) base) + low_pc : 0;
 874   if (low_pc) {
 875     // DW_AT_high_pc:
 876     Dwarf_Attribute attr;
 877     if (!dwarf_attr_integrate(die, DW_AT_high_pc, &attr)) {
 878       xbt_die("Missing DW_AT_high_pc matching with DW_AT_low_pc");
 879     }
 880
 881     Dwarf_Sword offset;
 882     Dwarf_Addr high_pc;
 883
 884     switch (simgrid::dwarf::classify_form(dwarf_whatform(&attr))) {
 885
 886       // DW_AT_high_pc if an offset from the low_pc:
 887     case simgrid::dwarf::FormClass::Constant:
 888
 889       if (dwarf_formsdata(&attr, &offset) != 0)
 890         xbt_die("Could not read constant");
 891       frame.high_pc = (void *) ((char *) frame.low_pc + offset);
 892       break;
 893
 894       // DW_AT_high_pc is a relocatable address:
 895     case simgrid::dwarf::FormClass::Address:
 896       if (dwarf_formaddr(&attr, &high_pc) != 0)
 897         xbt_die("Could not read address");
 898       frame.high_pc = ((char *) base) + high_pc;
 899       break;
 900
 901     default:
 902       xbt_die("Unexpected class for DW_AT_high_pc");
 903
 904     }
 905   }
 906
 907   if (klass == simgrid::dwarf::TagClass::Subprogram) {
 908     Dwarf_Attribute attr_frame_base;
 909     if (dwarf_attr_integrate(die, DW_AT_frame_base, &attr_frame_base))
 910       mc_dwarf_location_list_init(&frame.frame_base, info, die,
 911                                   &attr_frame_base);
 912   }
 913
 914   // Handle children:
 915   MC_dwarf_handle_children(info, die, unit, &frame, ns);
 916
 917   // Someone needs this to be sorted but who?
 918   std::sort(frame.variables.begin(), frame.variables.end(),
 919     MC_compare_variable);
 920
 921   // Register it:
 922   if (klass == simgrid::dwarf::TagClass::Subprogram)
 923     info->subprograms[frame.id] = frame;
 924   else if (klass == simgrid::dwarf::TagClass::Scope)
 925     parent_frame->scopes.push_back(std::move(frame));
 926 }
 927
 928 static void mc_dwarf_handle_namespace_die(simgrid::mc::ObjectInformation* info,
 929                                           Dwarf_Die * die, Dwarf_Die * unit,
 930                                           simgrid::mc::Frame* frame,
 931                                           const char *ns)
 932 {
 933   const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
 934   if (frame)
 935     xbt_die("Unexpected namespace in a subprogram");
 936   char *new_ns = ns == NULL ? xbt_strdup(name)
 937       : bprintf("%s::%s", ns, name);
 938   MC_dwarf_handle_children(info, die, unit, frame, new_ns);
 939   xbt_free(new_ns);
 940 }
 941
 942 static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 943                                      Dwarf_Die * unit, simgrid::mc::Frame* frame,
 944                                      const char *ns)
 945 {
 946   // For each child DIE:
 947   Dwarf_Die child;
 948   int res;
 949   for (res = dwarf_child(die, &child); res == 0;
 950        res = dwarf_siblingof(&child, &child)) {
 951     MC_dwarf_handle_die(info, &child, unit, frame, ns);
 952   }
 953 }
 954
 955 static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die,
 956                                 Dwarf_Die * unit, simgrid::mc::Frame* frame,
 957                                 const char *ns)
 958 {
 959   int tag = dwarf_tag(die);
 960   simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag);
 961   switch (klass) {
 962
 963     // Type:
 964   case simgrid::dwarf::TagClass::Type:
 965     MC_dwarf_handle_type_die(info, die, unit, frame, ns);
 966     break;
 967
 968     // Subprogram or scope:
 969   case simgrid::dwarf::TagClass::Subprogram:
 970   case simgrid::dwarf::TagClass::Scope:
 971     MC_dwarf_handle_scope_die(info, die, unit, frame, ns);
 972     return;
 973
 974     // Variable:
 975   case simgrid::dwarf::TagClass::Variable:
 976     MC_dwarf_handle_variable_die(info, die, unit, frame, ns);
 977     break;
 978
 979   case simgrid::dwarf::TagClass::Namespace:
 980     mc_dwarf_handle_namespace_die(info, die, unit, frame, ns);
 981     break;
 982
 983   default:
 984     break;
 985
 986   }
 987 }
 988
 989 /** \brief Populate the debugging informations of the given ELF object
 990  *
 991  *  Read the DWARf information of the EFFL object and populate the
 992  *  lists of types, variables, functions.
 993  */
 994 void MC_dwarf_get_variables(simgrid::mc::ObjectInformation* info)
 995 {
 996   int fd = open(info->file_name.c_str(), O_RDONLY);
 997   if (fd < 0)
 998     xbt_die("Could not open file %s", info->file_name.c_str());
 999   Dwarf *dwarf = dwarf_begin(fd, DWARF_C_READ);
1000   if (dwarf == NULL)
1001     xbt_die("Missing debugging information in %s\n"
1002       "Your program and its dependencies must have debugging information.\n"
1003       "You might want to recompile with -g or install the suitable debugging package.\n",
1004       info->file_name.c_str());
1005   // For each compilation unit:
1006   Dwarf_Off offset = 0;
1007   Dwarf_Off next_offset = 0;
1008   size_t length;
1009
1010   while (dwarf_nextcu(dwarf, offset, &next_offset, &length, NULL, NULL, NULL) ==
1011          0) {
1012     Dwarf_Die unit_die;
1013     if (dwarf_offdie(dwarf, offset + length, &unit_die) != NULL)
1014       MC_dwarf_handle_children(info, &unit_die, &unit_die, NULL, NULL);
1015     offset = next_offset;
1016   }
1017
1018   dwarf_end(dwarf);
1019   close(fd);
1020 }
1021
1022 // ***** Functions index
1023
1024 static int MC_compare_frame_index_items(simgrid::mc::FunctionIndexEntry* a,
1025                                         simgrid::mc::FunctionIndexEntry* b)
1026 {
1027   if (a->low_pc < b->low_pc)
1028     return -1;
1029   else if (a->low_pc == b->low_pc)
1030     return 0;
1031   else
1032     return 1;
1033 }
1034
1035 static void MC_make_functions_index(simgrid::mc::ObjectInformation* info)
1036 {
1037   info->functions_index.clear();
1038
1039   for (auto& e : info->subprograms) {
1040     if (e.second.low_pc == nullptr)
1041       continue;
1042     simgrid::mc::FunctionIndexEntry entry;
1043     entry.low_pc = e.second.low_pc;
1044     entry.function = &e.second;
1045     info->functions_index.push_back(entry);
1046   }
1047
1048   info->functions_index.shrink_to_fit();
1049
1050   // Sort the array by low_pc:
1051   std::sort(info->functions_index.begin(), info->functions_index.end(),
1052         [](simgrid::mc::FunctionIndexEntry const& a,
1053           simgrid::mc::FunctionIndexEntry const& b)
1054         {
1055           return a.low_pc < b.low_pc;
1056         });
1057 }
1058
1059 static void MC_post_process_variables(simgrid::mc::ObjectInformation* info)
1060 {
1061   // Someone needs this to be sorted but who?
1062   std::sort(info->global_variables.begin(), info->global_variables.end(),
1063     MC_compare_variable);
1064
1065   for(simgrid::mc::Variable& variable : info->global_variables)
1066     if (variable.type_id)
1067       variable.type = simgrid::util::find_map_ptr(
1068         info->types, variable.type_id);
1069 }
1070
1071 static void mc_post_process_scope(simgrid::mc::ObjectInformation* info, simgrid::mc::Frame* scope)
1072 {
1073
1074   if (scope->tag == DW_TAG_inlined_subroutine) {
1075     // Attach correct namespaced name in inlined subroutine:
1076     auto i = info->subprograms.find(scope->abstract_origin_id);
1077     xbt_assert(i != info->subprograms.end(),
1078       "Could not lookup abstract origin %" PRIx64,
1079       (std::uint64_t) scope->abstract_origin_id);
1080     scope->name = i->second.name;
1081   }
1082
1083   // Direct:
1084   for (simgrid::mc::Variable& variable : scope->variables)
1085     if (variable.type_id)
1086       variable.type = simgrid::util::find_map_ptr(
1087         info->types, variable.type_id);
1088
1089   // Recursive post-processing of nested-scopes:
1090   for (simgrid::mc::Frame& nested_scope : scope->scopes)
1091       mc_post_process_scope(info, &nested_scope);
1092
1093 }
1094
1095 static
1096 simgrid::mc::Type* MC_resolve_type(
1097   simgrid::mc::ObjectInformation* info, unsigned type_id)
1098 {
1099   if (!type_id)
1100     return nullptr;
1101   simgrid::mc::Type* type = simgrid::util::find_map_ptr(info->types, type_id);
1102   if (type == nullptr)
1103     return nullptr;
1104
1105   // We already have the information on the type:
1106   if (type->byte_size != 0)
1107     return type;
1108
1109   // Don't have a name, we can't find a more complete version:
1110   if (type->name.empty())
1111     return type;
1112
1113   // Try to find a more complete description of the type:
1114   // We need to fix in order to support C++.
1115   simgrid::mc::Type** subtype = simgrid::util::find_map_ptr(
1116     info->full_types_by_name, type->name);
1117   if (subtype)
1118     type = *subtype;
1119   return type;
1120 }
1121
1122 static void MC_post_process_types(simgrid::mc::ObjectInformation* info)
1123 {
1124   // Lookup "subtype" field:
1125   for(auto& i : info->types) {
1126     i.second.subtype = MC_resolve_type(info, i.second.type_id);
1127     for (simgrid::mc::Member& member : i.second.members)
1128       member.type = MC_resolve_type(info, member.type_id);
1129   }
1130 }
1131
1132 /** \brief Finds informations about a given shared object/executable */
1133 std::shared_ptr<simgrid::mc::ObjectInformation> MC_find_object_info(
1134   std::vector<simgrid::mc::VmMap> const& maps, const char *name, int executable)
1135 {
1136   std::shared_ptr<simgrid::mc::ObjectInformation> result =
1137     std::make_shared<simgrid::mc::ObjectInformation>();
1138   if (executable)
1139     result->flags |= simgrid::mc::ObjectInformation::Executable;
1140   result->file_name = name;
1141   MC_find_object_address(maps, result.get());
1142   MC_dwarf_get_variables(result.get());
1143   MC_post_process_variables(result.get());
1144   MC_post_process_types(result.get());
1145   for (auto& entry : result.get()->subprograms)
1146     mc_post_process_scope(result.get(), &entry.second);
1147   MC_make_functions_index(result.get());
1148   return std::move(result);
1149 }
1150
1151 /*************************************************************************/
1152
1153 void MC_post_process_object_info(simgrid::mc::Process* process, simgrid::mc::ObjectInformation* info)
1154 {
1155   for (auto& i : info->types) {
1156
1157     simgrid::mc::Type* type = &(i.second);
1158     simgrid::mc::Type* subtype = type;
1159     while (subtype->type == DW_TAG_typedef
1160         || subtype->type == DW_TAG_volatile_type
1161         || subtype->type == DW_TAG_const_type)
1162       if (subtype->subtype)
1163         subtype = subtype->subtype;
1164       else
1165         break;
1166
1167     // Resolve full_type:
1168     if (!subtype->name.empty() && subtype->byte_size == 0) {
1169       for (auto const& object_info : process->object_infos) {
1170         auto i = object_info->full_types_by_name.find(subtype->name);
1171         if (i != object_info->full_types_by_name.end()
1172             && !i->second->name.empty() && i->second->byte_size) {
1173           type->full_type = i->second;
1174           break;
1175         }
1176       }
1177     } else type->full_type = subtype;
1178
1179   }
1180 }