Add some debug support code
[c11tester.git] / model.cc
index 1791695432cc0e7f3348e1564c06fd58c030d062..5b5ccf701c1798f9627c352f6ae50be4159fc929 100644 (file)
--- a/model.cc
+++ b/model.cc
 #include "history.h"
 #include "bugmessage.h"
 #include "params.h"
+#include "plugins.h"
 
 ModelChecker *model = NULL;
 
-/** Wrapper to run the user's main function, with appropriate arguments */
-void user_main_wrapper(void *)
+void placeholder(void *) {
+       ASSERT(0);
+}
+
+#include <signal.h>
+
+#define SIGSTACKSIZE 65536
+static void mprot_handle_pf(int sig, siginfo_t *si, void *unused)
 {
-       user_main(model->params.argc, model->params.argv);
+       model_print("Segmentation fault at %p\n", si->si_addr);
+       model_print("For debugging, place breakpoint at: %s:%d\n",
+                                                       __FILE__, __LINE__);
+       print_trace();  // Trace printing may cause dynamic memory allocation
+       while(1)
+               ;
+}
+
+void install_handler() {
+       stack_t ss;
+       ss.ss_sp = model_malloc(SIGSTACKSIZE);
+       ss.ss_size = SIGSTACKSIZE;
+       ss.ss_flags = 0;
+       sigaltstack(&ss, NULL);
+       struct sigaction sa;
+       sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESTART | SA_ONSTACK;
+       sigemptyset(&sa.sa_mask);
+       sa.sa_sigaction = mprot_handle_pf;
+
+       if (sigaction(SIGSEGV, &sa, NULL) == -1) {
+               perror("sigaction(SIGSEGV)");
+               exit(EXIT_FAILURE);
+       }
+
 }
 
 /** @brief Constructor */
 ModelChecker::ModelChecker() :
        /* Initialize default scheduler */
        params(),
-       restart_flag(false),
        scheduler(new Scheduler()),
-       execution(new ModelExecution(this, scheduler)),
        history(new ModelHistory()),
+       execution(new ModelExecution(this, scheduler)),
        execution_number(1),
        trace_analyses(),
        inspect_plugin(NULL)
 {
+       model_print("C11Tester\n"
+                                                       "Copyright (c) 2013 and 2019 Regents of the University of California. All rights reserved.\n"
+                                                       "Distributed under the GPLv2\n"
+                                                       "Written by Weiyu Luo, Brian Norris, and Brian Demsky\n\n");
        memset(&stats,0,sizeof(struct execution_stats));
-       init_thread = new Thread(execution->get_next_id(), (thrd_t *) model_malloc(sizeof(thrd_t)), &user_main_wrapper, NULL, NULL);    // L: user_main_wrapper passes the user program
+       init_thread = new Thread(execution->get_next_id(), (thrd_t *) model_malloc(sizeof(thrd_t)), &placeholder, NULL, NULL);
+#ifdef TLS
+       init_thread->setTLS((char *)get_tls_addr());
+#endif
        execution->add_thread(init_thread);
        scheduler->set_current_thread(init_thread);
+       register_plugins();
        execution->setParams(&params);
        param_defaults(&params);
+       parse_options(&params);
+       initRaceDetector();
+       /* Configure output redirection for the model-checker */
+       redirect_output();
+       install_trace_analyses(get_execution());
+       install_handler();
 }
 
 /** @brief Destructor */
@@ -73,7 +116,7 @@ void ModelChecker::reset_to_initial_state()
        for (unsigned int i = 0;i < get_num_threads();i++)
                delete get_thread(int_to_id(i))->get_pending();
 
-       snapshot_backtrack_before(0);
+       snapshot_roll_back(snapshot);
 }
 
 /** @return the number of user threads created during this execution */
@@ -126,7 +169,7 @@ Thread * ModelChecker::get_next_thread()
  * @param msg Descriptive message for the bug (do not include newline char)
  * @return True if bug is immediately-feasible
  */
