src/mc/mc_global.c

   1 /* Copyright (c) 2008-2012 Da SimGrid Team. All rights reserved.            */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include <unistd.h>
   7 #include <sys/types.h>
   8 #include <sys/wait.h>
   9 #include <sys/time.h>
  10
  11 #include "../surf/surf_private.h"
  12 #include "../simix/smx_private.h"
  13 #include "xbt/fifo.h"
  14 #include "mc_private.h"
  15 #include "xbt/automaton.h"
  16
  17 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
  19                                 "Logging specific to MC (global)");
  20
  21 /* Configuration support */
  22 e_mc_reduce_t mc_reduce_kind=e_mc_reduce_unset;
  23
  24 extern int _surf_init_status;
  25 void _mc_cfg_cb_reduce(const char *name, int pos) {
  26   if (_surf_init_status && !_surf_do_model_check) {
  27     xbt_die("You are specifying a reduction strategy after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
  28   }
  29   char *val= xbt_cfg_get_string(_surf_cfg_set, name);
  30   if (!strcasecmp(val,"none")) {
  31     mc_reduce_kind = e_mc_reduce_none;
  32   } else if (!strcasecmp(val,"dpor")) {
  33     mc_reduce_kind = e_mc_reduce_dpor;
  34   } else {
  35     xbt_die("configuration option %s can only take 'none' or 'dpor' as a value",name);
  36   }
  37   xbt_cfg_set_int(_surf_cfg_set,"model-check",1);
  38 }
  39
  40 void _mc_cfg_cb_checkpoint(const char *name, int pos) {
  41   if (_surf_init_status && !_surf_do_model_check) {
  42     xbt_die("You are specifying a checkpointing value after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
  43   }
  44   _surf_mc_checkpoint = xbt_cfg_get_int(_surf_cfg_set, name);
  45   xbt_cfg_set_int(_surf_cfg_set,"model-check",1);
  46 }
  47 void _mc_cfg_cb_property(const char *name, int pos) {
  48   if (_surf_init_status && !_surf_do_model_check) {
  49     xbt_die("You are specifying a property after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
  50   }
  51   _surf_mc_property_file= xbt_cfg_get_string(_surf_cfg_set, name);
  52   xbt_cfg_set_int(_surf_cfg_set,"model-check",1);
  53 }
  54
  55
  56 /* MC global data structures */
  57
  58 mc_state_t mc_current_state = NULL;
  59 char mc_replay_mode = FALSE;
  60 double *mc_time = NULL;
  61 mc_snapshot_t initial_snapshot = NULL;
  62 int raw_mem_set;
  63
  64 /* Safety */
  65
  66 xbt_fifo_t mc_stack_safety = NULL;
  67 mc_stats_t mc_stats = NULL;
  68
  69 /* Liveness */
  70
  71 mc_stats_pair_t mc_stats_pair = NULL;
  72 xbt_fifo_t mc_stack_liveness = NULL;
  73 mc_snapshot_t initial_snapshot_liveness = NULL;
  74
  75 xbt_automaton_t _mc_property_automaton = NULL;
  76
  77 static void MC_assert_pair(int prop);
  78
  79 void MC_do_the_modelcheck_for_real() {
  80   if (!_surf_mc_property_file || _surf_mc_property_file[0]=='\0') {
  81     if (mc_reduce_kind==e_mc_reduce_unset)
  82       mc_reduce_kind=e_mc_reduce_dpor;
  83
  84     XBT_INFO("Check a safety property");
  85     MC_modelcheck();
  86
  87   } else  {
  88
  89     if (mc_reduce_kind==e_mc_reduce_unset)
  90       mc_reduce_kind=e_mc_reduce_none;
  91
  92     XBT_INFO("Check the liveness property %s",_surf_mc_property_file);
  93     MC_automaton_load(_surf_mc_property_file);
  94     MC_modelcheck_liveness();
  95   }
  96 }
  97
  98 /**
  99  *  \brief Initialize the model-checker data structures
 100  */
 101 void MC_init_safety(void)
 102 {
 103
 104   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 105
 106   /* Check if MC is already initialized */
 107   if (initial_snapshot)
 108     return;
 109
 110   mc_time = xbt_new0(double, simix_process_maxpid);
 111
 112   /* Initialize the data structures that must be persistent across every
 113      iteration of the model-checker (in RAW memory) */
 114
 115   MC_SET_RAW_MEM;
 116
 117   /* Initialize statistics */
 118   mc_stats = xbt_new0(s_mc_stats_t, 1);
 119   mc_stats->state_size = 1;
 120
 121   /* Create exploration stack */
 122   mc_stack_safety = xbt_fifo_new();
 123
 124   MC_UNSET_RAW_MEM;
 125
 126   MC_dpor_init();
 127
 128   MC_SET_RAW_MEM;
 129   /* Save the initial state */
 130   initial_snapshot = xbt_new0(s_mc_snapshot_t, 1);
 131   MC_take_snapshot(initial_snapshot);
 132   MC_UNSET_RAW_MEM;
 133
 134
 135   if(raw_mem_set)
 136     MC_SET_RAW_MEM;
 137   else
 138     MC_UNSET_RAW_MEM;
 139
 140 }
 141
 142
 143 void MC_modelcheck(void)
 144 {
 145   MC_init_safety();
 146   MC_dpor();
 147   MC_exit();
 148 }
 149
 150 void MC_modelcheck_liveness(){
 151
 152   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 153
 154   /* init stuff */
 155   XBT_DEBUG("Start init mc");
 156
 157   mc_time = xbt_new0(double, simix_process_maxpid);
 158
 159   /* Initialize the data structures that must be persistent across every
 160      iteration of the model-checker (in RAW memory) */
 161
 162   MC_SET_RAW_MEM;
 163
 164   /* Initialize statistics */
 165   mc_stats_pair = xbt_new0(s_mc_stats_pair_t, 1);
 166
 167   XBT_DEBUG("Creating stack");
 168
 169   /* Create exploration stack */
 170   mc_stack_liveness = xbt_fifo_new();
 171
 172   MC_UNSET_RAW_MEM;
 173
 174
 175   MC_ddfs_init();
 176
 177   /* We're done */
 178   MC_print_statistics_pairs(mc_stats_pair);
 179   xbt_free(mc_time);
 180   MC_memory_exit();
 181   exit(0);
 182 }
 183
 184
 185 void MC_exit(void)
 186 {
 187   MC_print_statistics(mc_stats);
 188   xbt_free(mc_time);
 189   MC_memory_exit();
 190 }
 191
 192
 193 int MC_random(int min, int max)
 194 {
 195   /*FIXME: return mc_current_state->executed_transition->random.value;*/
 196   return 0;
 197 }
 198
 199 /**
 200  * \brief Schedules all the process that are ready to run
 201  */
 202 void MC_wait_for_requests(void)
 203 {
 204   smx_process_t process;
 205   smx_simcall_t req;
 206   unsigned int iter;
 207
 208   while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 209     SIMIX_process_runall();
 210     xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
 211       req = &process->simcall;
 212       if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
 213         SIMIX_simcall_pre(req, 0);
 214     }
 215   }
 216 }
 217
 218 int MC_deadlock_check()
 219 {
 220   int deadlock = FALSE;
 221   smx_process_t process;
 222   if(xbt_swag_size(simix_global->process_list)){
 223     deadlock = TRUE;
 224     xbt_swag_foreach(process, simix_global->process_list){
 225       if(process->simcall.call != SIMCALL_NONE
 226          && MC_request_is_enabled(&process->simcall)){
 227         deadlock = FALSE;
 228         break;
 229       }
 230     }
 231   }
 232   return deadlock;
 233 }
 234
 235 /**
 236  * \brief Re-executes from the state at position start all the transitions indicated by
 237  *        a given model-checker stack.
 238  * \param stack The stack with the transitions to execute.
 239  * \param start Start index to begin the re-execution.
 240  */
 241 void MC_replay(xbt_fifo_t stack, int start)
 242 {
 243   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 244
 245   int value, i = 1;
 246   char *req_str;
 247   smx_simcall_t req = NULL, saved_req = NULL;
 248   xbt_fifo_item_t item, start_item;
 249   mc_state_t state;
 250
 251   XBT_DEBUG("**** Begin Replay ****");
 252
 253   if(start == -1){
 254     /* Restore the initial state */
 255     MC_restore_snapshot(initial_snapshot);
 256     /* At the moment of taking the snapshot the raw heap was set, so restoring
 257      * it will set it back again, we have to unset it to continue  */
 258     MC_UNSET_RAW_MEM;
 259   }
 260
 261   start_item = xbt_fifo_get_last_item(stack);
 262   if(start != -1){
 263     while (i != start){
 264       start_item = xbt_fifo_get_prev_item(start_item);
 265       i++;
 266     }
 267   }
 268
 269   /* Traverse the stack from the state at position start and re-execute the transitions */
 270   for (item = start_item;
 271        item != xbt_fifo_get_first_item(stack);
 272        item = xbt_fifo_get_prev_item(item)) {
 273
 274     state = (mc_state_t) xbt_fifo_get_item_content(item);
 275     saved_req = MC_state_get_executed_request(state, &value);
 276
 277     if(saved_req){
 278       /* because we got a copy of the executed request, we have to fetch the
 279          real one, pointed by the request field of the issuer process */
 280       req = &saved_req->issuer->simcall;
 281
 282       /* Debug information */
 283       if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
 284         req_str = MC_request_to_string(req, value);
 285         XBT_DEBUG("Replay: %s (%p)", req_str, state);
 286         xbt_free(req_str);
 287       }
 288     }
 289
 290     SIMIX_simcall_pre(req, value);
 291     MC_wait_for_requests();
 292
 293     /* Update statistics */
 294     mc_stats->visited_states++;
 295     mc_stats->executed_transitions++;
 296   }
 297   XBT_DEBUG("**** End Replay ****");
 298
 299   if(raw_mem_set)
 300     MC_SET_RAW_MEM;
 301   else
 302     MC_UNSET_RAW_MEM;
 303
 304
 305 }
 306
 307 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
 308 {
 309
 310   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 311
 312   int value;
 313   char *req_str;
 314   smx_simcall_t req = NULL, saved_req = NULL;
 315   xbt_fifo_item_t item;
 316   mc_state_t state;
 317   mc_pair_stateless_t pair;
 318   int depth = 1;
 319
 320   XBT_DEBUG("**** Begin Replay ****");
 321
 322   /* Restore the initial state */
 323   MC_restore_snapshot(initial_snapshot_liveness);
 324   /* At the moment of taking the snapshot the raw heap was set, so restoring
 325    * it will set it back again, we have to unset it to continue  */
 326   MC_UNSET_RAW_MEM;
 327
 328   if(all_stack){
 329
 330     item = xbt_fifo_get_last_item(stack);
 331
 332     while(depth <= xbt_fifo_size(stack)){
 333
 334       pair = (mc_pair_stateless_t) xbt_fifo_get_item_content(item);
 335       state = (mc_state_t) pair->graph_state;
 336
 337       if(pair->requests > 0){
 338
 339         saved_req = MC_state_get_executed_request(state, &value);
 340         //XBT_DEBUG("SavedReq->call %u", saved_req->call);
 341
 342         if(saved_req != NULL){
 343           /* because we got a copy of the executed request, we have to fetch the
 344              real one, pointed by the request field of the issuer process */
 345           req = &saved_req->issuer->simcall;
 346           //XBT_DEBUG("Req->call %u", req->call);
 347
 348           /* Debug information */
 349           if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
 350             req_str = MC_request_to_string(req, value);
 351             XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
 352             xbt_free(req_str);
 353           }
 354
 355         }
 356
 357         SIMIX_simcall_pre(req, value);
 358         MC_wait_for_requests();
 359       }
 360
 361       depth++;
 362
 363       /* Update statistics */
 364       mc_stats_pair->visited_pairs++;
 365
 366       item = xbt_fifo_get_prev_item(item);
 367     }
 368
 369   }else{
 370
 371     /* Traverse the stack from the initial state and re-execute the transitions */
 372     for (item = xbt_fifo_get_last_item(stack);
 373          item != xbt_fifo_get_first_item(stack);
 374          item = xbt_fifo_get_prev_item(item)) {
 375
 376       pair = (mc_pair_stateless_t) xbt_fifo_get_item_content(item);
 377       state = (mc_state_t) pair->graph_state;
 378
 379       if(pair->requests > 0){
 380
 381         saved_req = MC_state_get_executed_request(state, &value);
 382         //XBT_DEBUG("SavedReq->call %u", saved_req->call);
 383
 384         if(saved_req != NULL){
 385           /* because we got a copy of the executed request, we have to fetch the
 386              real one, pointed by the request field of the issuer process */
 387           req = &saved_req->issuer->simcall;
 388           //XBT_DEBUG("Req->call %u", req->call);
 389
 390           /* Debug information */
 391           if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
 392             req_str = MC_request_to_string(req, value);
 393             XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
 394             xbt_free(req_str);
 395           }
 396
 397         }
 398
 399         SIMIX_simcall_pre(req, value);
 400         MC_wait_for_requests();
 401       }
 402
 403       depth++;
 404
 405       /* Update statistics */
 406       mc_stats_pair->visited_pairs++;
 407     }
 408   }
 409
 410   XBT_DEBUG("**** End Replay ****");
 411
 412   if(raw_mem_set)
 413     MC_SET_RAW_MEM;
 414   else
 415     MC_UNSET_RAW_MEM;
 416
 417 }
 418
 419 /**
 420  * \brief Dumps the contents of a model-checker's stack and shows the actual
 421  *        execution trace
 422  * \param stack The stack to dump
 423  */
 424 void MC_dump_stack_safety(xbt_fifo_t stack)
 425 {
 426
 427   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 428
 429   MC_show_stack_safety(stack);
 430
 431   if(!_surf_mc_checkpoint){
 432
 433     mc_state_t state;
 434
 435     MC_SET_RAW_MEM;
 436     while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
 437       MC_state_delete(state);
 438     MC_UNSET_RAW_MEM;
 439
 440   }
 441
 442   if(raw_mem_set)
 443     MC_SET_RAW_MEM;
 444   else
 445     MC_UNSET_RAW_MEM;
 446
 447 }
 448
 449
 450 void MC_show_stack_safety(xbt_fifo_t stack)
 451 {
 452   int value;
 453   mc_state_t state;
 454   xbt_fifo_item_t item;
 455   smx_simcall_t req;
 456   char *req_str = NULL;
 457
 458   for (item = xbt_fifo_get_last_item(stack);
 459        (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
 460         : (NULL)); item = xbt_fifo_get_prev_item(item)) {
 461     req = MC_state_get_executed_request(state, &value);
 462     if(req){
 463       req_str = MC_request_to_string(req, value);
 464       XBT_INFO("%s", req_str);
 465       xbt_free(req_str);
 466     }
 467   }
 468 }
 469
 470 void MC_show_deadlock(smx_simcall_t req)
 471 {
 472   /*char *req_str = NULL;*/
 473   XBT_INFO("**************************");
 474   XBT_INFO("*** DEAD-LOCK DETECTED ***");
 475   XBT_INFO("**************************");
 476   XBT_INFO("Locked request:");
 477   /*req_str = MC_request_to_string(req);
 478     XBT_INFO("%s", req_str);
 479     xbt_free(req_str);*/
 480   XBT_INFO("Counter-example execution trace:");
 481   MC_dump_stack_safety(mc_stack_safety);
 482 }
 483
 484
 485 void MC_show_stack_liveness(xbt_fifo_t stack){
 486   int value;
 487   mc_pair_stateless_t pair;
 488   xbt_fifo_item_t item;
 489   smx_simcall_t req;
 490   char *req_str = NULL;
 491
 492   for (item = xbt_fifo_get_last_item(stack);
 493        (item ? (pair = (mc_pair_stateless_t) (xbt_fifo_get_item_content(item)))
 494         : (NULL)); item = xbt_fifo_get_prev_item(item)) {
 495     req = MC_state_get_executed_request(pair->graph_state, &value);
 496     if(req){
 497       if(pair->requests>0){
 498         req_str = MC_request_to_string(req, value);
 499         XBT_INFO("%s", req_str);
 500         xbt_free(req_str);
 501       }else{
 502         XBT_INFO("End of system requests but evolution in Büchi automaton");
 503       }
 504     }
 505   }
 506 }
 507
 508 void MC_dump_stack_liveness(xbt_fifo_t stack){
 509
 510   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 511
 512   mc_pair_stateless_t pair;
 513
 514   MC_SET_RAW_MEM;
 515   while ((pair = (mc_pair_stateless_t) xbt_fifo_pop(stack)) != NULL)
 516     MC_pair_stateless_delete(pair);
 517   MC_UNSET_RAW_MEM;
 518
 519   if(raw_mem_set)
 520     MC_SET_RAW_MEM;
 521   else
 522     MC_UNSET_RAW_MEM;
 523
 524 }
 525
 526
 527 void MC_print_statistics(mc_stats_t stats)
 528 {
 529   //XBT_INFO("State space size ~= %lu", stats->state_size);
 530   XBT_INFO("Expanded states = %lu", stats->expanded_states);
 531   XBT_INFO("Visited states = %lu", stats->visited_states);
 532   XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
 533   XBT_INFO("Expanded / Visited = %lf",
 534            (double) stats->visited_states / stats->expanded_states);
 535   /*XBT_INFO("Exploration coverage = %lf",
 536     (double)stats->expanded_states / stats->state_size); */
 537 }
 538
 539 void MC_print_statistics_pairs(mc_stats_pair_t stats)
 540 {
 541   XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
 542   XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
 543   //XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
 544   XBT_INFO("Expanded / Visited = %lf",
 545            (double) stats->visited_pairs / stats->expanded_pairs);
 546   /*XBT_INFO("Exploration coverage = %lf",
 547     (double)stats->expanded_states / stats->state_size); */
 548 }
 549
 550 void MC_assert(int prop)
 551 {
 552   if (MC_IS_ENABLED && !prop){
 553     XBT_INFO("**************************");
 554     XBT_INFO("*** PROPERTY NOT VALID ***");
 555     XBT_INFO("**************************");
 556     XBT_INFO("Counter-example execution trace:");
 557     MC_dump_stack_safety(mc_stack_safety);
 558     MC_print_statistics(mc_stats);
 559     xbt_abort();
 560   }
 561 }
 562
 563 static void MC_assert_pair(int prop){
 564   if (MC_IS_ENABLED && !prop) {
 565     XBT_INFO("**************************");
 566     XBT_INFO("*** PROPERTY NOT VALID ***");
 567     XBT_INFO("**************************");
 568     //XBT_INFO("Counter-example execution trace:");
 569     MC_show_stack_liveness(mc_stack_liveness);
 570     //MC_dump_snapshot_stack(mc_snapshot_stack);
 571     MC_print_statistics_pairs(mc_stats_pair);
 572     xbt_abort();
 573   }
 574 }
 575
 576 void MC_process_clock_add(smx_process_t process, double amount)
 577 {
 578   mc_time[process->pid] += amount;
 579 }
 580
 581 double MC_process_clock_get(smx_process_t process)
 582 {
 583   if(mc_time)
 584     return mc_time[process->pid];
 585   else
 586     return 0;
 587 }
 588
 589 void MC_diff(void){
 590
 591   mc_snapshot_t sn = xbt_new0(s_mc_snapshot_t, 1);
 592   MC_take_snapshot_liveness(sn);
 593
 594   int i;
 595
 596   XBT_INFO("Number of regions : %u", sn->num_reg);
 597
 598   for(i=0; i<sn->num_reg; i++){
 599
 600     switch(sn->regions[i]->type){
 601     case 0: /* heap */
 602       XBT_INFO("Size of heap : %zu", sn->regions[i]->size);
 603       break;
 604     case 1 : /* libsimgrid */
 605       XBT_INFO("Size of libsimgrid : %zu", sn->regions[i]->size);
 606       break;
 607     case 2 : /* data program */
 608       XBT_INFO("Size of data program : %zu", sn->regions[i]->size);
 609       break;
 610     case 3 : /* stack */
 611       XBT_INFO("Size of stack : %zu", sn->regions[i]->size);
 612       XBT_INFO("Start addr of stack : %p", sn->regions[i]->start_addr);
 613       break;
 614     }
 615
 616   }
 617
 618 }
 619
 620 void MC_automaton_load(const char *file){
 621
 622   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 623
 624   MC_SET_RAW_MEM;
 625
 626   if (_mc_property_automaton == NULL)
 627     _mc_property_automaton = xbt_automaton_new();
 628
 629   xbt_automaton_load(_mc_property_automaton,file);
 630
 631   MC_UNSET_RAW_MEM;
 632
 633   if(raw_mem_set)
 634     MC_SET_RAW_MEM;
 635   else
 636     MC_UNSET_RAW_MEM;
 637
 638 }
 639
 640 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
 641
 642   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 643
 644   MC_SET_RAW_MEM;
 645
 646   if (_mc_property_automaton == NULL)
 647     _mc_property_automaton = xbt_automaton_new();
 648
 649   xbt_new_propositional_symbol(_mc_property_automaton,id,fct);
 650
 651   MC_UNSET_RAW_MEM;
 652
 653   if(raw_mem_set)
 654     MC_SET_RAW_MEM;
 655   else
 656     MC_UNSET_RAW_MEM;
 657
 658 }