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