Logo AND Algorithmique Numérique Distribuée

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