Logo AND Algorithmique Numérique Distribuée

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