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 typedef SnapList<ModelAction *> action_list_t;
24 struct PendingFutureValue {
25 PendingFutureValue(ModelAction *writer, ModelAction *reader) :
26 writer(writer), reader(reader)
28 const ModelAction *writer;
32 /** @brief The central structure for model-checking */
33 class ModelExecution {
35 ModelExecution(ModelChecker *m, Scheduler *scheduler);
38 struct model_params * get_params() const { return params; }
39 void setParams(struct model_params * _params) {params = _params;}
41 Thread * take_step(ModelAction *curr);
43 void print_summary() const;
44 #if SUPPORT_MOD_ORDER_DUMP
45 void dumpGraph(char *filename) const;
48 void add_thread(Thread *t);
49 Thread * get_thread(thread_id_t tid) const;
50 Thread * get_thread(const ModelAction *act) const;
52 uint32_t get_pthread_counter() { return pthread_counter; }
53 void incr_pthread_counter() { pthread_counter++; }
54 Thread * get_pthread(pthread_t pid);
56 bool is_enabled(Thread *t) const;
57 bool is_enabled(thread_id_t tid) const;
59 thread_id_t get_next_id();
60 unsigned int get_num_threads() const;
62 ClockVector * get_cv(thread_id_t tid) const;
63 ModelAction * get_parent_action(thread_id_t tid) const;
64 bool isfeasibleprefix() const;
66 ModelAction * get_last_action(thread_id_t tid) const;
68 bool check_action_enabled(ModelAction *curr);
70 bool assert_bug(const char *msg);
71 bool assert_race(const char *msg);
73 bool have_bug_reports() const;
74 bool have_fatal_bug_reports() const;
76 SnapVector<bug_message *> * get_bugs() const;
78 bool has_asserted() const;
80 bool is_complete_execution() const;
82 void print_infeasibility(const char *prefix) const;
83 bool is_infeasible() const;
84 bool is_deadlocked() const;
86 action_list_t * get_action_trace() { return &action_trace; }
88 CycleGraph * const get_mo_graph() { return mo_graph; }
89 HashTable<pthread_cond_t *, cdsc::snapcondition_variable *, uintptr_t, 4> * getCondMap() {return &cond_map;}
90 HashTable<pthread_mutex_t *, cdsc::snapmutex *, uintptr_t, 4> * getMutexMap() {return &mutex_map;}
91 ModelAction * check_current_action(ModelAction *curr);
93 SnapVector<func_id_list_t *> * get_thrd_func_list() { return &thrd_func_list; }
94 SnapVector< SnapList<func_inst_list_t *> *> * get_thrd_func_inst_lists() { return &thrd_func_inst_lists; }
98 int get_execution_number() const;
102 struct model_params * params;
104 /** The scheduler to use: tracks the running/ready Threads */
105 Scheduler * const scheduler;
107 bool mo_may_allow(const ModelAction *writer, const ModelAction *reader);
108 void set_bad_synchronization();
109 bool should_wake_up(const ModelAction *curr, const Thread *thread) const;
110 void wake_up_sleeping_actions(ModelAction *curr);
111 modelclock_t get_next_seq_num();
113 bool next_execution();
114 bool initialize_curr_action(ModelAction **curr);
115 void process_read(ModelAction *curr, SnapVector<ModelAction *> * rf_set);
116 void process_write(ModelAction *curr);
117 bool process_fence(ModelAction *curr);
118 bool process_mutex(ModelAction *curr);
120 bool process_thread_action(ModelAction *curr);
121 void read_from(ModelAction *act, ModelAction *rf);
122 bool synchronize(const ModelAction *first, ModelAction *second);
124 void add_action_to_lists(ModelAction *act);
125 void add_normal_write_to_lists(ModelAction *act);
126 void add_write_to_lists(ModelAction *act);
127 ModelAction * get_last_fence_release(thread_id_t tid) const;
128 ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
129 ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
130 ModelAction * get_last_unlock(ModelAction *curr) const;
131 SnapVector<ModelAction *> * build_may_read_from(ModelAction *curr);
132 ModelAction * process_rmw(ModelAction *curr);
134 bool r_modification_order(ModelAction *curr, const ModelAction *rf, SnapVector<const ModelAction *> *priorset, bool *canprune);
135 void w_modification_order(ModelAction *curr);
136 ClockVector * get_hb_from_write(ModelAction *rf) const;
137 ModelAction * get_uninitialized_action(ModelAction *curr) const;
138 ModelAction * convertNonAtomicStore(void*);
140 action_list_t action_trace;
141 SnapVector<Thread *> thread_map;
142 SnapVector<Thread *> pthread_map;
143 uint32_t pthread_counter;
145 /** Per-object list of actions. Maps an object (i.e., memory location)
146 * to a trace of all actions performed on the object. */
147 HashTable<const void *, action_list_t *, uintptr_t, 4> obj_map;
149 /** Per-object list of actions. Maps an object (i.e., memory location)
150 * to a trace of all actions performed on the object. */
151 HashTable<const void *, action_list_t *, uintptr_t, 4> condvar_waiters_map;
153 HashTable<const void *, SnapVector<action_list_t> *, uintptr_t, 4> obj_thrd_map;
155 HashTable<const void *, SnapVector<action_list_t> *, uintptr_t, 4> obj_wr_thrd_map;
157 HashTable<const void *, ModelAction *, uintptr_t, 4> obj_last_sc_map;
160 HashTable<pthread_mutex_t *, cdsc::snapmutex *, uintptr_t, 4> mutex_map;
161 HashTable<pthread_cond_t *, cdsc::snapcondition_variable *, uintptr_t, 4> cond_map;
164 * List of pending release sequences. Release sequences might be
165 * determined lazily as promises are fulfilled and modification orders
166 * are established. Each entry in the list may only be partially
167 * filled, depending on its pending status.
170 SnapVector<ModelAction *> thrd_last_action;
171 SnapVector<ModelAction *> thrd_last_fence_release;
173 /** A special model-checker Thread; used for associating with
174 * model-checker-related ModelAcitons */
175 Thread *model_thread;
177 /** Private data members that should be snapshotted. They are grouped
178 * together for efficiency and maintainability. */
179 struct model_snapshot_members * const priv;
182 * @brief The modification order graph
184 * A directed acyclic graph recording observations of the modification
185 * order on all the atomic objects in the system. This graph should
186 * never contain any cycles, as that represents a violation of the
187 * memory model (total ordering). This graph really consists of many
188 * disjoint (unconnected) subgraphs, each graph corresponding to a
189 * separate ordering on a distinct object.
191 * The edges in this graph represent the "ordered before" relation,
192 * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
195 CycleGraph * const mo_graph;
199 Thread * action_select_next_thread(const ModelAction *curr) const;
201 /* thrd_func_list stores a list of function ids for each thread.
202 * Each element in thrd_func_list stores the functions that
203 * thread i has entered and yet to exit from
205 * This data structure is handled by ModelHistory
207 SnapVector< func_id_list_t * > thrd_func_list;
209 /* Keeps track of atomic actions that thread i has performed in some
210 * function. Index of SnapVector is thread id. SnapList simulates
213 * This data structure is handled by ModelHistory
215 SnapVector< SnapList< func_inst_list_t *> *> thrd_func_inst_lists;
218 #endif /* __EXECUTION_H__ */