11 #include "snapshot-interface.h"
14 #include "threads-model.h"
16 #include "traceanalysis.h"
17 #include "execution.h"
19 #include "bugmessage.h"
23 ModelChecker *model = NULL;
25 void placeholder(void *) {
29 /** @brief Constructor */
30 ModelChecker::ModelChecker() :
31 /* Initialize default scheduler */
33 scheduler(new Scheduler()),
34 history(new ModelHistory()),
35 execution(new ModelExecution(this, scheduler)),
40 model_print("C11Tester\n"
41 "Copyright (c) 2013 and 2019 Regents of the University of California. All rights reserved.\n"
42 "Distributed under the GPLv2\n"
43 "Written by Weiyu Luo, Brian Norris, and Brian Demsky\n\n");
44 memset(&stats,0,sizeof(struct execution_stats));
45 init_thread = new Thread(execution->get_next_id(), (thrd_t *) model_malloc(sizeof(thrd_t)), &placeholder, NULL, NULL);
47 init_thread->setTLS((char *)get_tls_addr());
49 execution->add_thread(init_thread);
50 scheduler->set_current_thread(init_thread);
52 execution->setParams(¶ms);
53 param_defaults(¶ms);
54 parse_options(¶ms);
56 /* Configure output redirection for the model-checker */
58 install_trace_analyses(get_execution());
61 /** @brief Destructor */
62 ModelChecker::~ModelChecker()
67 /** Method to set parameters */
68 model_params * ModelChecker::getParams() {
73 * Restores user program to initial state and resets all model-checker data
76 void ModelChecker::reset_to_initial_state()
80 * FIXME: if we utilize partial rollback, we will need to free only
81 * those pending actions which were NOT pending before the rollback
84 for (unsigned int i = 0;i < get_num_threads();i++)
85 delete get_thread(int_to_id(i))->get_pending();
87 snapshot_roll_back(snapshot);
90 /** @return the number of user threads created during this execution */
91 unsigned int ModelChecker::get_num_threads() const
93 return execution->get_num_threads();
97 * Must be called from user-thread context (e.g., through the global
98 * thread_current() interface)
100 * @return The currently executing Thread.
102 Thread * ModelChecker::get_current_thread() const
104 return scheduler->get_current_thread();
108 * @brief Choose the next thread to execute.
110 * This function chooses the next thread that should execute. It can enforce
111 * execution replay/backtracking or, if the model-checker has no preference
112 * regarding the next thread (i.e., when exploring a new execution ordering),
113 * we defer to the scheduler.
115 * @return The next chosen thread to run, if any exist. Or else if the current
116 * execution should terminate, return NULL.
118 Thread * ModelChecker::get_next_thread()
122 * Have we completed exploring the preselected path? Then let the
125 return scheduler->select_next_thread();
129 * @brief Assert a bug in the executing program.
131 * Use this function to assert any sort of bug in the user program. If the
132 * current trace is feasible (actually, a prefix of some feasible execution),
133 * then this execution will be aborted, printing the appropriate message. If
134 * the current trace is not yet feasible, the error message will be stashed and
135 * printed if the execution ever becomes feasible.
137 * @param msg Descriptive message for the bug (do not include newline char)
138 * @return True if bug is immediately-feasible
140 void ModelChecker::assert_bug(const char *msg, ...)
146 vsnprintf(str, sizeof(str), msg, ap);
149 execution->assert_bug(str);
153 * @brief Assert a bug in the executing program, asserted by a user thread
154 * @see ModelChecker::assert_bug
155 * @param msg Descriptive message for the bug (do not include newline char)
157 void ModelChecker::assert_user_bug(const char *msg)
159 /* If feasible bug, bail out now */
161 switch_to_master(NULL);
164 /** @brief Print bug report listing for this execution (if any bugs exist) */
165 void ModelChecker::print_bugs() const
167 SnapVector<bug_message *> *bugs = execution->get_bugs();
169 model_print("Bug report: %zu bug%s detected\n",
171 bugs->size() > 1 ? "s" : "");
172 for (unsigned int i = 0;i < bugs->size();i++)
173 (*bugs)[i] -> print();
177 * @brief Record end-of-execution stats
179 * Must be run when exiting an execution. Records various stats.
180 * @see struct execution_stats
182 void ModelChecker::record_stats()
185 if (execution->have_bug_reports())
186 stats.num_buggy_executions ++;
187 else if (execution->is_complete_execution())
188 stats.num_complete ++;
190 //All threads are sleeping
192 * @todo We can violate this ASSERT() when fairness/sleep sets
193 * conflict to cause an execution to terminate, e.g. with:
194 * Scheduler: [0: disabled][1: disabled][2: sleep][3: current, enabled]
196 //ASSERT(scheduler->all_threads_sleeping());
200 /** @brief Print execution stats */
201 void ModelChecker::print_stats() const
203 model_print("Number of complete, bug-free executions: %d\n", stats.num_complete);
204 model_print("Number of buggy executions: %d\n", stats.num_buggy_executions);
205 model_print("Total executions: %d\n", stats.num_total);
209 * @brief End-of-exeuction print
210 * @param printbugs Should any existing bugs be printed?
212 void ModelChecker::print_execution(bool printbugs) const
214 model_print("Program output from execution %d:\n",
215 get_execution_number());
216 print_program_output();
218 if (params.verbose >= 3) {
222 /* Don't print invalid bugs */
223 if (printbugs && execution->have_bug_reports()) {
229 execution->print_summary();
233 * Queries the model-checker for more executions to explore and, if one
234 * exists, resets the model-checker state to execute a new execution.
236 * @return If there are more executions to explore, return true. Otherwise,
239 void ModelChecker::finish_execution(bool more_executions)
242 /* Is this execution a feasible execution that's worth bug-checking? */
243 bool complete = (execution->is_complete_execution() ||
244 execution->have_bug_reports());
246 /* End-of-execution bug checks */
248 if (execution->is_deadlocked())
249 assert_bug("Deadlock detected");
251 run_trace_analyses();
256 if ( (complete && params.verbose) || params.verbose>1 || (complete && execution->have_bug_reports()))
257 print_execution(complete);
259 clear_program_output();
264 reset_to_initial_state();
265 history->set_new_exec_flag();
268 /** @brief Run trace analyses on complete trace */
269 void ModelChecker::run_trace_analyses() {
270 for (unsigned int i = 0;i < trace_analyses.size();i ++)
271 trace_analyses[i] -> analyze(execution->get_action_trace());
275 * @brief Get a Thread reference by its ID
276 * @param tid The Thread's ID
277 * @return A Thread reference
279 Thread * ModelChecker::get_thread(thread_id_t tid) const
281 return execution->get_thread(tid);
285 * @brief Get a reference to the Thread in which a ModelAction was executed
286 * @param act The ModelAction
287 * @return A Thread reference
289 Thread * ModelChecker::get_thread(const ModelAction *act) const
291 return execution->get_thread(act);
295 * Switch from a model-checker context to a user-thread context. This is the
296 * complement of ModelChecker::switch_to_master and must be called from the
297 * model-checker context
299 * @param thread The user-thread to switch to
301 void ModelChecker::switch_from_master(Thread *thread)
303 scheduler->set_current_thread(thread);
304 Thread::swap(&system_context, thread);
308 * Switch from a user-context to the "master thread" context (a.k.a. system
309 * context). This switch is made with the intention of exploring a particular
310 * model-checking action (described by a ModelAction object). Must be called
311 * from a user-thread context.
313 * @param act The current action that will be explored. May be NULL only if
314 * trace is exiting via an assertion (see ModelExecution::set_assert and
315 * ModelExecution::has_asserted).
316 * @return Return the value returned by the current action
318 uint64_t ModelChecker::switch_to_master(ModelAction *act)
321 static bool fork_message_printed = false;
323 if (!fork_message_printed) {
324 model_print("Fork handler or dead thread trying to call into model checker...\n");
325 fork_message_printed = true;
331 Thread *old = thread_current();
332 scheduler->set_current_thread(NULL);
333 ASSERT(!old->get_pending());
335 if (inspect_plugin != NULL) {
336 inspect_plugin->inspectModelAction(act);
339 old->set_pending(act);
340 if (Thread::swap(old, &system_context) < 0) {
341 perror("swap threads");
344 return old->get_return_value();
347 void ModelChecker::continueRunExecution(Thread *old)
350 if (params.traceminsize != 0 &&
351 execution->get_curr_seq_num() > checkfree) {
352 checkfree += params.checkthreshold;
353 execution->collectActions();
356 thread_chosen = false;
358 Thread *thr = getNextThread();
359 if (thr != nullptr) {
360 scheduler->set_current_thread(thr);
361 if (Thread::swap(old, thr) < 0) {
362 perror("swap threads");
366 handleChosenThread(old);
369 void ModelChecker::startRunExecution(ucontext_t *old)
372 if (params.traceminsize != 0 &&
373 execution->get_curr_seq_num() > checkfree) {
374 checkfree += params.checkthreshold;
375 execution->collectActions();
378 thread_chosen = false;
380 Thread *thr = getNextThread();
381 if (thr != nullptr) {
382 scheduler->set_current_thread(thr);
383 if (Thread::swap(old, thr) < 0) {
384 perror("swap threads");
388 handleChosenThread(old);
391 Thread* ModelChecker::getNextThread()
393 Thread *nextThread = nullptr;
394 for (unsigned int i = curr_thread_num; i < get_num_threads(); i++) {
395 thread_id_t tid = int_to_id(i);
396 Thread *thr = get_thread(tid);
398 if (!thr->is_complete() && !thr->get_pending()) {
403 ModelAction *act = thr->get_pending();
405 if (act && execution->is_enabled(thr) && !execution->check_action_enabled(act)) {
406 scheduler->sleep(thr);
409 // chooseThread(act, thr);
414 void ModelChecker::finishRunExecution(Thread *old)
416 scheduler->set_current_thread(NULL);
417 if (Thread::swap(old, &system_context) < 0) {
418 perror("swap threads");
423 void ModelChecker::finishRunExecution(ucontext_t *old)
425 scheduler->set_current_thread(NULL);
426 break_execution = true;
429 void ModelChecker::consumeAction()
431 ModelAction *curr = chosen_thread->get_pending();
432 Thread * th = thread_current();
433 if (curr->get_type() == THREAD_FINISH && th != NULL) {
434 // Thread finish must be consumed in the master context
435 scheduler->set_current_thread(NULL);
436 if (Thread::swap(th, &system_context) < 0) {
437 perror("swap threads");
441 chosen_thread->set_pending(NULL);
442 chosen_thread = execution->take_step(curr);
446 void ModelChecker::chooseThread(ModelAction *act, Thread *thr)
448 if (!thread_chosen && act && execution->is_enabled(thr) && (thr->get_state() != THREAD_BLOCKED) ) {
449 if (act->is_write()) {
450 std::memory_order order = act->get_mo();
451 if (order == std::memory_order_relaxed || \
452 order == std::memory_order_release) {
454 thread_chosen = true;
456 } else if (act->get_type() == THREAD_CREATE || \
457 act->get_type() == PTHREAD_CREATE || \
458 act->get_type() == THREAD_START || \
459 act->get_type() == THREAD_FINISH) {
461 thread_chosen = true;
466 uint64_t ModelChecker::switch_thread(ModelAction *act)
469 static bool fork_message_printed = false;
471 if (!fork_message_printed) {
472 model_print("Fork handler or dead thread trying to call into model checker...\n");
473 fork_message_printed = true;
479 Thread *old = thread_current();
480 ASSERT(!old->get_pending());
482 if (inspect_plugin != NULL) {
483 inspect_plugin->inspectModelAction(act);
486 old->set_pending(act);
488 if (old->is_waiting_on(old))
489 assert_bug("Deadlock detected (thread %u)", curr_thread_num);
491 if (act && execution->is_enabled(old) && !execution->check_action_enabled(act)) {
492 scheduler->sleep(old);
494 // chooseThread(act, old);
497 Thread* next = getNextThread();
499 handleNewValidThread(old, next);
501 old->set_state(THREAD_READY); // Just to avoid the first ASSERT in ModelExecution::take_step
502 handleChosenThread(old);
505 return old->get_return_value();
508 void ModelChecker::handleNewValidThread(Thread *old, Thread *next)
510 scheduler->set_current_thread(next);
512 if (Thread::swap(old, next) < 0) {
513 perror("swap threads");
518 void ModelChecker::handleChosenThread(Thread *old)
520 if (execution->has_asserted())
521 finishRunExecution(old);
523 chosen_thread = get_next_thread();
524 if (!chosen_thread || chosen_thread->is_model_thread())
525 finishRunExecution(old);
526 if (chosen_thread->just_woken_up()) {
527 chosen_thread->set_wakeup_state(false);
528 chosen_thread->set_pending(NULL);
529 chosen_thread = NULL;
530 // Allow this thread to stash the next pending action
531 if (should_terminate_execution())
532 finishRunExecution(old);
534 continueRunExecution(old);
536 /* Consume the next action for a Thread */
539 if (should_terminate_execution())
540 finishRunExecution(old);
542 continueRunExecution(old);
546 void ModelChecker::handleChosenThread(ucontext_t *old)
548 if (execution->has_asserted()) {
549 finishRunExecution(old);
553 chosen_thread = get_next_thread();
554 if (!chosen_thread || chosen_thread->is_model_thread()) {
555 finishRunExecution(old);
558 /* if (chosen_thread->just_woken_up()) {
559 chosen_thread->set_wakeup_state(false);
560 chosen_thread->set_pending(NULL);
561 chosen_thread = NULL;
562 // Allow this thread to stash the next pending action
563 if (should_terminate_execution())
564 finishRunExecution(old);
566 startRunExecution(old);
570 /* Consume the next action for a Thread */
573 if (should_terminate_execution())
574 finishRunExecution(old);
576 startRunExecution(old);
581 static void runChecker() {
586 void ModelChecker::startChecker() {
587 startExecution(get_system_context(), runChecker);
588 snapshot = take_snapshot();
592 bool ModelChecker::should_terminate_execution()
594 if (execution->have_bug_reports()) {
595 execution->set_assert();
597 } else if (execution->isFinished()) {
603 /** @brief Run ModelChecker for the user program */
604 void ModelChecker::run()
606 //Need to initial random number generator state to avoid resets on rollback
607 char random_state[256];
608 initstate(423121, random_state, sizeof(random_state));
609 checkfree = params.checkthreshold;
610 for(int exec = 0;exec < params.maxexecutions;exec++) {
611 chosen_thread = init_thread;
612 break_execution = false;
617 thread_chosen = false;
619 startRunExecution(&system_context);
620 } while (!should_terminate_execution());
622 finish_execution((exec+1) < params.maxexecutions);
623 //restore random number generator state after rollback
624 setstate(random_state);
627 model_print("******* Model-checking complete: *******\n");
630 /* Have the trace analyses dump their output. */
631 for (unsigned int i = 0;i < trace_analyses.size();i++)
632 trace_analyses[i]->finish();
634 /* unlink tmp file created by last child process */
636 snprintf_(filename, sizeof(filename), "C11FuzzerTmp%d", getpid());