Logo AND Algorithmique Numérique Distribuée

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