src/mc/ObjectInformation.cpp

   1 /* Copyright (c) 2014-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "src/mc/Frame.hpp"
   8 #include "src/mc/ObjectInformation.hpp"
   9 #include "src/mc/Variable.hpp"
  10
  11 namespace simgrid {
  12 namespace mc {
  13
  14 ObjectInformation::ObjectInformation()
  15 {
  16   this->flags = 0;
  17   this->start = nullptr;
  18   this->end = nullptr;
  19   this->start_exec = nullptr;
  20   this->end_exec = nullptr;
  21   this->start_rw = nullptr;
  22   this->end_rw = nullptr;
  23   this->start_ro = nullptr;
  24   this->end_ro = nullptr;
  25 }
  26
  27 /** Find the DWARF offset for this ELF object
  28  *
  29  *  An offset is applied to address found in DWARF:
  30  *
  31  *  * for an executable obejct, addresses are virtual address
  32  *    (there is no offset) i.e.
  33  *    \f$\text{virtual address} = \{dwarf address}\f$;
  34  *
  35  *  * for a shared object, the addreses are offset from the begining
  36  *    of the shared object (the base address of the mapped shared
  37  *    object must be used as offset
  38  *    i.e. \f$\text{virtual address} = \text{shared object base address}
  39  *             + \text{dwarf address}\f$.
  40  */
  41 void *ObjectInformation::base_address() const
  42 {
  43   if (this->executable())
  44     return nullptr;
  45
  46   void *result = this->start_exec;
  47   if (this->start_rw != NULL && result > (void *) this->start_rw)
  48     result = this->start_rw;
  49   if (this->start_ro != NULL && result > (void *) this->start_ro)
  50     result = this->start_ro;
  51   return result;
  52 }
  53
  54 /* Find a function by instruction pointer */
  55 simgrid::mc::Frame* ObjectInformation::find_function(const void *ip) const
  56 {
  57   /* This is implemented by binary search on a sorted array.
  58    *
  59    * We do quite a lot ot those so we want this to be cache efficient.
  60    * We pack the only information we need in the index entries in order
  61    * to successfully do the binary search. We do not need the high_pc
  62    * during the binary search (only at the end) so it is not included
  63    * in the index entry. We could use parallel arrays as well.
  64    *
  65    * We cannot really use the std:: alogrithm for this.
  66    * We could use std::binary_search by including the high_pc inside
  67    * the FunctionIndexEntry.
  68    */
  69   const simgrid::mc::FunctionIndexEntry* base =
  70     this->functions_index.data();
  71   int i = 0;
  72   int j = this->functions_index.size() - 1;
  73   while (j >= i) {
  74     int k = i + ((j - i) / 2);
  75
  76     /* In most of the search, we do not dereference the base[k].function.
  77      * This way the memory accesses are located in the base[k] array. */
  78     if (ip < base[k].low_pc)
  79       j = k - 1;
  80     else if (k < j && ip >= base[k + 1].low_pc)
  81       i = k + 1;
  82
  83     /* At this point, the search is over.
  84      * Either we have found the correct function or we do not know
  85      * any function corresponding to this instruction address.
  86      * Only at the point do we derefernce the function pointer. */
  87     else if (ip < base[k].function->high_pc)
  88       return base[k].function;
  89     else
  90       return nullptr;
  91   }
  92   return nullptr;
  93 }
  94
  95 simgrid::mc::Variable* ObjectInformation::find_variable(const char* name) const
  96 {
  97   for (simgrid::mc::Variable& variable : this->global_variables)
  98     if(variable.name == name)
  99       return &variable;
 100   return nullptr;
 101 }
 102
 103 void ObjectInformation::remove_global_variable(const char* name)
 104 {
 105   typedef std::vector<Variable>::size_type size_type;
 106
 107   if (this->global_variables.empty())
 108     return;
 109
 110   // Binary search:
 111   size_type start = 0;
 112   size_type end = this->global_variables.size() - 1;
 113
 114   while (start <= end) {
 115     size_type cursor = start + (end - start) / 2;
 116     simgrid::mc::Variable& current_var = this->global_variables[cursor];
 117     int cmp = current_var.name.compare(name);
 118
 119     if (cmp == 0) {
 120       // Find the whole range:
 121       start = cursor;
 122       while (start != 0 && this->global_variables[start - 1].name == name)
 123         start--;
 124       size_type size = this->global_variables.size();
 125       end = cursor;
 126       while (end != size - 1 && this->global_variables[end + 1].name == name)
 127         end++;
 128       // Remove the whole range:
 129       this->global_variables.erase(
 130         this->global_variables.begin() + cursor,
 131         this->global_variables.begin() + end + 1);
 132       return;
 133     } else if (cmp < 0)
 134       start = cursor + 1;
 135     else if (cursor != 0)
 136       end = cursor - 1;
 137     else
 138       break;
 139   }
 140 }
 141
 142 /** \brief Ignore a local variable in a scope
 143  *
 144  *  Ignore all instances of variables with a given name in
 145  *  any (possibly inlined) subprogram with a given namespaced
 146  *  name.
 147  *
 148  *  \param var_name        Name of the local variable (or parameter to ignore)
 149  *  \param subprogram_name Name of the subprogram fo ignore (NULL for any)
 150  *  \param subprogram      (possibly inlined) Subprogram of the scope
 151  *  \param scope           Current scope
 152  */
 153 static void remove_local_variable(simgrid::mc::Frame& scope,
 154                             const char *var_name,
 155                             const char *subprogram_name,
 156                             simgrid::mc::Frame const& subprogram)
 157 {
 158   typedef std::vector<Variable>::size_type size_type;
 159
 160   // If the current subprogram matches the given name:
 161   if ((subprogram_name == nullptr ||
 162       (!subprogram.name.empty()
 163         && subprogram.name == subprogram_name))
 164       && !scope.variables.empty()) {
 165
 166     // Try to find the variable and remove it:
 167     size_type start = 0;
 168     size_type end = scope.variables.size() - 1;
 169
 170     // Binary search:
 171     while (start <= end) {
 172       size_type cursor = start + (end - start) / 2;
 173       simgrid::mc::Variable& current_var = scope.variables[cursor];
 174       int compare = current_var.name.compare(var_name);
 175       if (compare == 0) {
 176         // Variable found, remove it:
 177         scope.variables.erase(scope.variables.begin() + cursor);
 178         break;
 179       } else if (compare < 0)
 180         start = cursor + 1;
 181       else if (cursor != 0)
 182         end = cursor - 1;
 183       else
 184         break;
 185     }
 186   }
 187
 188   // And recursive processing in nested scopes:
 189   for (simgrid::mc::Frame& nested_scope : scope.scopes) {
 190     // The new scope may be an inlined subroutine, in this case we want to use its
 191     // namespaced name in recursive calls:
 192     simgrid::mc::Frame const& nested_subprogram =
 193         nested_scope.tag ==
 194         DW_TAG_inlined_subroutine ? nested_scope : subprogram;
 195     remove_local_variable(nested_scope, var_name, subprogram_name,
 196                           nested_subprogram);
 197   }
 198 }
 199
 200 void ObjectInformation::remove_local_variable(
 201   const char* var_name, const char* subprogram_name)
 202 {
 203   for (auto& entry : this->subprograms)
 204     simgrid::mc::remove_local_variable(entry.second,
 205       var_name, subprogram_name, entry.second);
 206 }
 207
 208 }
 209 }