Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
61414d794ab5f4fae7309c55694eaa29a6b198fa
[simgrid.git] / src / mc / mc_checkpoint.c
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 #define _GNU_SOURCE
8
9 #include <unistd.h>
10
11 #include <string.h>
12 #include <link.h>
13 #include <dirent.h>
14
15 #include "internal_config.h"
16 #include "mc_memory_map.h"
17 #include "mc_private.h"
18 #include "xbt/module.h"
19 #include <xbt/mmalloc.h>
20 #include "../smpi/private.h"
21 #include <alloca.h>
22
23 #include "xbt/mmalloc/mmprivate.h"
24
25 #include "../simix/smx_private.h"
26
27 #include <libunwind.h>
28 #include <libelf.h>
29
30 #include "mc_private.h"
31 #include <mc/mc.h>
32
33 #include "mc_snapshot.h"
34 #include "mc_object_info.h"
35 #include "mc_mmu.h"
36 #include "mc_unw.h"
37 #include "mc_protocol.h"
38 #include "mc_smx.h"
39
40 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
41                                 "Logging specific to mc_checkpoint");
42
43 /************************************  Free functions **************************************/
44 /*****************************************************************************************/
45
46 static void MC_snapshot_stack_free(mc_snapshot_stack_t s)
47 {
48   if (s) {
49     xbt_dynar_free(&(s->local_variables));
50     xbt_dynar_free(&(s->stack_frames));
51     mc_unw_destroy_context(s->context);
52     xbt_free(s->context);
53     xbt_free(s);
54   }
55 }
56
57 static void MC_snapshot_stack_free_voidp(void *s)
58 {
59   mc_snapshot_stack_t stack = (mc_snapshot_stack_t) * (void **) s;
60   MC_snapshot_stack_free(stack);
61 }
62
63 static void local_variable_free(local_variable_t v)
64 {
65   xbt_free(v->name);
66   xbt_free(v);
67 }
68
69 static void local_variable_free_voidp(void *v)
70 {
71   local_variable_free((local_variable_t) * (void **) v);
72 }
73
74 void MC_region_destroy(mc_mem_region_t region)
75 {
76   if (!region)
77     return;
78   switch(region->storage_type) {
79     case MC_REGION_STORAGE_TYPE_NONE:
80       break;
81     case MC_REGION_STORAGE_TYPE_FLAT:
82       xbt_free(region->flat.data);
83       break;
84     case MC_REGION_STORAGE_TYPE_CHUNKED:
85       mc_free_page_snapshot_region(region->chunked.page_numbers, mc_page_count(region->size));
86       xbt_free(region->chunked.page_numbers);
87       break;
88     case MC_REGION_STORAGE_TYPE_PRIVATIZED:
89       {
90         size_t regions_count = region->privatized.regions_count;
91         for (size_t i=0; i!=regions_count; ++i) {
92           MC_region_destroy(region->privatized.regions[i]);
93         }
94         free(region->privatized.regions);
95         break;
96       }
97   }
98   xbt_free(region);
99 }
100
101 void MC_free_snapshot(mc_snapshot_t snapshot)
102 {
103   for (size_t i = 0; i < snapshot->snapshot_regions_count; i++) {
104     MC_region_destroy(snapshot->snapshot_regions[i]);
105   }
106   xbt_free(snapshot->snapshot_regions);
107   xbt_free(snapshot->stack_sizes);
108   xbt_dynar_free(&(snapshot->stacks));
109   xbt_dynar_free(&(snapshot->to_ignore));
110   xbt_dynar_free(&snapshot->ignored_data);
111   xbt_free(snapshot);
112 }
113
114 /*******************************  Snapshot regions ********************************/
115 /*********************************************************************************/
116
117 static mc_mem_region_t mc_region_new_dense(
118   mc_region_type_t region_type,
119   void *start_addr, void* permanent_addr, size_t size, mc_mem_region_t ref_reg)
120 {
121   mc_mem_region_t region = xbt_new(s_mc_mem_region_t, 1);
122   region->region_type = region_type;
123   region->storage_type = MC_REGION_STORAGE_TYPE_FLAT;
124   region->start_addr = start_addr;
125   region->permanent_addr = permanent_addr;
126   region->size = size;
127   region->flat.data = xbt_malloc(size);
128   MC_process_read(&mc_model_checker->process, MC_ADDRESS_SPACE_READ_FLAGS_NONE,
129     region->flat.data, permanent_addr, size,
130     MC_PROCESS_INDEX_DISABLED);
131   XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu",
132             region_type, region->flat.data, permanent_addr, size);
133   return region;
134 }
135
136 /** @brief Take a snapshot of a given region
137  *
138  * @param type
139  * @param start_addr   Address of the region in the simulated process
140  * @param permanent_addr Permanent address of this data (for privatized variables, this is the virtual address of the privatized mapping)
141  * @param size         Size of the data*
142  * @param ref_reg      Reference corresponding region
143  */
144 static mc_mem_region_t MC_region_new(mc_region_type_t type, void *start_addr, void* permanent_addr, size_t size, mc_mem_region_t ref_reg)
145 {
146   if (_sg_mc_sparse_checkpoint) {
147     return mc_region_new_sparse(type, start_addr, permanent_addr, size, ref_reg);
148   } else  {
149     return mc_region_new_dense(type, start_addr, permanent_addr, size, ref_reg);
150   }
151 }
152
153 /** @brief Restore a region from a snapshot
154  *
155  *  If we are using per page snapshots, it is possible to use the reference
156  *  region in order to do an incremental restoration of the region: the
157  *  softclean pages which are shared between the two snapshots do not need
158  *  to be restored.
159  *
160  *  @param reg     Target region
161  *  @param reg_reg Current region (if not NULL), used for lazy per page restoration
162  */
163 static void MC_region_restore(mc_mem_region_t region, mc_mem_region_t ref_region)
164 {
165   switch(region->storage_type) {
166   case MC_REGION_STORAGE_TYPE_NONE:
167   default:
168     xbt_die("Storage type not supported");
169     break;
170
171   case MC_REGION_STORAGE_TYPE_FLAT:
172     MC_process_write(&mc_model_checker->process, region->flat.data,
173       region->permanent_addr, region->size);
174     break;
175
176   case MC_REGION_STORAGE_TYPE_CHUNKED:
177     mc_region_restore_sparse(&mc_model_checker->process, region, ref_region);
178     break;
179
180   case MC_REGION_STORAGE_TYPE_PRIVATIZED:
181     {
182       bool has_ref_regions = ref_region &&
183         ref_region->storage_type == MC_REGION_STORAGE_TYPE_PRIVATIZED;
184       size_t process_count = region->privatized.regions_count;
185       for (size_t i = 0; i < process_count; i++) {
186         MC_region_restore(region->privatized.regions[i],
187           has_ref_regions ? ref_region->privatized.regions[i] : NULL);
188       }
189       break;
190     }
191   }
192 }
193
194 static mc_mem_region_t MC_region_new_privatized(
195     mc_region_type_t region_type, void *start_addr, void* permanent_addr, size_t size,
196     mc_mem_region_t ref_reg)
197 {
198   size_t process_count = MC_smpi_process_count();
199   mc_mem_region_t region = xbt_new(s_mc_mem_region_t, 1);
200   region->region_type = region_type;
201   region->storage_type = MC_REGION_STORAGE_TYPE_PRIVATIZED;
202   region->start_addr = start_addr;
203   region->permanent_addr = permanent_addr;
204   region->size = size;
205   region->privatized.regions_count = process_count;
206   region->privatized.regions = xbt_new(mc_mem_region_t, process_count);
207
208   // Read smpi_privatisation_regions from MCed:
209   smpi_privatisation_region_t remote_smpi_privatisation_regions;
210   MC_process_read_variable(&mc_model_checker->process,
211     "smpi_privatisation_regions",
212     &remote_smpi_privatisation_regions, sizeof(remote_smpi_privatisation_regions));
213   s_smpi_privatisation_region_t privatisation_regions[process_count];
214   MC_process_read_simple(&mc_model_checker->process, &privatisation_regions,
215     remote_smpi_privatisation_regions, sizeof(privatisation_regions));
216
217   for (size_t i = 0; i < process_count; i++) {
218     mc_mem_region_t ref_subreg = NULL;
219     if (ref_reg && ref_reg->storage_type == MC_REGION_STORAGE_TYPE_PRIVATIZED)
220       ref_subreg = ref_reg->privatized.regions[i];
221     region->privatized.regions[i] =
222       MC_region_new(region_type, start_addr,
223         privatisation_regions[i].address, size,
224         ref_subreg);
225   }
226
227   return region;
228 }
229
230 static void MC_snapshot_add_region(int index, mc_snapshot_t snapshot, mc_region_type_t type,
231                                   mc_object_info_t object_info,
232                                   void *start_addr, void* permanent_addr, size_t size)
233 {
234   if (type == MC_REGION_TYPE_DATA)
235     xbt_assert(object_info, "Missing object info for object.");
236   else if (type == MC_REGION_TYPE_HEAP)
237     xbt_assert(!object_info, "Unexpected object info for heap region.");
238
239   mc_mem_region_t ref_reg = NULL;
240   if (mc_model_checker->parent_snapshot)
241     ref_reg = mc_model_checker->parent_snapshot->snapshot_regions[index];
242
243   mc_mem_region_t region;
244   const bool privatization_aware = MC_object_info_is_privatized(object_info);
245   if (privatization_aware && MC_smpi_process_count())
246     region = MC_region_new_privatized(type, start_addr, permanent_addr, size, ref_reg);
247   else
248     region = MC_region_new(type, start_addr, permanent_addr, size, ref_reg);
249
250   region->object_info = object_info;
251   snapshot->snapshot_regions[index] = region;
252   return;
253 }
254
255 static void MC_get_memory_regions(mc_process_t process, mc_snapshot_t snapshot)
256 {
257   const size_t n = process->object_infos_size;
258   snapshot->snapshot_regions_count = n + 1;
259   snapshot->snapshot_regions = xbt_new0(mc_mem_region_t, n + 1);
260
261   for (size_t i = 0; i!=n; ++i) {
262     mc_object_info_t object_info = process->object_infos[i];
263     MC_snapshot_add_region(i, snapshot, MC_REGION_TYPE_DATA, object_info,
264       object_info->start_rw, object_info->start_rw,
265       object_info->end_rw - object_info->start_rw);
266   }
267
268   xbt_mheap_t heap = MC_process_get_heap(process);
269   void *start_heap = heap->base;
270   void *end_heap = heap->breakval;
271
272   MC_snapshot_add_region(n, snapshot, MC_REGION_TYPE_HEAP, NULL,
273                         start_heap, start_heap,
274                         (char *) end_heap - (char *) start_heap);
275   snapshot->heap_bytes_used = mmalloc_get_bytes_used_remote(
276     heap->heaplimit,
277     MC_process_get_malloc_info(process));
278
279 #ifdef HAVE_SMPI
280   if (smpi_privatize_global_variables && MC_smpi_process_count()) {
281     // FIXME, cross-process
282     snapshot->privatization_index = smpi_loaded_page;
283   } else
284 #endif
285   {
286     snapshot->privatization_index = MC_PROCESS_INDEX_MISSING;
287   }
288 }
289
290 /** \brief Fills the position of the segments (executable, read-only, read/write).
291  *
292  *  `dl_iterate_phdr` would be more robust but would not work in cross-process.
293  * */
294 void MC_find_object_address(memory_map_t maps, mc_object_info_t result)
295 {
296   unsigned int i = 0;
297   s_map_region_t reg;
298   const char *name = basename(result->file_name);
299   while (i < maps->mapsize) {
300     reg = maps->regions[i];
301     if (maps->regions[i].pathname == NULL
302         || strcmp(basename(maps->regions[i].pathname), name)) {
303       // Nothing to do
304     } else if ((reg.prot & PROT_WRITE)) {
305       xbt_assert(!result->start_rw,
306                  "Multiple read-write segments for %s, not supported",
307                  maps->regions[i].pathname);
308       result->start_rw = reg.start_addr;
309       result->end_rw = reg.end_addr;
310       // .bss is usually after the .data:
311       s_map_region_t *next = &(maps->regions[i + 1]);
312       if (next->pathname == NULL && (next->prot & PROT_WRITE)
313           && next->start_addr == reg.end_addr) {
314         result->end_rw = maps->regions[i + 1].end_addr;
315       }
316     } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)) {
317       xbt_assert(!result->start_exec,
318                  "Multiple executable segments for %s, not supported",
319                  maps->regions[i].pathname);
320       result->start_exec = reg.start_addr;
321       result->end_exec = reg.end_addr;
322     } else if ((reg.prot & PROT_READ) && !(reg.prot & PROT_EXEC)) {
323       xbt_assert(!result->start_ro,
324                  "Multiple read only segments for %s, not supported",
325                  maps->regions[i].pathname);
326       result->start_ro = reg.start_addr;
327       result->end_ro = reg.end_addr;
328     }
329     i++;
330   }
331
332   result->start = result->start_rw;
333   if ((const void*) result->start_ro > result->start)
334     result->start = result->start_ro;
335   if ((const void*) result->start_exec > result->start)
336     result->start = result->start_exec;
337
338   result->end = result->end_rw;
339   if (result->end_ro && (const void*) result->end_ro < result->end)
340     result->end = result->end_ro;
341   if (result->end_exec && (const void*) result->end_exec > result->end)
342     result->end = result->end_exec;
343
344   xbt_assert(result->file_name);
345   xbt_assert(result->start_rw);
346   xbt_assert(result->start_exec);
347 }
348
349 /************************************* Take Snapshot ************************************/
350 /****************************************************************************************/
351
352 /** \brief Checks whether the variable is in scope for a given IP.
353  *
354  *  A variable may be defined only from a given value of IP.
355  *
356  *  \param var   Variable description
357  *  \param frame Scope description
358  *  \param ip    Instruction pointer
359  *  \return      true if the variable is valid
360  * */
361 static bool mc_valid_variable(dw_variable_t var, dw_frame_t scope,
362                               const void *ip)
363 {
364   // The variable is not yet valid:
365   if ((const void *) ((const char *) scope->low_pc + var->start_scope) > ip)
366     return false;
367   else
368     return true;
369 }
370
371 static void mc_fill_local_variables_values(mc_stack_frame_t stack_frame,
372                                            dw_frame_t scope, int process_index, xbt_dynar_t result)
373 {
374   mc_process_t process = &mc_model_checker->process;
375
376   void *ip = (void *) stack_frame->ip;
377   if (ip < scope->low_pc || ip >= scope->high_pc)
378     return;
379
380   unsigned cursor = 0;
381   dw_variable_t current_variable;
382   xbt_dynar_foreach(scope->variables, cursor, current_variable) {
383
384     if (!mc_valid_variable(current_variable, scope, (void *) stack_frame->ip))
385       continue;
386
387     int region_type;
388     // FIXME, get rid of `region_type`
389     if ((long) stack_frame->ip > (long) process->libsimgrid_info->start_exec)
390       region_type = 1;
391     else
392       region_type = 2;
393
394     local_variable_t new_var = xbt_new0(s_local_variable_t, 1);
395     new_var->subprogram = stack_frame->frame;
396     new_var->ip = stack_frame->ip;
397     new_var->name = xbt_strdup(current_variable->name);
398     new_var->type = current_variable->type;
399     new_var->region = region_type;
400
401     if (current_variable->address != NULL) {
402       new_var->address = current_variable->address;
403     } else if (current_variable->locations.size != 0) {
404       s_mc_location_t location;
405       // FIXME, cross-process support
406       mc_dwarf_resolve_locations(&location, &current_variable->locations,
407                                               current_variable->object_info,
408                                               &(stack_frame->unw_cursor),
409                                               (void *) stack_frame->frame_base,
410                                               NULL, process_index);
411
412       switch(mc_get_location_type(&location)) {
413       case MC_LOCATION_TYPE_ADDRESS:
414         new_var->address = location.memory_location;
415         break;
416       case MC_LOCATION_TYPE_REGISTER:
417       default:
418         xbt_die("Cannot handle non-address variable");
419       }
420
421     } else {
422       xbt_die("No address");
423     }
424
425     xbt_dynar_push(result, &new_var);
426   }
427
428   // Recursive processing of nested scopes:
429   dw_frame_t nested_scope = NULL;
430   xbt_dynar_foreach(scope->scopes, cursor, nested_scope) {
431     mc_fill_local_variables_values(stack_frame, nested_scope, process_index, result);
432   }
433 }
434
435 static xbt_dynar_t MC_get_local_variables_values(xbt_dynar_t stack_frames, int process_index)
436 {
437
438   unsigned cursor1 = 0;
439   mc_stack_frame_t stack_frame;
440   xbt_dynar_t variables =
441       xbt_dynar_new(sizeof(local_variable_t), local_variable_free_voidp);
442
443   xbt_dynar_foreach(stack_frames, cursor1, stack_frame) {
444     mc_fill_local_variables_values(stack_frame, stack_frame->frame, process_index, variables);
445   }
446
447   return variables;
448 }
449
450 static void MC_stack_frame_free_voipd(void *s)
451 {
452   mc_stack_frame_t stack_frame = *(mc_stack_frame_t *) s;
453   if (stack_frame) {
454     xbt_free(stack_frame->frame_name);
455     xbt_free(stack_frame);
456   }
457 }
458
459 static xbt_dynar_t MC_unwind_stack_frames(mc_unw_context_t stack_context)
460 {
461   mc_process_t process = &mc_model_checker->process;
462   xbt_dynar_t result =
463       xbt_dynar_new(sizeof(mc_stack_frame_t), MC_stack_frame_free_voipd);
464
465   unw_cursor_t c;
466
467   // TODO, check condition check (unw_init_local==0 means end of frame)
468   if (mc_unw_init_cursor(&c, stack_context) != 0) {
469
470     xbt_die("Could not initialize stack unwinding");
471
472   } else
473     while (1) {
474
475       mc_stack_frame_t stack_frame = xbt_new(s_mc_stack_frame_t, 1);
476       xbt_dynar_push(result, &stack_frame);
477
478       stack_frame->unw_cursor = c;
479
480       unw_word_t ip, sp;
481
482       unw_get_reg(&c, UNW_REG_IP, &ip);
483       unw_get_reg(&c, UNW_REG_SP, &sp);
484
485       stack_frame->ip = ip;
486       stack_frame->sp = sp;
487
488       // TODO, use real addresses in frame_t instead of fixing it here
489
490       dw_frame_t frame = MC_process_find_function(process, (void *) ip);
491       stack_frame->frame = frame;
492
493       if (frame) {
494         stack_frame->frame_name = xbt_strdup(frame->name);
495         stack_frame->frame_base =
496             (unw_word_t) mc_find_frame_base(frame, frame->object_info, &c);
497       } else {
498         stack_frame->frame_base = 0;
499         stack_frame->frame_name = NULL;
500       }
501
502       /* Stop before context switch with maestro */
503       if (frame != NULL && frame->name != NULL
504           && !strcmp(frame->name, "smx_ctx_sysv_wrapper"))
505         break;
506
507       int ret = unw_step(&c);
508       if (ret == 0) {
509         xbt_die("Unexpected end of stack.");
510       } else if (ret < 0) {
511         xbt_die("Error while unwinding stack");
512       }
513     }
514
515   if (xbt_dynar_length(result) == 0) {
516     XBT_INFO("unw_init_local failed");
517     xbt_abort();
518   }
519
520   return result;
521 };
522
523 static xbt_dynar_t MC_take_snapshot_stacks(mc_snapshot_t * snapshot)
524 {
525
526   xbt_dynar_t res =
527       xbt_dynar_new(sizeof(s_mc_snapshot_stack_t),
528                     MC_snapshot_stack_free_voidp);
529
530   unsigned int cursor = 0;
531   stack_region_t current_stack;
532
533   // FIXME, cross-process support (stack_areas)
534   xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
535     mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
536
537     unw_context_t* original_context = (unw_context_t*) current_stack->context;
538
539     st->context = xbt_new0(s_mc_unw_context_t, 1);
540     if (mc_unw_init_context(st->context, &mc_model_checker->process,
541       original_context) < 0) {
542       xbt_die("Could not initialise the libunwind context.");
543     }
544
545     st->stack_frames = MC_unwind_stack_frames(st->context);
546     st->local_variables = MC_get_local_variables_values(st->stack_frames, current_stack->process_index);
547     st->process_index = current_stack->process_index;
548
549     unw_word_t sp = xbt_dynar_get_as(st->stack_frames, 0, mc_stack_frame_t)->sp;
550
551     xbt_dynar_push(res, &st);
552     (*snapshot)->stack_sizes =
553         xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
554     (*snapshot)->stack_sizes[cursor] =
555       (char*) current_stack->address + current_stack->size - (char*) sp;
556   }
557
558   return res;
559
560 }
561
562 static xbt_dynar_t MC_take_snapshot_ignore()
563 {
564
565   if (mc_heap_comparison_ignore == NULL)
566     return NULL;
567
568   xbt_dynar_t cpy =
569       xbt_dynar_new(sizeof(mc_heap_ignore_region_t),
570                     heap_ignore_region_free_voidp);
571
572   unsigned int cursor = 0;
573   mc_heap_ignore_region_t current_region;
574
575   xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region) {
576     mc_heap_ignore_region_t new_region = NULL;
577     new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
578     new_region->address = current_region->address;
579     new_region->size = current_region->size;
580     new_region->block = current_region->block;
581     new_region->fragment = current_region->fragment;
582     xbt_dynar_push(cpy, &new_region);
583   }
584
585   return cpy;
586
587 }
588
589 static void mc_free_snapshot_ignored_data_pvoid(void* data) {
590   mc_snapshot_ignored_data_t ignored_data = (mc_snapshot_ignored_data_t) data;
591   free(ignored_data->data);
592 }
593
594 static void MC_snapshot_handle_ignore(mc_snapshot_t snapshot)
595 {
596   xbt_assert(snapshot->process);
597   snapshot->ignored_data = xbt_dynar_new(sizeof(s_mc_snapshot_ignored_data_t), mc_free_snapshot_ignored_data_pvoid);
598
599   // Copy the memory:
600   unsigned int cursor = 0;
601   mc_checkpoint_ignore_region_t region;
602   xbt_dynar_foreach (mc_model_checker->process.checkpoint_ignore, cursor, region) {
603     s_mc_snapshot_ignored_data_t ignored_data;
604     ignored_data.start = region->addr;
605     ignored_data.size = region->size;
606     ignored_data.data = malloc(region->size);
607     // TODO, we should do this once per privatization segment:
608     MC_process_read(snapshot->process,
609       MC_ADDRESS_SPACE_READ_FLAGS_NONE,
610       ignored_data.data, region->addr, region->size, MC_PROCESS_INDEX_DISABLED);
611     xbt_dynar_push(snapshot->ignored_data, &ignored_data);
612   }
613
614   // Zero the memory:
615   xbt_dynar_foreach (mc_model_checker->process.checkpoint_ignore, cursor, region) {
616     MC_process_clear_memory(snapshot->process, region->addr, region->size);
617   }
618
619 }
620
621 static void MC_snapshot_ignore_restore(mc_snapshot_t snapshot)
622 {
623   unsigned int cursor = 0;
624   s_mc_snapshot_ignored_data_t ignored_data;
625   xbt_dynar_foreach (snapshot->ignored_data, cursor, ignored_data) {
626     MC_process_write(snapshot->process,
627       ignored_data.data, ignored_data.start, ignored_data.size);
628   }
629 }
630
631 /** @brief Can we remove this snapshot?
632  *
633  * Some snapshots cannot be removed (yet) because we need them
634  * at this point.
635  *
636  * @param snapshot
637  */
638 int mc_important_snapshot(mc_snapshot_t snapshot)
639 {
640   // We need this snapshot in order to know which
641   // pages needs to be stored in the next snapshot.
642   // This field is only non-NULL when using soft-dirty
643   // page tracking.
644   if (snapshot == mc_model_checker->parent_snapshot)
645     return true;
646
647   return false;
648 }
649
650 static void MC_get_current_fd(mc_snapshot_t snapshot)
651 {
652
653   snapshot->total_fd = 0;
654
655   const size_t fd_dir_path_size = 20;
656   char fd_dir_path[fd_dir_path_size];
657   if (snprintf(fd_dir_path, fd_dir_path_size,
658     "/proc/%lli/fd", (long long int) snapshot->process->pid) > fd_dir_path_size)
659     xbt_die("Unexpected buffer is too small for fd_dir_path");
660
661   DIR* fd_dir = opendir(fd_dir_path);
662   if (fd_dir == NULL)
663     xbt_die("Cannot open directory '/proc/self/fd'\n");
664
665   size_t total_fd = 0;
666   struct dirent* fd_number;
667   while ((fd_number = readdir(fd_dir))) {
668
669     int fd_value = atoi(fd_number->d_name);
670
671     if(fd_value < 3)
672       continue;
673
674     const size_t source_size = 25;
675     char source[25];
676     if (snprintf(source, source_size, "/proc/%lli/fd/%s",
677         (long long int) snapshot->process->pid, fd_number->d_name) > source_size)
678       xbt_die("Unexpected buffer is too small for fd %s", fd_number->d_name);
679
680     const size_t link_size = 200;
681     char link[200];
682     int res = readlink(source, link, link_size);
683     if (res<0) {
684       xbt_die("Could not read link for %s", source);
685     }
686     if (res==200) {
687       xbt_die("Buffer to small for link of %s", source);
688     }
689     link[res] = '\0';
690
691     if(smpi_is_privatisation_file(link))
692       continue;
693
694     // This is (probably) the DIR* we are reading:
695     // TODO, read all the file entries at once and close the DIR.*
696     if(strcmp(fd_dir_path, link) == 0)
697       continue;
698
699     // We don't handle them.
700     // It does not mean we should silently ignore them however.
701     if (strncmp(link, "pipe:", 5) == 0 || strncmp(link, "socket:", 7) == 0)
702       continue;
703
704     // If dot_output enabled, do not handle the corresponding file
705     if (dot_output !=  NULL && strcmp(basename(link), _sg_mc_dot_output_file) == 0)
706       continue;
707
708     // This is probably a shared memory used by lttng-ust:
709     if(strncmp("/dev/shm/ust-shm-tmp-", link, 21)==0)
710       continue;
711
712     // Add an entry for this FD in the snapshot:
713     fd_infos_t fd = xbt_new0(s_fd_infos_t, 1);
714     fd->filename = strdup(link);
715     fd->number = fd_value;
716     fd->flags = fcntl(fd_value, F_GETFL) | fcntl(fd_value, F_GETFD) ;
717     fd->current_position = lseek(fd_value, 0, SEEK_CUR);
718     snapshot->current_fd = xbt_realloc(snapshot->current_fd, (total_fd + 1) * sizeof(fd_infos_t));
719     snapshot->current_fd[total_fd] = fd;
720     total_fd++;
721   }
722
723   snapshot->total_fd = total_fd;
724   closedir (fd_dir);
725 }
726
727 static s_mc_address_space_class_t mc_snapshot_class = {
728   .read = (void*) &MC_snapshot_read
729 };
730
731 mc_snapshot_t MC_take_snapshot(int num_state)
732 {
733   mc_process_t mc_process = &mc_model_checker->process;
734   mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
735   snapshot->process = mc_process;
736   snapshot->address_space.address_space_class = &mc_snapshot_class;
737
738   snapshot->enabled_processes = xbt_dynar_new(sizeof(int), NULL);
739
740   smx_process_t process;
741   MC_EACH_SIMIX_PROCESS(process,
742     xbt_dynar_push_as(snapshot->enabled_processes, int, (int)process->pid));
743
744   MC_snapshot_handle_ignore(snapshot);
745
746   if (_sg_mc_snapshot_fds)
747     MC_get_current_fd(snapshot);
748
749   const bool use_soft_dirty = _sg_mc_sparse_checkpoint
750     && _sg_mc_soft_dirty
751     && MC_process_is_self(mc_process);
752
753   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
754   MC_get_memory_regions(mc_process, snapshot);
755   if (use_soft_dirty)
756     mc_softdirty_reset();
757
758   snapshot->to_ignore = MC_take_snapshot_ignore();
759
760   if (_sg_mc_visited > 0 || strcmp(_sg_mc_property_file, "")) {
761     snapshot->stacks =
762         MC_take_snapshot_stacks(&snapshot);
763     if (_sg_mc_hash && snapshot->stacks != NULL) {
764       snapshot->hash = mc_hash_processes_state(num_state, snapshot->stacks);
765     } else {
766       snapshot->hash = 0;
767     }
768   } else {
769     snapshot->hash = 0;
770   }
771
772   MC_snapshot_ignore_restore(snapshot);
773   if (use_soft_dirty)
774     mc_model_checker->parent_snapshot = snapshot;
775   return snapshot;
776 }
777
778 static inline
779 void MC_restore_snapshot_regions(mc_snapshot_t snapshot)
780 {
781   mc_snapshot_t parent_snapshot = mc_model_checker->parent_snapshot;
782
783   const size_t n = snapshot->snapshot_regions_count;
784   for (size_t i = 0; i < n; i++) {
785     // For privatized, variables we decided it was not necessary to take the snapshot:
786     if (snapshot->snapshot_regions[i])
787       MC_region_restore(snapshot->snapshot_regions[i],
788         parent_snapshot ? parent_snapshot->snapshot_regions[i] : NULL);
789   }
790
791 #ifdef HAVE_SMPI
792   if(snapshot->privatization_index >= 0) {
793     // We just rewrote the global variables.
794     // The privatisation segment SMPI thinks
795     // is mapped might be inconsistent with the segment which
796     // is really mapped in memory (kernel state).
797     // We ask politely SMPI to map the segment anyway,
798     // even if it thinks it is the current one:
799     smpi_really_switch_data_segment(snapshot->privatization_index);
800   }
801 #endif
802 }
803
804 static inline
805 void MC_restore_snapshot_fds(mc_snapshot_t snapshot)
806 {
807   if (mc_mode == MC_MODE_SERVER)
808     xbt_die("FD snapshot not implemented in client/server mode.");
809
810   int new_fd;
811   size_t i;
812   for(i=0; i < snapshot->total_fd; i++){
813     
814     new_fd = open(snapshot->current_fd[i]->filename, snapshot->current_fd[i]->flags);
815     if (new_fd <0) {
816       xbt_die("Could not reopen the file %s fo restoring the file descriptor",
817         snapshot->current_fd[i]->filename);
818     }
819     if(new_fd != -1 && new_fd != snapshot->current_fd[i]->number){
820       dup2(new_fd, snapshot->current_fd[i]->number);
821       //fprintf(stderr, "%p\n", fdopen(snapshot->current_fd[i]->number, "rw"));
822       close(new_fd);
823     };
824     lseek(snapshot->current_fd[i]->number, snapshot->current_fd[i]->current_position, SEEK_SET);
825   }
826 }
827
828 void MC_restore_snapshot(mc_snapshot_t snapshot)
829 {
830   const bool use_soft_dirty = _sg_mc_sparse_checkpoint
831     && _sg_mc_soft_dirty
832     && MC_process_is_self(&mc_model_checker->process);
833
834   MC_restore_snapshot_regions(snapshot);
835   if (_sg_mc_snapshot_fds)
836     MC_restore_snapshot_fds(snapshot);
837   if (use_soft_dirty) {
838     mc_softdirty_reset();
839   }
840   MC_snapshot_ignore_restore(snapshot);
841   if (use_soft_dirty) {
842     mc_model_checker->parent_snapshot = snapshot;
843   }
844
845   mc_model_checker->process.cache_flags = 0;
846 }
847
848 mc_snapshot_t simcall_HANDLER_mc_snapshot(smx_simcall_t simcall)
849 {
850   return MC_take_snapshot(1);
851 }