-bool ModelChecker::assert_bug(const char *msg, ...)
+void ModelChecker::assert_bug(const char *msg, ...)
 {
        char str[800];
 
@@ -135,7 +178,7 @@ bool ModelChecker::assert_bug(const char *msg, ...)
        vsnprintf(str, sizeof(str), msg, ap);
        va_end(ap);
 
-       return execution->assert_bug(str);
+       execution->assert_bug(str);
 }
 
 /**
@@ -146,8 +189,8 @@ bool ModelChecker::assert_bug(const char *msg, ...)
 void ModelChecker::assert_user_bug(const char *msg)
 {
        /* If feasible bug, bail out now */
-       if (assert_bug(msg))
-               switch_to_master(NULL);
+       assert_bug(msg);
+       switch_to_master(NULL);
 }
 
 /** @brief Print bug report listing for this execution (if any bugs exist) */
@@ -159,7 +202,7 @@ void ModelChecker::print_bugs() const
                                                        bugs->size(),
                                                        bugs->size() > 1 ? "s" : "");
        for (unsigned int i = 0;i < bugs->size();i++)
-               (*bugs)[i]->print();
+               (*bugs)[i] -> print();
 }
 
 /**
@@ -170,16 +213,13 @@ void ModelChecker::print_bugs() const
  */
 void ModelChecker::record_stats()
 {
-       stats.num_total++;
-       if (!execution->isfeasibleprefix())
-               stats.num_infeasible++;
-       else if (execution->have_bug_reports())
-               stats.num_buggy_executions++;
+       stats.num_total ++;
+       if (execution->have_bug_reports())
+               stats.num_buggy_executions ++;
        else if (execution->is_complete_execution())
-               stats.num_complete++;
+               stats.num_complete ++;
        else {
-               stats.num_redundant++;
-
+               //All threads are sleeping
                /**
                 * @todo We can violate this ASSERT() when fairness/sleep sets
                 * conflict to cause an execution to terminate, e.g. with:
@@ -193,9 +233,7 @@ void ModelChecker::record_stats()
 void ModelChecker::print_stats() const
 {
        model_print("Number of complete, bug-free executions: %d\n", stats.num_complete);
-       model_print("Number of redundant executions: %d\n", stats.num_redundant);
        model_print("Number of buggy executions: %d\n", stats.num_buggy_executions);
-       model_print("Number of infeasible executions: %d\n", stats.num_infeasible);
        model_print("Total executions: %d\n", stats.num_total);
 }
 
@@ -230,12 +268,11 @@ void ModelChecker::print_execution(bool printbugs) const
  * @return If there are more executions to explore, return true. Otherwise,
  * return false.
  */
-bool ModelChecker::next_execution()
+void ModelChecker::finish_execution(bool more_executions)
 {
        DBG();
        /* Is this execution a feasible execution that's worth bug-checking? */
-       bool complete = execution->isfeasibleprefix() &&
-                                                                       (execution->is_complete_execution() ||
+       bool complete = (execution->is_complete_execution() ||
                                                                         execution->have_bug_reports());
 
        /* End-of-execution bug checks */
@@ -243,7 +280,6 @@ bool ModelChecker::next_execution()
                if (execution->is_deadlocked())
                        assert_bug("Deadlock detected");
 
-               checkDataRaces();
                run_trace_analyses();
        }
 
@@ -254,20 +290,17 @@ bool ModelChecker::next_execution()
        else
                clear_program_output();
 
-       if (restart_flag) {
-               do_restart();
-               return true;
-       }
 // test code
-       execution_number++;
-       reset_to_initial_state();
-       return false;
+       execution_number ++;
+       if (more_executions)
+               reset_to_initial_state();
+       history->set_new_exec_flag();
 }
 
 /** @brief Run trace analyses on complete trace */
 void ModelChecker::run_trace_analyses() {
-       for (unsigned int i = 0;i < trace_analyses.size();i++)
-               trace_analyses[i]->analyze(execution->get_action_trace());
+       for (unsigned int i = 0;i < trace_analyses.size();i ++)
+               trace_analyses[i] -> analyze(execution->get_action_trace());
 }
 
 /**
@@ -316,11 +349,11 @@ void ModelChecker::switch_from_master(Thread *thread)
  */
 uint64_t ModelChecker::switch_to_master(ModelAction *act)
 {
-       if (forklock) {
+       if (modellock) {
                static bool fork_message_printed = false;
 
                if (!fork_message_printed) {
-                       model_print("Fork handler trying to call into model checker...\n");
+                       model_print("Fork handler or dead thread trying to call into model checker...\n");
                        fork_message_printed = true;
                }
                delete act;
@@ -350,51 +383,17 @@ static void runChecker() {
 
 void ModelChecker::startChecker() {
        startExecution(get_system_context(), runChecker);
+       snapshot = take_snapshot();
+       initMainThread();
 }
 
 bool ModelChecker::should_terminate_execution()
 {
-       /* Infeasible -> don't take any more steps */
-       if (execution->is_infeasible())
-               return true;
-       else if (execution->isfeasibleprefix() && execution->have_bug_reports()) {
+       if (execution->have_bug_reports()) {
                execution->set_assert();
                return true;
-       }
-       return false;
-}
-
-/** @brief Restart ModelChecker upon returning to the run loop of the
- *     model checker. */
-void ModelChecker::restart()
-{
-       restart_flag = true;
-}
-
-void ModelChecker::do_restart()
-{
-       restart_flag = false;
-       reset_to_initial_state();
-       memset(&stats,0,sizeof(struct execution_stats));
-       execution_number = 1;
-}
-
-void ModelChecker::startMainThread() {
-       init_thread->set_state(THREAD_RUNNING);
-       scheduler->set_current_thread(init_thread);
-       thread_startup();
-}
-
-static bool is_nonsc_write(const ModelAction *act) {
-       if (act->get_type() == ATOMIC_WRITE) {
-               std::memory_order order = act->get_mo();
-               switch(order) {
-               case std::memory_order_relaxed:
-               case std::memory_order_release:
-                       return true;
-               default:
-                       return false;
-               }
+       } else if (execution->isFinished()) {
+               return true;
        }
        return false;
 }
@@ -405,23 +404,30 @@ void ModelChecker::run()
        //Need to initial random number generator state to avoid resets on rollback
        char random_state[256];
        initstate(423121, random_state, sizeof(random_state));
-
+       modelclock_t checkfree = params.checkthreshold;
        for(int exec = 0;exec < params.maxexecutions;exec++) {
                Thread * t = init_thread;
 
                do {
+                       /* Check whether we need to free model actions. */
+
+                       if (params.traceminsize != 0 &&
+                                       execution->get_curr_seq_num() > checkfree) {
+                               checkfree += params.checkthreshold;
+                               execution->collectActions();
+                       }
+
                        /*
                         * Stash next pending action(s) for thread(s). There
                         * should only need to stash one thread's action--the
                         * thread which just took a step--plus the first step
                         * for any newly-created thread
                         */
-                       ModelAction * pending;
                        for (unsigned int i = 0;i < get_num_threads();i++) {
                                thread_id_t tid = int_to_id(i);
                                Thread *thr = get_thread(tid);
-                               if (!thr->is_model_thread() && !thr->is_complete() && ((!(pending=thr->get_pending())) || is_nonsc_write(pending)) ) {
-                                       switch_from_master(thr);        // L: context swapped, and action type of thr changed.
+                               if (!thr->is_model_thread() && !thr->is_complete() && !thr->get_pending()) {
+                                       switch_from_master(thr);
                                        if (thr->is_waiting_on(thr))
                                                assert_bug("Deadlock detected (thread %u)", i);
                                }
@@ -466,13 +472,19 @@ void ModelChecker::run()
                                t = get_next_thread();
                        if (!t || t->is_model_thread())
                                break;
+                       if (t->just_woken_up()) {
+                               t->set_wakeup_state(false);
+                               t->set_pending(NULL);
+                               t = NULL;
+                               continue;       // Allow this thread to stash the next pending action
+                       }
 
                        /* Consume the next action for a Thread */
                        ModelAction *curr = t->get_pending();
                        t->set_pending(NULL);
                        t = execution->take_step(curr);
                } while (!should_terminate_execution());
-               next_execution();
+               finish_execution((exec+1) < params.maxexecutions);
                //restore random number generator state after rollback
                setstate(random_state);
        }
@@ -483,4 +495,9 @@ void ModelChecker::run()
        /* Have the trace analyses dump their output. */
        for (unsigned int i = 0;i < trace_analyses.size();i++)
                trace_analyses[i]->finish();
+
+       /* unlink tmp file created by last child process */
+       char filename[256];
+       snprintf_(filename, sizeof(filename), "C11FuzzerTmp%d", getpid());
+       unlink(filename);
 }