add support for pthread_mutex
[c11tester.git] / model.cc
index 90ef906ef6348ed9cdfc6717c1eaab1fb3d9e886..39f0c694e9b7e440ee5ffa952ded7b4b06f0a7ca 100644 (file)
--- a/model.cc
+++ b/model.cc
@@ -2,6 +2,8 @@
 #include <algorithm>
 #include <new>
 #include <stdarg.h>
+#include <string.h>
+#include <cstdlib>
 
 #include "model.h"
 #include "action.h"
@@ -22,14 +24,18 @@ ModelChecker *model;
 ModelChecker::ModelChecker(struct model_params params) :
        /* Initialize default scheduler */
        params(params),
+       restart_flag(false),
+       exit_flag(false),
        scheduler(new Scheduler()),
        node_stack(new NodeStack()),
-       execution(new ModelExecution(this, &this->params, scheduler, node_stack)),
+       execution(new ModelExecution(this, &this->params, scheduler, node_stack)),      // L: Model thread is created inside
        execution_number(1),
        diverge(NULL),
        earliest_diverge(NULL),
-       trace_analyses()
+       trace_analyses(),
+       inspect_plugin(NULL)
 {
+       memset(&stats,0,sizeof(struct execution_stats));
 }
 
 /** @brief Destructor */
@@ -95,10 +101,9 @@ Thread * ModelChecker::get_next_thread()
         * Have we completed exploring the preselected path? Then let the
         * scheduler decide
         */
-       if (diverge == NULL)
+       if (diverge == NULL)    // W: diverge is set to NULL permanently
                return scheduler->select_next_thread(node_stack->get_head());
 
-
        /* Else, we are trying to replay an execution */
        ModelAction *next = node_stack->get_next()->get_action();
 
@@ -197,15 +202,13 @@ void ModelChecker::assert_user_bug(const char *msg)
 /** @brief Print bug report listing for this execution (if any bugs exist) */
 void ModelChecker::print_bugs() const
 {
-       if (execution->have_bug_reports()) {
-               SnapVector<bug_message *> *bugs = execution->get_bugs();
-
-               model_print("Bug report: %zu bug%s detected\n",
-                               bugs->size(),
-                               bugs->size() > 1 ? "s" : "");
-               for (unsigned int i = 0; i < bugs->size(); i++)
-                       (*bugs)[i]->print();
-       }
+       SnapVector<bug_message *> *bugs = execution->get_bugs();
+
+       model_print("Bug report: %zu bug%s detected\n",
+                       bugs->size(),
+                       bugs->size() > 1 ? "s" : "");
+       for (unsigned int i = 0; i < bugs->size(); i++)
+               (*bugs)[i]->print();
 }
 
 /**
@@ -243,7 +246,8 @@ void ModelChecker::print_stats() const
        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);
-       model_print("Total nodes created: %d\n", node_stack->get_total_nodes());
+       if (params.verbose)
+               model_print("Total nodes created: %d\n", node_stack->get_total_nodes());
 }
 
 /**
@@ -252,10 +256,12 @@ void ModelChecker::print_stats() const
  */
 void ModelChecker::print_execution(bool printbugs) const
 {
+       model_print("Program output from execution %d:\n",
+                       get_execution_number());
        print_program_output();
 
-       if (params.verbose) {
-               model_print("Earliest divergence point since last feasible execution:\n");
+       if (params.verbose >= 3) {
+               model_print("\nEarliest divergence point since last feasible execution:\n");
                if (earliest_diverge)
                        earliest_diverge->print();
                else
@@ -266,8 +272,10 @@ void ModelChecker::print_execution(bool printbugs) const
        }
 
        /* Don't print invalid bugs */
-       if (printbugs)
+       if (printbugs && execution->have_bug_reports()) {
+               model_print("\n");
                print_bugs();
+       }
 
        model_print("\n");
        execution->print_summary();
@@ -295,22 +303,41 @@ bool ModelChecker::next_execution()
 
                checkDataRaces();
                run_trace_analyses();
-       }
+       } 
 
        record_stats();
-
        /* Output */
-       if (params.verbose || (complete && execution->have_bug_reports()))
+       if ( (complete && params.verbose) || params.verbose>1 || (complete && execution->have_bug_reports()))
                print_execution(complete);
        else
                clear_program_output();
 
+       if (restart_flag) {
+               do_restart();
+               return true;
+       }
+// test code
+       execution_number++;
+       reset_to_initial_state();
+       node_stack->pop_restofstack(2);
+//     node_stack->full_reset();
+       diverge = NULL;
+       return false;
+/* test
        if (complete)
                earliest_diverge = NULL;
 
-       if ((diverge = execution->get_next_backtrack()) == NULL)
+       if (exit_flag)
                return false;
 
+//     diverge = execution->get_next_backtrack();
+       if (diverge == NULL) {
+               execution_number++;
+               reset_to_initial_state();
+               model_print("Does not diverge\n");
+               return false;
+       } 
+
        if (DBG_ENABLED()) {
                model_print("Next execution will diverge at:\n");
                diverge->print();
@@ -318,8 +345,13 @@ bool ModelChecker::next_execution()
 
        execution_number++;
 
+       if (params.maxexecutions != 0 && stats.num_complete >= params.maxexecutions)
+               return false;
+
        reset_to_initial_state();
        return true;
+*/
+
 }
 
 /** @brief Run trace analyses on complete trace */
