Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of github.com:mquinson/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   return real_count;
159 }
160
161 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
162 static const void* zero_buffer;
163 static const size_t zero_buffer_size = 10 * 4096;
164
165 static void MC_zero_buffer_init(void)
166 {
167   int fd = open("/dev/zero", O_RDONLY);
168   if (fd<0)
169     xbt_die("Could not open /dev/zero");
170   zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
171   if (zero_buffer == MAP_FAILED)
172     xbt_die("Could not map the zero buffer");
173   close(fd);
174 }
175
176 static
177 int open_process_file(pid_t pid, const char* file, int flags)
178 {
179   char buff[50];
180   snprintf(buff, sizeof(buff), "/proc/%li/%s", (long) pid, file);
181   return open(buff, flags);
182 }
183
184 }
185
186 namespace simgrid {
187 namespace mc {
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   
202 }
203 }
204
205 // ***** Process
206
207 namespace simgrid {
208 namespace mc {
209
210 Process::Process(pid_t pid, int sockfd) :
211    AddressSpace(this),pid_(pid), socket_(sockfd), running_(true)
212 {}
213
214 void Process::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 (!std_heap_var)
227     xbt_die("No heap information in the target process");
228   if(!std_heap_var->address)
229     xbt_die("No constant address for this variable");
230   this->read_bytes(&this->heap_address, sizeof(struct mdesc*),
231     remote(std_heap_var->address),
232     simgrid::mc::ProcessIndexDisabled);
233
234   this->smx_process_infos.clear();
235   this->smx_old_process_infos.clear();
236   this->unw_addr_space = unw_create_addr_space(&mc_unw_accessors  , __BYTE_ORDER);
237   this->unw_underlying_addr_space = unw_create_addr_space(&mc_unw_vmread_accessors, __BYTE_ORDER);
238   this->unw_underlying_context = _UPT_create(this->pid_);
239 }
240
241 Process::~Process()
242 {
243   if (this->socket_ >= 0 && close(this->socket_) < 0)
244     xbt_die("Could not close communication socket");
245
246   this->maestro_stack_start_ = nullptr;
247   this->maestro_stack_end_ = nullptr;
248
249   if (this->memory_file >= 0)
250     close(this->memory_file);
251
252   if (this->unw_underlying_addr_space != unw_local_addr_space) {
253     unw_destroy_addr_space(this->unw_underlying_addr_space);
254     _UPT_destroy(this->unw_underlying_context);
255   }
256   this->unw_underlying_context = nullptr;
257   this->unw_underlying_addr_space = nullptr;
258
259   unw_destroy_addr_space(this->unw_addr_space);
260   this->unw_addr_space = nullptr;
261
262   this->cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
263
264   if (this->clear_refs_fd_ >= 0)
265     close(this->clear_refs_fd_);
266   if (this->pagemap_fd_ >= 0)
267     close(this->pagemap_fd_);
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 Process::refresh_heap()
276 {
277   xbt_assert(mc_mode == MC_MODE_SERVER);
278   // Read/dereference/refresh the std_heap pointer:
279   if (!this->heap)
280     this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
281   this->read_bytes(this->heap.get(), sizeof(struct mdesc),
282     remote(this->heap_address), simgrid::mc::ProcessIndexDisabled);
283   this->cache_flags |= MC_PROCESS_CACHE_FLAG_HEAP;
284 }
285
286 /** Refresh the information about the process
287  *
288  *  Do not use direclty, this is used by the getters when appropriate
289  *  in order to have fresh data.
290  * */
291 void Process::refresh_malloc_info()
292 {
293   xbt_assert(mc_mode == MC_MODE_SERVER);
294   if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
295     this->refresh_heap();
296   // Refresh process->heapinfo:
297   size_t count = this->heap->heaplimit + 1;
298   if (this->heap_info.size() < count)
299     this->heap_info.resize(count);
300   this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info),
301     remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
302   this->cache_flags |= MC_PROCESS_CACHE_FLAG_MALLOC_INFO;
303 }
304
305 /** @brief Finds the range of the different memory segments and binary paths */
306 void Process::init_memory_map_info()
307 {
308   XBT_DEBUG("Get debug information ...");
309   this->maestro_stack_start_ = nullptr;
310   this->maestro_stack_end_ = nullptr;
311   this->object_infos.resize(0);
312   this->binary_info = nullptr;
313   this->libsimgrid_info = nullptr;
314
315   struct s_mc_memory_map_re res;
316
317   if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
318     xbt_die(".so regexp did not compile");
319
320   std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
321
322   const char* current_name = nullptr;
323
324   this->object_infos.resize(0);
325
326   for (size_t i=0; i < maps.size(); i++) {
327     simgrid::xbt::VmMap const& reg = maps[i];
328     const char* pathname = maps[i].pathname.c_str();
329
330     // Nothing to do
331     if (maps[i].pathname.empty()) {
332       current_name = nullptr;
333       continue;
334     }
335
336     // [stack], [vvar], [vsyscall], [vdso] ...
337     if (pathname[0] == '[') {
338       if ((reg.prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
339         this->maestro_stack_start_ = remote(reg.start_addr);
340         this->maestro_stack_end_ = remote(reg.end_addr);
341       }
342       current_name = nullptr;
343       continue;
344     }
345
346     if (current_name && strcmp(current_name, pathname)==0)
347       continue;
348
349     current_name = pathname;
350     if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
351       continue;
352
353     const bool is_executable = !i;
354     char* libname = nullptr;
355     if (!is_executable) {
356       libname = MC_get_lib_name(pathname, &res);
357       if(!libname)
358         continue;
359       if (MC_is_filtered_lib(libname)) {
360         free(libname);
361         continue;
362       }
363     }
364
365     std::shared_ptr<simgrid::mc::ObjectInformation> info =
366       MC_find_object_info(this->memory_map_, pathname);
367     this->object_infos.push_back(info);
368     if (is_executable)
369       this->binary_info = info;
370     else if (libname && MC_is_simgrid_lib(libname))
371       this->libsimgrid_info = info;
372     free(libname);
373   }
374
375   regfree(&res.so_re);
376   regfree(&res.version_re);
377
378   // Resolve time (including accross differents objects):
379   for (auto const& object_info : this->object_infos)
380     MC_post_process_object_info(this, object_info.get());
381
382   xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
383   xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
384
385   XBT_DEBUG("Get debug information done !");
386 }
387
388 std::shared_ptr<simgrid::mc::ObjectInformation> Process::find_object_info(RemotePtr<void> addr) const
389 {
390   for (auto const& object_info : this->object_infos)
391     if (addr.address() >= (std::uint64_t)object_info->start
392         && addr.address() <= (std::uint64_t)object_info->end)
393       return object_info;
394   return nullptr;
395 }
396
397 std::shared_ptr<ObjectInformation> Process::find_object_info_exec(RemotePtr<void> addr) const
398 {
399   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
400     if (addr.address() >= (std::uint64_t) info->start_exec
401         && addr.address() <= (std::uint64_t) info->end_exec)
402       return info;
403   return nullptr;
404 }
405
406 std::shared_ptr<ObjectInformation> Process::find_object_info_rw(RemotePtr<void> addr) const
407 {
408   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
409     if (addr.address() >= (std::uint64_t)info->start_rw
410         && addr.address() <= (std::uint64_t)info->end_rw)
411       return info;
412   return nullptr;
413 }
414
415 simgrid::mc::Frame* Process::find_function(RemotePtr<void> ip) const
416 {
417   std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
418   return info ? info->find_function((void*) ip.address()) : nullptr;
419 }
420
421 /** Find (one occurence of) the named variable definition
422  */
423 simgrid::mc::Variable* Process::find_variable(const char* name) const
424 {
425   // First lookup the variable in the executable shared object.
426   // A global variable used directly by the executable code from a library
427   // is reinstanciated in the executable memory .data/.bss.
428   // We need to look up the variable in the execvutable first.
429   if (this->binary_info) {
430     std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
431     simgrid::mc::Variable* var = info->find_variable(name);
432     if (var)
433       return var;
434   }
435
436   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
437     simgrid::mc::Variable* var = info->find_variable(name);
438     if (var)
439       return var;
440   }
441
442   return nullptr;
443 }
444
445 void Process::read_variable(const char* name, void* target, size_t size) const
446 {
447   simgrid::mc::Variable* var = this->find_variable(name);
448   if (!var->address)
449     xbt_die("No simple location for this variable");
450   if (!var->type->full_type)
451     xbt_die("Partial type for %s, cannot check size", name);
452   if ((size_t) var->type->full_type->byte_size != size)
453     xbt_die("Unexpected size for %s (expected %zi, was %zi)",
454       name, size, (size_t) var->type->full_type->byte_size);
455   this->read_bytes(target, size, remote(var->address));
456 }
457
458 char* Process::read_string(RemotePtr<void> address) const
459 {
460   if (!address)
461     return nullptr;
462
463   off_t len = 128;
464   char* res = (char*) malloc(len);
465   off_t off = 0;
466
467   while (1) {
468     ssize_t c = pread(this->memory_file, res + off, len - off, (off_t) address.address() + off);
469     if (c == -1) {
470       if (errno == EINTR)
471         continue;
472       else
473         xbt_die("Could not read from from remote process");
474     }
475     if (c==0)
476       xbt_die("Could not read string from remote process");
477
478     void* p = memchr(res + off, '\0', c);
479     if (p)
480       return res;
481
482     off += c;
483     if (off == len) {
484       len *= 2;
485       res = (char*) realloc(res, len);
486     }
487   }
488 }
489
490 const void *Process::read_bytes(void* buffer, std::size_t size,
491   RemotePtr<void> address, int process_index,
492   ReadOptions options) const
493 {
494   if (process_index != simgrid::mc::ProcessIndexDisabled) {
495     std::shared_ptr<simgrid::mc::ObjectInformation> const& info =
496       this->find_object_info_rw((void*)address.address());
497     // Segment overlap is not handled.
498 #ifdef HAVE_SMPI
499     if (info.get() && this->privatized(*info)) {
500       if (process_index < 0)
501         xbt_die("Missing process index");
502       if (process_index >= (int) MC_smpi_process_count())
503         xbt_die("Invalid process index");
504
505       // Read smpi_privatisation_regions from MCed:
506       smpi_privatisation_region_t remote_smpi_privatisation_regions =
507         mc_model_checker->process().read_variable<smpi_privatisation_region_t>(
508           "smpi_privatisation_regions");
509
510       s_smpi_privatisation_region_t privatisation_region =
511         mc_model_checker->process().read<s_smpi_privatisation_region_t>(
512           remote(remote_smpi_privatisation_regions + process_index));
513
514       // Address translation in the privaization segment:
515       size_t offset = address.address() - (std::uint64_t)info->start_rw;
516       address = remote((char*)privatisation_region.address + offset);
517     }
518 #endif
519   }
520
521   if (pread_whole(this->memory_file, buffer, size, address.address()) < 0)
522     xbt_die("Read from process %lli failed", (long long) this->pid_);
523   return buffer;
524 }
525
526 /** Write data to a process memory
527  *
528  *  @param process the process
529  *  @param local   local memory address (source)
530  *  @param remote  target process memory address (target)
531  *  @param len     data size
532  */
533 void Process::write_bytes(const void* buffer, size_t len, RemotePtr<void> address)
534 {
535   if (pwrite_whole(this->memory_file, buffer, len, address.address()) < 0)
536     xbt_die("Write to process %lli failed", (long long) this->pid_);
537 }
538
539 void Process::clear_bytes(RemotePtr<void> address, size_t len)
540 {
541   pthread_once(&zero_buffer_flag, MC_zero_buffer_init);
542   while (len) {
543     size_t s = len > zero_buffer_size ? zero_buffer_size : len;
544     this->write_bytes(zero_buffer, s, address);
545     address = remote((char*) address.address() + s);
546     len -= s;
547   }
548 }
549
550 void Process::ignore_region(std::uint64_t addr, std::size_t size)
551 {
552   IgnoredRegion region;
553   region.addr = addr;
554   region.size = size;
555
556   if (ignored_regions_.empty()) {
557     ignored_regions_.push_back(region);
558     return;
559   }
560
561   unsigned int cursor = 0;
562   IgnoredRegion* current_region = nullptr;
563
564   int start = 0;
565   int end = ignored_regions_.size() - 1;
566   while (start <= end) {
567     cursor = (start + end) / 2;
568     current_region = &ignored_regions_[cursor];
569     if (current_region->addr == addr) {
570       if (current_region->size == size)
571         return;
572       else if (current_region->size < size)
573         start = cursor + 1;
574       else
575         end = cursor - 1;
576     } else if (current_region->addr < addr)
577       start = cursor + 1;
578     else
579       end = cursor - 1;
580   }
581
582   std::size_t position;
583   if (current_region->addr == addr) {
584     if (current_region->size < size)
585       position = cursor + 1;
586     else
587       position = cursor;
588   } else if (current_region->addr < addr)
589     position = cursor + 1;
590   else
591     position = cursor;
592   ignored_regions_.insert(
593     ignored_regions_.begin() + position, region);
594 }
595
596 void Process::reset_soft_dirty()
597 {
598   if (this->clear_refs_fd_ < 0) {
599     this->clear_refs_fd_ = open_process_file(pid_, "clear_refs", O_WRONLY|O_CLOEXEC);
600     if (this->clear_refs_fd_ < 0)
601       xbt_die("Could not open clear_refs file for soft-dirty tracking. Run as root?");
602   }
603   if(::write(this->clear_refs_fd_, "4\n", 2) != 2)
604     xbt_die("Could not reset softdirty bits");
605 }
606
607 void Process::read_pagemap(uint64_t* pagemap, size_t page_start, size_t page_count)
608 {
609   if (pagemap_fd_ < 0) {
610     pagemap_fd_ = open_process_file(pid_, "pagemap", O_RDONLY|O_CLOEXEC);
611     if (pagemap_fd_ < 0)
612       xbt_die("Could not open pagemap file for soft-dirty tracking. Run as root?");
613   }
614   ssize_t bytesize = sizeof(uint64_t) * page_count;
615   off_t offset = sizeof(uint64_t) * page_start;
616   if (pread_whole(pagemap_fd_, pagemap, bytesize, offset) != bytesize)
617     xbt_die("Could not read pagemap");
618 }
619
620 void Process::ignore_heap(IgnoredHeapRegion const& region)
621 {
622   if (ignored_heap_.empty()) {
623     ignored_heap_.push_back(std::move(region));
624     return;
625   }
626
627   typedef std::vector<IgnoredHeapRegion>::size_type size_type;
628
629   size_type start = 0;
630   size_type end = ignored_heap_.size() - 1;
631
632   // Binary search the position of insertion:
633   size_type cursor;
634   while (start <= end) {
635     cursor = start + (end - start) / 2;
636     auto& current_region = ignored_heap_[cursor];
637     if (current_region.address == region.address)
638       return;
639     else if (current_region.address < region.address)
640       start = cursor + 1;
641     else if (cursor != 0)
642       end = cursor - 1;
643     // Avoid underflow:
644     else
645       break;
646   }
647
648   // Insert it mc_heap_ignore_region_t:
649   if (ignored_heap_[cursor].address < region.address)
650     ++cursor;
651   ignored_heap_.insert( ignored_heap_.begin() + cursor, region);
652 }
653
654 void Process::unignore_heap(void *address, size_t size)
655 {
656   typedef std::vector<IgnoredHeapRegion>::size_type size_type;
657
658   size_type start = 0;
659   size_type end = ignored_heap_.size() - 1;
660
661   // Binary search:
662   size_type cursor;
663   while (start <= end) {
664     cursor = (start + end) / 2;
665     auto& region = ignored_heap_[cursor];
666     if (region.address == address) {
667       ignored_heap_.erase(ignored_heap_.begin() + cursor);
668       return;
669     } else if (region.address < address)
670       start = cursor + 1;
671     else if ((char *) region.address <= ((char *) address + size)) {
672       ignored_heap_.erase(ignored_heap_.begin() + cursor);
673       return;
674     } else if (cursor != 0)
675       end = cursor - 1;
676     // Avoid underflow:
677     else
678       break;
679   }
680 }
681
682 void Process::ignore_local_variable(const char *var_name, const char *frame_name)
683 {
684   if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
685     frame_name = nullptr;
686   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
687       this->object_infos)
688     info->remove_local_variable(var_name, frame_name);
689 }
690
691 std::vector<simgrid::mc::SimixProcessInformation>& Process::simix_processes()
692 {
693   xbt_assert(mc_mode != MC_MODE_CLIENT);
694   MC_process_smx_refresh(&mc_model_checker->process());
695   return smx_process_infos;
696 }
697
698 }
699 }