Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix MC builds on gcc
[simgrid.git] / src / mc / inspect / ObjectInformation.cpp
1 /* Copyright (c) 2014-2019. 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 <cstdint>
7 #include <sys/mman.h> // PROT_READ and friends
8 #include <vector>
9
10 #include "src/mc/inspect/Frame.hpp"
11 #include "src/mc/inspect/ObjectInformation.hpp"
12 #include "src/mc/inspect/Variable.hpp"
13 #include "src/mc/mc_private.hpp"
14 #include "xbt/file.hpp"
15
16 namespace simgrid {
17 namespace mc {
18
19 /* For an executable object, addresses are virtual address
20  * (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 begining
24  * of the shared object (the base address of the mapped shared
25  * object must be used as offset
26  * i.e. \f$\text{virtual address} = \text{shared object base address}
27  *             + \text{dwarf address}\f$.
28  */
29 void* ObjectInformation::base_address() const
30 {
31   // For an executable (more precisely for a ET_EXEC) the base it 0:
32   if (this->executable())
33     return nullptr;
34
35   // For an a shared-object (ET_DYN, including position-independent executables)
36   // the base address is its lowest address:
37   void* result = this->start_exec;
38   if (this->start_rw != nullptr && result > (void*)this->start_rw)
39     result = this->start_rw;
40   if (this->start_ro != nullptr && result > (void*)this->start_ro)
41     result = this->start_ro;
42   return result;
43 }
44
45 simgrid::mc::Frame* ObjectInformation::find_function(const void* ip) const
46 {
47   /* This is implemented by binary search on a sorted array.
48    *
49    * We do quite a lot of those so we want this to be cache efficient.
50    * We pack the only information we need in the index entries in order
51    * to successfully do the binary search. We do not need the high_pc
52    * during the binary search (only at the end) so it is not included
53    * in the index entry. We could use parallel arrays as well.
54    *
55    * We cannot really use the std:: algorithm for this.
56    * We could use std::binary_search by including the high_pc inside
57    * the FunctionIndexEntry.
58    */
59   const simgrid::mc::FunctionIndexEntry* base = this->functions_index.data();
60   int i                                       = 0;
61   int j                                       = this->functions_index.size() - 1;
62   while (j >= i) {
63     int k = i + ((j - i) / 2);
64
65     /* In most of the search, we do not dereference the base[k].function.
66      * This way the memory accesses are located in the base[k] array. */
67     if (ip < base[k].low_pc)
68       j = k - 1;
69     else if (k < j && ip >= base[k + 1].low_pc)
70       i = k + 1;
71
72     /* At this point, the search is over.
73      * Either we have found the correct function or we do not know
74      * any function corresponding to this instruction address.
75      * Only at the point do we dereference the function pointer. */
76     else if ((std::uint64_t)ip < base[k].function->range.end())
77       return base[k].function;
78     else
79       return nullptr;
80   }
81   return nullptr;
82 }
83
84 const simgrid::mc::Variable* ObjectInformation::find_variable(const char* name) const
85 {
86   for (simgrid::mc::Variable const& variable : this->global_variables)
87     if (variable.name == name)
88       return &variable;
89   return nullptr;
90 }
91
92 void ObjectInformation::remove_global_variable(const char* name)
93 {
94   typedef std::vector<Variable>::size_type size_type;
95
96   if (this->global_variables.empty())
97     return;
98
99   // Binary search:
100   size_type first = 0;
101   size_type last  = this->global_variables.size() - 1;
102
103   while (first <= last) {
104     size_type cursor                   = first + (last - first) / 2;
105     simgrid::mc::Variable& current_var = this->global_variables[cursor];
106     int cmp                            = current_var.name.compare(name);
107
108     if (cmp == 0) {
109
110       // Find the whole range:
111       first = cursor;
112       while (first != 0 && this->global_variables[first - 1].name == name)
113         first--;
114       size_type size = this->global_variables.size();
115       last           = cursor;
116       while (last != size - 1 && this->global_variables[last + 1].name == name)
117         last++;
118
119       // Remove the whole range:
120       this->global_variables.erase(this->global_variables.begin() + first, this->global_variables.begin() + last + 1);
121
122       return;
123     } else if (cmp < 0)
124       first = cursor + 1;
125     else if (cursor != 0)
126       last = cursor - 1;
127     else
128       break;
129   }
130 }
131
132 /** Ignore a local variable in a scope
133  *
134  *  Ignore all instances of variables with a given name in
135  *  any (possibly inlined) subprogram with a given namespaced
136  *  name.
137  *
138  *  @param var_name        Name of the local variable to ignore
139  *  @param subprogram_name Name of the subprogram to ignore (nullptr for any)
140  *  @param subprogram      (possibly inlined) Subprogram of the scope current scope
141  *  @param scope           Current scope
142  */
143 static void remove_local_variable(simgrid::mc::Frame& scope, const char* var_name, const char* subprogram_name,
144                                   simgrid::mc::Frame const& subprogram)
145 {
146   typedef std::vector<Variable>::size_type size_type;
147
148   // If the current subprogram matches the given name:
149   if ((subprogram_name == nullptr || (not subprogram.name.empty() && subprogram.name == subprogram_name)) &&
150       not scope.variables.empty()) {
151
152     // Try to find the variable and remove it:
153     size_type start = 0;
154     size_type end   = scope.variables.size() - 1;
155
156     // Binary search:
157     while (start <= end) {
158       size_type cursor                   = start + (end - start) / 2;
159       simgrid::mc::Variable& current_var = scope.variables[cursor];
160       int compare                        = current_var.name.compare(var_name);
161       if (compare == 0) {
162         // Variable found, remove it:
163         scope.variables.erase(scope.variables.begin() + cursor);
164         break;
165       } else if (compare < 0)
166         start = cursor + 1;
167       else if (cursor != 0)
168         end = cursor - 1;
169       else
170         break;
171     }
172   }
173
174   // And recursive processing in nested scopes:
175   for (simgrid::mc::Frame& nested_scope : scope.scopes) {
176     // The new scope may be an inlined subroutine, in this case we want to use its
177     // namespaced name in recursive calls:
178     simgrid::mc::Frame const& nested_subprogram =
179         nested_scope.tag == DW_TAG_inlined_subroutine ? nested_scope : subprogram;
180     remove_local_variable(nested_scope, var_name, subprogram_name, nested_subprogram);
181   }
182 }
183
184 void ObjectInformation::remove_local_variable(const char* var_name, const char* subprogram_name)
185 {
186   for (auto& entry : this->subprograms)
187     simgrid::mc::remove_local_variable(entry.second, var_name, subprogram_name, entry.second);
188 }
189
190 /** @brief Fills the position of the segments (executable, read-only, read/write) */
191 // TODO, use the ELF segment information for more robustness
192 void find_object_address(std::vector<simgrid::xbt::VmMap> const& maps, simgrid::mc::ObjectInformation* result)
193 {
194   const int PROT_RW = PROT_READ | PROT_WRITE;
195   const int PROT_RX = PROT_READ | PROT_EXEC;
196
197   std::string name = simgrid::xbt::Path(result->file_name).get_base_name();
198
199   for (size_t i = 0; i < maps.size(); ++i) {
200     simgrid::xbt::VmMap const& reg = maps[i];
201     if (maps[i].pathname.empty())
202       continue;
203     std::string map_basename = simgrid::xbt::Path(maps[i].pathname).get_base_name();
204     if (map_basename != name)
205       continue;
206
207     // This is the non-GNU_RELRO-part of the data segment:
208     if (reg.prot == PROT_RW) {
209       xbt_assert(not result->start_rw, "Multiple read-write segments for %s, not supported", maps[i].pathname.c_str());
210       result->start_rw = (char*)reg.start_addr;
211       result->end_rw   = (char*)reg.end_addr;
212
213       // The next VMA might be end of the data segment:
214       if (i + 1 < maps.size() && maps[i + 1].pathname.empty() && maps[i + 1].prot == PROT_RW &&
215           maps[i + 1].start_addr == reg.end_addr)
216         result->end_rw = (char*)maps[i + 1].end_addr;
217     }
218
219     // This is the text segment:
220     else if (reg.prot == PROT_RX) {
221       xbt_assert(not result->start_exec, "Multiple executable segments for %s, not supported",
222                  maps[i].pathname.c_str());
223       result->start_exec = (char*)reg.start_addr;
224       result->end_exec   = (char*)reg.end_addr;
225
226       // The next VMA might be end of the data segment:
227       if (i + 1 < maps.size() && maps[i + 1].pathname.empty() && maps[i + 1].prot == PROT_RW &&
228           maps[i + 1].start_addr == reg.end_addr) {
229         result->start_rw = (char*)maps[i + 1].start_addr;
230         result->end_rw   = (char*)maps[i + 1].end_addr;
231       }
232     }
233
234     // This is the GNU_RELRO-part of the data segment:
235     else if (reg.prot == PROT_READ) {
236       xbt_assert(not result->start_ro, "Multiple read only segments for %s, not supported", maps[i].pathname.c_str());
237       result->start_ro = (char*)reg.start_addr;
238       result->end_ro   = (char*)reg.end_addr;
239     }
240   }
241
242   result->start = result->start_rw;
243   if ((const void*)result->start_ro < result->start)
244     result->start = result->start_ro;
245   if ((const void*)result->start_exec < result->start)
246     result->start = result->start_exec;
247
248   result->end = result->end_rw;
249   if (result->end_ro && (const void*)result->end_ro > result->end)
250     result->end = result->end_ro;
251   if (result->end_exec && (const void*)result->end_exec > result->end)
252     result->end = result->end_exec;
253
254   xbt_assert(result->start_exec || result->start_rw || result->start_ro);
255 }
256
257 } // namespace mc
258 } // namespace simgrid