@@ -348,26 +380,6 @@ Thread * ModelChecker::get_thread(const ModelAction *act) const
        return execution->get_thread(act);
 }
 
-/**
- * @brief Check if a Thread is currently enabled
- * @param t The Thread to check
- * @return True if the Thread is currently enabled
- */
-bool ModelChecker::is_enabled(Thread *t) const
-{
-       return scheduler->is_enabled(t);
-}
-
-/**
- * @brief Check if a Thread is currently enabled
- * @param tid The ID of the Thread to check
- * @return True if the Thread is currently enabled
- */
-bool ModelChecker::is_enabled(thread_id_t tid) const
-{
-       return scheduler->is_enabled(tid);
-}
-
 /**
  * Switch from a model-checker context to a user-thread context. This is the
  * complement of ModelChecker::switch_to_master and must be called from the
@@ -398,6 +410,10 @@ uint64_t ModelChecker::switch_to_master(ModelAction *act)
        Thread *old = thread_current();
        scheduler->set_current_thread(NULL);
        ASSERT(!old->get_pending());
+/* W: No plugin
+       if (inspect_plugin != NULL) {
+               inspect_plugin->inspectModelAction(act); 
+       }*/
        old->set_pending(act);
        if (Thread::swap(old, &system_context) < 0) {
                perror("swap threads");
@@ -427,14 +443,40 @@ bool ModelChecker::should_terminate_execution()
        return false;
 }
 
+/** @brief Exit ModelChecker upon returning to the run loop of the
+ *     model checker. */
+void ModelChecker::exit_model_checker()
+{
+       exit_flag = true;
+}
+
+/** @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;
+       diverge = NULL;
+       earliest_diverge = NULL;
+       reset_to_initial_state();
+       node_stack->full_reset();
+       memset(&stats,0,sizeof(struct execution_stats));
+       execution_number = 1;
+}
+
 /** @brief Run ModelChecker for the user program */
 void ModelChecker::run()
 {
+       bool has_next;
+       int i = 0;
        do {
                thrd_t user_thread;
-               Thread *t = new Thread(execution->get_next_id(), &user_thread, &user_main_wrapper, NULL, NULL);
+               Thread *t = new Thread(execution->get_next_id(), &user_thread, &user_main_wrapper, NULL, NULL); // L: user_main_wrapper passes the user program
                execution->add_thread(t);
-
                do {
                        /*
                         * Stash next pending action(s) for thread(s). There
@@ -442,11 +484,12 @@ void ModelChecker::run()
                         * thread which just took a step--plus the first step
                         * for any newly-created thread
                         */
+
                        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() && !thr->get_pending()) {
-                                       switch_from_master(thr);
+                                       switch_from_master(thr);        // L: context swapped, and action type of thr changed. 
                                        if (thr->is_waiting_on(thr))
                                                assert_bug("Deadlock detected (thread %u)", i);
                                }
@@ -456,17 +499,38 @@ void ModelChecker::run()
                        for (unsigned int i = 0; i < get_num_threads(); i++) {
                                Thread *th = get_thread(int_to_id(i));
                                ModelAction *act = th->get_pending();
-                               if (act && is_enabled(th) && !execution->check_action_enabled(act)) {
+                               if (act && execution->is_enabled(th) && !execution->check_action_enabled(act)) {
                                        scheduler->sleep(th);
                                }
                        }
 
+                       for (unsigned int i = 1; i < get_num_threads(); i++) {
+                               Thread *th = get_thread(int_to_id(i));
+                               ModelAction *act = th->get_pending();
+                               if (act && execution->is_enabled(th) && (th->get_state() != THREAD_BLOCKED) ){
+                                       if (act->is_write()){
+                                               std::memory_order order = act->get_mo(); 
+                                               if (order == std::memory_order_relaxed || \
+                                                       order == std::memory_order_release) {
+                                                       t = th;
+                                                       break;
+                                               }
+                                       } else if (act->get_type() == THREAD_CREATE || \
+                                                       act->get_type() == PTHREAD_CREATE || \
+                                                       act->get_type() == THREAD_START || \
+                                                       act->get_type() == THREAD_FINISH) {
+                                               t = th;
+                                               break;
+                                       }                               
+                               }
+                       }
+
                        /* Catch assertions from prior take_step or from
                         * between-ModelAction bugs (e.g., data races) */
+
                        if (execution->has_asserted())
                                break;
-
-                       if (!t)
+                       if (!t)                         
                                t = get_next_thread();
                        if (!t || t->is_model_thread())
                                break;
@@ -477,7 +541,11 @@ void ModelChecker::run()
                        t = execution->take_step(curr);
                } while (!should_terminate_execution());
 
-       } while (next_execution());
+               has_next = next_execution();
+               pthread_map.clear();
+               mutex_map.clear();
+               i++;
+       } while (i<100); // while (has_next);
 
        execution->fixup_release_sequences();