Logo AND Algorithmique Numérique Distribuée

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