hook up the race detector...

[model-checker.git] / model.h

diff --git a/model.h b/model.h
index d89a8a2b123b1743c58f3c5d7c883c87263b45b9..97e9849f0bbb441c5af72999e3453bc9adbe5745 100644 (file)
--- a/model.h
+++ b/model.h
@@ -1,3 +1,7 @@
+/** @file model.h
+ *  @brief Core model checker. 
+ */
+
 #ifndef __MODEL_H__
 #define __MODEL_H__
 
@@ -14,20 +18,29 @@
 #include "libatomic.h"
 #include "threads.h"
 #include "action.h"
+#include "clockvector.h"
 
 /* Forward declaration */
 class NodeStack;
 
+/** @brief The central structure for model-checking */
 class ModelChecker {
 public:
        ModelChecker();
        ~ModelChecker();
-       class Scheduler *scheduler;
 
+       /** The scheduler to use: tracks the running/ready Threads */
+       Scheduler *scheduler;
+
+       /** Stores the context for the main model-checking system thread (call
+        * once)
+        * @param ctxt The system context structure
+        */
        void set_system_context(ucontext_t *ctxt) { system_context = ctxt; }
+
+       /** @returns the context for the main model-checking system thread */
        ucontext_t * get_system_context(void) { return system_context; }
 
-       void set_current_action(ModelAction *act) { current_action = act; }
        void check_current_action(void);
        void print_summary(void);
        Thread * schedule_next_thread();
@@ -38,18 +51,26 @@ public:
 
        thread_id_t get_next_id();
        int get_num_threads();
-       int get_next_seq_num();
+       modelclock_t get_next_seq_num();
 
        int switch_to_master(ModelAction *act);
-
+       ClockVector * get_cv(thread_id_t tid);
        bool next_execution();
 
        MEMALLOC
 private:
        int next_thread_id;
-       int used_sequence_numbers;
+       modelclock_t used_sequence_numbers;
        int num_executions;
 
+       /**
+        * Stores the ModelAction for the current thread action.  Call this
+        * immediately before switching from user- to system-context to pass
+        * data between them.
+        * @param act The ModelAction created by the user-thread action
+        */
+       void set_current_action(ModelAction *act) { current_action = act; }
+
        ModelAction * get_last_conflict(ModelAction *act);
        void set_backtracking(ModelAction *act);
        thread_id_t get_next_replay_thread();
@@ -59,8 +80,7 @@ private:
        void add_action_to_lists(ModelAction *act);
        ModelAction * get_last_action(thread_id_t tid);
        ModelAction * get_parent_action(thread_id_t tid);
-
-       void print_list(action_list_t *list);
+       void build_reads_from_past(ModelAction *curr);
 
        ModelAction *current_action;
        ModelAction *diverge;
@@ -68,10 +88,10 @@ private:
 
        ucontext_t *system_context;
        action_list_t *action_trace;
-       std::map<int, class Thread *> *thread_map;
+       std::map<int, Thread *> *thread_map;
        std::map<void *, std::vector<action_list_t> > *obj_thrd_map;
        std::vector<ModelAction *> *thrd_last_action;
-       class NodeStack *node_stack;
+       NodeStack *node_stack;
        ModelAction *next_backtrack;
 };