model.cc

   1 #include <stdio.h>
   2 #include <algorithm>
   3 #include <new>
   4 #include <stdarg.h>
   5 #include <string.h>
   6
   7 #include "model.h"
   8 #include "action.h"
   9 #include "nodestack.h"
  10 #include "schedule.h"
  11 #include "snapshot-interface.h"
  12 #include "common.h"
  13 #include "datarace.h"
  14 #include "threads-model.h"
  15 #include "output.h"
  16 #include "traceanalysis.h"
  17 #include "execution.h"
  18 #include "bugmessage.h"
  19
  20 ModelChecker *model;
  21
  22 /** @brief Constructor */
  23 ModelChecker::ModelChecker(struct model_params params) :
  24         /* Initialize default scheduler */
  25         params(params),
  26         restart_flag(false),
  27         exit_flag(false),
  28         scheduler(new Scheduler()),
  29         node_stack(new NodeStack()),
  30         execution(new ModelExecution(this, &this->params, scheduler, node_stack)),
  31         execution_number(1),
  32         diverge(NULL),
  33         earliest_diverge(NULL),
  34         trace_analyses(),
  35         inspect_plugin(NULL)
  36 {
  37         memset(&stats,0,sizeof(struct execution_stats));
  38 }
  39
  40 /** @brief Destructor */
  41 ModelChecker::~ModelChecker()
  42 {
  43         delete node_stack;
  44         delete scheduler;
  45 }
  46
  47 /**
  48  * Restores user program to initial state and resets all model-checker data
  49  * structures.
  50  */
  51 void ModelChecker::reset_to_initial_state()
  52 {
  53         DEBUG("+++ Resetting to initial state +++\n");
  54         node_stack->reset_execution();
  55
  56         /**
  57          * FIXME: if we utilize partial rollback, we will need to free only
  58          * those pending actions which were NOT pending before the rollback
  59          * point
  60          */
  61         for (unsigned int i = 0; i < get_num_threads(); i++)
  62                 delete get_thread(int_to_id(i))->get_pending();
  63
  64         snapshot_backtrack_before(0);
  65 }
  66
  67 /** @return the number of user threads created during this execution */
  68 unsigned int ModelChecker::get_num_threads() const
  69 {
  70         return execution->get_num_threads();
  71 }
  72
  73 /**
  74  * Must be called from user-thread context (e.g., through the global
  75  * thread_current() interface)
  76  *
  77  * @return The currently executing Thread.
  78  */
  79 Thread * ModelChecker::get_current_thread() const
  80 {
  81         return scheduler->get_current_thread();
  82 }
  83
  84 /**
  85  * @brief Choose the next thread to execute.
  86  *
  87  * This function chooses the next thread that should execute. It can enforce
  88  * execution replay/backtracking or, if the model-checker has no preference
  89  * regarding the next thread (i.e., when exploring a new execution ordering),
  90  * we defer to the scheduler.
  91  *
  92  * @return The next chosen thread to run, if any exist. Or else if the current
  93  * execution should terminate, return NULL.
  94  */
  95 Thread * ModelChecker::get_next_thread()
  96 {
  97         thread_id_t tid;
  98
  99         /*
 100          * Have we completed exploring the preselected path? Then let the
 101          * scheduler decide
 102          */
 103         if (diverge == NULL)
 104                 return scheduler->select_next_thread(node_stack->get_head());
 105
 106
 107         /* Else, we are trying to replay an execution */
 108         ModelAction *next = node_stack->get_next()->get_action();
 109
 110         if (next == diverge) {
 111                 if (earliest_diverge == NULL || *diverge < *earliest_diverge)
 112                         earliest_diverge = diverge;
 113
 114                 Node *nextnode = next->get_node();
 115                 Node *prevnode = nextnode->get_parent();
 116                 scheduler->update_sleep_set(prevnode);
 117
 118                 /* Reached divergence point */
 119                 if (nextnode->increment_behaviors()) {
 120                         /* Execute the same thread with a new behavior */
 121                         tid = next->get_tid();
 122                         node_stack->pop_restofstack(2);
 123                 } else {
 124                         ASSERT(prevnode);
 125                         /* Make a different thread execute for next step */
 126                         scheduler->add_sleep(get_thread(next->get_tid()));
 127                         tid = prevnode->get_next_backtrack();
 128                         /* Make sure the backtracked thread isn't sleeping. */
 129                         node_stack->pop_restofstack(1);
 130                         if (diverge == earliest_diverge) {
 131                                 earliest_diverge = prevnode->get_action();
 132                         }
 133                 }
 134                 /* Start the round robin scheduler from this thread id */
 135                 scheduler->set_scheduler_thread(tid);
 136                 /* The correct sleep set is in the parent node. */
 137                 execute_sleep_set();
 138
 139                 DEBUG("*** Divergence point ***\n");
 140
 141                 diverge = NULL;
 142         } else {
 143                 tid = next->get_tid();
 144         }
 145         DEBUG("*** ModelChecker chose next thread = %d ***\n", id_to_int(tid));
 146         ASSERT(tid != THREAD_ID_T_NONE);
 147         return get_thread(id_to_int(tid));
 148 }
 149
 150 /**
 151  * We need to know what the next actions of all threads in the sleep
 152  * set will be.  This method computes them and stores the actions at
 153  * the corresponding thread object's pending action.
 154  */
 155 void ModelChecker::execute_sleep_set()
 156 {
 157         for (unsigned int i = 0; i < get_num_threads(); i++) {
 158                 thread_id_t tid = int_to_id(i);
 159                 Thread *thr = get_thread(tid);
 160                 if (scheduler->is_sleep_set(thr) && thr->get_pending()) {
 161                         thr->get_pending()->set_sleep_flag();
 162                 }
 163         }
 164 }
 165
 166 /**
 167  * @brief Assert a bug in the executing program.
 168  *
 169  * Use this function to assert any sort of bug in the user program. If the
 170  * current trace is feasible (actually, a prefix of some feasible execution),
 171  * then this execution will be aborted, printing the appropriate message. If
 172  * the current trace is not yet feasible, the error message will be stashed and
 173  * printed if the execution ever becomes feasible.
 174  *
 175  * @param msg Descriptive message for the bug (do not include newline char)
 176  * @return True if bug is immediately-feasible
 177  */
 178 bool ModelChecker::assert_bug(const char *msg, ...)
 179 {
 180         char str[800];
 181
 182         va_list ap;
 183         va_start(ap, msg);
 184         vsnprintf(str, sizeof(str), msg, ap);
 185         va_end(ap);
 186
 187         return execution->assert_bug(str);
 188 }
 189
 190 /**
 191  * @brief Assert a bug in the executing program, asserted by a user thread
 192  * @see ModelChecker::assert_bug
 193  * @param msg Descriptive message for the bug (do not include newline char)
 194  */
 195 void ModelChecker::assert_user_bug(const char *msg)
 196 {
 197         /* If feasible bug, bail out now */
 198         if (assert_bug(msg))
 199                 switch_to_master(NULL);
 200 }
 201
 202 /** @brief Print bug report listing for this execution (if any bugs exist) */
 203 void ModelChecker::print_bugs() const
 204 {
 205         SnapVector<bug_message *> *bugs = execution->get_bugs();
 206
 207         model_print("Bug report: %zu bug%s detected\n",
 208                         bugs->size(),
 209                         bugs->size() > 1 ? "s" : "");
 210         for (unsigned int i = 0; i < bugs->size(); i++)
 211                 (*bugs)[i]->print();
 212 }
 213
 214 /**
 215  * @brief Record end-of-execution stats
 216  *
 217  * Must be run when exiting an execution. Records various stats.
 218  * @see struct execution_stats
 219  */
 220 void ModelChecker::record_stats()
 221 {
 222         stats.num_total++;
 223         if (!execution->isfeasibleprefix())
 224                 stats.num_infeasible++;
 225         else if (execution->have_bug_reports())
 226                 stats.num_buggy_executions++;
 227         else if (execution->is_complete_execution())
 228                 stats.num_complete++;
 229         else {
 230                 stats.num_redundant++;
 231
 232                 /**
 233                  * @todo We can violate this ASSERT() when fairness/sleep sets
 234                  * conflict to cause an execution to terminate, e.g. with:
 235                  * Scheduler: [0: disabled][1: disabled][2: sleep][3: current, enabled]
 236                  */
 237                 //ASSERT(scheduler->all_threads_sleeping());
 238         }
 239 }
 240
 241 /** @brief Print execution stats */
 242 void ModelChecker::print_stats() const
 243 {
 244         model_print("Number of complete, bug-free executions: %d\n", stats.num_complete);
 245         model_print("Number of redundant executions: %d\n", stats.num_redundant);
 246         model_print("Number of buggy executions: %d\n", stats.num_buggy_executions);
 247         model_print("Number of infeasible executions: %d\n", stats.num_infeasible);
 248         model_print("Total executions: %d\n", stats.num_total);
 249         if (params.verbose)
 250                 model_print("Total nodes created: %d\n", node_stack->get_total_nodes());
 251 }
 252
 253 /**
 254  * @brief End-of-exeuction print
 255  * @param printbugs Should any existing bugs be printed?
 256  */
 257 void ModelChecker::print_execution(bool printbugs) const
 258 {
 259         model_print("Program output from execution %d:\n",
 260                         get_execution_number());
 261         print_program_output();
 262
 263         if (params.verbose >= 3) {
 264                 model_print("\nEarliest divergence point since last feasible execution:\n");
 265                 if (earliest_diverge)
 266                         earliest_diverge->print();
 267                 else
 268                         model_print("(Not set)\n");
 269
 270                 model_print("\n");
 271                 print_stats();
 272         }
 273
 274         /* Don't print invalid bugs */
 275         if (printbugs && execution->have_bug_reports()) {
 276                 model_print("\n");
 277                 print_bugs();
 278         }
 279
 280         model_print("\n");
 281         execution->print_summary();
 282 }
 283
 284 /**
 285  * Queries the model-checker for more executions to explore and, if one
 286  * exists, resets the model-checker state to execute a new execution.
 287  *
 288  * @return If there are more executions to explore, return true. Otherwise,
 289  * return false.
 290  */
 291 bool ModelChecker::next_execution()
 292 {
 293         DBG();
 294         /* Is this execution a feasible execution that's worth bug-checking? */
 295         bool complete = execution->isfeasibleprefix() &&
 296                 (execution->is_complete_execution() ||
 297                  execution->have_bug_reports());
 298
 299         /* End-of-execution bug checks */
 300         if (complete) {
 301                 if (execution->is_deadlocked())
 302                         assert_bug("Deadlock detected");
 303
 304                 checkDataRaces();
 305                 run_trace_analyses();
 306         } else if (inspect_plugin && !execution->is_complete_execution() &&
 307                 (execution->too_many_steps())) {
 308                  inspect_plugin->analyze(execution->get_action_trace());
 309         }
 310
 311         record_stats();
 312
 313         /* Output */
 314         if ( (complete && params.verbose) || params.verbose>1 || (complete && execution->have_bug_reports()))
 315                 print_execution(complete);
 316         else
 317                 clear_program_output();
 318
 319         if (complete)
 320                 earliest_diverge = NULL;
 321
 322         if (restart_flag) {
 323                 do_restart();
 324                 return true;
 325         }
 326
 327         if (exit_flag)
 328                 return false;
 329
 330         if ((diverge = execution->get_next_backtrack()) == NULL)
 331                 return false;
 332
 333         if (DBG_ENABLED()) {
 334                 model_print("Next execution will diverge at:\n");
 335                 diverge->print();
 336         }
 337
 338         execution_number++;
 339
 340         if (params.maxexecutions != 0 && stats.num_complete >= params.maxexecutions)
 341                 return false;
 342
 343         reset_to_initial_state();
 344         return true;
 345 }
 346
 347 /** @brief Run trace analyses on complete trace */
 348 void ModelChecker::run_trace_analyses() {
 349         for (unsigned int i = 0; i < trace_analyses.size(); i++)
 350                 trace_analyses[i]->analyze(execution->get_action_trace());
 351 }
 352
 353 /**
 354  * @brief Get a Thread reference by its ID
 355  * @param tid The Thread's ID
 356  * @return A Thread reference
 357  */
 358 Thread * ModelChecker::get_thread(thread_id_t tid) const
 359 {
 360         return execution->get_thread(tid);
 361 }
 362
 363 /**
 364  * @brief Get a reference to the Thread in which a ModelAction was executed
 365  * @param act The ModelAction
 366  * @return A Thread reference
 367  */
 368 Thread * ModelChecker::get_thread(const ModelAction *act) const
 369 {
 370         return execution->get_thread(act);
 371 }
 372
 373 /**
 374  * Switch from a model-checker context to a user-thread context. This is the
 375  * complement of ModelChecker::switch_to_master and must be called from the
 376  * model-checker context
 377  *
 378  * @param thread The user-thread to switch to
 379  */
 380 void ModelChecker::switch_from_master(Thread *thread)
 381 {
 382         scheduler->set_current_thread(thread);
 383         Thread::swap(&system_context, thread);
 384 }
 385
 386 /**
 387  * Switch from a user-context to the "master thread" context (a.k.a. system
 388  * context). This switch is made with the intention of exploring a particular
 389  * model-checking action (described by a ModelAction object). Must be called
 390  * from a user-thread context.
 391  *
 392  * @param act The current action that will be explored. May be NULL only if
 393  * trace is exiting via an assertion (see ModelExecution::set_assert and
 394  * ModelExecution::has_asserted).
 395  * @return Return the value returned by the current action
 396  */
 397 uint64_t ModelChecker::switch_to_master(ModelAction *act)
 398 {
 399         DBG();
 400         Thread *old = thread_current();
 401         scheduler->set_current_thread(NULL);
 402         ASSERT(!old->get_pending());
 403         if (inspect_plugin != NULL) {
 404                 inspect_plugin->inspectModelAction(act);
 405         }
 406         old->set_pending(act);
 407         if (Thread::swap(old, &system_context) < 0) {
 408                 perror("swap threads");
 409                 exit(EXIT_FAILURE);
 410         }
 411         return old->get_return_value();
 412 }
 413
 414 /** Wrapper to run the user's main function, with appropriate arguments */
 415 void user_main_wrapper(void *)
 416 {
 417         user_main(model->params.argc, model->params.argv);
 418 }
 419
 420 bool ModelChecker::should_terminate_execution()
 421 {
 422         /* Infeasible -> don't take any more steps */
 423         if (execution->is_infeasible())
 424                 return true;
 425         else if (execution->isfeasibleprefix() && execution->have_bug_reports()) {
 426                 execution->set_assert();
 427                 return true;
 428         }
 429
 430         if (execution->too_many_steps())
 431                 return true;
 432         return false;
 433 }
 434
 435 /** @brief Exit ModelChecker upon returning to the run loop of the
 436  *      model checker. */
 437 void ModelChecker::exit_model_checker()
 438 {
 439         exit_flag = true;
 440 }
 441
 442 /** @brief Restart ModelChecker upon returning to the run loop of the
 443  *      model checker. */
 444 void ModelChecker::restart()
 445 {
 446         restart_flag = true;
 447 }
 448
 449 void ModelChecker::do_restart()
 450 {
 451         restart_flag = false;
 452         diverge = NULL;
 453         earliest_diverge = NULL;
 454         reset_to_initial_state();
 455         node_stack->full_reset();
 456         memset(&stats,0,sizeof(struct execution_stats));
 457         execution_number = 1;
 458 }
 459
 460 /** @brief Run ModelChecker for the user program */
 461 void ModelChecker::run()
 462 {
 463         bool has_next;
 464         do {
 465                 thrd_t user_thread;
 466                 Thread *t = new Thread(execution->get_next_id(), &user_thread, &user_main_wrapper, NULL, NULL);
 467                 execution->add_thread(t);
 468
 469                 do {
 470                         /*
 471                          * Stash next pending action(s) for thread(s). There
 472                          * should only need to stash one thread's action--the
 473                          * thread which just took a step--plus the first step
 474                          * for any newly-created thread
 475                          */
 476                         for (unsigned int i = 0; i < get_num_threads(); i++) {
 477                                 thread_id_t tid = int_to_id(i);
 478                                 Thread *thr = get_thread(tid);
 479                                 if (!thr->is_model_thread() && !thr->is_complete() && !thr->get_pending()) {
 480                                         switch_from_master(thr);
 481                                         if (thr->is_waiting_on(thr))
 482                                                 assert_bug("Deadlock detected (thread %u)", i);
 483                                 }
 484                         }
 485
 486                         /* Don't schedule threads which should be disabled */
 487                         for (unsigned int i = 0; i < get_num_threads(); i++) {
 488                                 Thread *th = get_thread(int_to_id(i));
 489                                 ModelAction *act = th->get_pending();
 490                                 if (act && execution->is_enabled(th) && !execution->check_action_enabled(act)) {
 491                                         scheduler->sleep(th);
 492                                 }
 493                         }
 494
 495                         /* Catch assertions from prior take_step or from
 496                          * between-ModelAction bugs (e.g., data races) */
 497                         if (execution->has_asserted())
 498                                 break;
 499
 500                         if (!t)
 501                                 t = get_next_thread();
 502                         if (!t || t->is_model_thread())
 503                                 break;
 504
 505                         /* Consume the next action for a Thread */
 506                         ModelAction *curr = t->get_pending();
 507                         t->set_pending(NULL);
 508                         t = execution->take_step(curr);
 509                 } while (!should_terminate_execution());
 510
 511                 has_next = next_execution();
 512                 if (inspect_plugin != NULL && !has_next) {
 513                         inspect_plugin->actionAtModelCheckingFinish();
 514                         // Check if the inpect plugin set the restart flag
 515                         if (restart_flag) {
 516                                 model_print("******* Model-checking RESTART: *******\n");
 517                                 has_next = true;
 518                                 do_restart();
 519                         }
 520                 }
 521         } while (has_next);
 522
 523         execution->fixup_release_sequences();
 524
 525         model_print("******* Model-checking complete: *******\n");
 526         print_stats();
 527
 528         /* Have the trace analyses dump their output. */
 529         for (unsigned int i = 0; i < trace_analyses.size(); i++)
 530                 trace_analyses[i]->finish();
 531 }