Logo AND Algorithmique Numérique Distribuée

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