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 <string.h>
  11 #include <link.h>
  12 #include "mc_private.h"
  13 #include "xbt/module.h"
  14 #include <xbt/mmalloc.h>
  15 #include "../smpi/private.h"
  16
  17 #include "xbt/mmalloc/mmprivate.h"
  18
  19 #include "../simix/smx_private.h"
  20
  21 #include <libunwind.h>
  22 #include <libelf.h>
  23
  24 #include "mc_private.h"
  25
  26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
  27                                 "Logging specific to mc_checkpoint");
  28
  29 char *libsimgrid_path;
  30
  31 /************************************  Free functions **************************************/
  32 /*****************************************************************************************/
  33
  34 static void MC_snapshot_stack_free(mc_snapshot_stack_t s){
  35   if(s){
  36     xbt_dynar_free(&(s->local_variables));
  37     xbt_dynar_free(&(s->stack_frames));
  38     xbt_free(s);
  39   }
  40 }
  41
  42 static void MC_snapshot_stack_free_voidp(void *s){
  43   MC_snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
  44 }
  45
  46 static void local_variable_free(local_variable_t v){
  47   xbt_free(v->name);
  48   xbt_free(v);
  49 }
  50
  51 static void local_variable_free_voidp(void *v){
  52   local_variable_free((local_variable_t) * (void **) v);
  53 }
  54
  55 static void MC_region_destroy(mc_mem_region_t reg)
  56 {
  57   //munmap(reg->data, reg->size);
  58   xbt_free(reg->data);
  59   xbt_free(reg);
  60 }
  61
  62 void MC_free_snapshot(mc_snapshot_t snapshot){
  63   unsigned int i;
  64   for(i=0; i < NB_REGIONS; i++)
  65     MC_region_destroy(snapshot->regions[i]);
  66
  67   xbt_free(snapshot->stack_sizes);
  68   xbt_dynar_free(&(snapshot->stacks));
  69   xbt_dynar_free(&(snapshot->to_ignore));
  70
  71   if(snapshot->privatization_regions){
  72     size_t n = snapshot->nb_processes;
  73     for(i=0; i!=n; ++i) {
  74       MC_region_destroy(snapshot->privatization_regions[i]);
  75     }
  76     xbt_free(snapshot->privatization_regions);
  77   }
  78
  79   xbt_free(snapshot);
  80 }
  81
  82
  83 /*******************************  Snapshot regions ********************************/
  84 /*********************************************************************************/
  85
  86 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
  87 {
  88   mc_mem_region_t new_reg = xbt_new(s_mc_mem_region_t, 1);
  89   new_reg->start_addr = start_addr;
  90   new_reg->size = size;
  91   //new_reg->data = mmap(NULL, size, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
  92   //if(new_reg->data==MAP_FAILED)
  93   //xbt_die("Could not mmap new memory for snapshot.");
  94   new_reg->data = xbt_malloc(size);
  95   memcpy(new_reg->data, start_addr, size);
  96   //madvise(new_reg->data, size, MADV_MERGEABLE);
  97
  98   XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
  99
 100   return new_reg;
 101 }
 102
 103 static void MC_region_restore(mc_mem_region_t reg)
 104 {
 105   /*FIXME: check if start_addr is still mapped, if it is not, then map it
 106     before copying the data */
 107
 108   memcpy(reg->start_addr, reg->data, reg->size);
 109   return;
 110 }
 111
 112 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
 113 {
 114   mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
 115   snapshot->regions[type] = new_reg;
 116   return;
 117 }
 118
 119 static void MC_get_memory_regions(mc_snapshot_t snapshot){
 120   size_t i;
 121
 122   void* start_heap = ((xbt_mheap_t)std_heap)->base;
 123   void* end_heap   = ((xbt_mheap_t)std_heap)->breakval;
 124   MC_snapshot_add_region(snapshot, 0, start_heap, (char*) end_heap - (char*) start_heap);
 125   snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
 126
 127   MC_snapshot_add_region(snapshot, 1,  mc_libsimgrid_info->start_rw, mc_libsimgrid_info->end_rw - mc_libsimgrid_info->start_rw);
 128   if(!smpi_privatize_global_variables) {
 129     MC_snapshot_add_region(snapshot, 2,  mc_binary_info->start_rw, mc_binary_info->end_rw - mc_binary_info->start_rw);
 130     snapshot->privatization_regions = NULL;
 131     snapshot->privatization_index = -1;
 132   } else {
 133     snapshot->privatization_regions = xbt_new(mc_mem_region_t, SIMIX_process_count());
 134     for (i=0; i< SIMIX_process_count(); i++){
 135       snapshot->privatization_regions[i] = MC_region_new(-1, mappings[i], size_data_exe);
 136     }
 137     snapshot->privatization_index = loaded_page;
 138   }
 139 }
 140
 141 /** @brief Finds the range of the different memory segments and binary paths */
 142 void MC_init_memory_map_info(){
 143
 144   unsigned int i = 0;
 145   s_map_region_t reg;
 146   memory_map_t maps = MC_get_memory_map();
 147
 148   maestro_stack_start = NULL;
 149   maestro_stack_end = NULL;
 150   libsimgrid_path = NULL;
 151
 152   while (i < maps->mapsize) {
 153     reg = maps->regions[i];
 154     if (maps->regions[i].pathname == NULL) {
 155       // Nothing to do
 156     }
 157     else if ((reg.prot & PROT_WRITE) && !memcmp(maps->regions[i].pathname, "[stack]", 7)){
 158           maestro_stack_start = reg.start_addr;
 159           maestro_stack_end = reg.end_addr;
 160     } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC) && !memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
 161       if(libsimgrid_path == NULL)
 162           libsimgrid_path = strdup(maps->regions[i].pathname);
 163     }
 164     i++;
 165   }
 166
 167   xbt_assert(maestro_stack_start, "maestro_stack_start");
 168   xbt_assert(maestro_stack_end, "maestro_stack_end");
 169   xbt_assert(libsimgrid_path, "libsimgrid_path&");
 170
 171   MC_free_memory_map(maps);
 172
 173 }
 174
 175 /** \brief Fill/lookup the "subtype" field.
 176  */
 177 static void MC_resolve_subtype(mc_object_info_t info, dw_type_t type) {
 178
 179   if(type->dw_type_id==NULL)
 180     return;
 181   type->subtype = xbt_dict_get_or_null(info->types, type->dw_type_id);
 182   if(type->subtype==NULL)
 183     return;
 184   if(type->subtype->byte_size != 0)
 185     return;
 186   if(type->subtype->name==NULL)
 187     return;
 188   // Try to find a more complete description of the type:
 189   // We need to fix in order to support C++.
 190
 191   dw_type_t subtype = xbt_dict_get_or_null(info->full_types_by_name, type->subtype->name);
 192   if(subtype!=NULL) {
 193     type->subtype = subtype;
 194   }
 195
 196 }
 197
 198 void MC_post_process_types(mc_object_info_t info) {
 199   xbt_dict_cursor_t cursor = NULL;
 200   char *origin;
 201   dw_type_t type;
 202
 203   // Lookup "subtype" field:
 204   xbt_dict_foreach(info->types, cursor, origin, type){
 205     MC_resolve_subtype(info, type);
 206
 207     dw_type_t member;
 208     unsigned int i = 0;
 209     if(type->members!=NULL) xbt_dynar_foreach(type->members, i, member) {
 210       MC_resolve_subtype(info, member);
 211     }
 212   }
 213 }
 214
 215 /** \brief Fills the position of the segments (executable, read-only, read/write).
 216  *
 217  * TODO, use dl_iterate_phdr to be more robust
 218  * */
 219 void MC_find_object_address(memory_map_t maps, mc_object_info_t result) {
 220
 221   unsigned int i = 0;
 222   s_map_region_t reg;
 223   const char* name = basename(result->file_name);
 224   while (i < maps->mapsize) {
 225     reg = maps->regions[i];
 226     if (maps->regions[i].pathname == NULL || strcmp(basename(maps->regions[i].pathname),  name)) {
 227       // Nothing to do
 228     }
 229     else if ((reg.prot & PROT_WRITE)){
 230           xbt_assert(!result->start_rw,
 231             "Multiple read-write segments for %s, not supported",
 232             maps->regions[i].pathname);
 233           result->start_rw = reg.start_addr;
 234           result->end_rw   = reg.end_addr;
 235           // .bss is usually after the .data:
 236           s_map_region_t* next = &(maps->regions[i+1]);
 237           if(next->pathname == NULL && (next->prot & PROT_WRITE) && next->start_addr == reg.end_addr) {
 238             result->end_rw = maps->regions[i+1].end_addr;
 239           }
 240     } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)){
 241           xbt_assert(!result->start_exec,
 242             "Multiple executable segments for %s, not supported",
 243             maps->regions[i].pathname);
 244           result->start_exec = reg.start_addr;
 245           result->end_exec   = reg.end_addr;
 246     }
 247     else if((reg.prot & PROT_READ) && !(reg.prot & PROT_EXEC)) {
 248         xbt_assert(!result->start_ro,
 249           "Multiple read only segments for %s, not supported",
 250           maps->regions[i].pathname);
 251         result->start_ro = reg.start_addr;
 252         result->end_ro   = reg.end_addr;
 253     }
 254     i++;
 255   }
 256
 257   xbt_assert(result->file_name);
 258   xbt_assert(result->start_rw);
 259   xbt_assert(result->start_exec);
 260 }
 261
 262 /************************************* Take Snapshot ************************************/
 263 /****************************************************************************************/
 264
 265 /** \brief Checks whether the variable is in scope for a given IP.
 266  *
 267  *  A variable may be defined only from a given value of IP.
 268  *
 269  *  \param var   Variable description
 270  *  \param frame Scope description
 271  *  \param ip    Instruction pointer
 272  *  \return      true if the variable is valid
 273  * */
 274 static bool mc_valid_variable(dw_variable_t var, dw_frame_t scope, const void* ip) {
 275   // The variable is not yet valid:
 276   if((const void*)((const char*) scope->low_pc + var->start_scope) > ip)
 277     return false;
 278   else
 279     return true;
 280 }
 281
 282 static void mc_fill_local_variables_values(mc_stack_frame_t stack_frame, dw_frame_t scope, xbt_dynar_t result) {
 283   void* ip = (void*) stack_frame->ip;
 284   if(ip < scope->low_pc || ip>= scope->high_pc)
 285     return;
 286
 287   unsigned cursor = 0;
 288   dw_variable_t current_variable;
 289   xbt_dynar_foreach(scope->variables, cursor, current_variable){
 290
 291     if(!mc_valid_variable(current_variable, scope, (void*) stack_frame->ip))
 292       continue;
 293
 294     int region_type;
 295     if((long)stack_frame->ip > (long)mc_libsimgrid_info->start_exec)
 296       region_type = 1;
 297     else
 298       region_type = 2;
 299
 300     local_variable_t new_var = xbt_new0(s_local_variable_t, 1);
 301     new_var->subprogram = stack_frame->frame;
 302     new_var->ip = stack_frame->ip;
 303     new_var->name = xbt_strdup(current_variable->name);
 304     new_var->type = current_variable->type;
 305     new_var->region= region_type;
 306
 307     if(current_variable->address!=NULL) {
 308       new_var->address = current_variable->address;
 309     } else
 310     if(current_variable->locations.size != 0){
 311       new_var->address = (void*) mc_dwarf_resolve_locations(&current_variable->locations,
 312         current_variable->object_info,
 313         &(stack_frame->unw_cursor), (void*)stack_frame->frame_base, NULL);
 314     } else {
 315       xbt_die("No address");
 316     }
 317
 318     xbt_dynar_push(result, &new_var);
 319   }
 320
 321   // Recursive processing of nested scopes:
 322   dw_frame_t nested_scope = NULL;
 323   xbt_dynar_foreach(scope->scopes, cursor, nested_scope) {
 324     mc_fill_local_variables_values(stack_frame, nested_scope, result);
 325   }
 326 }
 327
 328 static xbt_dynar_t MC_get_local_variables_values(xbt_dynar_t stack_frames){
 329
 330   unsigned cursor1 = 0;
 331   mc_stack_frame_t stack_frame;
 332   xbt_dynar_t variables = xbt_dynar_new(sizeof(local_variable_t), local_variable_free_voidp);
 333
 334   xbt_dynar_foreach(stack_frames,cursor1,stack_frame) {
 335     mc_fill_local_variables_values(stack_frame, stack_frame->frame, variables);
 336   }
 337
 338   return variables;
 339 }
 340
 341 static void MC_stack_frame_free_voipd(void *s){
 342   mc_stack_frame_t stack_frame = *(mc_stack_frame_t*)s;
 343   if(stack_frame) {
 344     xbt_free(stack_frame->frame_name);
 345     xbt_free(stack_frame);
 346   }
 347 }
 348
 349 static xbt_dynar_t MC_unwind_stack_frames(void *stack_context) {
 350   xbt_dynar_t result = xbt_dynar_new(sizeof(mc_stack_frame_t), MC_stack_frame_free_voipd);
 351
 352   unw_cursor_t c;
 353
 354   // TODO, check condition check (unw_init_local==0 means end of frame)
 355   if(unw_init_local(&c, (unw_context_t *)stack_context)!=0) {
 356
 357     xbt_die("Could not initialize stack unwinding");
 358
 359   } else while(1) {
 360
 361     mc_stack_frame_t stack_frame = xbt_new(s_mc_stack_frame_t, 1);
 362     xbt_dynar_push(result, &stack_frame);
 363
 364     stack_frame->unw_cursor = c;
 365
 366     unw_word_t ip, sp;
 367
 368     unw_get_reg(&c, UNW_REG_IP, &ip);
 369     unw_get_reg(&c, UNW_REG_SP, &sp);
 370
 371     stack_frame->ip = ip;
 372     stack_frame->sp = sp;
 373
 374     // TODO, use real addresses in frame_t instead of fixing it here
 375
 376     dw_frame_t frame = MC_find_function_by_ip((void*) ip);
 377     stack_frame->frame = frame;
 378
 379     if(frame) {
 380       stack_frame->frame_name = xbt_strdup(frame->name);
 381       stack_frame->frame_base = (unw_word_t)mc_find_frame_base(frame, frame->object_info, &c);
 382     } else {
 383       stack_frame->frame_base = 0;
 384       stack_frame->frame_name = NULL;
 385     }
 386
 387     /* Stop before context switch with maestro */
 388     if(frame!=NULL && frame->name!=NULL && !strcmp(frame->name, "smx_ctx_sysv_wrapper"))
 389       break;
 390
 391     int ret = ret = unw_step(&c);
 392     if(ret==0) {
 393       xbt_die("Unexpected end of stack.");
 394     } else if(ret<0) {
 395       xbt_die("Error while unwinding stack.");
 396     }
 397   }
 398
 399   if(xbt_dynar_length(result) == 0){
 400     XBT_INFO("unw_init_local failed");
 401     xbt_abort();
 402   }
 403
 404   return result;
 405 };
 406
 407 static xbt_dynar_t MC_take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
 408
 409   xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), MC_snapshot_stack_free_voidp);
 410
 411   unsigned int cursor = 0;
 412   stack_region_t current_stack;
 413
 414   xbt_dynar_foreach(stacks_areas, cursor, current_stack){
 415     mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
 416     st->stack_frames = MC_unwind_stack_frames(current_stack->context);
 417     st->local_variables = MC_get_local_variables_values(st->stack_frames);
 418
 419     unw_word_t sp = xbt_dynar_get_as(st->stack_frames, 0, mc_stack_frame_t)->sp;
 420     st->stack_pointer = ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
 421
 422     st->real_address = current_stack->address;
 423     xbt_dynar_push(res, &st);
 424     (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
 425     (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
 426   }
 427
 428   return res;
 429
 430 }
 431
 432 static xbt_dynar_t MC_take_snapshot_ignore(){
 433
 434   if(mc_heap_comparison_ignore == NULL)
 435     return NULL;
 436
 437   xbt_dynar_t cpy = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
 438
 439   unsigned int cursor = 0;
 440   mc_heap_ignore_region_t current_region;
 441
 442   xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region){
 443     mc_heap_ignore_region_t new_region = NULL;
 444     new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
 445     new_region->address = current_region->address;
 446     new_region->size = current_region->size;
 447     new_region->block = current_region->block;
 448     new_region->fragment = current_region->fragment;
 449     xbt_dynar_push(cpy, &new_region);
 450   }
 451
 452   return cpy;
 453
 454 }
 455
 456 static void MC_dump_checkpoint_ignore(mc_snapshot_t snapshot){
 457
 458   unsigned int cursor = 0;
 459   mc_checkpoint_ignore_region_t region;
 460   size_t offset;
 461
 462   xbt_dynar_foreach(mc_checkpoint_ignore, cursor, region){
 463     if(region->addr > snapshot->regions[0]->start_addr && (char *)(region->addr) < (char *)snapshot->regions[0]->start_addr + STD_HEAP_SIZE){
 464       offset = (char *)region->addr - (char *)snapshot->regions[0]->start_addr;
 465       memset((char *)snapshot->regions[0]->data + offset, 0, region->size);
 466     }else if(region->addr > snapshot->regions[2]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[2]->start_addr + snapshot->regions[2]->size){
 467       offset = (char *)region->addr - (char *)snapshot->regions[2]->start_addr;
 468       memset((char *)snapshot->regions[2]->data + offset, 0, region->size);
 469     }else if(region->addr > snapshot->regions[1]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[1]->start_addr + snapshot->regions[1]->size){
 470       offset = (char *)region->addr - (char *)snapshot->regions[1]->start_addr;
 471       memset((char *)snapshot->regions[1]->data + offset, 0, region->size);
 472     }
 473   }
 474
 475 }
 476
 477
 478 mc_snapshot_t MC_take_snapshot(int num_state){
 479
 480   mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
 481   snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
 482
 483   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
 484   MC_get_memory_regions(snapshot);
 485
 486   snapshot->to_ignore = MC_take_snapshot_ignore();
 487
 488   if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,"")){
 489     snapshot->stacks = MC_take_snapshot_stacks(&snapshot, snapshot->regions[0]->data);
 490     if(_sg_mc_hash && snapshot->stacks!=NULL) {
 491       snapshot->hash = mc_hash_processes_state(num_state, snapshot->stacks);
 492     } else {
 493       snapshot->hash = 0;
 494     }
 495   }
 496   else {
 497     snapshot->hash = 0;
 498   }
 499
 500   if(num_state > 0)
 501     MC_dump_checkpoint_ignore(snapshot);
 502
 503   // mprotect the region after zero-ing ignored parts:
 504   size_t i;
 505   for(i=0; i!=NB_REGIONS; ++i) {
 506     mc_mem_region_t region = snapshot->regions[i];
 507     mprotect(region->data, region->size, PROT_READ);
 508   }
 509
 510   return snapshot;
 511
 512 }
 513
 514 void MC_restore_snapshot(mc_snapshot_t snapshot){
 515   unsigned int i;
 516   for(i=0; i < NB_REGIONS; i++){
 517     // For privatized, variables we decided it was not necessary to take the snapshot:
 518     if(snapshot->regions[i])
 519       MC_region_restore(snapshot->regions[i]);
 520   }
 521
 522   if(snapshot->privatization_regions) {
 523     for (i=0; i< SIMIX_process_count(); i++){
 524       if(snapshot->privatization_regions[i]) {
 525         MC_region_restore(snapshot->privatization_regions[i]);
 526       }
 527     }
 528     switch_data_segment(snapshot->privatization_index);
 529   }
 530 }
 531
 532 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot) {
 533
 534   // If not in a process state/clone:
 535   if(!snapshot) {
 536     return (uintptr_t*) addr;
 537   }
 538
 539   // If it is in a snapshot:
 540   for(size_t i=0; i!=NB_REGIONS; ++i) {
 541     mc_mem_region_t region = snapshot->regions[i];
 542     uintptr_t start = (uintptr_t) region->start_addr;
 543     uintptr_t end = start + region->size;
 544
 545     // The address is in this region:
 546     if(addr >= start && addr < end) {
 547       uintptr_t offset = addr - start;
 548       return (void*) ((uintptr_t)region->data + offset);
 549     }
 550
 551   }
 552
 553   // It is not in a snapshot:
 554   return (void*) addr;
 555 }
 556
 557 uintptr_t mc_untranslate_address(void* addr, mc_snapshot_t snapshot) {
 558   if(!snapshot) {
 559     return (uintptr_t) addr;
 560   }
 561
 562   for(size_t i=0; i!=NB_REGIONS; ++i) {
 563     mc_mem_region_t region = snapshot->regions[i];
 564     if(addr>=region->data && addr<=(void*)(((char*)region->data)+region->size)) {
 565       size_t offset = (size_t) ((char*) addr - (char*) region->data);
 566       return ((uintptr_t) region->start_addr) + offset;
 567     }
 568   }
 569
 570   return (uintptr_t) addr;
 571 }
 572
 573 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
 574   return MC_take_snapshot(1);
 575 }
 576
 577 void *MC_snapshot(void){
 578   return simcall_mc_snapshot();
 579 }