2 * @brief Model-checker core
5 #ifndef __EXECUTION_H__
6 #define __EXECUTION_H__
12 #include "hashtable.h"
14 #include "modeltypes.h"
15 #include "stl-model.h"
17 #include "mypthread.h"
19 #include <condition_variable>
20 #include "classlist.h"
22 /** @brief Shorthand for a list of release sequence heads */
23 typedef ModelVector<const ModelAction *> rel_heads_list_t;
24 typedef SnapList<ModelAction *> action_list_t;
26 struct PendingFutureValue {
27 PendingFutureValue(ModelAction *writer, ModelAction *reader) :
28 writer(writer), reader(reader)
30 const ModelAction *writer;
34 /** @brief Records information regarding a single pending release sequence */
36 /** @brief The acquire operation */
38 /** @brief The read operation that may read from a release sequence;
39 * may be the same as acquire, or else an earlier action in the same
40 * thread (i.e., when 'acquire' is a fence-acquire) */
41 const ModelAction *read;
42 /** @brief The head of the RMW chain from which 'read' reads; may be
43 * equal to 'release' */
44 const ModelAction *rf;
45 /** @brief The head of the potential longest release sequence chain */
46 const ModelAction *release;
47 /** @brief The write(s) that may break the release sequence */
48 SnapVector<const ModelAction *> writes;
51 /** @brief The central structure for model-checking */
52 class ModelExecution {
54 ModelExecution(ModelChecker *m,
56 NodeStack *node_stack);
59 struct model_params * get_params() const { return params; }
60 void setParams(struct model_params * _params) {params = _params;}
62 Thread * take_step(ModelAction *curr);
64 void print_summary() const;
65 #if SUPPORT_MOD_ORDER_DUMP
66 void dumpGraph(char *filename) const;
69 void add_thread(Thread *t);
70 Thread * get_thread(thread_id_t tid) const;
71 Thread * get_thread(const ModelAction *act) const;
73 uint32_t get_pthread_counter() { return pthread_counter; }
74 void incr_pthread_counter() { pthread_counter++; }
75 Thread * get_pthread(pthread_t pid);
77 bool is_enabled(Thread *t) const;
78 bool is_enabled(thread_id_t tid) const;
80 thread_id_t get_next_id();
81 unsigned int get_num_threads() const;
83 ClockVector * get_cv(thread_id_t tid) const;
84 ModelAction * get_parent_action(thread_id_t tid) const;
85 bool isfeasibleprefix() const;
87 ModelAction * get_last_action(thread_id_t tid) const;
89 bool check_action_enabled(ModelAction *curr);
91 bool assert_bug(const char *msg);
92 bool have_bug_reports() const;
93 SnapVector<bug_message *> * get_bugs() const;
95 bool has_asserted() const;
97 bool is_complete_execution() const;
99 void print_infeasibility(const char *prefix) const;
100 bool is_infeasible() const;
101 bool is_deadlocked() const;
103 action_list_t * get_action_trace() { return &action_trace; }
104 Fuzzer * getFuzzer();
105 CycleGraph * const get_mo_graph() { return mo_graph; }
106 HashTable<pthread_cond_t *, cdsc::snapcondition_variable *, uintptr_t, 4> * getCondMap() {return &cond_map;}
107 HashTable<pthread_mutex_t *, cdsc::snapmutex *, uintptr_t, 4> * getMutexMap() {return &mutex_map;}
108 ModelAction * check_current_action(ModelAction *curr);
110 SnapVector<func_id_list_t *> * get_thrd_func_list() { return &thrd_func_list; }
114 int get_execution_number() const;
118 struct model_params * params;
120 /** The scheduler to use: tracks the running/ready Threads */
121 Scheduler * const scheduler;
123 bool mo_may_allow(const ModelAction *writer, const ModelAction *reader);
124 void set_bad_synchronization();
125 bool should_wake_up(const ModelAction *curr, const Thread *thread) const;
126 void wake_up_sleeping_actions(ModelAction *curr);
127 modelclock_t get_next_seq_num();
129 bool next_execution();
130 bool initialize_curr_action(ModelAction **curr);
131 void process_read(ModelAction *curr, SnapVector<const ModelAction *> * rf_set);
132 void process_write(ModelAction *curr);
133 bool process_fence(ModelAction *curr);
134 bool process_mutex(ModelAction *curr);
136 bool process_thread_action(ModelAction *curr);
137 bool read_from(ModelAction *act, const ModelAction *rf);
138 bool synchronize(const ModelAction *first, ModelAction *second);
140 void add_action_to_lists(ModelAction *act);
141 ModelAction * get_last_fence_release(thread_id_t tid) const;
142 ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
143 ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
144 ModelAction * get_last_unlock(ModelAction *curr) const;
145 SnapVector<const ModelAction *> * build_may_read_from(ModelAction *curr);
146 ModelAction * process_rmw(ModelAction *curr);
148 bool r_modification_order(ModelAction *curr, const ModelAction *rf, SnapVector<const ModelAction *> *priorset, bool *canprune);
149 void w_modification_order(ModelAction *curr);
150 void get_release_seq_heads(ModelAction *acquire, ModelAction *read, rel_heads_list_t *release_heads);
151 bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads) const;
152 ModelAction * get_uninitialized_action(const ModelAction *curr) const;
154 action_list_t action_trace;
155 SnapVector<Thread *> thread_map;
156 SnapVector<Thread *> pthread_map;
157 uint32_t pthread_counter;
159 /** Per-object list of actions. Maps an object (i.e., memory location)
160 * to a trace of all actions performed on the object. */
161 HashTable<const void *, action_list_t *, uintptr_t, 4> obj_map;
163 /** Per-object list of actions. Maps an object (i.e., memory location)
164 * to a trace of all actions performed on the object. */
165 HashTable<const void *, action_list_t *, uintptr_t, 4> condvar_waiters_map;
167 HashTable<void *, SnapVector<action_list_t> *, uintptr_t, 4> obj_thrd_map;
169 HashTable<pthread_mutex_t *, cdsc::snapmutex *, uintptr_t, 4> mutex_map;
170 HashTable<pthread_cond_t *, cdsc::snapcondition_variable *, uintptr_t, 4> cond_map;
173 * List of pending release sequences. Release sequences might be
174 * determined lazily as promises are fulfilled and modification orders
175 * are established. Each entry in the list may only be partially
176 * filled, depending on its pending status.
179 SnapVector<ModelAction *> thrd_last_action;
180 SnapVector<ModelAction *> thrd_last_fence_release;
181 NodeStack * const node_stack;
183 /** A special model-checker Thread; used for associating with
184 * model-checker-related ModelAcitons */
185 Thread *model_thread;
187 /** Private data members that should be snapshotted. They are grouped
188 * together for efficiency and maintainability. */
189 struct model_snapshot_members * const priv;
192 * @brief The modification order graph
194 * A directed acyclic graph recording observations of the modification
195 * order on all the atomic objects in the system. This graph should
196 * never contain any cycles, as that represents a violation of the
197 * memory model (total ordering). This graph really consists of many
198 * disjoint (unconnected) subgraphs, each graph corresponding to a
199 * separate ordering on a distinct object.
201 * The edges in this graph represent the "ordered before" relation,
202 * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
205 CycleGraph * const mo_graph;
209 Thread * action_select_next_thread(const ModelAction *curr) const;
211 /* thrd_func_list stores a list of function ids for each thread.
212 * Each element in thrd_func_list stores the functions that
213 * thread i has entered and yet to exit from */
214 SnapVector< func_id_list_t * > thrd_func_list;
218 #endif /* __EXECUTION_H__ */