Logo AND Algorithmique Numérique Distribuée

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