cyclegraph: straighten out header vs. implementation vs. usage

[model-checker.git] / model.h

diff --git a/model.h b/model.h
index c13dffd7f24c01a2802ebcc2a1351d1a7231aa22..fcdc69fd9cf510fc1681e05c4b0edc346a4b0e31 100644 (file)
--- a/model.h
+++ b/model.h
@@ -23,29 +23,28 @@ class NodeStack;
 class CycleGraph;
 class Promise;
 
+/**
+ * Model checker parameter structure. Holds run-time configuration options for
+ * the model checker.
+ */
+struct model_params {
+};
+
 /** @brief The central structure for model-checking */
 class ModelChecker {
 public:
-       ModelChecker();
+       ModelChecker(struct model_params params);
        ~ModelChecker();
 
-       /** 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; }
+       ucontext_t * get_system_context() { return &system_context; }
+
+       /** Prints an execution summary with trace information. */
+       void print_summary();
 
-       void check_current_action(void);
-       void print_summary(void);
        Thread * schedule_next_thread();
 
-       int add_thread(Thread *t);
+       void add_thread(Thread *t);
        void remove_thread(Thread *t);
        Thread * get_thread(thread_id_t tid) { return thread_map->get(id_to_int(tid)); }
 
@@ -53,6 +52,9 @@ public:
        int get_num_threads();
        modelclock_t get_next_seq_num();
 
+       /** @return The currently executing Thread. */
+       Thread * get_current_thread() { return scheduler->get_current_thread(); }
+
        int switch_to_master(ModelAction *act);
        ClockVector * get_cv(thread_id_t tid);
        bool next_execution();
@@ -60,12 +62,19 @@ public:
        bool isfinalfeasible();
        void check_promises(ClockVector *old_cv, ClockVector * merge_cv);
 
+       void finish_execution();
+
        MEMALLOC
 private:
+       /** The scheduler to use: tracks the running/ready Threads */
+       Scheduler *scheduler;
+
        int next_thread_id;
        modelclock_t used_sequence_numbers;
        int num_executions;
 
+       const model_params params;
+
        /**
         * Stores the ModelAction for the current thread action.  Call this
         * immediately before switching from user- to system-context to pass
@@ -73,6 +82,9 @@ private:
         * @param act The ModelAction created by the user-thread action
         */
        void set_current_action(ModelAction *act) { current_action = act; }
+       void check_current_action();
+
+       bool take_step();
 
        ModelAction * get_last_conflict(ModelAction *act);
        void set_backtracking(ModelAction *act);
@@ -88,6 +100,7 @@ private:
        ModelAction * get_last_seq_cst(const void *location);
        void build_reads_from_past(ModelAction *curr);
        ModelAction * process_rmw(ModelAction * curr);
+       void post_r_modification_order(ModelAction * curr, const ModelAction *rf);
        void r_modification_order(ModelAction * curr, const ModelAction *rf);
        void w_modification_order(ModelAction * curr);
 
@@ -95,7 +108,7 @@ private:
        ModelAction *diverge;
        thread_id_t nextThread;
 
-       ucontext_t *system_context;
+       ucontext_t system_context;
        action_list_t *action_trace;
        HashTable<int, Thread *, int> *thread_map;
 
@@ -108,7 +121,24 @@ private:
        std::vector<ModelAction *> *thrd_last_action;
        NodeStack *node_stack;
        ModelAction *next_backtrack;
-       CycleGraph * cyclegraph;
+
+       /**
+        * @brief The modification order graph
+        *
+        * A direceted acyclic graph recording observations of the modification
+        * order on all the atomic objects in the system. This graph should
+        * never contain any cycles, as that represents a violation of the
+        * memory model (total ordering). This graph really consists of many
+        * disjoint (unconnected) subgraphs, each graph corresponding to a
+        * separate ordering on a distinct object.
+        *
+        * Note that the edges in this graph actually represent the "ordered
+        * after" relation, such that <tt>a --> b</tt> means <tt>a</tt> was
+        * ordered after <tt>b</tt>, or in the traditional sense of
+        * modification order, <tt>b --mo--> a</tt>.
+        */
+       CycleGraph *mo_graph;
+
        bool failed_promise;
 };