Logo AND Algorithmique Numérique Distribuée

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