model.cc

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