fixup whitespace

[c11tester.git] / model.h

diff --git a/model.h b/model.h
index 205b8d0bd236989a6131efa45cdefba0f7cc1096..c13dffd7f24c01a2802ebcc2a1351d1a7231aa22 100644 (file)
--- a/model.h
+++ b/model.h
@@ -1,47 +1,115 @@
+/** @file model.h
+ *  @brief Core model checker.
+ */
+
 #ifndef __MODEL_H__
 #define __MODEL_H__
 
+#include <list>
+#include <vector>
+#include <cstddef>
+#include <ucontext.h>
+
 #include "schedule.h"
+#include "mymemory.h"
 #include "libthreads.h"
-#include "libatomic.h"
-
-#define VALUE_NONE -1
+#include "threads.h"
+#include "action.h"
+#include "clockvector.h"
+#include "hashtable.h"
 
-typedef enum action_type {
-       THREAD_CREATE,
-       THREAD_YIELD,
-       THREAD_JOIN,
-       ATOMIC_READ,
-       ATOMIC_WRITE
-} action_type_t;
-
-class ModelAction {
-public:
-       ModelAction(action_type_t type, memory_order order, void *loc, int value);
-       void print(void);
-private:
-       action_type type;
-       memory_order order;
-       void *location;
-       thread_id_t tid;
-       int value;
-};
+/* Forward declaration */
+class NodeStack;
+class CycleGraph;
+class Promise;
 
+/** @brief The central structure for model-checking */
 class ModelChecker {
 public:
        ModelChecker();
        ~ModelChecker();
-       class Scheduler *scheduler;
-       struct thread *system_thread;
 
-       void add_system_thread(struct thread *t);
-       void assign_id(struct thread *t);
+       /** The scheduler to use: tracks the running/ready Threads */
+       Scheduler *scheduler;
 
-       void set_current_action(ModelAction *act) { current_action = act; }
+       /** 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 check_current_action(void);
+       void print_summary(void);
+       Thread * schedule_next_thread();
+
+       int add_thread(Thread *t);
+       void remove_thread(Thread *t);
+       Thread * get_thread(thread_id_t tid) { return thread_map->get(id_to_int(tid)); }
 
+       thread_id_t get_next_id();
+       int get_num_threads();
+       modelclock_t get_next_seq_num();
+
+       int switch_to_master(ModelAction *act);
+       ClockVector * get_cv(thread_id_t tid);
+       bool next_execution();
+       bool isfeasible();
+       bool isfinalfeasible();
+       void check_promises(ClockVector *old_cv, ClockVector * merge_cv);
+
+       MEMALLOC
 private:
-       int used_thread_id;
-       class ModelAction *current_action;
+       int next_thread_id;
+       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();
+       ModelAction * get_next_backtrack();
+       void reset_to_initial_state();
+       void resolve_promises(ModelAction *curr);
+       void compute_promises(ModelAction *curr);
+
+       void add_action_to_lists(ModelAction *act);
+       ModelAction * get_last_action(thread_id_t tid);
+       ModelAction * get_parent_action(thread_id_t tid);
+       ModelAction * get_last_seq_cst(const void *location);
+       void build_reads_from_past(ModelAction *curr);
+       ModelAction * process_rmw(ModelAction * curr);
+       void r_modification_order(ModelAction * curr, const ModelAction *rf);
+       void w_modification_order(ModelAction * curr);
+
+       ModelAction *current_action;
+       ModelAction *diverge;
+       thread_id_t nextThread;
+
+       ucontext_t *system_context;
+       action_list_t *action_trace;
+       HashTable<int, Thread *, int> *thread_map;
+
+       /** Per-object list of actions. Maps an object (i.e., memory location)
+        * to a trace of all actions performed on the object. */
+       HashTable<const void *, action_list_t, uintptr_t, 4> *obj_map;
+
+       HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 > *obj_thrd_map;
+       std::vector<Promise *> * promises;
+       std::vector<ModelAction *> *thrd_last_action;
+       NodeStack *node_stack;
+       ModelAction *next_backtrack;
+       CycleGraph * cyclegraph;
+       bool failed_promise;
 };
 
 extern ModelChecker *model;