model: privatize some functions
[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 "mymemory.h"
14 #include "action.h"
15 #include "hashtable.h"
16 #include "workqueue.h"
17 #include "config.h"
18 #include "modeltypes.h"
19
20 /* Forward declaration */
21 class NodeStack;
22 class CycleGraph;
23 class Promise;
24 class Scheduler;
25 class Thread;
26 struct model_snapshot_members;
27
28 /** @brief Shorthand for a list of release sequence heads */
29 typedef std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > rel_heads_list_t;
30
31 /**
32  * Model checker parameter structure. Holds run-time configuration options for
33  * the model checker.
34  */
35 struct model_params {
36         int maxreads;
37         int maxfuturedelay;
38         unsigned int fairwindow;
39         unsigned int enabledcount;
40         unsigned int bound;
41
42         /** @brief Maximum number of future values that can be sent to the same
43          *  read */
44         int maxfuturevalues;
45
46         /** @brief Only generate a new future value/expiration pair if the
47          *  expiration time exceeds the existing one by more than the slop
48          *  value */
49         unsigned int expireslop;
50
51         /** @brief Verbosity (0 = quiet; 1 = noisy) */
52         int verbose;
53
54         /** @brief Command-line argument count to pass to user program */
55         int argc;
56
57         /** @brief Command-line arguments to pass to user program */
58         char **argv;
59 };
60
61 /** @brief Model checker execution stats */
62 struct execution_stats {
63         int num_total; /**< @brief Total number of executions */
64         int num_infeasible; /**< @brief Number of infeasible executions */
65         int num_buggy_executions; /** @brief Number of buggy executions */
66         int num_complete; /**< @brief Number of feasible, non-buggy, complete executions */
67         int num_redundant; /**< @brief Number of redundant, aborted executions */
68 };
69
70 struct PendingFutureValue {
71         ModelAction *writer;
72         ModelAction *act;
73 };
74
75 /** @brief Records information regarding a single pending release sequence */
76 struct release_seq {
77         /** @brief The acquire operation */
78         ModelAction *acquire;
79         /** @brief The head of the RMW chain from which 'acquire' reads; may be
80          *  equal to 'release' */
81         const ModelAction *rf;
82         /** @brief The head of the potential longest release sequence chain */
83         const ModelAction *release;
84         /** @brief The write(s) that may break the release sequence */
85         std::vector<const ModelAction *> writes;
86 };
87
88 /** @brief The central structure for model-checking */
89 class ModelChecker {
90 public:
91         ModelChecker(struct model_params params);
92         ~ModelChecker();
93
94         void run();
95
96         /** @returns the context for the main model-checking system thread */
97         ucontext_t * get_system_context() { return &system_context; }
98
99         void print_summary() const;
100 #if SUPPORT_MOD_ORDER_DUMP
101         void dumpGraph(char *filename);
102 #endif
103
104         void add_thread(Thread *t);
105         void remove_thread(Thread *t);
106         Thread * get_thread(thread_id_t tid) const;
107         Thread * get_thread(ModelAction *act) const;
108
109         bool is_enabled(Thread *t) const;
110         bool is_enabled(thread_id_t tid) const;
111
112         thread_id_t get_next_id();
113         unsigned int get_num_threads() const;
114         Thread * get_current_thread();
115
116         int switch_to_master(ModelAction *act);
117         ClockVector * get_cv(thread_id_t tid);
118         ModelAction * get_parent_action(thread_id_t tid);
119         bool isfinalfeasible() const;
120         void check_promises_thread_disabled();
121         void mo_check_promises(thread_id_t tid, const ModelAction *write);
122         void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector * merge_cv);
123         void get_release_seq_heads(ModelAction *act, rel_heads_list_t *release_heads);
124         bool isfeasibleprefix() const;
125
126         bool assert_bug(const char *msg);
127         void assert_user_bug(const char *msg);
128
129         void set_bad_synchronization();
130
131         const model_params params;
132         Node * get_curr_node();
133
134         MEMALLOC
135 private:
136         /** The scheduler to use: tracks the running/ready Threads */
137         Scheduler *scheduler;
138
139         bool sleep_can_read_from(ModelAction * curr, const ModelAction *write);
140         bool thin_air_constraint_may_allow(const ModelAction * writer, const ModelAction *reader);
141         bool mo_may_allow(const ModelAction * writer, const ModelAction *reader);
142         bool has_asserted() const;
143         void set_assert();
144         bool promises_expired() const;
145         void execute_sleep_set();
146         void wake_up_sleeping_actions(ModelAction * curr);
147         modelclock_t get_next_seq_num();
148
149         bool next_execution();
150         void set_current_action(ModelAction *act);
151         Thread * check_current_action(ModelAction *curr);
152         bool initialize_curr_action(ModelAction **curr);
153         bool process_read(ModelAction *curr, bool second_part_of_rmw);
154         bool process_write(ModelAction *curr);
155         bool process_mutex(ModelAction *curr);
156         bool process_thread_action(ModelAction *curr);
157         void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
158         bool check_action_enabled(ModelAction *curr);
159
160         bool take_step();
161
162         void check_recency(ModelAction *curr, const ModelAction *rf);
163         ModelAction * get_last_conflict(ModelAction *act);
164         void set_backtracking(ModelAction *act);
165         Thread * get_next_thread(ModelAction *curr);
166         ModelAction * get_next_backtrack();
167         void reset_to_initial_state();
168         bool resolve_promises(ModelAction *curr);
169         void compute_promises(ModelAction *curr);
170         void compute_relseq_breakwrites(ModelAction *curr);
171
172         void check_curr_backtracking(ModelAction * curr);
173         void add_action_to_lists(ModelAction *act);
174         ModelAction * get_last_action(thread_id_t tid) const;
175         ModelAction * get_last_seq_cst(ModelAction *curr) const;
176         ModelAction * get_last_unlock(ModelAction *curr) const;
177         void build_reads_from_past(ModelAction *curr);
178         ModelAction * process_rmw(ModelAction *curr);
179         void post_r_modification_order(ModelAction *curr, const ModelAction *rf);
180         bool r_modification_order(ModelAction *curr, const ModelAction *rf);
181         bool w_modification_order(ModelAction *curr);
182         bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
183         bool resolve_release_sequences(void *location, work_queue_t *work_queue);
184
185         ModelAction *diverge;
186         ModelAction *earliest_diverge;
187
188         ucontext_t system_context;
189         action_list_t *action_trace;
190         HashTable<int, Thread *, int> *thread_map;
191
192         /** Per-object list of actions. Maps an object (i.e., memory location)
193          * to a trace of all actions performed on the object. */
194         HashTable<const void *, action_list_t *, uintptr_t, 4> *obj_map;
195
196         /** Per-object list of actions. Maps an object (i.e., memory location)
197          * to a trace of all actions performed on the object. */
198         HashTable<const void *, action_list_t *, uintptr_t, 4> *lock_waiters_map;
199
200         /** Per-object list of actions. Maps an object (i.e., memory location)
201          * to a trace of all actions performed on the object. */
202         HashTable<const void *, action_list_t *, uintptr_t, 4> *condvar_waiters_map;
203
204         HashTable<void *, std::vector<action_list_t> *, uintptr_t, 4 > *obj_thrd_map;
205         std::vector< Promise *, SnapshotAlloc<Promise *> > *promises;
206         std::vector< struct PendingFutureValue, SnapshotAlloc<struct PendingFutureValue> > *futurevalues;
207
208         /**
209          * List of pending release sequences. Release sequences might be
210          * determined lazily as promises are fulfilled and modification orders
211          * are established. Each entry in the list may only be partially
212          * filled, depending on its pending status.
213          */
214         std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> > *pending_rel_seqs;
215
216         std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > *thrd_last_action;
217         NodeStack *node_stack;
218
219         /** Private data members that should be snapshotted. They are grouped
220          * together for efficiency and maintainability. */
221         struct model_snapshot_members *priv;
222
223         /** A special model-checker Thread; used for associating with
224          *  model-checker-related ModelAcitons */
225         Thread *model_thread;
226
227         /**
228          * @brief The modification order graph
229          *
230          * A directed acyclic graph recording observations of the modification
231          * order on all the atomic objects in the system. This graph should
232          * never contain any cycles, as that represents a violation of the
233          * memory model (total ordering). This graph really consists of many
234          * disjoint (unconnected) subgraphs, each graph corresponding to a
235          * separate ordering on a distinct object.
236          *
237          * The edges in this graph represent the "ordered before" relation,
238          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
239          * <tt>b</tt>.
240          */
241         CycleGraph *mo_graph;
242
243         /** @brief The cumulative execution stats */
244         struct execution_stats stats;
245         void record_stats();
246
247         bool isfeasibleotherthanRMW() const;
248         bool isfeasible() const;
249         bool is_deadlocked() const;
250         bool is_complete_execution() const;
251         bool have_bug_reports() const;
252         void print_bugs() const;
253         void print_execution(bool printbugs) const;
254         void print_stats() const;
255
256         friend void user_main_wrapper();
257 };
258
259 extern ModelChecker *model;
260
261 #endif /* __MODEL_H__ */