main, threads: improve comments regarding thread stepping

[model-checker.git] / main.cc

diff --git a/main.cc b/main.cc
index 9af745d4280d865dab0c350a306e3594640a4968..62acd90de18e4e05114b4519af0e707f5f954aa1 100644 (file)
--- a/main.cc
+++ b/main.cc
@@ -1,22 +1,23 @@
-#include <stdlib.h>
+/** @file main.cc
+ *  @brief Entry point for the model checker.
+ */
 
 #include "libthreads.h"
-#include "schedule.h"
 #include "common.h"
 #include "threads.h"
 
+#include "datarace.h"
+
 /* global "model" object */
 #include "model.h"
+#include "snapshot-interface.h"
 
-/*
- * Return 1 if found next thread, 0 otherwise
+/**
+ * The thread_system_next function takes the next step in the execution, if
+ * possible.
+ * @return Returns 0 (success) if there is another step and non-zero otherwise.
  */
-int num;
-int num1;
-int num2;
-
-static int thread_system_next(void)
-{
+static int thread_system_next(void) {
        Thread *curr, *next;
 
        curr = thread_current();
@@ -24,47 +25,62 @@ static int thread_system_next(void)
                if (curr->get_state() == THREAD_READY) {
                        model->check_current_action();
                        model->scheduler->add_thread(curr);
-               } else if (curr->get_state() == THREAD_RUNNING)
+               } else if (curr->get_state() == THREAD_RUNNING) {
                        /* Stopped while running; i.e., completed */
                        curr->complete();
-               else
+               } else {
                        ASSERT(false);
+               }
        }
        next = model->scheduler->next_thread();
+
+       /* Infeasible -> don't take any more steps */
+       if (!model->isfeasible())
+               return 1;
+
        if (next)
                next->set_state(THREAD_RUNNING);
        DEBUG("(%d, %d)\n", curr ? curr->get_id() : -1, next ? next->get_id() : -1);
+
+       /* next == NULL -> don't take any more steps */
        if (!next)
                return 1;
+       /* Return non-zero only if swap fails with an error */
        return Thread::swap(model->get_system_context(), next);
 }
 
-static void thread_wait_finish(void)
-{
-
+/** The thread_wait_finish method runs the current execution until we
+ *  have no more steps to take.
+ */
+static void thread_wait_finish(void) {
        DBG();
 
        while (!thread_system_next());
 }
 
-/*
- * Main system function
- */
-int main()
-{
+
+/** The real_main function contains the main model checking loop. */
+static void real_main() {
        thrd_t user_thread;
        ucontext_t main_context;
 
+       //Initialize race detector
+       initRaceDetector();
+
+       //Create the singleton SnapshotStack object
+       snapshotObject = new SnapshotStack();
+
        model = new ModelChecker();
 
        if (getcontext(&main_context))
-               return 1;
+               return;
 
        model->set_system_context(&main_context);
 
+       snapshotObject->snapshotStep(0);
        do {
                /* Start user program */
-               model->add_thread(new Thread(&user_thread, &user_main, NULL));
+               model->add_thread(new Thread(&user_thread, (void (*)(void *)) &user_main, NULL));
 
                /* Wait for all threads to complete */
                thread_wait_finish();
@@ -73,5 +89,20 @@ int main()
        delete model;
 
        DEBUG("Exiting\n");
-       return 0;
+}
+
+int main_numargs;
+char ** main_args;
+
+/**
+ * Main function.  Just initializes snapshotting library and the
+ * snapshotting library calls the real_main function.
+ */
+int main(int numargs, char ** args) {
+       /* Stash this stuff in case someone wants it eventually */
+       main_numargs=numargs;
+       main_args=args;
+
+       /* Let's jump in quickly and start running stuff */
+       initSnapShotLibrary(10000, 1024, 1024, 1000, &real_main);
 }