src/mc/inspect/ObjectInformation.cpp

   1 /* Copyright (c) 2014-2021. 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 <algorithm>
   7 #include <cstdint>
   8 #include <sys/mman.h> // PROT_READ and friends
   9 #include <vector>
  10
  11 #include "src/mc/inspect/Frame.hpp"
  12 #include "src/mc/inspect/ObjectInformation.hpp"
  13 #include "src/mc/inspect/Variable.hpp"
  14 #include "src/mc/mc_private.hpp"
  15 #include "xbt/file.hpp"
  16
  17 namespace simgrid {
  18 namespace mc {
  19
  20 /* For an executable object, addresses are virtual address (there is no offset) i.e.
  21  *  \f$\text{virtual address} = \{dwarf address}\f$
  22  *
  23  * For a shared object, the addresses are offset from the beginning of the shared object (the base address of the
  24  * mapped shared object must be used as offset
  25  * i.e. \f$\text{virtual address} = \text{shared object base address}
  26  *             + \text{dwarf address}\f$.
  27  */
  28 void* ObjectInformation::base_address() const
  29 {
  30   // For an executable (more precisely for an ET_EXEC) the base it 0:
  31   if (this->executable())
  32     return nullptr;
  33
  34   // For an a shared-object (ET_DYN, including position-independent executables) the base address is its lowest address:
  35   void* result = this->start_exec;
  36   if (this->start_rw != nullptr && result > (void*)this->start_rw)
  37     result = this->start_rw;
  38   if (this->start_ro != nullptr && result > (void*)this->start_ro)
  39     result = this->start_ro;
  40   return result;
  41 }
  42
  43 Frame* ObjectInformation::find_function(const void* ip) const
  44 {
  45   /* This is implemented by binary search on a sorted array.
  46    *
  47    * We do quite a lot of those so we want this to be cache efficient.
  48    * We pack the only information we need in the index entries in order
  49    * to successfully do the binary search. We do not need the high_pc
  50    * during the binary search (only at the end) so it is not included
  51    * in the index entry. We could use parallel arrays as well.
  52    *
  53    * Note the usage of reverse iterators to match the correct interval.
  54    */
  55   auto pos = std::lower_bound(this->functions_index.rbegin(), this->functions_index.rend(), ip,
  56                               [](auto const& func, auto const* addr) { return func.low_pc > addr; });
  57
  58   /* At this point, the search is over.
  59    * Either we have found the correct function or we do not know
  60    * any function corresponding to this instruction address.
  61    * Only at the point do we dereference the function pointer. */
  62   return (pos != this->functions_index.rend() && reinterpret_cast<std::uint64_t>(ip) < pos->function->range.end())
  63              ? pos->function
  64              : nullptr;
  65 }
  66
  67 const Variable* ObjectInformation::find_variable(const char* var_name) const
  68 {
  69   auto pos = std::lower_bound(this->global_variables.begin(), this->global_variables.end(), var_name,
  70                               [](auto const& var, const char* name) { return var.name < name; });
  71   return (pos != this->global_variables.end() && pos->name == var_name) ? &(*pos) : nullptr;
  72 }
  73
  74 void ObjectInformation::remove_global_variable(const char* var_name)
  75 {
  76   // Binary search:
  77   auto pos1 = std::lower_bound(this->global_variables.begin(), this->global_variables.end(), var_name,
  78                                [](auto const& var, const char* name) { return var.name < name; });
  79   // Find the whole range:
  80   auto pos2 = std::upper_bound(pos1, this->global_variables.end(), var_name,
  81                                [](const char* name, auto const& var) { return name < var.name; });
  82   // Remove the whole range:
  83   this->global_variables.erase(pos1, pos2);
  84 }
  85
  86 /** Ignore a local variable in a scope
  87  *
  88  *  Ignore all instances of variables with a given name in any (possibly inlined) subprogram with a given namespaced
  89  *  name.
  90  *
  91  *  @param var_name        Name of the local variable to ignore
  92  *  @param subprogram_name Name of the subprogram to ignore (nullptr for any)
  93  *  @param subprogram      (possibly inlined) Subprogram of the scope current scope
  94  *  @param scope           Current scope
  95  */
  96 static void remove_local_variable(Frame& scope, const char* var_name, const char* subprogram_name,
  97                                   Frame const& subprogram)
  98 {
  99   // If the current subprogram matches the given name:
 100   if (subprogram_name == nullptr || (not subprogram.name.empty() && subprogram.name == subprogram_name)) {
 101     // Try to find the variable and remove it:
 102
 103     // Binary search:
 104     auto pos = std::lower_bound(scope.variables.begin(), scope.variables.end(), var_name,
 105                                 [](auto const& var, const char* name) { return var.name < name; });
 106     if (pos != scope.variables.end() && pos->name == var_name) {
 107       // Variable found, remove it:
 108       scope.variables.erase(pos);
 109     }
 110   }
 111
 112   // And recursive processing in nested scopes:
 113   for (Frame& nested_scope : scope.scopes) {
 114     // The new scope may be an inlined subroutine, in this case we want to use its
 115     // namespaced name in recursive calls:
 116     Frame const& nested_subprogram = nested_scope.tag == DW_TAG_inlined_subroutine ? nested_scope : subprogram;
 117     remove_local_variable(nested_scope, var_name, subprogram_name, nested_subprogram);
 118   }
 119 }
 120
 121 void ObjectInformation::remove_local_variable(const char* var_name, const char* subprogram_name)
 122 {
 123   for (auto& entry : this->subprograms)
 124     mc::remove_local_variable(entry.second, var_name, subprogram_name, entry.second);
 125 }
 126
 127 /** @brief Fills the position of the segments (executable, read-only, read/write) */
 128 // TODO, use the ELF segment information for more robustness
 129 void find_object_address(std::vector<xbt::VmMap> const& maps, ObjectInformation* result)
 130 {
 131   const int PROT_RW = PROT_READ | PROT_WRITE;
 132   const int PROT_RX = PROT_READ | PROT_EXEC;
 133
 134   std::string name = xbt::Path(result->file_name).get_base_name();
 135
 136   for (size_t i = 0; i < maps.size(); ++i) {
 137     simgrid::xbt::VmMap const& reg = maps[i];
 138     if (maps[i].pathname.empty())
 139       continue;
 140     std::string map_basename = simgrid::xbt::Path(maps[i].pathname).get_base_name();
 141     if (map_basename != name)
 142       continue;
 143
 144     // This is the non-GNU_RELRO-part of the data segment:
 145     if (reg.prot == PROT_RW) {
 146       xbt_assert(not result->start_rw, "Multiple read-write segments for %s, not supported", maps[i].pathname.c_str());
 147       result->start_rw = (char*)reg.start_addr;
 148       result->end_rw   = (char*)reg.end_addr;
 149
 150       // The next VMA might be end of the data segment:
 151       if (i + 1 < maps.size() && maps[i + 1].pathname.empty() && maps[i + 1].prot == PROT_RW &&
 152           maps[i + 1].start_addr == reg.end_addr)
 153         result->end_rw = (char*)maps[i + 1].end_addr;
 154     }
 155
 156     // This is the text segment:
 157     else if (reg.prot == PROT_RX) {
 158       xbt_assert(not result->start_exec, "Multiple executable segments for %s, not supported",
 159                  maps[i].pathname.c_str());
 160       result->start_exec = (char*)reg.start_addr;
 161       result->end_exec   = (char*)reg.end_addr;
 162
 163       // The next VMA might be end of the data segment:
 164       if (i + 1 < maps.size() && maps[i + 1].pathname.empty() && maps[i + 1].prot == PROT_RW &&
 165           maps[i + 1].start_addr == reg.end_addr) {
 166         result->start_rw = (char*)maps[i + 1].start_addr;
 167         result->end_rw   = (char*)maps[i + 1].end_addr;
 168       }
 169     }
 170
 171     // This is the GNU_RELRO-part of the data segment:
 172     else if (reg.prot == PROT_READ) {
 173       xbt_assert(not result->start_ro,
 174                  "Multiple read-only segments for %s, not supported. Compiling with the following may help: "
 175                  "-Wl,-znorelro -Wl,-znoseparate-code",
 176                  maps[i].pathname.c_str());
 177       result->start_ro = (char*)reg.start_addr;
 178       result->end_ro   = (char*)reg.end_addr;
 179     }
 180   }
 181
 182   result->start = result->start_rw;
 183   if ((const void*)result->start_ro < result->start)
 184     result->start = result->start_ro;
 185   if ((const void*)result->start_exec < result->start)
 186     result->start = result->start_exec;
 187
 188   result->end = result->end_rw;
 189   if (result->end_ro && (const void*)result->end_ro > result->end)
 190     result->end = result->end_ro;
 191   if (result->end_exec && (const void*)result->end_exec > result->end)
 192     result->end = result->end_exec;
 193
 194   xbt_assert(result->start_exec || result->start_rw || result->start_ro);
 195 }
 196
 197 } // namespace mc
 198 } // namespace simgrid