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