this is the bad line...
[model-checker.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
27 /** @brief Shorthand for a list of release sequence heads */
28 typedef std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > rel_heads_list_t;
29
30 /**
31  * Model checker parameter structure. Holds run-time configuration options for
32  * the model checker.
33  */
34 struct model_params {
35         int maxreads;
36         int maxfuturedelay;
37         unsigned int fairwindow;
38         unsigned int enabledcount;
39         unsigned int bound;
40 };
41
42 struct PendingFutureValue {
43         ModelAction *writer;
44         ModelAction * act;
45 };
46
47 /**
48  * Structure for holding small ModelChecker members that should be snapshotted
49  */
50 struct model_snapshot_members {
51         ModelAction *current_action;
52         unsigned int next_thread_id;
53         modelclock_t used_sequence_numbers;
54         Thread *nextThread;
55         ModelAction *next_backtrack;
56 };
57
58 /** @brief Records information regarding a single pending release sequence */
59 struct release_seq {
60         /** @brief The acquire operation */
61         ModelAction *acquire;
62         /** @brief The head of the RMW chain from which 'acquire' reads; may be
63          *  equal to 'release' */
64         const ModelAction *rf;
65         /** @brief The head of the potential longest release sequence chain */
66         const ModelAction *release;
67         /** @brief The write(s) that may break the release sequence */
68         std::vector<const ModelAction *> writes;
69 };
70
71 /** @brief The central structure for model-checking */
72 class ModelChecker {
73 public:
74         ModelChecker(struct model_params params);
75         ~ModelChecker();
76
77         /** @returns the context for the main model-checking system thread */
78         ucontext_t * get_system_context() { return &system_context; }
79
80         /** Prints an execution summary with trace information. */
81         void print_summary();
82 #if SUPPORT_MOD_ORDER_DUMP
83         void dumpGraph(char *filename);
84 #endif
85
86         void add_thread(Thread *t);
87         void remove_thread(Thread *t);
88         Thread * get_thread(thread_id_t tid) const;
89         Thread * get_thread(ModelAction *act) const;
90
91         thread_id_t get_next_id();
92         unsigned int get_num_threads();
93         Thread * get_current_thread();
94
95         int switch_to_master(ModelAction *act);
96         ClockVector * get_cv(thread_id_t tid);
97         ModelAction * get_parent_action(thread_id_t tid);
98         bool next_execution();
99         bool isfeasible();
100         bool isfeasibleotherthanRMW();
101         bool isfinalfeasible();
102         void mo_check_promises(thread_id_t tid, const ModelAction *write);
103         void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector * merge_cv);
104         void get_release_seq_heads(ModelAction *act, rel_heads_list_t *release_heads);
105         void finish_execution();
106         bool isfeasibleprefix();
107         void set_assert() {asserted=true;}
108
109         /** @brief Alert the model-checker that an incorrectly-ordered
110          * synchronization was made */
111         void set_bad_synchronization() { bad_synchronization = true; }
112
113         const model_params params;
114         Scheduler * get_scheduler() { return scheduler;}
115         Node * get_curr_node();
116
117         MEMALLOC
118 private:
119         /** The scheduler to use: tracks the running/ready Threads */
120         Scheduler *scheduler;
121
122         bool sleep_can_read_from(ModelAction * curr, const ModelAction *write);
123         bool thin_air_constraint_may_allow(const ModelAction * writer, const ModelAction *reader);
124         bool mo_may_allow(const ModelAction * writer, const ModelAction *reader);
125         bool has_asserted() {return asserted;}
126         void reset_asserted() {asserted=false;}
127         int num_executions;
128         int num_feasible_executions;
129         bool promises_expired();
130         void execute_sleep_set();
131         void wake_up_sleeping_actions(ModelAction * curr);
132         modelclock_t get_next_seq_num();
133
134         /**
135          * Stores the ModelAction for the current thread action.  Call this
136          * immediately before switching from user- to system-context to pass
137          * data between them.
138          * @param act The ModelAction created by the user-thread action
139          */
140         void set_current_action(ModelAction *act) { priv->current_action = act; }
141         Thread * check_current_action(ModelAction *curr);
142         bool initialize_curr_action(ModelAction **curr);
143         bool process_read(ModelAction *curr, bool second_part_of_rmw);
144         bool process_write(ModelAction *curr);
145         bool process_mutex(ModelAction *curr);
146         bool process_thread_action(ModelAction *curr);
147         void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
148         bool check_action_enabled(ModelAction *curr);
149
150         bool take_step();
151
152         void check_recency(ModelAction *curr, const ModelAction *rf);
153         ModelAction * get_last_conflict(ModelAction *act);
154         void set_backtracking(ModelAction *act);
155         Thread * get_next_thread(ModelAction *curr);
156         ModelAction * get_next_backtrack();
157         void reset_to_initial_state();
158         bool resolve_promises(ModelAction *curr);
159         void compute_promises(ModelAction *curr);
160         void compute_relseq_breakwrites(ModelAction *curr);
161
162         void check_curr_backtracking(ModelAction * curr);
163         void add_action_to_lists(ModelAction *act);
164         ModelAction * get_last_action(thread_id_t tid) const;
165         ModelAction * get_last_seq_cst(ModelAction *curr) const;
166         ModelAction * get_last_unlock(ModelAction *curr) const;
167         void build_reads_from_past(ModelAction *curr);
168         ModelAction * process_rmw(ModelAction *curr);
169         void post_r_modification_order(ModelAction *curr, const ModelAction *rf);
170         bool r_modification_order(ModelAction *curr, const ModelAction *rf);
171         bool w_modification_order(ModelAction *curr);
172         bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
173         bool resolve_release_sequences(void *location, work_queue_t *work_queue);
174
175         ModelAction *diverge;
176         ModelAction *earliest_diverge;
177
178         ucontext_t system_context;
179         action_list_t *action_trace;
180         HashTable<int, Thread *, int> *thread_map;
181
182         /** Per-object list of actions. Maps an object (i.e., memory location)
183          * to a trace of all actions performed on the object. */
184         HashTable<const void *, action_list_t, uintptr_t, 4> *obj_map;
185
186         /** Per-object list of actions. Maps an object (i.e., memory location)
187          * to a trace of all actions performed on the object. */
188         HashTable<const void *, action_list_t, uintptr_t, 4> *lock_waiters_map;
189
190         /** Per-object list of actions. Maps an object (i.e., memory location)
191          * to a trace of all actions performed on the object. */
192         HashTable<const void *, action_list_t, uintptr_t, 4> *condvar_waiters_map;
193
194         HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 > *obj_thrd_map;
195         std::vector< Promise *, SnapshotAlloc<Promise *> > *promises;
196         std::vector< struct PendingFutureValue, SnapshotAlloc<struct PendingFutureValue> > *futurevalues;
197
198         /**
199          * List of pending release sequences. Release sequences might be
200          * determined lazily as promises are fulfilled and modification orders
201          * are established. Each entry in the list may only be partially
202          * filled, depending on its pending status.
203          */
204         std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> > *pending_rel_seqs;
205
206         std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > *thrd_last_action;
207         NodeStack *node_stack;
208
209         /** Private data members that should be snapshotted. They are grouped
210          * together for efficiency and maintainability. */
211         struct model_snapshot_members *priv;
212
213         /** A special model-checker Thread; used for associating with
214          *  model-checker-related ModelAcitons */
215         Thread *model_thread;
216
217         /**
218          * @brief The modification order graph
219          *
220          * A directed acyclic graph recording observations of the modification
221          * order on all the atomic objects in the system. This graph should
222          * never contain any cycles, as that represents a violation of the
223          * memory model (total ordering). This graph really consists of many
224          * disjoint (unconnected) subgraphs, each graph corresponding to a
225          * separate ordering on a distinct object.
226          *
227          * The edges in this graph represent the "ordered before" relation,
228          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
229          * <tt>b</tt>.
230          */
231         CycleGraph *mo_graph;
232         bool failed_promise;
233         bool too_many_reads;
234         bool asserted;
235         /** @brief Incorrectly-ordered synchronization was made */
236         bool bad_synchronization;
237 };
238
239 extern ModelChecker *model;
240
241 #endif /* __MODEL_H__ */