3c225559606224878ce5c84497242f29604dda23
[c11tester.git] / model.h
1 /** @file model.h
2  *  @brief Core model checker.
3  */
4
5 #ifndef __MODEL_H__
6 #define __MODEL_H__
7
8 #include <list>
9 #include <vector>
10 #include <cstddef>
11 #include <ucontext.h>
12
13 #include "schedule.h"
14 #include "mymemory.h"
15 #include "libthreads.h"
16 #include "threads.h"
17 #include "action.h"
18 #include "clockvector.h"
19 #include "hashtable.h"
20
21 /* Forward declaration */
22 class NodeStack;
23 class CycleGraph;
24 class Promise;
25
26 /** @brief The central structure for model-checking */
27 class ModelChecker {
28 public:
29         ModelChecker();
30         ~ModelChecker();
31
32         /** The scheduler to use: tracks the running/ready Threads */
33         Scheduler *scheduler;
34
35         /** Stores the context for the main model-checking system thread (call
36          * once)
37          * @param ctxt The system context structure
38          */
39         void set_system_context(ucontext_t *ctxt) { system_context = ctxt; }
40
41         /** @returns the context for the main model-checking system thread */
42         ucontext_t * get_system_context(void) { return system_context; }
43
44         void check_current_action(void);
45         void print_summary(void);
46         Thread * schedule_next_thread();
47
48         int add_thread(Thread *t);
49         void remove_thread(Thread *t);
50         Thread * get_thread(thread_id_t tid) { return thread_map->get(id_to_int(tid)); }
51
52         thread_id_t get_next_id();
53         int get_num_threads();
54         modelclock_t get_next_seq_num();
55
56         int switch_to_master(ModelAction *act);
57         ClockVector * get_cv(thread_id_t tid);
58         bool next_execution();
59         bool isfeasible();
60         void check_promises(ClockVector *old_cv, ClockVector * merge_cv);
61
62         MEMALLOC
63 private:
64         int next_thread_id;
65         modelclock_t used_sequence_numbers;
66         int num_executions;
67
68         /**
69          * Stores the ModelAction for the current thread action.  Call this
70          * immediately before switching from user- to system-context to pass
71          * data between them.
72          * @param act The ModelAction created by the user-thread action
73          */
74         void set_current_action(ModelAction *act) { current_action = act; }
75
76         ModelAction * get_last_conflict(ModelAction *act);
77         void set_backtracking(ModelAction *act);
78         thread_id_t get_next_replay_thread();
79         ModelAction * get_next_backtrack();
80         void reset_to_initial_state();
81         void resolve_promises(ModelAction *curr);
82
83         void add_action_to_lists(ModelAction *act);
84         ModelAction * get_last_action(thread_id_t tid);
85         ModelAction * get_parent_action(thread_id_t tid);
86         ModelAction * get_last_seq_cst(const void *location);
87         void build_reads_from_past(ModelAction *curr);
88         ModelAction * process_rmw(ModelAction * curr);
89         void r_modification_order(ModelAction * curr, const ModelAction *rf);
90         void w_modification_order(ModelAction * curr);
91         
92         ModelAction *current_action;
93         ModelAction *diverge;
94         thread_id_t nextThread;
95
96         ucontext_t *system_context;
97         action_list_t *action_trace;
98         HashTable<int, Thread *, int> *thread_map;
99
100         /** Per-object list of actions. Maps an object (i.e., memory location)
101          * to a trace of all actions performed on the object. */
102         HashTable<const void *, action_list_t, uintptr_t, 4> *obj_map;
103
104         HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 > *obj_thrd_map;
105         std::vector<Promise *> * promises;
106         std::vector<ModelAction *> *thrd_last_action;
107         NodeStack *node_stack;
108         ModelAction *next_backtrack;
109         CycleGraph * cyclegraph;
110         bool failed_promise;
111 };
112
113 extern ModelChecker *model;
114
115 #endif /* __MODEL_H__ */