Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Move process_vm_readv-based implementation of libunwind in simgrid::mc
[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 = simgrid::unw::create_addr_space();
231   this->unw_underlying_context = simgrid::unw::create_context(
232     this->unw_underlying_addr_space, this->pid_);
233 }
234
235 Process::~Process()
236 {
237   if (this->memory_file >= 0)
238     close(this->memory_file);
239
240   if (this->unw_underlying_addr_space != unw_local_addr_space) {
241     unw_destroy_addr_space(this->unw_underlying_addr_space);
242     _UPT_destroy(this->unw_underlying_context);
243   }
244
245   unw_destroy_addr_space(this->unw_addr_space);
246
247   if (this->clear_refs_fd_ >= 0)
248     close(this->clear_refs_fd_);
249   if (this->pagemap_fd_ >= 0)
250     close(this->pagemap_fd_);
251 }
252
253 /** Refresh the information about the process
254  *
255  *  Do not use direclty, this is used by the getters when appropriate
256  *  in order to have fresh data.
257  */
258 void Process::refresh_heap()
259 {
260   xbt_assert(mc_mode == MC_MODE_SERVER);
261   // Read/dereference/refresh the std_heap pointer:
262   if (!this->heap)
263     this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
264   this->read_bytes(this->heap.get(), sizeof(struct mdesc),
265     remote(this->heap_address), simgrid::mc::ProcessIndexDisabled);
266   this->cache_flags_ |= Process::cache_heap;
267 }
268
269 /** Refresh the information about the process
270  *
271  *  Do not use direclty, this is used by the getters when appropriate
272  *  in order to have fresh data.
273  * */
274 void Process::refresh_malloc_info()
275 {
276   xbt_assert(mc_mode == MC_MODE_SERVER);
277   // Refresh process->heapinfo:
278   if (this->cache_flags_ & Process::cache_malloc)
279     return;
280   size_t count = this->heap->heaplimit + 1;
281   if (this->heap_info.size() < count)
282     this->heap_info.resize(count);
283   this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info),
284     remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
285   this->cache_flags_ |= Process::cache_malloc;
286 }
287
288 /** @brief Finds the range of the different memory segments and binary paths */
289 void Process::init_memory_map_info()
290 {
291   XBT_DEBUG("Get debug information ...");
292   this->maestro_stack_start_ = nullptr;
293   this->maestro_stack_end_ = nullptr;
294   this->object_infos.resize(0);
295   this->binary_info = nullptr;
296   this->libsimgrid_info = nullptr;
297
298   struct s_mc_memory_map_re res;
299
300   if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
301     xbt_die(".so regexp did not compile");
302
303   std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
304
305   const char* current_name = nullptr;
306
307   this->object_infos.clear();
308
309   for (size_t i=0; i < maps.size(); i++) {
310     simgrid::xbt::VmMap const& reg = maps[i];
311     const char* pathname = maps[i].pathname.c_str();
312
313     // Nothing to do
314     if (maps[i].pathname.empty()) {
315       current_name = nullptr;
316       continue;
317     }
318
319     // [stack], [vvar], [vsyscall], [vdso] ...
320     if (pathname[0] == '[') {
321       if ((reg.prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
322         this->maestro_stack_start_ = remote(reg.start_addr);
323         this->maestro_stack_end_ = remote(reg.end_addr);
324       }
325       current_name = nullptr;
326       continue;
327     }
328
329     if (current_name && strcmp(current_name, pathname)==0)
330       continue;
331
332     current_name = pathname;
333     if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
334       continue;
335
336     const bool is_executable = !i;
337     char* libname = nullptr;
338     if (!is_executable) {
339       libname = get_lib_name(pathname, &res);
340       if(!libname)
341         continue;
342       if (is_filtered_lib(libname)) {
343         free(libname);
344         continue;
345       }
346     }
347
348     std::shared_ptr<simgrid::mc::ObjectInformation> info =
349       simgrid::mc::createObjectInformation(this->memory_map_, pathname);
350     this->object_infos.push_back(info);
351     if (is_executable)
352       this->binary_info = info;
353     else if (libname && is_simgrid_lib(libname))
354       this->libsimgrid_info = info;
355     free(libname);
356   }
357
358   regfree(&res.so_re);
359   regfree(&res.version_re);
360
361   // Resolve time (including accross differents objects):
362   for (auto const& object_info : this->object_infos)
363     postProcessObjectInformation(this, object_info.get());
364
365   xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
366   xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
367
368   XBT_DEBUG("Get debug information done !");
369 }
370
371 std::shared_ptr<simgrid::mc::ObjectInformation> Process::find_object_info(RemotePtr<void> addr) const
372 {
373   for (auto const& object_info : this->object_infos)
374     if (addr.address() >= (std::uint64_t)object_info->start
375         && addr.address() <= (std::uint64_t)object_info->end)
376       return object_info;
377   return nullptr;
378 }
379
380 std::shared_ptr<ObjectInformation> Process::find_object_info_exec(RemotePtr<void> addr) const
381 {
382   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
383     if (addr.address() >= (std::uint64_t) info->start_exec
384         && addr.address() <= (std::uint64_t) info->end_exec)
385       return info;
386   return nullptr;
387 }
388
389 std::shared_ptr<ObjectInformation> Process::find_object_info_rw(RemotePtr<void> addr) const
390 {
391   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
392     if (addr.address() >= (std::uint64_t)info->start_rw
393         && addr.address() <= (std::uint64_t)info->end_rw)
394       return info;
395   return nullptr;
396 }
397
398 simgrid::mc::Frame* Process::find_function(RemotePtr<void> ip) const
399 {
400   std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
401   return info ? info->find_function((void*) ip.address()) : nullptr;
402 }
403
404 /** Find (one occurence of) the named variable definition
405  */
406 simgrid::mc::Variable* Process::find_variable(const char* name) const
407 {
408   // First lookup the variable in the executable shared object.
409   // A global variable used directly by the executable code from a library
410   // is reinstanciated in the executable memory .data/.bss.
411   // We need to look up the variable in the execvutable first.
412   if (this->binary_info) {
413     std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
414     simgrid::mc::Variable* var = info->find_variable(name);
415     if (var)
416       return var;
417   }
418
419   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
420     simgrid::mc::Variable* var = info->find_variable(name);
421     if (var)
422       return var;
423   }
424
425   return nullptr;
426 }
427
428 void Process::read_variable(const char* name, void* target, size_t size) const
429 {
430   simgrid::mc::Variable* var = this->find_variable(name);
431   if (!var->address)
432     xbt_die("No simple location for this variable");
433   if (!var->type->full_type)
434     xbt_die("Partial type for %s, cannot check size", name);
435   if ((size_t) var->type->full_type->byte_size != size)
436     xbt_die("Unexpected size for %s (expected %zi, was %zi)",
437       name, size, (size_t) var->type->full_type->byte_size);
438   this->read_bytes(target, size, remote(var->address));
439 }
440
441 char* Process::read_string(RemotePtr<void> address) const
442 {
443   if (!address)
444     return nullptr;
445
446   off_t len = 128;
447   char* res = (char*) malloc(len);
448   off_t off = 0;
449
450   while (1) {
451     ssize_t c = pread(this->memory_file, res + off, len - off, (off_t) address.address() + off);
452     if (c == -1) {
453       if (errno == EINTR)
454         continue;
455       else
456         xbt_die("Could not read from from remote process");
457     }
458     if (c==0)
459       xbt_die("Could not read string from remote process");
460
461     void* p = memchr(res + off, '\0', c);
462     if (p)
463       return res;
464
465     off += c;
466     if (off == len) {
467       len *= 2;
468       res = (char*) realloc(res, len);
469     }
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 privaization 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::reset_soft_dirty()
580 {
581   if (this->clear_refs_fd_ < 0) {
582     this->clear_refs_fd_ = open_process_file(pid_, "clear_refs", O_WRONLY|O_CLOEXEC);
583     if (this->clear_refs_fd_ < 0)
584       xbt_die("Could not open clear_refs file for soft-dirty tracking. Run as root?");
585   }
586   if(::write(this->clear_refs_fd_, "4\n", 2) != 2)
587     xbt_die("Could not reset softdirty bits");
588 }
589
590 void Process::read_pagemap(uint64_t* pagemap, size_t page_start, size_t page_count)
591 {
592   if (pagemap_fd_ < 0) {
593     pagemap_fd_ = open_process_file(pid_, "pagemap", O_RDONLY|O_CLOEXEC);
594     if (pagemap_fd_ < 0)
595       xbt_die("Could not open pagemap file for soft-dirty tracking. Run as root?");
596   }
597   ssize_t bytesize = sizeof(uint64_t) * page_count;
598   off_t offset = sizeof(uint64_t) * page_start;
599   if (pread_whole(pagemap_fd_, pagemap, bytesize, offset) != bytesize)
600     xbt_die("Could not read pagemap");
601 }
602
603 void Process::ignore_heap(IgnoredHeapRegion const& region)
604 {
605   if (ignored_heap_.empty()) {
606     ignored_heap_.push_back(std::move(region));
607     return;
608   }
609
610   typedef std::vector<IgnoredHeapRegion>::size_type size_type;
611
612   size_type start = 0;
613   size_type end = ignored_heap_.size() - 1;
614
615   // Binary search the position of insertion:
616   size_type cursor;
617   while (start <= end) {
618     cursor = start + (end - start) / 2;
619     auto& current_region = ignored_heap_[cursor];
620     if (current_region.address == region.address)
621       return;
622     else if (current_region.address < region.address)
623       start = cursor + 1;
624     else if (cursor != 0)
625       end = cursor - 1;
626     // Avoid underflow:
627     else
628       break;
629   }
630
631   // Insert it mc_heap_ignore_region_t:
632   if (ignored_heap_[cursor].address < region.address)
633     ++cursor;
634   ignored_heap_.insert( ignored_heap_.begin() + cursor, region);
635 }
636
637 void Process::unignore_heap(void *address, size_t size)
638 {
639   typedef std::vector<IgnoredHeapRegion>::size_type size_type;
640
641   size_type start = 0;
642   size_type end = ignored_heap_.size() - 1;
643
644   // Binary search:
645   size_type cursor;
646   while (start <= end) {
647     cursor = (start + end) / 2;
648     auto& region = ignored_heap_[cursor];
649     if (region.address == address) {
650       ignored_heap_.erase(ignored_heap_.begin() + cursor);
651       return;
652     } else if (region.address < address)
653       start = cursor + 1;
654     else if ((char *) region.address <= ((char *) address + size)) {
655       ignored_heap_.erase(ignored_heap_.begin() + cursor);
656       return;
657     } else if (cursor != 0)
658       end = cursor - 1;
659     // Avoid underflow:
660     else
661       break;
662   }
663 }
664
665 void Process::ignore_local_variable(const char *var_name, const char *frame_name)
666 {
667   if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
668     frame_name = nullptr;
669   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
670       this->object_infos)
671     info->remove_local_variable(var_name, frame_name);
672 }
673
674 std::vector<simgrid::mc::SimixProcessInformation>& Process::simix_processes()
675 {
676   xbt_assert(mc_mode != MC_MODE_CLIENT);
677   this->refresh_simix();
678   return smx_process_infos;
679 }
680
681 std::vector<simgrid::mc::SimixProcessInformation>& Process::old_simix_processes()
682 {
683   xbt_assert(mc_mode != MC_MODE_CLIENT);
684   this->refresh_simix();
685   return smx_old_process_infos;
686 }
687
688 }
689 }