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 *) {
31 #define SIGSTACKSIZE 65536
32 static void mprot_handle_pf(int sig, siginfo_t *si, void *unused)
34 model_print("Segmentation fault at %p\n", si->si_addr);
35 model_print("For debugging, place breakpoint at: %s:%d\n",
37 print_trace(); // Trace printing may cause dynamic memory allocation
42 void install_handler() {
44 ss.ss_sp = model_malloc(SIGSTACKSIZE);
45 ss.ss_size = SIGSTACKSIZE;
47 sigaltstack(&ss, NULL);
49 sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESTART | SA_ONSTACK;
50 sigemptyset(&sa.sa_mask);
51 sa.sa_sigaction = mprot_handle_pf;
53 if (sigaction(SIGSEGV, &sa, NULL) == -1) {
54 perror("sigaction(SIGSEGV)");
60 /** @brief Constructor */
61 ModelChecker::ModelChecker() :
62 /* Initialize default scheduler */
64 scheduler(new Scheduler()),
65 history(new ModelHistory()),
66 execution(new ModelExecution(this, scheduler)),
72 model_print("C11Tester\n"
73 "Copyright (c) 2013 and 2019 Regents of the University of California. All rights reserved.\n"
74 "Distributed under the GPLv2\n"
75 "Written by Weiyu Luo, Brian Norris, and Brian Demsky\n\n");
76 memset(&stats,0,sizeof(struct execution_stats));
77 init_thread = new Thread(execution->get_next_id(), (thrd_t *) model_malloc(sizeof(thrd_t)), &placeholder, NULL, NULL);
79 init_thread->setTLS((char *)get_tls_addr());
81 execution->add_thread(init_thread);
82 scheduler->set_current_thread(init_thread);
84 execution->setParams(¶ms);
85 param_defaults(¶ms);
86 parse_options(¶ms);
88 /* Configure output redirection for the model-checker */
92 /** @brief Destructor */
93 ModelChecker::~ModelChecker()
98 /** Method to set parameters */
99 model_params * ModelChecker::getParams() {
104 * Restores user program to initial state and resets all model-checker data
107 void ModelChecker::reset_to_initial_state()
111 * FIXME: if we utilize partial rollback, we will need to free only
112 * those pending actions which were NOT pending before the rollback
115 for (unsigned int i = 0;i < get_num_threads();i++)
116 delete get_thread(int_to_id(i))->get_pending();
118 snapshot_roll_back(snapshot);
121 /** @return the number of user threads created during this execution */
122 unsigned int ModelChecker::get_num_threads() const
124 return execution->get_num_threads();
128 * Must be called from user-thread context (e.g., through the global
129 * thread_current() interface)
131 * @return The currently executing Thread.
133 Thread * ModelChecker::get_current_thread() const
135 return scheduler->get_current_thread();
139 * @brief Choose the next thread to execute.
141 * This function chooses the next thread that should execute. It can enforce
142 * execution replay/backtracking or, if the model-checker has no preference
143 * regarding the next thread (i.e., when exploring a new execution ordering),
144 * we defer to the scheduler.
146 * @return The next chosen thread to run, if any exist. Or else if the current
147 * execution should terminate, return NULL.
149 Thread * ModelChecker::get_next_thread()
153 * Have we completed exploring the preselected path? Then let the
156 return scheduler->select_next_thread();
160 * @brief Assert a bug in the executing program.
162 * Use this function to assert any sort of bug in the user program. If the
163 * current trace is feasible (actually, a prefix of some feasible execution),
164 * then this execution will be aborted, printing the appropriate message. If
165 * the current trace is not yet feasible, the error message will be stashed and
166 * printed if the execution ever becomes feasible.
168 * @param msg Descriptive message for the bug (do not include newline char)
169 * @return True if bug is immediately-feasible
171 void ModelChecker::assert_bug(const char *msg, ...)
177 vsnprintf(str, sizeof(str), msg, ap);
180 execution->assert_bug(str);
184 * @brief Assert a bug in the executing program, asserted by a user thread
185 * @see ModelChecker::assert_bug
186 * @param msg Descriptive message for the bug (do not include newline char)
188 void ModelChecker::assert_user_bug(const char *msg)
190 /* If feasible bug, bail out now */
195 /** @brief Print bug report listing for this execution (if any bugs exist) */
196 void ModelChecker::print_bugs() const
198 SnapVector<bug_message *> *bugs = execution->get_bugs();
200 model_print("Bug report: %zu bug%s detected\n",
202 bugs->size() > 1 ? "s" : "");
203 for (unsigned int i = 0;i < bugs->size();i++)
204 (*bugs)[i] -> print();
208 * @brief Record end-of-execution stats
210 * Must be run when exiting an execution. Records various stats.
211 * @see struct execution_stats
213 void ModelChecker::record_stats()
216 if (execution->have_bug_reports())
217 stats.num_buggy_executions ++;
218 else if (execution->is_complete_execution())
219 stats.num_complete ++;
221 //All threads are sleeping
223 * @todo We can violate this ASSERT() when fairness/sleep sets
224 * conflict to cause an execution to terminate, e.g. with:
225 * Scheduler: [0: disabled][1: disabled][2: sleep][3: current, enabled]
227 //ASSERT(scheduler->all_threads_sleeping());
231 /** @brief Print execution stats */
232 void ModelChecker::print_stats() const
234 model_print("Number of complete, bug-free executions: %d\n", stats.num_complete);
235 model_print("Number of buggy executions: %d\n", stats.num_buggy_executions);
236 model_print("Total executions: %d\n", stats.num_total);
240 * @brief End-of-exeuction print
241 * @param printbugs Should any existing bugs be printed?
243 void ModelChecker::print_execution(bool printbugs) const
245 model_print("Program output from execution %d:\n",
246 get_execution_number());
247 print_program_output();
249 if (params.verbose >= 3) {
253 /* Don't print invalid bugs */
254 if (printbugs && execution->have_bug_reports()) {
260 execution->print_summary();
264 * Queries the model-checker for more executions to explore and, if one
265 * exists, resets the model-checker state to execute a new execution.
267 * @return If there are more executions to explore, return true. Otherwise,
270 void ModelChecker::finish_execution(bool more_executions)
273 /* Is this execution a feasible execution that's worth bug-checking? */
274 bool complete = (execution->is_complete_execution() ||
275 execution->have_bug_reports());
277 /* End-of-execution bug checks */
279 if (execution->is_deadlocked())
280 assert_bug("Deadlock detected");
282 run_trace_analyses();
287 if ( (complete && params.verbose) || params.verbose>1 || (complete && execution->have_bug_reports()))
288 print_execution(complete);
290 clear_program_output();
293 history->set_new_exec_flag();
296 reset_to_initial_state();
299 /** @brief Run trace analyses on complete trace */
300 void ModelChecker::run_trace_analyses() {
301 for (unsigned int i = 0;i < trace_analyses.size();i ++)
302 trace_analyses[i] -> analyze(execution->get_action_trace());
306 * @brief Get a Thread reference by its ID
307 * @param tid The Thread's ID
308 * @return A Thread reference
310 Thread * ModelChecker::get_thread(thread_id_t tid) const
312 return execution->get_thread(tid);
316 * @brief Get a reference to the Thread in which a ModelAction was executed
317 * @param act The ModelAction
318 * @return A Thread reference
320 Thread * ModelChecker::get_thread(const ModelAction *act) const
322 return execution->get_thread(act);
325 void ModelChecker::startRunExecution(Thread *old) {
327 if (params.traceminsize != 0 &&
328 execution->get_curr_seq_num() > checkfree) {
329 checkfree += params.checkthreshold;
330 execution->collectActions();
333 thread_chosen = false;
335 Thread *thr = getNextThread(old);
336 if (thr != nullptr) {
337 scheduler->set_current_thread(thr);
339 if (Thread::swap(old, thr) < 0) {
340 perror("swap threads");
346 if (!handleChosenThread(old)) {
352 Thread* ModelChecker::getNextThread(Thread *old)
354 Thread *nextThread = nullptr;
355 for (unsigned int i = curr_thread_num;i < get_num_threads();i++) {
356 thread_id_t tid = int_to_id(i);
357 Thread *thr = get_thread(tid);
359 if (!thr->is_complete()) {
360 if (!thr->get_pending()) {
365 } else if (thr != old && !thr->is_freed()) {
366 thr->freeResources();
369 ModelAction *act = thr->get_pending();
370 if (act && execution->is_enabled(tid)){
371 /* Don't schedule threads which should be disabled */
372 if (!execution->check_action_enabled(act)) {
373 scheduler->sleep(thr);
376 /* Allow pending relaxed/release stores or thread actions to perform first */
377 else if (!thread_chosen) {
378 if (act->is_write()) {
379 std::memory_order order = act->get_mo();
380 if (order == std::memory_order_relaxed || \
381 order == std::memory_order_release) {
383 thread_chosen = true;
385 } else if (act->get_type() == THREAD_CREATE || \
386 act->get_type() == PTHREAD_CREATE || \
387 act->get_type() == THREAD_START || \
388 act->get_type() == THREAD_FINISH) {
390 thread_chosen = true;
398 /* Swap back to system_context and terminate this execution */
399 void ModelChecker::finishRunExecution(Thread *old)
401 scheduler->set_current_thread(NULL);
403 /** Reset curr_thread_num to initial value for next execution. */
406 /** If we have more executions, we won't make it past this call. */
407 finish_execution(execution_number < params.maxexecutions);
410 /** We finished the final execution. Print stuff and exit. */
411 model_print("******* Model-checking complete: *******\n");
414 /* Have the trace analyses dump their output. */
415 for (unsigned int i = 0;i < trace_analyses.size();i++)
416 trace_analyses[i]->finish();
418 /* unlink tmp file created by last child process */
420 snprintf_(filename, sizeof(filename), "C11FuzzerTmp%d", getpid());
427 uint64_t ModelChecker::switch_thread(ModelAction *act)
430 static bool fork_message_printed = false;
432 if (!fork_message_printed) {
433 model_print("Fork handler or dead thread trying to call into model checker...\n");
434 fork_message_printed = true;
440 Thread *old = thread_current();
441 old->set_state(THREAD_READY);
443 ASSERT(!old->get_pending());
445 if (inspect_plugin != NULL) {
446 inspect_plugin->inspectModelAction(act);
449 old->set_pending(act);
451 if (old->is_waiting_on(old))
452 assert_bug("Deadlock detected (thread %u)", curr_thread_num);
454 Thread* next = getNextThread(old);
455 if (next != nullptr) {
456 scheduler->set_current_thread(next);
457 if (Thread::swap(old, next) < 0) {
458 perror("swap threads");
462 if (handleChosenThread(old)) {
463 startRunExecution(old);
466 return old->get_return_value();
469 bool ModelChecker::handleChosenThread(Thread *old)
471 if (execution->has_asserted()) {
472 finishRunExecution(old);
475 if (!chosen_thread) {
476 chosen_thread = get_next_thread();
478 if (!chosen_thread || chosen_thread->is_model_thread()) {
479 finishRunExecution(old);
482 if (chosen_thread->just_woken_up()) {
483 chosen_thread->set_wakeup_state(false);
484 chosen_thread->set_pending(NULL);
485 chosen_thread = NULL;
486 // Allow this thread to stash the next pending action
490 // Consume the next action for a Thread
491 ModelAction *curr = chosen_thread->get_pending();
492 chosen_thread->set_pending(NULL);
493 chosen_thread = execution->take_step(curr);
495 if (should_terminate_execution()) {
496 finishRunExecution(old);
503 void ModelChecker::startChecker() {
505 //Need to initial random number generator state to avoid resets on rollback
506 initstate(423121, random_state, sizeof(random_state));
508 snapshot = take_snapshot();
510 //reset random number generator state
511 setstate(random_state);
513 install_trace_analyses(get_execution());
518 bool ModelChecker::should_terminate_execution()
520 if (execution->have_bug_reports()) {
521 execution->set_assert();
523 } else if (execution->isFinished()) {