2 * @brief Core model checker.
15 #include "hashtable.h"
16 #include "workqueue.h"
18 #include "modeltypes.h"
20 /* Forward declaration */
27 /** @brief Shorthand for a list of release sequence heads */
28 typedef std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > rel_heads_list_t;
31 * Model checker parameter structure. Holds run-time configuration options for
37 unsigned int fairwindow;
38 unsigned int enabledcount;
41 struct PendingFutureValue {
43 modelclock_t expiration;
48 * Structure for holding small ModelChecker members that should be snapshotted
50 struct model_snapshot_members {
51 ModelAction *current_action;
52 unsigned int next_thread_id;
53 modelclock_t used_sequence_numbers;
55 ModelAction *next_backtrack;
58 /** @brief Records information regarding a single pending release sequence */
60 /** @brief The acquire operation */
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;
71 /** @brief The central structure for model-checking */
74 ModelChecker(struct model_params params);
77 /** @returns the context for the main model-checking system thread */
78 ucontext_t * get_system_context() { return &system_context; }
80 /** Prints an execution summary with trace information. */
82 #if SUPPORT_MOD_ORDER_DUMP
83 void dumpGraph(char *filename);
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;
91 thread_id_t get_next_id();
92 unsigned int get_num_threads();
93 Thread * get_current_thread();
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();
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;}
109 /** @brief Alert the model-checker that an incorrectly-ordered
110 * synchronization was made */
111 void set_bad_synchronization() { bad_synchronization = true; }
113 const model_params params;
114 Scheduler * get_scheduler() { return scheduler;}
118 /** The scheduler to use: tracks the running/ready Threads */
119 Scheduler *scheduler;
121 bool thin_air_constraint_may_allow(const ModelAction * writer, const ModelAction *reader);
122 bool has_asserted() {return asserted;}
123 void reset_asserted() {asserted=false;}
125 int num_feasible_executions;
126 bool promises_expired();
127 void execute_sleep_set();
128 void wake_up_sleeping_actions(ModelAction * curr);
129 modelclock_t get_next_seq_num();
132 * Stores the ModelAction for the current thread action. Call this
133 * immediately before switching from user- to system-context to pass
135 * @param act The ModelAction created by the user-thread action
137 void set_current_action(ModelAction *act) { priv->current_action = act; }
138 Thread * check_current_action(ModelAction *curr);
139 ModelAction * initialize_curr_action(ModelAction *curr);
140 bool process_read(ModelAction *curr, bool second_part_of_rmw);
141 bool process_write(ModelAction *curr);
142 bool process_mutex(ModelAction *curr);
143 bool process_thread_action(ModelAction *curr);
144 void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
145 bool check_action_enabled(ModelAction *curr);
149 void check_recency(ModelAction *curr, const ModelAction *rf);
150 ModelAction * get_last_conflict(ModelAction *act);
151 void set_backtracking(ModelAction *act);
152 Thread * get_next_thread(ModelAction *curr);
153 ModelAction * get_next_backtrack();
154 void reset_to_initial_state();
155 bool resolve_promises(ModelAction *curr);
156 void compute_promises(ModelAction *curr);
157 void compute_relseq_breakwrites(ModelAction *curr);
159 void check_curr_backtracking(ModelAction * curr);
160 void add_action_to_lists(ModelAction *act);
161 ModelAction * get_last_action(thread_id_t tid) const;
162 ModelAction * get_last_seq_cst(ModelAction *curr) const;
163 ModelAction * get_last_unlock(ModelAction *curr) const;
164 void build_reads_from_past(ModelAction *curr);
165 ModelAction * process_rmw(ModelAction *curr);
166 void post_r_modification_order(ModelAction *curr, const ModelAction *rf);
167 bool r_modification_order(ModelAction *curr, const ModelAction *rf);
168 bool w_modification_order(ModelAction *curr);
169 bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
170 bool resolve_release_sequences(void *location, work_queue_t *work_queue);
171 void do_complete_join(ModelAction *join);
173 ModelAction *diverge;
174 ModelAction *earliest_diverge;
176 ucontext_t system_context;
177 action_list_t *action_trace;
178 HashTable<int, Thread *, int> *thread_map;
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;
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;
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;
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.
198 std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> > *pending_rel_seqs;
200 std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > *thrd_last_action;
201 NodeStack *node_stack;
203 /** Private data members that should be snapshotted. They are grouped
204 * together for efficiency and maintainability. */
205 struct model_snapshot_members *priv;
207 /** A special model-checker Thread; used for associating with
208 * model-checker-related ModelAcitons */
209 Thread *model_thread;
212 * @brief The modification order graph
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.
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
225 CycleGraph *mo_graph;
229 /** @brief Incorrectly-ordered synchronization was made */
230 bool bad_synchronization;
233 extern ModelChecker *model;
235 #endif /* __MODEL_H__ */