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