Logo AND Algorithmique Numérique Distribuée

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