Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Do not use linkage_name as a name
[simgrid.git] / src / mc / mc_dwarf.c
index 84747d0..94f0513 100644 (file)
@@ -1,6 +1,5 @@
 /* Copyright (c) 2008-2013. The SimGrid Team.
  * All rights reserved.                                                     */
-
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
@@ -118,6 +117,61 @@ const char* MC_dwarf_tagname(int tag) {
   }
 }
 
+/** \brief A class of DWARF tags (DW_TAG_*)
+ */
+typedef enum mc_tag_class {
+  mc_tag_unkonwn,
+  mc_tag_type,
+  mc_tag_subprogram,
+  mc_tag_variable,
+  mc_tag_scope
+} mc_tag_class;
+
+static mc_tag_class MC_dwarg_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_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_mutable_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_inlined_subroutine:
+      return mc_tag_scope;
+
+    default:
+      return mc_tag_unkonwn;
+
+  }
+}
+
 #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
@@ -140,6 +194,7 @@ static int MC_dwarf_form_get_class(int form) {
   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:
@@ -215,7 +270,7 @@ static const char* MC_dwarf_at_linkage_name(Dwarf_Die* die) {
  *  \return MC specific representation of the location list represented by the given attribute
  *  of the given die
  */
-static dw_location_t MC_dwarf_get_location_list(Dwarf_Die* die, Dwarf_Attribute* attr) {
+static dw_location_t MC_dwarf_get_location_list(mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr) {
 
   dw_location_t location = xbt_new0(s_dw_location_t, 1);
   location->type = e_dw_loclist;
@@ -236,8 +291,11 @@ static dw_location_t MC_dwarf_get_location_list(Dwarf_Die* die, Dwarf_Attribute*
       xbt_die("Error while loading location list");
 
     dw_location_entry_t new_entry = xbt_new0(s_dw_location_entry_t, 1);
-    new_entry->lowpc = start;
-    new_entry->highpc = end;
+
+    void* base = info->flags & MC_OBJECT_INFO_EXECUTABLE ? 0 : MC_object_base_address(info);
+
+    new_entry->lowpc = (char*) base + start;
+    new_entry->highpc = (char*) base + end;
     new_entry->location = MC_dwarf_get_expression(expr, len);
 
     xbt_dynar_push(loclist, &new_entry);
@@ -245,6 +303,31 @@ static dw_location_t MC_dwarf_get_location_list(Dwarf_Die* die, Dwarf_Attribute*
   }
 }
 
+/** \brief Find the frame base of a given frame
+ *
+ *  \param ip         Instruction pointer
+ *  \param frame
+ *  \param unw_cursor
+ */
+void* mc_find_frame_base(void* ip, dw_frame_t frame, unw_cursor_t* unw_cursor) {
+  switch(frame->frame_base->type) {
+  case e_dw_loclist:
+  {
+    int loclist_cursor;
+    for(loclist_cursor=0; loclist_cursor < xbt_dynar_length(frame->frame_base->location.loclist); loclist_cursor++){
+      dw_location_entry_t entry = xbt_dynar_get_as(frame->frame_base->location.loclist, loclist_cursor, dw_location_entry_t);
+      if((ip >= entry->lowpc) && (ip < entry->highpc)){
+        return (void*) MC_dwarf_resolve_location(unw_cursor, entry->location, NULL);
+      }
+    }
+    return NULL;
+  }
+  // Not handled:
+  default:
+    return NULL;
+  }
+}
+
 /** \brief Get the location expression or location list from an attribute
  *
  *  Processes direct expressions as well as location lists.
@@ -254,7 +337,7 @@ static dw_location_t MC_dwarf_get_location_list(Dwarf_Die* die, Dwarf_Attribute*
  *  \return MC specific representation of the location represented by the given attribute
  *  of the given die
  */
-static dw_location_t MC_dwarf_get_location(Dwarf_Die* die, Dwarf_Attribute* attr) {
+static dw_location_t MC_dwarf_get_location(mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr) {
   int form = dwarf_whatform(attr);
   switch (form) {
 
@@ -274,11 +357,12 @@ static dw_location_t MC_dwarf_get_location(Dwarf_Die* die, Dwarf_Attribute* attr
 
   // The attribute is a reference to a location list entry:
   case DW_FORM_sec_offset:
+  case DW_FORM_data1:
   case DW_FORM_data2:
   case DW_FORM_data4:
   case DW_FORM_data8:
     {
-      return MC_dwarf_get_location_list(die, attr);
+      return MC_dwarf_get_location_list(info, die, attr);
     }
     break;
 
@@ -301,13 +385,13 @@ static dw_location_t MC_dwarf_get_location(Dwarf_Die* die, Dwarf_Attribute* attr
  *  \return MC specific representation of the location represented by the given attribute
  *  of the given die
  */
-static dw_location_t MC_dwarf_at_location(Dwarf_Die* die, int attribute) {
+static dw_location_t MC_dwarf_at_location(mc_object_info_t info, Dwarf_Die* die, int attribute) {
   if(!dwarf_hasattr_integrate(die, attribute))
     return xbt_new0(s_dw_location_t, 1);
 
   Dwarf_Attribute attr;
   dwarf_attr_integrate(die, attribute, &attr);
-  return MC_dwarf_get_location(die, &attr);
+  return MC_dwarf_get_location(info, die, &attr);
 }
 
 static char* MC_dwarf_at_type(Dwarf_Die* die) {
@@ -479,7 +563,8 @@ static void MC_dwarf_fill_member_location(dw_type_t type, dw_type_t member, Dwar
 
   Dwarf_Attribute attr;
   dwarf_attr_integrate(child, DW_AT_data_member_location, &attr);
-  int klass = MC_dwarf_form_get_class(dwarf_whatform(&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:
@@ -519,7 +604,9 @@ static void MC_dwarf_fill_member_location(dw_type_t type, dw_type_t member, Dwar
     // 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 0x%x (%i) as DW_AT_member_location", klass, klass);
+    xbt_die(
+      "Can't handle form class (%i) / form 0x%x as DW_AT_member_location",
+      klass, form);
   }
 
 }
@@ -634,6 +721,10 @@ static void MC_dwarf_handle_type_die(mc_object_info_t info, Dwarf_Die* die, Dwar
 
   char* key = bprintf("%" PRIx64, (uint64_t) type->id);
   xbt_dict_set(info->types, key, type, NULL);
+
+  if(type->name && type->byte_size!=0) {
+    xbt_dict_set(info->types_by_name, type->name, type, NULL);
+  }
 }
 
 /** \brief Convert libdw location expresion elment into native one (or NULL in some cases) */
@@ -795,6 +886,8 @@ static dw_location_t MC_dwarf_get_expression(Dwarf_Op* expr,  size_t len) {
   return loc;
 }
 
+static int mc_anonymous_variable_index = 0;
+
 static dw_variable_t MC_die_to_variable(mc_object_info_t info, Dwarf_Die* die, Dwarf_Die* unit, dw_frame_t frame) {
   // Drop declaration:
   if (MC_dwarf_attr_flag(die, DW_AT_declaration, false))
@@ -811,7 +904,6 @@ static dw_variable_t MC_die_to_variable(mc_object_info_t info, Dwarf_Die* die, D
   variable->global = frame == NULL; // Can be override base on DW_AT_location
   variable->name = xbt_strdup(MC_dwarf_attr_string(die, DW_AT_name));
   variable->type_origin = MC_dwarf_at_type(die);
-  variable->address.address = NULL;
 
   int klass = MC_dwarf_form_get_class(dwarf_whatform(&attr_location));
   switch (klass) {
@@ -832,9 +924,9 @@ static dw_variable_t MC_die_to_variable(mc_object_info_t info, Dwarf_Die* die, D
         Dwarf_Off offset = expr[0].number;
         // TODO, Why is this different base on the object?
         Dwarf_Off base = strcmp(info->file_name, xbt_binary_name) !=0 ? (Dwarf_Off) info->start_exec : 0;
-        variable->address.address = (void*) (base + offset);
+        variable->address = (void*) (base + offset);
       } else {
-        variable->address.location = MC_dwarf_get_expression(expr, len);
+        variable->location = MC_dwarf_get_expression(expr, len);
       }
 
       break;
@@ -842,13 +934,19 @@ static dw_variable_t MC_die_to_variable(mc_object_info_t info, Dwarf_Die* die, D
   case MC_DW_CLASS_LOCLISTPTR:
   case MC_DW_CLASS_CONSTANT:
     // Reference to location list:
-    variable->address.location = MC_dwarf_get_location_list(die, &attr_location);
+    variable->location = MC_dwarf_get_location_list(info, die, &attr_location);
     break;
   default:
     xbt_die("Unexpected calss 0x%x (%i) list for location in <%p>%s",
       klass, klass, (void*) variable->dwarf_offset, variable->name);
   }
 
+  // The current code needs a variable name,
+  // generate a fake one:
+  if(!variable->name) {
+    variable->name = bprintf("@anonymous#%i", mc_anonymous_variable_index++);
+  }
+
   return variable;
 }
 
@@ -864,23 +962,26 @@ static void MC_dwarf_handle_subprogram_die(mc_object_info_t info, Dwarf_Die* die
 
   frame->start = dwarf_dieoffset(die);
 
-  const char* name = MC_dwarf_at_linkage_name(die);
-  if (name==NULL)
-    name = MC_dwarf_attr_string(die, DW_AT_name);
+  const char* name = MC_dwarf_attr_string(die, DW_AT_name);
   frame->name = xbt_strdup(name);
 
+  // This is the base address for DWARF addresses.
+  // Relocated addresses are offset from this base address.
+  // See DWARF4 spec 7.5
+  void* base = info->flags & MC_OBJECT_INFO_EXECUTABLE ? 0 : MC_object_base_address(info);
+
   // Variables are filled in the (recursive) call of MC_dwarf_handle_children:
   frame->variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
-  frame->high_pc = (void*) MC_dwarf_attr_addr(die, DW_AT_high_pc);
-  frame->low_pc = (void*) MC_dwarf_attr_addr(die, DW_AT_low_pc);
-  frame->frame_base = MC_dwarf_at_location(die, DW_AT_frame_base);
+  frame->high_pc = ((char*) base) + MC_dwarf_attr_addr(die, DW_AT_high_pc);
+  frame->low_pc = ((char*) base) + MC_dwarf_attr_addr(die, DW_AT_low_pc);
+  frame->frame_base = MC_dwarf_at_location(info, die, DW_AT_frame_base);
   frame->end = -1; // This one is now useless:
 
   // Handle children:
   MC_dwarf_handle_children(info, die, unit, frame);
 
   // Register it:
-  xbt_dict_set(info->local_variables, frame->name, frame, NULL);
+  xbt_dynar_push(info->subprograms, &frame);
 }
 
 static void MC_dwarf_handle_children(mc_object_info_t info, Dwarf_Die* die, Dwarf_Die* unit, dw_frame_t frame) {
@@ -893,44 +994,33 @@ static void MC_dwarf_handle_children(mc_object_info_t info, Dwarf_Die* die, Dwar
 
 static void MC_dwarf_handle_die(mc_object_info_t info, Dwarf_Die* die, Dwarf_Die* unit, dw_frame_t frame) {
   int tag = dwarf_tag(die);
-  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_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_mutable_type:
-    case DW_TAG_shared_type:
+  mc_tag_class klass = MC_dwarg_tag_classify(tag);
+  switch (klass) {
+
+    // Type:
+    case mc_tag_type:
       MC_dwarf_handle_type_die(info, die, unit);
       break;
-    case DW_TAG_inlined_subroutine:
-    case DW_TAG_subprogram:
+
+    // Program:
+    case mc_tag_subprogram:
       MC_dwarf_handle_subprogram_die(info, die, unit, frame);
       return;
-    // case DW_TAG_formal_parameter:
-    case DW_TAG_variable:
-    case DW_TAG_formal_parameter:
+
+    // Variable:
+    case mc_tag_variable:
       MC_dwarf_handle_variable_die(info, die, unit, frame);
       break;
-  }
 
-  // Recursive processing of children DIE:
-  MC_dwarf_handle_children(info, die, unit, frame);
+    // Scope:
+    case mc_tag_scope:
+      // TODO
+      break;
+
+    default:
+      break;
+
+  }
 }
 
 void MC_dwarf_get_variables(mc_object_info_t info) {
@@ -947,9 +1037,14 @@ void MC_dwarf_get_variables(mc_object_info_t info) {
   Dwarf_Off next_offset = 0;
   size_t length;
   while (dwarf_nextcu (dwarf, offset, &next_offset, &length, NULL, NULL, NULL) == 0) {
-    Dwarf_Die die;
-    if(dwarf_offdie(dwarf, offset+length, &die)!=NULL) {
-      MC_dwarf_handle_die(info, &die, &die, NULL);
+    Dwarf_Die unit_die;
+
+    if(dwarf_offdie(dwarf, offset+length, &unit_die)!=NULL) {
+      Dwarf_Die child;
+      int res;
+      for (res=dwarf_child(&unit_die, &child); res==0; res=dwarf_siblingof(&child,&child)) {
+        MC_dwarf_handle_die(info, &child, &unit_die, NULL);
+      }
     }
     offset = next_offset;
   }