Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
6046e0977212d38b9552561d2932b1bd82804c8b
[simgrid.git] / src / mc / remote / RemoteClient.cpp
1 /* Copyright (c) 2014-2017. 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 #define _FILE_OFFSET_BITS 64 /* needed for pread_whole to work as expected on 32bits */
7
8 #include <assert.h>
9 #include <errno.h>
10 #include <stddef.h>
11 #include <stdint.h>
12
13 #include <sys/ptrace.h>
14
15 #include <cstdio>
16
17 #include <fcntl.h>
18 #include <regex.h>
19 #include <sys/mman.h> // PROT_*
20 #include <sys/types.h>
21 #include <unistd.h>
22
23 #include <pthread.h>
24
25 #include <libgen.h>
26
27 #include <libunwind-ptrace.h>
28 #include <libunwind.h>
29
30 #include "xbt/base.h"
31 #include "xbt/log.h"
32 #include <xbt/mmalloc.h>
33
34 #include "src/mc/mc_smx.h"
35 #include "src/mc/mc_snapshot.h"
36 #include "src/mc/mc_unw.h"
37
38 #include "src/mc/AddressSpace.hpp"
39 #include "src/mc/ObjectInformation.hpp"
40 #include "src/mc/Variable.hpp"
41 #include "src/mc/remote/RemoteClient.hpp"
42
43 using simgrid::mc::remote;
44
45 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc, "MC process information");
46
47 // ***** Helper stuff
48
49 namespace simgrid {
50 namespace mc {
51
52 #define SO_RE "\\.so[\\.0-9]*$"
53 #define VERSION_RE "-[\\.0-9-]*$"
54
55 // List of library which memory segments are not considered:
56 static const char* const filtered_libraries[] = {
57 #ifdef __linux__
58     "ld",
59 #elif defined __FreeBSD__
60     "ld-elf",
61     "ld-elf32",
62     "libkvm",      /* kernel data access library */
63     "libprocstat", /* process and file information retrieval */
64     "libthr",      /* thread library */
65     "libutil",
66 #endif
67     "libasan", /* gcc sanitizers */
68     "libargp", /* workarounds for glibc-less systems */
69     "libtsan",
70     "libubsan",
71     "libbz2",
72     "libboost_chrono",
73     "libboost_context",
74     "libboost_context-mt",
75     "libboost_system",
76     "libboost_thread",
77     "libc",
78     "libc++",
79     "libcdt",
80     "libcgraph",
81     "libcrypto",
82     "libcxxrt",
83     "libdl",
84     "libdw",
85     "libelf",
86     "libevent",
87     "libgcc_s",
88     "liblua5.1",
89     "liblua5.3",
90     "liblzma",
91     "libm",
92     "libpthread",
93     "librt",
94     "libstdc++",
95     "libunwind",
96     "libunwind-x86_64",
97     "libunwind-x86",
98     "libunwind-ptrace",
99     "libz"};
100
101 static bool is_simgrid_lib(const char* libname)
102 {
103   return not strcmp(libname, "libsimgrid");
104 }
105
106 static bool is_filtered_lib(const char* libname)
107 {
108   for (const char* filtered_lib : filtered_libraries)
109     if (strcmp(libname, filtered_lib) == 0)
110       return true;
111   return false;
112 }
113
114 struct s_mc_memory_map_re {
115   regex_t so_re;
116   regex_t version_re;
117 };
118
119 static char* get_lib_name(const char* pathname, struct s_mc_memory_map_re* res)
120 {
121   char* map_basename = xbt_basename(pathname);
122
123   regmatch_t match;
124   if (regexec(&res->so_re, map_basename, 1, &match, 0)) {
125     free(map_basename);
126     return nullptr;
127   }
128
129   char* libname = strndup(map_basename, match.rm_so);
130   free(map_basename);
131   map_basename = nullptr;
132
133   // Strip the version suffix:
134   if (libname && not regexec(&res->version_re, libname, 1, &match, 0)) {
135     char* temp = libname;
136     libname    = strndup(temp, match.rm_so);
137     free(temp);
138   }
139
140   return libname;
141 }
142
143 static ssize_t pread_whole(int fd, void* buf, size_t count, off_t offset)
144 {
145   char* buffer       = (char*)buf;
146   ssize_t real_count = count;
147   while (count) {
148     ssize_t res = pread(fd, buffer, count, offset);
149     if (res > 0) {
150       count -= res;
151       buffer += res;
152       offset += res;
153     } else if (res == 0)
154       return -1;
155     else if (errno != EINTR) {
156       perror("pread_whole");
157       return -1;
158     }
159   }
160   return real_count;
161 }
162
163 static ssize_t pwrite_whole(int fd, const void* buf, size_t count, off_t offset)
164 {
165   const char* buffer = (const char*)buf;
166   ssize_t real_count = count;
167   while (count) {
168     ssize_t res = pwrite(fd, buffer, count, offset);
169     if (res > 0) {
170       count -= res;
171       buffer += res;
172       offset += res;
173     } else if (res == 0)
174       return -1;
175     else if (errno != EINTR)
176       return -1;
177   }
178   return real_count;
179 }
180
181 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
182 static const void* zero_buffer;
183 static const size_t zero_buffer_size = 10 * 4096;
184
185 static void zero_buffer_init()
186 {
187   int fd = open("/dev/zero", O_RDONLY);
188   if (fd < 0)
189     xbt_die("Could not open /dev/zero");
190   zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
191   if (zero_buffer == MAP_FAILED)
192     xbt_die("Could not map the zero buffer");
193   close(fd);
194 }
195
196 int open_vm(pid_t pid, int flags)
197 {
198   const size_t buffer_size = 30;
199   char buffer[buffer_size];
200   int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long)pid);
201   if (res < 0 || (size_t)res >= buffer_size) {
202     errno = ENAMETOOLONG;
203     return -1;
204   }
205   return open(buffer, flags);
206 }
207
208 // ***** Process
209
210 RemoteClient::RemoteClient(pid_t pid, int sockfd) : AddressSpace(this), pid_(pid), channel_(sockfd), running_(true)
211 {
212 }
213
214 void RemoteClient::init()
215 {
216   this->memory_map_ = simgrid::xbt::get_memory_map(this->pid_);
217   this->init_memory_map_info();
218
219   int fd = open_vm(this->pid_, O_RDWR);
220   if (fd < 0)
221     xbt_die("Could not open file for process virtual address space");
222   this->memory_file = fd;
223
224   // Read std_heap (is a struct mdesc*):
225   simgrid::mc::Variable* std_heap_var = this->find_variable("__mmalloc_default_mdp");
226   if (not std_heap_var)
227     xbt_die("No heap information in the target process");
228   if (not std_heap_var->address)
229     xbt_die("No constant address for this variable");
230   this->read_bytes(&this->heap_address, sizeof(struct mdesc*), remote(std_heap_var->address),
231                    simgrid::mc::ProcessIndexDisabled);
232
233   this->smx_actors_infos.clear();
234   this->smx_dead_actors_infos.clear();
235   this->unw_addr_space            = simgrid::mc::UnwindContext::createUnwindAddressSpace();
236   this->unw_underlying_addr_space = simgrid::unw::create_addr_space();
237   this->unw_underlying_context    = simgrid::unw::create_context(this->unw_underlying_addr_space, this->pid_);
238 }
239
240 RemoteClient::~RemoteClient()
241 {
242   if (this->memory_file >= 0)
243     close(this->memory_file);
244
245   if (this->unw_underlying_addr_space != unw_local_addr_space) {
246     if (this->unw_underlying_addr_space)
247       unw_destroy_addr_space(this->unw_underlying_addr_space);
248     if (this->unw_underlying_context)
249       _UPT_destroy(this->unw_underlying_context);
250   }
251
252   unw_destroy_addr_space(this->unw_addr_space);
253 }
254
255 /** Refresh the information about the process
256  *
257  *  Do not use directly, this is used by the getters when appropriate
258  *  in order to have fresh data.
259  */
260 void RemoteClient::refresh_heap()
261 {
262   // Read/dereference/refresh the std_heap pointer:
263   if (not this->heap)
264     this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
265   this->read_bytes(this->heap.get(), sizeof(struct mdesc), remote(this->heap_address),
266                    simgrid::mc::ProcessIndexDisabled);
267   this->cache_flags_ |= RemoteClient::cache_heap;
268 }
269
270 /** Refresh the information about the process
271  *
272  *  Do not use direclty, this is used by the getters when appropriate
273  *  in order to have fresh data.
274  * */
275 void RemoteClient::refresh_malloc_info()
276 {
277   // Refresh process->heapinfo:
278   if (this->cache_flags_ & RemoteClient::cache_malloc)
279     return;
280   size_t count = this->heap->heaplimit + 1;
281   if (this->heap_info.size() < count)
282     this->heap_info.resize(count);
283   this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info), remote(this->heap->heapinfo),
284                    simgrid::mc::ProcessIndexDisabled);
285   this->cache_flags_ |= RemoteClient::cache_malloc;
286 }
287
288 /** @brief Finds the range of the different memory segments and binary paths */
289 void RemoteClient::init_memory_map_info()
290 {
291   XBT_DEBUG("Get debug information ...");
292   this->maestro_stack_start_ = nullptr;
293   this->maestro_stack_end_   = nullptr;
294   this->object_infos.resize(0);
295   this->binary_info     = nullptr;
296   this->libsimgrid_info = nullptr;
297
298   struct s_mc_memory_map_re res;
299
300   if (regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
301     xbt_die(".so regexp did not compile");
302
303   std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
304
305   const char* current_name = nullptr;
306
307   this->object_infos.clear();
308
309   for (size_t i = 0; i < maps.size(); i++) {
310     simgrid::xbt::VmMap const& reg = maps[i];
311     const char* pathname           = maps[i].pathname.c_str();
312
313     // Nothing to do
314     if (maps[i].pathname.empty()) {
315       current_name = nullptr;
316       continue;
317     }
318
319     // [stack], [vvar], [vsyscall], [vdso] ...
320     if (pathname[0] == '[') {
321       if ((reg.prot & PROT_WRITE) && not memcmp(pathname, "[stack]", 7)) {
322         this->maestro_stack_start_ = remote(reg.start_addr);
323         this->maestro_stack_end_   = remote(reg.end_addr);
324       }
325       current_name = nullptr;
326       continue;
327     }
328
329     if (current_name && strcmp(current_name, pathname) == 0)
330       continue;
331
332     current_name = pathname;
333     if (not(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
334       continue;
335
336     const bool is_executable = not i;
337     char* libname            = nullptr;
338     if (not is_executable) {
339       libname = get_lib_name(pathname, &res);
340       if (not libname)
341         continue;
342       if (is_filtered_lib(libname)) {
343         free(libname);
344         continue;
345       }
346     }
347
348     std::shared_ptr<simgrid::mc::ObjectInformation> info =
349         simgrid::mc::createObjectInformation(this->memory_map_, pathname);
350     this->object_infos.push_back(info);
351     if (is_executable)
352       this->binary_info = info;
353     else if (libname && is_simgrid_lib(libname))
354       this->libsimgrid_info = info;
355     free(libname);
356   }
357
358   regfree(&res.so_re);
359   regfree(&res.version_re);
360
361   // Resolve time (including across different objects):
362   for (auto const& object_info : this->object_infos)
363     postProcessObjectInformation(this, object_info.get());
364
365   xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
366   xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
367
368   XBT_DEBUG("Get debug information done !");
369 }
370
371 std::shared_ptr<simgrid::mc::ObjectInformation> RemoteClient::find_object_info(RemotePtr<void> addr) const
372 {
373   for (auto const& object_info : this->object_infos)
374     if (addr.address() >= (std::uint64_t)object_info->start && addr.address() <= (std::uint64_t)object_info->end)
375       return object_info;
376   return nullptr;
377 }
378
379 std::shared_ptr<ObjectInformation> RemoteClient::find_object_info_exec(RemotePtr<void> addr) const
380 {
381   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
382     if (addr.address() >= (std::uint64_t)info->start_exec && addr.address() <= (std::uint64_t)info->end_exec)
383       return info;
384   return nullptr;
385 }
386
387 std::shared_ptr<ObjectInformation> RemoteClient::find_object_info_rw(RemotePtr<void> addr) const
388 {
389   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
390     if (addr.address() >= (std::uint64_t)info->start_rw && addr.address() <= (std::uint64_t)info->end_rw)
391       return info;
392   return nullptr;
393 }
394
395 simgrid::mc::Frame* RemoteClient::find_function(RemotePtr<void> ip) const
396 {
397   std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
398   return info ? info->find_function((void*)ip.address()) : nullptr;
399 }
400
401 /** Find (one occurrence of) the named variable definition
402  */
403 simgrid::mc::Variable* RemoteClient::find_variable(const char* name) const
404 {
405   // First lookup the variable in the executable shared object.
406   // A global variable used directly by the executable code from a library
407   // is reinstanciated in the executable memory .data/.bss.
408   // We need to look up the variable in the executable first.
409   if (this->binary_info) {
410     std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
411     simgrid::mc::Variable* var                                  = info->find_variable(name);
412     if (var)
413       return var;
414   }
415
416   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
417     simgrid::mc::Variable* var = info->find_variable(name);
418     if (var)
419       return var;
420   }
421
422   return nullptr;
423 }
424
425 void RemoteClient::read_variable(const char* name, void* target, size_t size) const
426 {
427   simgrid::mc::Variable* var = this->find_variable(name);
428   xbt_assert(var->address, "No simple location for this variable");
429   xbt_assert(var->type->full_type, "Partial type for %s, cannot check size", name);
430   xbt_assert((size_t)var->type->full_type->byte_size == size, "Unexpected size for %s (expected %zi, was %zi)", name,
431              size, (size_t)var->type->full_type->byte_size);
432   this->read_bytes(target, size, remote(var->address));
433 }
434
435 std::string RemoteClient::read_string(RemotePtr<char> address) const
436 {
437   if (not address)
438     return {};
439
440   // TODO, use std::vector with .data() in C++17 to avoid useless copies
441   std::vector<char> res(128);
442   off_t off = 0;
443
444   while (1) {
445     ssize_t c = pread(this->memory_file, res.data() + off, res.size() - off, (off_t)address.address() + off);
446     if (c == -1) {
447       if (errno == EINTR)
448         continue;
449       else
450         xbt_die("Could not read from from remote process");
451     }
452     if (c == 0)
453       xbt_die("Could not read string from remote process");
454
455     void* p = memchr(res.data() + off, '\0', c);
456     if (p)
457       return std::string(res.data());
458
459     off += c;
460     if (off == (off_t)res.size())
461       res.resize(res.size() * 2);
462   }
463 }
464
465 const void* RemoteClient::read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, int process_index,
466                                      ReadOptions options) const
467 {
468   if (process_index != simgrid::mc::ProcessIndexDisabled) {
469     std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->find_object_info_rw((void*)address.address());
470 // Segment overlap is not handled.
471 #if HAVE_SMPI
472     if (info.get() && this->privatized(*info)) {
473       if (process_index < 0)
474         xbt_die("Missing process index");
475       if (process_index >= (int)MC_smpi_process_count())
476         xbt_die("Invalid process index");
477
478       // Read smpi_privatization_regions from MCed:
479       smpi_privatization_region_t remote_smpi_privatization_regions =
480           mc_model_checker->process().read_variable<smpi_privatization_region_t>("smpi_privatization_regions");
481
482       s_smpi_privatization_region_t privatization_region =
483           mc_model_checker->process().read<s_smpi_privatization_region_t>(
484               remote(remote_smpi_privatization_regions + process_index));
485
486       // Address translation in the privatization segment:
487       size_t offset = address.address() - (std::uint64_t)info->start_rw;
488       address       = remote((char*)privatization_region.address + offset);
489     }
490 #endif
491   }
492   if (pread_whole(this->memory_file, buffer, size, (size_t)address.address()) < 0)
493     xbt_die("Read at %p from process %lli failed", (void*)address.address(), (long long)this->pid_);
494   return buffer;
495 }
496
497 /** Write data to a process memory
498  *
499  *  @param buffer   local memory address (source)
500  *  @param len      data size
501  *  @param address  target process memory address (target)
502  */
503 void RemoteClient::write_bytes(const void* buffer, size_t len, RemotePtr<void> address)
504 {
505   if (pwrite_whole(this->memory_file, buffer, len, (size_t)address.address()) < 0)
506     xbt_die("Write to process %lli failed", (long long)this->pid_);
507 }
508
509 void RemoteClient::clear_bytes(RemotePtr<void> address, size_t len)
510 {
511   pthread_once(&zero_buffer_flag, zero_buffer_init);
512   while (len) {
513     size_t s = len > zero_buffer_size ? zero_buffer_size : len;
514     this->write_bytes(zero_buffer, s, address);
515     address = remote((char*)address.address() + s);
516     len -= s;
517   }
518 }
519
520 void RemoteClient::ignore_region(std::uint64_t addr, std::size_t size)
521 {
522   IgnoredRegion region;
523   region.addr = addr;
524   region.size = size;
525
526   if (ignored_regions_.empty()) {
527     ignored_regions_.push_back(region);
528     return;
529   }
530
531   unsigned int cursor           = 0;
532   IgnoredRegion* current_region = nullptr;
533
534   int start = 0;
535   int end   = ignored_regions_.size() - 1;
536   while (start <= end) {
537     cursor         = (start + end) / 2;
538     current_region = &ignored_regions_[cursor];
539     if (current_region->addr == addr) {
540       if (current_region->size == size)
541         return;
542       else if (current_region->size < size)
543         start = cursor + 1;
544       else
545         end = cursor - 1;
546     } else if (current_region->addr < addr)
547       start = cursor + 1;
548     else
549       end = cursor - 1;
550   }
551
552   std::size_t position;
553   if (current_region->addr == addr) {
554     if (current_region->size < size)
555       position = cursor + 1;
556     else
557       position = cursor;
558   } else if (current_region->addr < addr)
559     position = cursor + 1;
560   else
561     position = cursor;
562   ignored_regions_.insert(ignored_regions_.begin() + position, region);
563 }
564
565 void RemoteClient::ignore_heap(IgnoredHeapRegion const& region)
566 {
567   if (ignored_heap_.empty()) {
568     ignored_heap_.push_back(std::move(region));
569     return;
570   }
571
572   typedef std::vector<IgnoredHeapRegion>::size_type size_type;
573
574   size_type start = 0;
575   size_type end   = ignored_heap_.size() - 1;
576
577   // Binary search the position of insertion:
578   size_type cursor;
579   while (start <= end) {
580     cursor               = start + (end - start) / 2;
581     auto& current_region = ignored_heap_[cursor];
582     if (current_region.address == region.address)
583       return;
584     else if (current_region.address < region.address)
585       start = cursor + 1;
586     else if (cursor != 0)
587       end = cursor - 1;
588     // Avoid underflow:
589     else
590       break;
591   }
592
593   // Insert it mc_heap_ignore_region_t:
594   if (ignored_heap_[cursor].address < region.address)
595     ++cursor;
596   ignored_heap_.insert(ignored_heap_.begin() + cursor, region);
597 }
598
599 void RemoteClient::unignore_heap(void* address, size_t size)
600 {
601   typedef std::vector<IgnoredHeapRegion>::size_type size_type;
602
603   size_type start = 0;
604   size_type end   = ignored_heap_.size() - 1;
605
606   // Binary search:
607   size_type cursor;
608   while (start <= end) {
609     cursor       = (start + end) / 2;
610     auto& region = ignored_heap_[cursor];
611     if (region.address == address) {
612       ignored_heap_.erase(ignored_heap_.begin() + cursor);
613       return;
614     } else if (region.address < address)
615       start = cursor + 1;
616     else if ((char*)region.address <= ((char*)address + size)) {
617       ignored_heap_.erase(ignored_heap_.begin() + cursor);
618       return;
619     } else if (cursor != 0)
620       end = cursor - 1;
621     // Avoid underflow:
622     else
623       break;
624   }
625 }
626
627 void RemoteClient::ignore_local_variable(const char* var_name, const char* frame_name)
628 {
629   if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
630     frame_name = nullptr;
631   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos)
632     info->remove_local_variable(var_name, frame_name);
633 }
634
635 std::vector<simgrid::mc::ActorInformation>& RemoteClient::actors()
636 {
637   this->refresh_simix();
638   return smx_actors_infos;
639 }
640
641 std::vector<simgrid::mc::ActorInformation>& RemoteClient::dead_actors()
642 {
643   this->refresh_simix();
644   return smx_dead_actors_infos;
645 }
646
647 void RemoteClient::dumpStack()
648 {
649   unw_addr_space_t as = unw_create_addr_space(&_UPT_accessors, BYTE_ORDER);
650   if (as == nullptr) {
651     XBT_ERROR("Could not initialize ptrace address space");
652     return;
653   }
654
655   void* context = _UPT_create(this->pid_);
656   if (context == nullptr) {
657     unw_destroy_addr_space(as);
658     XBT_ERROR("Could not initialize ptrace context");
659     return;
660   }
661
662   unw_cursor_t cursor;
663   if (unw_init_remote(&cursor, as, context) != 0) {
664     _UPT_destroy(context);
665     unw_destroy_addr_space(as);
666     XBT_ERROR("Could not initialiez ptrace cursor");
667     return;
668   }
669
670   simgrid::mc::dumpStack(stderr, cursor);
671
672   _UPT_destroy(context);
673   unw_destroy_addr_space(as);
674   return;
675 }
676 }
677 }