.gitignore: fixup VIM swapfile ignore
[model-checker.git] / execution.h
1 /** @file execution.h
2  *  @brief Model-checker core
3  */
4
5 #ifndef __EXECUTION_H__
6 #define __EXECUTION_H__
7
8 #include <cstddef>
9 #include <inttypes.h>
10
11 #include "mymemory.h"
12 #include "hashtable.h"
13 #include "workqueue.h"
14 #include "config.h"
15 #include "modeltypes.h"
16 #include "stl-model.h"
17 #include "params.h"
18
19 /* Forward declaration */
20 class Node;
21 class NodeStack;
22 class CycleGraph;
23 class Promise;
24 class Scheduler;
25 class Thread;
26 class ClockVector;
27 struct model_snapshot_members;
28 class ModelChecker;
29 struct bug_message;
30
31 /** @brief Shorthand for a list of release sequence heads */
32 typedef ModelVector<const ModelAction *> rel_heads_list_t;
33 typedef SnapList<ModelAction *> action_list_t;
34
35 struct PendingFutureValue {
36         PendingFutureValue(ModelAction *writer, ModelAction *reader) :
37                 writer(writer), reader(reader)
38         { }
39         const ModelAction *writer;
40         ModelAction *reader;
41 };
42
43 /** @brief Records information regarding a single pending release sequence */
44 struct release_seq {
45         /** @brief The acquire operation */
46         ModelAction *acquire;
47         /** @brief The read operation that may read from a release sequence;
48          *  may be the same as acquire, or else an earlier action in the same
49          *  thread (i.e., when 'acquire' is a fence-acquire) */
50         const ModelAction *read;
51         /** @brief The head of the RMW chain from which 'read' reads; may be
52          *  equal to 'release' */
53         const ModelAction *rf;
54         /** @brief The head of the potential longest release sequence chain */
55         const ModelAction *release;
56         /** @brief The write(s) that may break the release sequence */
57         SnapVector<const ModelAction *> writes;
58 };
59
60 /** @brief The central structure for model-checking */
61 class ModelExecution {
62 public:
63         ModelExecution(ModelChecker *m,
64                         const struct model_params *params,
65                         Scheduler *scheduler,
66                         NodeStack *node_stack);
67         ~ModelExecution();
68
69         const struct model_params * get_params() const { return params; }
70
71         Thread * take_step(ModelAction *curr);
72         void fixup_release_sequences();
73
74         void print_summary() const;
75 #if SUPPORT_MOD_ORDER_DUMP
76         void dumpGraph(char *filename) const;
77 #endif
78
79         void add_thread(Thread *t);
80         Thread * get_thread(thread_id_t tid) const;
81         Thread * get_thread(const ModelAction *act) const;
82         int get_promise_number(const Promise *promise) const;
83
84         bool is_enabled(Thread *t) const;
85         bool is_enabled(thread_id_t tid) const;
86
87         thread_id_t get_next_id();
88         unsigned int get_num_threads() const;
89
90         ClockVector * get_cv(thread_id_t tid) const;
91         ModelAction * get_parent_action(thread_id_t tid) const;
92         void check_promises_thread_disabled();
93         bool isfeasibleprefix() const;
94
95         action_list_t * get_actions_on_obj(void * obj, thread_id_t tid) const;
96         ModelAction * get_last_action(thread_id_t tid) const;
97
98         bool check_action_enabled(ModelAction *curr);
99
100         bool assert_bug(const char *msg);
101         bool have_bug_reports() const;
102         SnapVector<bug_message *> * get_bugs() const;
103
104         bool has_asserted() const;
105         void set_assert();
106         bool is_complete_execution() const;
107
108         void print_infeasibility(const char *prefix) const;
109         bool is_feasible_prefix_ignore_relseq() const;
110         bool is_infeasible() const;
111         bool is_deadlocked() const;
112         bool is_yieldblocked() const;
113         bool too_many_steps() const;
114
115         ModelAction * get_next_backtrack();
116
117         action_list_t * get_action_trace() { return &action_trace; }
118
119         SNAPSHOTALLOC
120 private:
121         int get_execution_number() const;
122
123         ModelChecker *model;
124
125         const model_params * const params;
126
127         /** The scheduler to use: tracks the running/ready Threads */
128         Scheduler * const scheduler;
129
130         bool sleep_can_read_from(ModelAction *curr, const ModelAction *write);
131         bool thin_air_constraint_may_allow(const ModelAction *writer, const ModelAction *reader) const;
132         bool mo_may_allow(const ModelAction *writer, const ModelAction *reader);
133         bool promises_may_allow(const ModelAction *writer, const ModelAction *reader) const;
134         void set_bad_synchronization();
135         bool promises_expired() const;
136         bool should_wake_up(const ModelAction *curr, const Thread *thread) const;
137         void wake_up_sleeping_actions(ModelAction *curr);
138         modelclock_t get_next_seq_num();
139
140         bool next_execution();
141         ModelAction * check_current_action(ModelAction *curr);
142         bool initialize_curr_action(ModelAction **curr);
143         bool process_read(ModelAction *curr);
144         bool process_write(ModelAction *curr, work_queue_t *work);
145         bool process_fence(ModelAction *curr);
146         bool process_mutex(ModelAction *curr);
147         bool process_thread_action(ModelAction *curr);
148         void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
149         bool read_from(ModelAction *act, const ModelAction *rf);
150         bool synchronize(const ModelAction *first, ModelAction *second);
151
152         template <typename T>
153         bool check_recency(ModelAction *curr, const T *rf) const;
154
155         template <typename T, typename U>
156         bool should_read_instead(const ModelAction *curr, const T *rf, const U *other_rf) const;
157
158         ModelAction * get_last_fence_conflict(ModelAction *act) const;
159         ModelAction * get_last_conflict(ModelAction *act) const;
160         void set_backtracking(ModelAction *act);
161         bool set_latest_backtrack(ModelAction *act);
162         Promise * pop_promise_to_resolve(const ModelAction *curr);
163         bool resolve_promise(ModelAction *curr, Promise *promise,
164                         work_queue_t *work);
165         void compute_promises(ModelAction *curr);
166         void compute_relseq_breakwrites(ModelAction *curr);
167
168         void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector *merge_cv);
169         void mo_check_promises(const ModelAction *act, bool is_read_check);
170         void thread_blocking_check_promises(Thread *blocker, Thread *waiting);
171
172         void check_curr_backtracking(ModelAction *curr);
173         void add_action_to_lists(ModelAction *act);
174         ModelAction * get_last_fence_release(thread_id_t tid) const;
175         ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
176         ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
177         ModelAction * get_last_unlock(ModelAction *curr) const;
178         void build_may_read_from(ModelAction *curr);
179         ModelAction * process_rmw(ModelAction *curr);
180
181         template <typename rf_type>
182         bool r_modification_order(ModelAction *curr, const rf_type *rf);
183
184         bool w_modification_order(ModelAction *curr, ModelVector<ModelAction *> *send_fv);
185         void get_release_seq_heads(ModelAction *acquire, ModelAction *read, rel_heads_list_t *release_heads);
186         bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
187         void propagate_clockvector(ModelAction *acquire, work_queue_t *work);
188         bool resolve_release_sequences(void *location, work_queue_t *work_queue);
189         void add_future_value(const ModelAction *writer, ModelAction *reader);
190
191         ModelAction * get_uninitialized_action(const ModelAction *curr) const;
192
193         action_list_t action_trace;
194         SnapVector<Thread *> thread_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> obj_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 *, SnapVector<action_list_t> *, uintptr_t, 4> obj_thrd_map;
205         SnapVector<Promise *> promises;
206         SnapVector<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         SnapVector<struct release_seq *> pending_rel_seqs;
215
216         SnapVector<ModelAction *> thrd_last_action;
217         SnapVector<ModelAction *> thrd_last_fence_release;
218         NodeStack * const node_stack;
219
220         /** A special model-checker Thread; used for associating with
221          *  model-checker-related ModelAcitons */
222         Thread *model_thread;
223
224         /** Private data members that should be snapshotted. They are grouped
225          * together for efficiency and maintainability. */
226         struct model_snapshot_members * const priv;
227
228         /**
229          * @brief The modification order graph
230          *
231          * A directed acyclic graph recording observations of the modification
232          * order on all the atomic objects in the system. This graph should
233          * never contain any cycles, as that represents a violation of the
234          * memory model (total ordering). This graph really consists of many
235          * disjoint (unconnected) subgraphs, each graph corresponding to a
236          * separate ordering on a distinct object.
237          *
238          * The edges in this graph represent the "ordered before" relation,
239          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
240          * <tt>b</tt>.
241          */
242         CycleGraph * const mo_graph;
243
244         Thread * action_select_next_thread(const ModelAction *curr) const;
245 };
246
247 #endif /* __EXECUTION_H__ */