-#include "mc_object_info.h"
-#include "mc_private.h"
-
-static void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
-static void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
-static void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
-static void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing");
-
-/** \brief The default DW_TAG_lower_bound for a given DW_AT_language.
- *
- * The default for a given language is defined in the DWARF spec.
- *
- * \param language consant as defined by the DWARf spec
- */
-static uint64_t MC_dwarf_default_lower_bound(int lang);
-
-/** \brief Computes the the element_count of a DW_TAG_enumeration_type DIE
- *
- * This is the number of elements in a given array dimension.
- *
- * A reference of the compilation unit (DW_TAG_compile_unit) is
- * needed because the default lower bound (when there is no DW_AT_lower_bound)
- * depends of the language of the compilation unit (DW_AT_language).
- *
- * \param die DIE for the DW_TAG_enumeration_type or DW_TAG_subrange_type
- * \param unit DIE of the DW_TAG_compile_unit
- */
-static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die * die,
- Dwarf_Die * unit);
-
-/** \brief Computes the number of elements of a given DW_TAG_array_type.
- *
- * \param die DIE for the DW_TAG_array_type
- */
-static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit);
-
-/** \brief Process a DIE
- *
- * \param info the resulting object fot the library/binary file (output)
- * \param die the current DIE
- * \param unit the DIE of the compile unit of the current DIE
- * \param frame containg frame if any
- */
-static void MC_dwarf_handle_die(mc_object_info_t info, Dwarf_Die * die,
- Dwarf_Die * unit, dw_frame_t frame,
- const char *ns);
-
-/** \brief Process a type DIE
- */
-static void MC_dwarf_handle_type_die(mc_object_info_t info, Dwarf_Die * die,
- Dwarf_Die * unit, dw_frame_t frame,
- const char *ns);
-
-/** \brief Calls MC_dwarf_handle_die on all childrend of the given die
- *
- * \param info the resulting object fot the library/binary file (output)
- * \param die the current DIE
- * \param unit the DIE of the compile unit of the current DIE
- * \param frame containg frame if any
- */
-static void MC_dwarf_handle_children(mc_object_info_t info, Dwarf_Die * die,
- Dwarf_Die * unit, dw_frame_t frame,
- const char *ns);
-
-/** \brief Handle a variable (DW_TAG_variable or other)
- *
- * \param info the resulting object fot the library/binary file (output)
- * \param die the current DIE
- * \param unit the DIE of the compile unit of the current DIE
- * \param frame containg frame if any
- */
-static void MC_dwarf_handle_variable_die(mc_object_info_t info, Dwarf_Die * die,
- Dwarf_Die * unit, dw_frame_t frame,
- const char *ns);
-
-/** \brief Get the DW_TAG_type of the DIE
- *
- * \param die DIE
- * \return DW_TAG_type attribute as a new string (NULL if none)
- */
-static char *MC_dwarf_at_type(Dwarf_Die * die);
-
-/** \brief A class of DWARF tags (DW_TAG_*)
- */
-typedef enum mc_tag_class {
- mc_tag_unknown,
- mc_tag_type,
- mc_tag_subprogram,
- mc_tag_variable,
- mc_tag_scope,
- mc_tag_namespace
-} mc_tag_class;
-
-static mc_tag_class MC_dwarf_tag_classify(int tag)
-{
- switch (tag) {
-
- case DW_TAG_array_type:
- case DW_TAG_class_type:
- case DW_TAG_enumeration_type:
- case DW_TAG_typedef:
- case DW_TAG_pointer_type:
- case DW_TAG_reference_type:
- case DW_TAG_rvalue_reference_type:
- case DW_TAG_string_type:
- case DW_TAG_structure_type:
- case DW_TAG_subroutine_type:
- case DW_TAG_union_type:
- case DW_TAG_ptr_to_member_type:
- case DW_TAG_set_type:
- case DW_TAG_subrange_type:
- case DW_TAG_base_type:
- case DW_TAG_const_type:
- case DW_TAG_file_type:
- case DW_TAG_packed_type:
- case DW_TAG_volatile_type:
- case DW_TAG_restrict_type:
- case DW_TAG_interface_type:
- case DW_TAG_unspecified_type:
- case DW_TAG_shared_type:
- return mc_tag_type;
-
- case DW_TAG_subprogram:
- return mc_tag_subprogram;
-
- case DW_TAG_variable:
- case DW_TAG_formal_parameter:
- return mc_tag_variable;
-
- case DW_TAG_lexical_block:
- case DW_TAG_try_block:
- case DW_TAG_catch_block:
- case DW_TAG_inlined_subroutine:
- case DW_TAG_with_stmt:
- return mc_tag_scope;
-
- case DW_TAG_namespace:
- return mc_tag_namespace;
-
- default:
- return mc_tag_unknown;
-
- }
-}
-
-#define MC_DW_CLASS_UNKNOWN 0
-#define MC_DW_CLASS_ADDRESS 1 // Location in the address space of the program
-#define MC_DW_CLASS_BLOCK 2 // Arbitrary block of bytes
-#define MC_DW_CLASS_CONSTANT 3
-#define MC_DW_CLASS_STRING 3 // String
-#define MC_DW_CLASS_FLAG 4 // Boolean
-#define MC_DW_CLASS_REFERENCE 5 // Reference to another DIE
-#define MC_DW_CLASS_EXPRLOC 6 // DWARF expression/location description
-#define MC_DW_CLASS_LINEPTR 7
-#define MC_DW_CLASS_LOCLISTPTR 8
-#define MC_DW_CLASS_MACPTR 9
-#define MC_DW_CLASS_RANGELISTPTR 10
-
-/** \brief Find the DWARF data class for a given DWARF data form
- *
- * This mapping is defined in the DWARF spec.
- *
- * \param form The form (values taken from the DWARF spec)
- * \return An internal representation for the corresponding class
- * */
-static int MC_dwarf_form_get_class(int form)
-{
- switch (form) {
- case DW_FORM_addr:
- return MC_DW_CLASS_ADDRESS;
- case DW_FORM_block2:
- case DW_FORM_block4:
- case DW_FORM_block:
- case DW_FORM_block1:
- return MC_DW_CLASS_BLOCK;
- case DW_FORM_data1:
- case DW_FORM_data2:
- case DW_FORM_data4:
- case DW_FORM_data8:
- case DW_FORM_udata:
- case DW_FORM_sdata:
- return MC_DW_CLASS_CONSTANT;
- case DW_FORM_string:
- case DW_FORM_strp:
- return MC_DW_CLASS_STRING;
- case DW_FORM_ref_addr:
- case DW_FORM_ref1:
- case DW_FORM_ref2:
- case DW_FORM_ref4:
- case DW_FORM_ref8:
- case DW_FORM_ref_udata:
- return MC_DW_CLASS_REFERENCE;
- case DW_FORM_flag:
- case DW_FORM_flag_present:
- return MC_DW_CLASS_FLAG;
- case DW_FORM_exprloc:
- return MC_DW_CLASS_EXPRLOC;
- // TODO sec offset
- // TODO indirect
- default:
- return MC_DW_CLASS_UNKNOWN;
- }
-}
-
-/** \brief Get the name of the tag of a given DIE
- *
- * \param die DIE
- * \return name of the tag of this DIE
- */
-static inline const char *MC_dwarf_die_tagname(Dwarf_Die * die)
-{
- return MC_dwarf_tagname(dwarf_tag(die));
-}
-
-// ***** Attributes
-
-/** \brief Get an attribute of a given DIE as a string
- *
- * \param die the DIE
- * \param attribute attribute
- * \return value of the given attribute of the given DIE
- */
-static const char *MC_dwarf_attr_integrate_string(Dwarf_Die * die,
- int attribute)
-{
- Dwarf_Attribute attr;
- if (!dwarf_attr_integrate(die, attribute, &attr)) {
- return NULL;
- } else {
- return dwarf_formstring(&attr);
- }
-}
-
-/** \brief Get the linkage name of a DIE.
- *
- * Use either DW_AT_linkage_name or DW_AT_MIPS_linkage_name.
- * DW_AT_linkage_name is standardized since DWARF 4.
- * Before this version of DWARF, the MIPS extensions
- * DW_AT_MIPS_linkage_name is used (at least by GCC).
- *
- * \param the DIE
- * \return linkage name of the given DIE (or NULL)
- * */
-static const char *MC_dwarf_at_linkage_name(Dwarf_Die * die)
-{
- const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_linkage_name);
- if (!name)
- name = MC_dwarf_attr_integrate_string(die, DW_AT_MIPS_linkage_name);
- return name;
-}
-
-static Dwarf_Off MC_dwarf_attr_dieoffset(Dwarf_Die * die, int attribute)
-{
- Dwarf_Attribute attr;
- if (dwarf_hasattr_integrate(die, attribute)) {
- dwarf_attr_integrate(die, attribute, &attr);
- Dwarf_Die subtype_die;
- if (dwarf_formref_die(&attr, &subtype_die) == NULL) {
- xbt_die("Could not find DIE");
- }
- return dwarf_dieoffset(&subtype_die);
- } else
- return 0;
-}
-
-static Dwarf_Off MC_dwarf_attr_integrate_dieoffset(Dwarf_Die * die,
- int attribute)
-{
- Dwarf_Attribute attr;
- if (dwarf_hasattr_integrate(die, attribute)) {
- dwarf_attr_integrate(die, DW_AT_type, &attr);
- Dwarf_Die subtype_die;
- if (dwarf_formref_die(&attr, &subtype_die) == NULL) {
- xbt_die("Could not find DIE");
- }
- return dwarf_dieoffset(&subtype_die);
- } else
- return 0;
-}
-
-/** \brief Find the type/subtype (DW_AT_type) for a DIE
- *
- * \param dit the DIE
- * \return DW_AT_type reference as a global offset in hexadecimal (or NULL)
- */
-static char *MC_dwarf_at_type(Dwarf_Die * die)
-{
- Dwarf_Off offset = MC_dwarf_attr_integrate_dieoffset(die, DW_AT_type);
- return offset == 0 ? NULL : bprintf("%" PRIx64, offset);
-}
-
-static uint64_t MC_dwarf_attr_integrate_addr(Dwarf_Die * die, int attribute)
-{
- Dwarf_Attribute attr;
- if (dwarf_attr_integrate(die, attribute, &attr) == NULL)
- return 0;
- Dwarf_Addr value;
- if (dwarf_formaddr(&attr, &value) == 0)
- return (uint64_t) value;
- else
- return 0;
-}
-
-static uint64_t MC_dwarf_attr_integrate_uint(Dwarf_Die * die, int attribute,
- uint64_t default_value)
-{
- Dwarf_Attribute attr;
- if (dwarf_attr_integrate(die, attribute, &attr) == NULL)
- return default_value;
- Dwarf_Word value;
- return dwarf_formudata(dwarf_attr_integrate(die, attribute, &attr),
- &value) == 0 ? (uint64_t) value : default_value;
-}
-
-static bool MC_dwarf_attr_flag(Dwarf_Die * die, int attribute, bool integrate)
-{
- Dwarf_Attribute attr;
- if ((integrate ? dwarf_attr_integrate(die, attribute, &attr)
- : dwarf_attr(die, attribute, &attr)) == 0)
- return false;
-
- bool result;
- if (dwarf_formflag(&attr, &result))
- xbt_die("Unexpected form for attribute %s", MC_dwarf_attrname(attribute));
- return result;
-}
-
-/** \brief Find the default lower bound for a given language
- *
- * The default lower bound of an array (when DW_TAG_lower_bound
- * is missing) depends on the language of the compilation unit.
- *
- * \param lang Language of the compilation unit (values defined in the DWARF spec)
- * \return Default lower bound of an array in this compilation unit
- * */
-static uint64_t MC_dwarf_default_lower_bound(int lang)
-{
- switch (lang) {
- case DW_LANG_C:
- case DW_LANG_C89:
- case DW_LANG_C99:
- case DW_LANG_C_plus_plus:
- case DW_LANG_D:
- case DW_LANG_Java:
- case DW_LANG_ObjC:
- case DW_LANG_ObjC_plus_plus:
- case DW_LANG_Python:
- case DW_LANG_UPC:
- return 0;
- case DW_LANG_Ada83:
- case DW_LANG_Ada95:
- case DW_LANG_Fortran77:
- case DW_LANG_Fortran90:
- case DW_LANG_Fortran95:
- case DW_LANG_Modula2:
- case DW_LANG_Pascal83:
- case DW_LANG_PL1:
- case DW_LANG_Cobol74:
- case DW_LANG_Cobol85:
- return 1;
- default:
- xbt_die("No default DW_TAG_lower_bound for language %i and none given",
- lang);
- return 0;
- }
-}
-
-/** \brief Finds the number of elements in a DW_TAG_subrange_type or DW_TAG_enumeration_type DIE
- *
- * \param die the DIE
- * \param unit DIE of the compilation unit
- * \return number of elements in the range
- * */
-static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die * die,
- Dwarf_Die * unit)
-{
- xbt_assert(dwarf_tag(die) == DW_TAG_enumeration_type
- || dwarf_tag(die) == DW_TAG_subrange_type,
- "MC_dwarf_subrange_element_count called with DIE of type %s",
- MC_dwarf_die_tagname(die));
-
- // Use DW_TAG_count if present:
- if (dwarf_hasattr_integrate(die, DW_AT_count)) {
- return MC_dwarf_attr_integrate_uint(die, DW_AT_count, 0);
- }
- // Otherwise compute DW_TAG_upper_bound-DW_TAG_lower_bound + 1:
-
- if (!dwarf_hasattr_integrate(die, DW_AT_upper_bound)) {
- // This is not really 0, but the code expects this (we do not know):
- return 0;
- }
- uint64_t upper_bound =
- MC_dwarf_attr_integrate_uint(die, DW_AT_upper_bound, -1);
-
- uint64_t lower_bound = 0;
- if (dwarf_hasattr_integrate(die, DW_AT_lower_bound)) {
- lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, -1);
- } else {
- lower_bound = MC_dwarf_default_lower_bound(dwarf_srclang(unit));
- }
- return upper_bound - lower_bound + 1;
-}
-
-/** \brief Finds the number of elements in a array type (DW_TAG_array_type)
- *
- * The compilation unit might be needed because the default lower
- * bound depends on the language of the compilation unit.
- *
- * \param die the DIE of the DW_TAG_array_type
- * \param unit the DIE of the compilation unit
- * \return number of elements in this array type
- * */
-static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit)
-{
- xbt_assert(dwarf_tag(die) == DW_TAG_array_type,
- "MC_dwarf_array_element_count called with DIE of type %s",
- MC_dwarf_die_tagname(die));
-
- int result = 1;
- Dwarf_Die child;
- int res;
- for (res = dwarf_child(die, &child); res == 0;
- res = dwarf_siblingof(&child, &child)) {
- int child_tag = dwarf_tag(&child);
- if (child_tag == DW_TAG_subrange_type
- || child_tag == DW_TAG_enumeration_type) {
- result *= MC_dwarf_subrange_element_count(&child, unit);
- }
- }
- return result;
-}
-
-// ***** dw_type_t
-
-/** \brief Initialize the location of a member of a type
- * (DW_AT_data_member_location of a DW_TAG_member).
- *
- * \param type a type (struct, class)
- * \param member the member of the type
- * \param child DIE of the member (DW_TAG_member)
- */
-static void MC_dwarf_fill_member_location(dw_type_t type, dw_type_t member,
- Dwarf_Die * child)
-{
- if (dwarf_hasattr(child, DW_AT_data_bit_offset)) {
- xbt_die("Can't groke DW_AT_data_bit_offset.");
- }
-
- if (!dwarf_hasattr_integrate(child, DW_AT_data_member_location)) {
- if (type->type != DW_TAG_union_type) {
- xbt_die
- ("Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%"
- PRIx64 ">%s", member->name, (uint64_t) type->id, type->name);
- } else {
- return;
- }
- }
-
- Dwarf_Attribute attr;
- dwarf_attr_integrate(child, DW_AT_data_member_location, &attr);
- int form = dwarf_whatform(&attr);
- int klass = MC_dwarf_form_get_class(form);
- switch (klass) {
- case MC_DW_CLASS_EXPRLOC:
- case MC_DW_CLASS_BLOCK:
- // Location expression:
- {
- Dwarf_Op *expr;
- size_t len;
- if (dwarf_getlocation(&attr, &expr, &len)) {
- xbt_die
- ("Could not read location expression DW_AT_data_member_location in DW_TAG_member %s of type <%"
- PRIx64 ">%s", MC_dwarf_attr_integrate_string(child, DW_AT_name),
- (uint64_t) type->id, type->name);
- }
- if (len == 1 && expr[0].atom == DW_OP_plus_uconst) {
- member->offset = expr[0].number;
- } else {
- mc_dwarf_expression_init(&member->location, len, expr);
- }
- break;
- }
- case MC_DW_CLASS_CONSTANT:
- // Offset from the base address of the object:
- {
- Dwarf_Word offset;
- if (!dwarf_formudata(&attr, &offset))
- member->offset = offset;
- else
- xbt_die("Cannot get %s location <%" PRIx64 ">%s",
- MC_dwarf_attr_integrate_string(child, DW_AT_name),
- (uint64_t) type->id, type->name);
- break;
- }
- case MC_DW_CLASS_LOCLISTPTR:
- // Reference to a location list:
- // TODO
- case MC_DW_CLASS_REFERENCE:
- // It's supposed to be possible in DWARF2 but I couldn't find its semantic
- // in the spec.
- default:
- xbt_die("Can't handle form class (%i) / form 0x%x as DW_AT_member_location",
- klass, form);
- }
-
-}
-
-static void dw_type_free_voidp(void *t)
-{
- delete *(dw_type_t*)t;
-}
-
-/** \brief Populate the list of members of a type
- *
- * \param info ELF object containing the type DIE
- * \param die DIE of the type
- * \param unit DIE of the compilation unit containing the type DIE
- * \param type the type
- */
-static void MC_dwarf_add_members(mc_object_info_t info, Dwarf_Die * die,
- Dwarf_Die * unit, dw_type_t type)
-{
- int res;
- Dwarf_Die child;
- xbt_assert(!type->members);
- type->members =
- xbt_dynar_new(sizeof(dw_type_t), (void (*)(void *)) dw_type_free_voidp);
- for (res = dwarf_child(die, &child); res == 0;
- res = dwarf_siblingof(&child, &child)) {
- int tag = dwarf_tag(&child);
- if (tag == DW_TAG_member || tag == DW_TAG_inheritance) {
-
- // Skip declarations:
- if (MC_dwarf_attr_flag(&child, DW_AT_declaration, false))
- continue;
-
- // Skip compile time constants:
- if (dwarf_hasattr(&child, DW_AT_const_value))
- continue;
-
- // TODO, we should use another type (because is is not a type but a member)
- dw_type_t member = xbt_new0(s_dw_type_t, 1);
- member->type = tag;
-
- // Global Offset:
- member->id = dwarf_dieoffset(&child);
-
- const char *name = MC_dwarf_attr_integrate_string(&child, DW_AT_name);
- if (name)
- member->name = xbt_strdup(name);
- else
- member->name = NULL;
-
- member->byte_size =
- MC_dwarf_attr_integrate_uint(&child, DW_AT_byte_size, 0);
- member->element_count = -1;
- member->dw_type_id = MC_dwarf_at_type(&child);
- member->members = NULL;
- member->is_pointer_type = 0;
- member->offset = 0;
-
- if (dwarf_hasattr(&child, DW_AT_data_bit_offset)) {
- xbt_die("Can't groke DW_AT_data_bit_offset.");
- }
-
- MC_dwarf_fill_member_location(type, member, &child);
-
- if (!member->dw_type_id) {
- xbt_die("Missing type for member %s of <%" PRIx64 ">%s", member->name,
- (uint64_t) type->id, type->name);
- }
-
- xbt_dynar_push(type->members, &member);
- }
- }
-}
-
-/** \brief Create a MC type object from a DIE
- *
- * \param info current object info object
- * \param DIE (for a given type);
- * \param unit compilation unit of the current DIE
- * \return MC representation of the type
- */
-static dw_type_t MC_dwarf_die_to_type(mc_object_info_t info, Dwarf_Die * die,
- Dwarf_Die * unit, dw_frame_t frame,
- const char *ns)
-{
-
- dw_type_t type = new s_dw_type();
- type->type = -1;
- type->id = 0;
- type->name = NULL;
- type->byte_size = 0;
- type->element_count = -1;
- type->dw_type_id = NULL;
- type->members = NULL;
- type->is_pointer_type = 0;
- type->offset = 0;
-
- type->type = dwarf_tag(die);
-
- // Global Offset
- type->id = dwarf_dieoffset(die);
-
- const char *prefix = "";
- switch (type->type) {
- case DW_TAG_structure_type:
- prefix = "struct ";
- break;
- case DW_TAG_union_type:
- prefix = "union ";
- break;
- case DW_TAG_class_type:
- prefix = "class ";
- break;
- default:
- prefix = "";
- }
-
- const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
- if (name != NULL) {
- type->name =
- ns ? bprintf("%s%s::%s", prefix, ns,
- name) : bprintf("%s%s", prefix, name);
- }
-
- type->dw_type_id = MC_dwarf_at_type(die);
-
- // Some compilers do not emit DW_AT_byte_size for pointer_type,
- // so we fill this. We currently assume that the model-checked process is in
- // the same architecture..
- if (type->type == DW_TAG_pointer_type)
- type->byte_size = sizeof(void*);
-
- // Computation of the byte_size;
- if (dwarf_hasattr_integrate(die, DW_AT_byte_size))
- type->byte_size = MC_dwarf_attr_integrate_uint(die, DW_AT_byte_size, 0);
- else if (type->type == DW_TAG_array_type
- || type->type == DW_TAG_structure_type
- || type->type == DW_TAG_class_type) {
- Dwarf_Word size;
- if (dwarf_aggregate_size(die, &size) == 0) {
- type->byte_size = size;
- }
- }
-
- switch (type->type) {
- case DW_TAG_array_type:
- type->element_count = MC_dwarf_array_element_count(die, unit);
- // TODO, handle DW_byte_stride and (not) DW_bit_stride
- break;
-
- case DW_TAG_pointer_type:
- case DW_TAG_reference_type:
- case DW_TAG_rvalue_reference_type:
- type->is_pointer_type = 1;
- break;
-
- case DW_TAG_structure_type:
- case DW_TAG_union_type:
- case DW_TAG_class_type:
- MC_dwarf_add_members(info, die, unit, type);
- char *new_ns = ns == NULL ? xbt_strdup(type->name)
- : bprintf("%s::%s", ns, name);
- MC_dwarf_handle_children(info, die, unit, frame, new_ns);
- free(new_ns);
- break;
- }
-
- return type;
-}
-
-static void MC_dwarf_handle_type_die(mc_object_info_t info, Dwarf_Die * die,
- Dwarf_Die * unit, dw_frame_t frame,
- const char *ns)
-{
- dw_type_t type = MC_dwarf_die_to_type(info, die, unit, frame, ns);
-
- char *key = bprintf("%" PRIx64, (uint64_t) type->id);
- xbt_dict_set(info->types, key, type, NULL);
- xbt_free(key);
-
- if (type->name && type->byte_size != 0) {
- xbt_dict_set(info->full_types_by_name, type->name, type, NULL);
- }
-}
-
-static int mc_anonymous_variable_index = 0;