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