Logo AND Algorithmique Numérique Distribuée

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