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