Logo AND Algorithmique Numérique Distribuée

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