Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Make s_mc_snapshot_stack::stack_frames a std::vector
[simgrid.git] / src / mc / mc_checkpoint.cpp
1 /* Copyright (c) 2008-2014. 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 #include <unistd.h>
8
9 #include <string.h>
10 #include <link.h>
11 #include <dirent.h>
12
13 #include "internal_config.h"
14 #include "mc_memory_map.h"
15 #include "mc_private.h"
16 #include "xbt/module.h"
17 #include <xbt/mmalloc.h>
18 #include "../smpi/private.h"
19 #include <alloca.h>
20
21 #include "xbt/mmalloc/mmprivate.h"
22
23 #include "../simix/smx_private.h"
24
25 #include <libunwind.h>
26 #include <libelf.h>
27
28 #include "mc_private.h"
29 #include <mc/mc.h>
30
31 #include "mc_snapshot.h"
32 #include "mc_object_info.h"
33 #include "mc_mmu.h"
34 #include "mc_unw.h"
35 #include "mc_protocol.h"
36 #include "mc_smx.h"
37 #include "mc_hash.hpp"
38
39 using simgrid::mc::remote;
40
41 extern "C" {
42
43 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
44                                 "Logging specific to mc_checkpoint");
45
46 /************************************  Free functions **************************************/
47 /*****************************************************************************************/
48
49 s_mc_snapshot_stack::~s_mc_snapshot_stack()
50 {
51   if (this->context)
52     mc_unw_destroy_context(this->context);
53   xbt_free(this->context);
54 }
55
56 static void MC_snapshot_stack_free_voidp(void *s)
57 {
58   mc_snapshot_stack_t stack = (mc_snapshot_stack_t) * (void **) s;
59   delete stack;
60 }
61
62 static void local_variable_free_voidp(void *v)
63 {
64   local_variable_t var = *(local_variable_t*)v;
65   delete var;
66 }
67
68 }
69
70 extern "C" {
71
72 /** @brief Restore a region from a snapshot
73  *
74  *  @param reg     Target region
75  */
76 static void MC_region_restore(mc_mem_region_t region)
77 {
78   switch(region->storage_type()) {
79   case simgrid::mc::StorageType::NoData:
80   default:
81     xbt_die("Storage type not supported");
82     break;
83
84   case simgrid::mc::StorageType::Flat:
85     mc_model_checker->process().write_bytes(region->flat_data().data(),
86       region->size(), region->permanent_address());
87     break;
88
89   case simgrid::mc::StorageType::Chunked:
90     mc_region_restore_sparse(&mc_model_checker->process(), region);
91     break;
92
93   case simgrid::mc::StorageType::Privatized:
94     for (auto& p : region->privatized_data())
95       MC_region_restore(&p);
96     break;
97   }
98 }
99
100 }
101
102 namespace simgrid {
103 namespace mc {
104
105 simgrid::mc::RegionSnapshot privatized_region(
106     RegionType region_type, void *start_addr, void* permanent_addr, size_t size
107     )
108 {
109   size_t process_count = MC_smpi_process_count();
110
111   // Read smpi_privatisation_regions from MCed:
112   smpi_privatisation_region_t remote_smpi_privatisation_regions;
113   mc_model_checker->process().read_variable(
114     "smpi_privatisation_regions",
115     &remote_smpi_privatisation_regions, sizeof(remote_smpi_privatisation_regions));
116   s_smpi_privatisation_region_t privatisation_regions[process_count];
117   mc_model_checker->process().read_bytes(
118     &privatisation_regions, sizeof(privatisation_regions),
119     remote(remote_smpi_privatisation_regions));
120
121   std::vector<simgrid::mc::RegionSnapshot> data;
122   data.reserve(process_count);
123   for (size_t i = 0; i < process_count; i++)
124     data.push_back(
125       simgrid::mc::region(region_type, start_addr,
126         privatisation_regions[i].address, size)
127       );
128
129   simgrid::mc::RegionSnapshot region = simgrid::mc::RegionSnapshot(
130     region_type, start_addr, permanent_addr, size);
131   region.privatized_data(std::move(data));
132   return std::move(region);
133 }
134
135 }
136 }
137
138 extern "C" {
139
140 static void MC_snapshot_add_region(int index, mc_snapshot_t snapshot,
141                                   simgrid::mc::RegionType type,
142                                   mc_object_info_t object_info,
143                                   void *start_addr, void* permanent_addr, size_t size)
144 {
145   if (type == simgrid::mc::RegionType::Data)
146     xbt_assert(object_info, "Missing object info for object.");
147   else if (type == simgrid::mc::RegionType::Heap)
148     xbt_assert(!object_info, "Unexpected object info for heap region.");
149
150   const bool privatization_aware = MC_object_info_is_privatized(object_info);
151
152   simgrid::mc::RegionSnapshot region;
153   if (privatization_aware && MC_smpi_process_count())
154     region = simgrid::mc::privatized_region(type, start_addr, permanent_addr, size);
155   else
156     region = simgrid::mc::region(type, start_addr, permanent_addr, size);
157
158   region.object_info(object_info);
159   snapshot->snapshot_regions[index]
160     = std::unique_ptr<simgrid::mc::RegionSnapshot>(
161       new simgrid::mc::RegionSnapshot(std::move(region)));
162   return;
163 }
164
165 static void MC_get_memory_regions(mc_process_t process, mc_snapshot_t snapshot)
166 {
167   const size_t n = process->object_infos_size;
168   snapshot->snapshot_regions.resize(n + 1);
169   for (size_t i = 0; i != n; ++i) {
170     mc_object_info_t object_info = process->object_infos[i];
171     MC_snapshot_add_region(i, snapshot, simgrid::mc::RegionType::Data, object_info,
172       object_info->start_rw, object_info->start_rw,
173       object_info->end_rw - object_info->start_rw);
174   }
175
176   xbt_mheap_t heap = process->get_heap();
177   void *start_heap = heap->base;
178   void *end_heap = heap->breakval;
179
180   MC_snapshot_add_region(n, snapshot, simgrid::mc::RegionType::Heap, NULL,
181                         start_heap, start_heap,
182                         (char *) end_heap - (char *) start_heap);
183   snapshot->heap_bytes_used = mmalloc_get_bytes_used_remote(
184     heap->heaplimit,
185     process->get_malloc_info());
186
187 #ifdef HAVE_SMPI
188   if (smpi_privatize_global_variables && MC_smpi_process_count()) {
189     // snapshot->privatization_index = smpi_loaded_page
190     mc_model_checker->process().read_variable(
191       "smpi_loaded_page", &snapshot->privatization_index,
192       sizeof(snapshot->privatization_index));
193   } else
194 #endif
195   {
196     snapshot->privatization_index = simgrid::mc::ProcessIndexMissing;
197   }
198 }
199
200 /** \brief Fills the position of the segments (executable, read-only, read/write).
201  *
202  *  `dl_iterate_phdr` would be more robust but would not work in cross-process.
203  * */
204 void MC_find_object_address(std::vector<simgrid::mc::VmMap> const& maps, mc_object_info_t result)
205 {
206   const char *name = basename(result->file_name);
207   for (size_t i = 0; i < maps.size(); ++i) {
208     simgrid::mc::VmMap const& reg = maps[i];
209     if (maps[i].pathname.empty()
210         || strcmp(basename(maps[i].pathname.c_str()), name)) {
211       // Nothing to do
212     } else if ((reg.prot & PROT_WRITE)) {
213       xbt_assert(!result->start_rw,
214                  "Multiple read-write segments for %s, not supported",
215                  maps[i].pathname.c_str());
216       result->start_rw = (char*) reg.start_addr;
217       result->end_rw = (char*) reg.end_addr;
218       // .bss is usually after the .data:
219       simgrid::mc::VmMap const& next = maps[i + 1];
220       if (next.pathname.empty() && (next.prot & PROT_WRITE)
221           && next.start_addr == reg.end_addr) {
222         result->end_rw = (char*) maps[i + 1].end_addr;
223       }
224     } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)) {
225       xbt_assert(!result->start_exec,
226                  "Multiple executable segments for %s, not supported",
227                  maps[i].pathname.c_str());
228       result->start_exec = (char*) reg.start_addr;
229       result->end_exec = (char*) reg.end_addr;
230     } else if ((reg.prot & PROT_READ) && !(reg.prot & PROT_EXEC)) {
231       xbt_assert(!result->start_ro,
232                  "Multiple read only segments for %s, not supported",
233                  maps[i].pathname.c_str());
234       result->start_ro = (char*) reg.start_addr;
235       result->end_ro = (char*) reg.end_addr;
236     }
237   }
238
239   result->start = result->start_rw;
240   if ((const void*) result->start_ro > result->start)
241     result->start = result->start_ro;
242   if ((const void*) result->start_exec > result->start)
243     result->start = result->start_exec;
244
245   result->end = result->end_rw;
246   if (result->end_ro && (const void*) result->end_ro < result->end)
247     result->end = result->end_ro;
248   if (result->end_exec && (const void*) result->end_exec > result->end)
249     result->end = result->end_exec;
250
251   xbt_assert(result->file_name);
252   xbt_assert(result->start_rw);
253   xbt_assert(result->start_exec);
254 }
255
256 /************************************* Take Snapshot ************************************/
257 /****************************************************************************************/
258
259 /** \brief Checks whether the variable is in scope for a given IP.
260  *
261  *  A variable may be defined only from a given value of IP.
262  *
263  *  \param var   Variable description
264  *  \param frame Scope description
265  *  \param ip    Instruction pointer
266  *  \return      true if the variable is valid
267  * */
268 static bool mc_valid_variable(dw_variable_t var, dw_frame_t scope,
269                               const void *ip)
270 {
271   // The variable is not yet valid:
272   if ((const void *) ((const char *) scope->low_pc + var->start_scope) > ip)
273     return false;
274   else
275     return true;
276 }
277
278 static void mc_fill_local_variables_values(mc_stack_frame_t stack_frame,
279                                            dw_frame_t scope, int process_index,
280                                            std::vector<s_local_variable>& result)
281 {
282   mc_process_t process = &mc_model_checker->process();
283
284   void *ip = (void *) stack_frame->ip;
285   if (ip < scope->low_pc || ip >= scope->high_pc)
286     return;
287
288   unsigned cursor = 0;
289   dw_variable_t current_variable;
290   xbt_dynar_foreach(scope->variables, cursor, current_variable) {
291
292     if (!mc_valid_variable(current_variable, scope, (void *) stack_frame->ip))
293       continue;
294
295     int region_type;
296     // FIXME, get rid of `region_type`
297     if ((long) stack_frame->ip > (long) process->libsimgrid_info->start_exec)
298       region_type = 1;
299     else
300       region_type = 2;
301
302     s_local_variable_t new_var;
303     new_var.subprogram = stack_frame->frame;
304     new_var.ip = stack_frame->ip;
305     new_var.name = current_variable->name;
306     new_var.type = current_variable->type;
307     new_var.region = region_type;
308     new_var.address = nullptr;
309
310     if (current_variable->address != NULL) {
311       new_var.address = current_variable->address;
312     } else if (current_variable->locations.size != 0) {
313       s_mc_location_t location;
314       mc_dwarf_resolve_locations(
315         &location, &current_variable->locations,
316         current_variable->object_info,
317         &(stack_frame->unw_cursor),
318         (void *) stack_frame->frame_base,
319         &mc_model_checker->process(), process_index);
320
321       switch(mc_get_location_type(&location)) {
322       case MC_LOCATION_TYPE_ADDRESS:
323         new_var.address = location.memory_location;
324         break;
325       case MC_LOCATION_TYPE_REGISTER:
326       default:
327         xbt_die("Cannot handle non-address variable");
328       }
329
330     } else {
331       xbt_die("No address");
332     }
333
334     result.push_back(std::move(new_var));
335   }
336
337   // Recursive processing of nested scopes:
338   dw_frame_t nested_scope = NULL;
339   xbt_dynar_foreach(scope->scopes, cursor, nested_scope) {
340     mc_fill_local_variables_values(stack_frame, nested_scope, process_index, result);
341   }
342 }
343
344 static std::vector<s_local_variable> MC_get_local_variables_values(
345   std::vector<s_mc_stack_frame_t>& stack_frames, int process_index)
346 {
347   std::vector<s_local_variable> variables;
348   for (s_mc_stack_frame_t& stack_frame : stack_frames)
349     mc_fill_local_variables_values(&stack_frame, stack_frame.frame, process_index, variables);
350   return std::move(variables);
351 }
352
353 static void MC_stack_frame_free_voipd(void *s)
354 {
355   mc_stack_frame_t stack_frame = *(mc_stack_frame_t *) s;
356   delete(stack_frame);
357 }
358
359 static std::vector<s_mc_stack_frame_t> MC_unwind_stack_frames(mc_unw_context_t stack_context)
360 {
361   mc_process_t process = &mc_model_checker->process();
362   std::vector<s_mc_stack_frame_t> result;
363
364   unw_cursor_t c;
365
366   // TODO, check condition check (unw_init_local==0 means end of frame)
367   if (mc_unw_init_cursor(&c, stack_context) != 0) {
368
369     xbt_die("Could not initialize stack unwinding");
370
371   } else
372     while (1) {
373
374       s_mc_stack_frame_t stack_frame;
375
376       stack_frame.unw_cursor = c;
377
378       unw_word_t ip, sp;
379
380       unw_get_reg(&c, UNW_REG_IP, &ip);
381       unw_get_reg(&c, UNW_REG_SP, &sp);
382
383       stack_frame.ip = ip;
384       stack_frame.sp = sp;
385
386       // TODO, use real addresses in frame_t instead of fixing it here
387
388       dw_frame_t frame = process->find_function(remote(ip));
389       stack_frame.frame = frame;
390
391       if (frame) {
392         stack_frame.frame_name = frame->name;
393         stack_frame.frame_base =
394             (unw_word_t) mc_find_frame_base(frame, frame->object_info, &c);
395       } else {
396         stack_frame.frame_base = 0;
397         stack_frame.frame_name = std::string();
398       }
399
400       result.push_back(std::move(stack_frame));
401
402       /* Stop before context switch with maestro */
403       if (frame != NULL && frame->name != NULL
404           && !strcmp(frame->name, "smx_ctx_sysv_wrapper"))
405         break;
406
407       int ret = unw_step(&c);
408       if (ret == 0) {
409         xbt_die("Unexpected end of stack.");
410       } else if (ret < 0) {
411         xbt_die("Error while unwinding stack");
412       }
413     }
414
415   if (result.empty()) {
416     XBT_INFO("unw_init_local failed");
417     xbt_abort();
418   }
419
420   return std::move(result);
421 };
422
423 static std::vector<s_mc_snapshot_stack_t> MC_take_snapshot_stacks(mc_snapshot_t * snapshot)
424 {
425   std::vector<s_mc_snapshot_stack_t> res;
426
427   unsigned int cursor = 0;
428   stack_region_t current_stack;
429
430   // FIXME, cross-process support (stack_areas)
431   xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
432     s_mc_snapshot_stack_t st;
433
434     // Read the context from remote process:
435     unw_context_t context;
436     mc_model_checker->process().read_bytes(
437       &context, sizeof(context), remote(current_stack->context));
438
439     st.context = xbt_new0(s_mc_unw_context_t, 1);
440     if (mc_unw_init_context(st.context, &mc_model_checker->process(),
441       &context) < 0) {
442       xbt_die("Could not initialise the libunwind context.");
443     }
444     st.stack_frames = MC_unwind_stack_frames(st.context);
445     st.local_variables = MC_get_local_variables_values(st.stack_frames, current_stack->process_index);
446     st.process_index = current_stack->process_index;
447
448     unw_word_t sp = st.stack_frames[0].sp;
449
450     res.push_back(std::move(st));
451
452     size_t stack_size =
453       (char*) current_stack->address + current_stack->size - (char*) sp;
454     (*snapshot)->stack_sizes.push_back(stack_size);
455   }
456
457   return std::move(res);
458
459 }
460
461 static std::vector<s_mc_heap_ignore_region_t> MC_take_snapshot_ignore()
462 {
463   std::vector<s_mc_heap_ignore_region_t> res;
464
465   if (mc_heap_comparison_ignore == NULL)
466     return std::move(res);
467
468   unsigned int cursor = 0;
469   mc_heap_ignore_region_t current_region;
470
471   xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region) {
472     s_mc_heap_ignore_region_t new_region;
473     new_region.address = current_region->address;
474     new_region.size = current_region->size;
475     new_region.block = current_region->block;
476     new_region.fragment = current_region->fragment;
477     res.push_back(std::move(new_region));
478   }
479
480   return std::move(res);
481 }
482
483 static void MC_snapshot_handle_ignore(mc_snapshot_t snapshot)
484 {
485   xbt_assert(snapshot->process);
486   
487   // Copy the memory:
488   for (auto const& region : mc_model_checker->process().ignored_regions()) {
489     s_mc_snapshot_ignored_data_t ignored_data;
490     ignored_data.start = (void*)region.addr;
491     ignored_data.data.resize(region.size);
492     // TODO, we should do this once per privatization segment:
493     snapshot->process->read_bytes(
494       ignored_data.data.data(), region.size, remote(region.addr),
495       simgrid::mc::ProcessIndexDisabled);
496     snapshot->ignored_data.push_back(std::move(ignored_data));
497   }
498
499   // Zero the memory:
500   for(auto const& region : mc_model_checker->process().ignored_regions()) {
501     snapshot->process->clear_bytes(remote(region.addr), region.size);
502   }
503
504 }
505
506 static void MC_snapshot_ignore_restore(mc_snapshot_t snapshot)
507 {
508   for (auto const& ignored_data : snapshot->ignored_data)
509     snapshot->process->write_bytes(
510       ignored_data.data.data(), ignored_data.data.size(),
511       remote(ignored_data.start));
512 }
513
514 static std::vector<s_fd_infos_t> MC_get_current_fds(pid_t pid)
515 {
516   const size_t fd_dir_path_size = 20;
517   char fd_dir_path[fd_dir_path_size];
518   int res = snprintf(fd_dir_path, fd_dir_path_size,
519     "/proc/%lli/fd", (long long int) pid);
520   xbt_assert(res >= 0);
521   if ((size_t) res > fd_dir_path_size)
522     xbt_die("Unexpected buffer is too small for fd_dir_path");
523
524   DIR* fd_dir = opendir(fd_dir_path);
525   if (fd_dir == NULL)
526     xbt_die("Cannot open directory '/proc/self/fd'\n");
527
528   std::vector<s_fd_infos_t> fds;
529
530   struct dirent* fd_number;
531   while ((fd_number = readdir(fd_dir))) {
532
533     int fd_value = atoi(fd_number->d_name);
534
535     if(fd_value < 3)
536       continue;
537
538     const size_t source_size = 25;
539     char source[25];
540     int res = snprintf(source, source_size, "/proc/%lli/fd/%s",
541         (long long int) pid, fd_number->d_name);
542     xbt_assert(res >= 0);
543     if ((size_t) res > source_size)
544       xbt_die("Unexpected buffer is too small for fd %s", fd_number->d_name);
545
546     const size_t link_size = 200;
547     char link[200];
548     res = readlink(source, link, link_size);
549     if (res<0) {
550       xbt_die("Could not read link for %s", source);
551     }
552     if (res==200) {
553       xbt_die("Buffer to small for link of %s", source);
554     }
555     link[res] = '\0';
556
557     if(smpi_is_privatisation_file(link))
558       continue;
559
560     // This is (probably) the DIR* we are reading:
561     // TODO, read all the file entries at once and close the DIR.*
562     if(strcmp(fd_dir_path, link) == 0)
563       continue;
564
565     // We don't handle them.
566     // It does not mean we should silently ignore them however.
567     if (strncmp(link, "pipe:", 5) == 0 || strncmp(link, "socket:", 7) == 0)
568       continue;
569
570     // If dot_output enabled, do not handle the corresponding file
571     if (dot_output !=  NULL && strcmp(basename(link), _sg_mc_dot_output_file) == 0)
572       continue;
573
574     // This is probably a shared memory used by lttng-ust:
575     if(strncmp("/dev/shm/ust-shm-tmp-", link, 21)==0)
576       continue;
577
578     // Add an entry for this FD in the snapshot:
579     s_fd_infos_t fd;
580     fd.filename = std::string(link);
581     fd.number = fd_value;
582     fd.flags = fcntl(fd_value, F_GETFL) | fcntl(fd_value, F_GETFD) ;
583     fd.current_position = lseek(fd_value, 0, SEEK_CUR);
584     fds.push_back(std::move(fd));
585   }
586
587   closedir (fd_dir);
588   return std::move(fds);
589 }
590
591 mc_snapshot_t MC_take_snapshot(int num_state)
592 {
593   XBT_DEBUG("Taking snapshot %i", num_state);
594
595   mc_process_t mc_process = &mc_model_checker->process();
596
597   mc_snapshot_t snapshot = new simgrid::mc::Snapshot();
598
599   snapshot->process = mc_process;
600   snapshot->num_state = num_state;
601
602   smx_process_t process;
603   MC_EACH_SIMIX_PROCESS(process,
604     snapshot->enabled_processes.insert(process->pid));
605
606   MC_snapshot_handle_ignore(snapshot);
607
608   if (_sg_mc_snapshot_fds)
609     snapshot->current_fds = MC_get_current_fds(process->pid);
610
611   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
612   MC_get_memory_regions(mc_process, snapshot);
613
614   snapshot->to_ignore = MC_take_snapshot_ignore();
615
616   if (_sg_mc_visited > 0 || strcmp(_sg_mc_property_file, "")) {
617     snapshot->stacks =
618         MC_take_snapshot_stacks(&snapshot);
619     if (_sg_mc_hash && !snapshot->stacks.empty()) {
620       snapshot->hash = mc_hash_processes_state(num_state, snapshot->stacks);
621     } else {
622       snapshot->hash = 0;
623     }
624   } else {
625     snapshot->hash = 0;
626   }
627
628   MC_snapshot_ignore_restore(snapshot);
629   return snapshot;
630 }
631
632 static inline
633 void MC_restore_snapshot_regions(mc_snapshot_t snapshot)
634 {
635   for(std::unique_ptr<s_mc_mem_region_t> const& region : snapshot->snapshot_regions) {
636     // For privatized, variables we decided it was not necessary to take the snapshot:
637     if (region)
638       MC_region_restore(region.get());
639   }
640
641 #ifdef HAVE_SMPI
642   // TODO, send a message to implement this in the MCed process
643   if(snapshot->privatization_index >= 0) {
644     // We just rewrote the global variables.
645     // The privatisation segment SMPI thinks
646     // is mapped might be inconsistent with the segment which
647     // is really mapped in memory (kernel state).
648     // We ask politely SMPI to map the segment anyway,
649     // even if it thinks it is the current one:
650     smpi_really_switch_data_segment(snapshot->privatization_index);
651   }
652 #endif
653 }
654
655 static inline
656 void MC_restore_snapshot_fds(mc_snapshot_t snapshot)
657 {
658   if (mc_mode == MC_MODE_SERVER)
659     xbt_die("FD snapshot not implemented in client/server mode.");
660
661   for (auto const& fd : snapshot->current_fds) {
662     
663     int new_fd = open(fd.filename.c_str(), fd.flags);
664     if (new_fd < 0) {
665       xbt_die("Could not reopen the file %s fo restoring the file descriptor",
666         fd.filename.c_str());
667     }
668     if (new_fd != fd.number) {
669       dup2(new_fd, fd.number);
670       close(new_fd);
671     };
672     lseek(fd.number, fd.current_position, SEEK_SET);
673   }
674 }
675
676 void MC_restore_snapshot(mc_snapshot_t snapshot)
677 {
678   XBT_DEBUG("Restore snapshot %i", snapshot->num_state);
679   MC_restore_snapshot_regions(snapshot);
680   if (_sg_mc_snapshot_fds)
681     MC_restore_snapshot_fds(snapshot);
682   MC_snapshot_ignore_restore(snapshot);
683   mc_model_checker->process().cache_flags = 0;
684 }
685
686 mc_snapshot_t simcall_HANDLER_mc_snapshot(smx_simcall_t simcall)
687 {
688   return MC_take_snapshot(1);
689 }
690
691 }