remove EOL spaces, fix indentation

[model-checker.git] / main.cc

diff --git a/main.cc b/main.cc
index 8db63e6d1733d1204e9855575c49d06dafc6d9a6..19f12f182494685d718a963b23ee01d3ef3ffcb0 100644 (file)
--- a/main.cc
+++ b/main.cc
@@ -1,15 +1,22 @@
+/** @file main.cc
+ *  @brief Entry point for the model checker.
+ */
+
 #include "libthreads.h"
 #include "common.h"
 #include "threads.h"
 
+#include "datarace.h"
+
 /* global "model" object */
 #include "model.h"
-#include "snapshot.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.  @return Returns the 1 if there is another step and 0
+ *  otherwise.
  */
+
 static int thread_system_next(void) {
        Thread *curr, *next;
 
@@ -33,18 +40,28 @@ static int thread_system_next(void) {
        return Thread::swap(model->get_system_context(), next);
 }
 
+/** 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());
 }
 
+
+/** The real_main function contains the main model checking loop. */
+
 void real_main() {
        thrd_t user_thread;
        ucontext_t main_context;
 
-       //Create the singleton snapshotStack object
-       snapshotObject = new snapshotStack();
+       //Initialize race detector
+       initRaceDetector();
+
+       //Create the singleton SnapshotStack object
+       snapshotObject = new SnapshotStack();
 
        model = new ModelChecker();
 
@@ -71,8 +88,9 @@ void real_main() {
 int main_numargs;
 char ** main_args;
 
-/*
- * Main system function
+/**
+ * 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 */