Logo AND Algorithmique Numérique Distribuée

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