Logo AND Algorithmique Numérique Distribuée

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