src/mc/mc_checkpoint.c

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