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         CycleGraph * const get_mo_graph() { return mo_graph; }
 120
 121         SNAPSHOTALLOC
 122 private:
 123         int get_execution_number() const;
 124
 125         ModelChecker *model;
 126
 127         const model_params * const params;
 128
 129         /** The scheduler to use: tracks the running/ready Threads */
 130         Scheduler * const scheduler;
 131
 132         bool sleep_can_read_from(ModelAction *curr, const ModelAction *write);
 133         bool thin_air_constraint_may_allow(const ModelAction *writer, const ModelAction *reader) const;
 134         bool mo_may_allow(const ModelAction *writer, const ModelAction *reader);
 135         bool promises_may_allow(const ModelAction *writer, const ModelAction *reader) const;
 136         void set_bad_synchronization();
 137         void set_bad_sc_read();
 138         bool promises_expired() const;
 139         bool should_wake_up(const ModelAction *curr, const Thread *thread) const;
 140         void wake_up_sleeping_actions(ModelAction *curr);
 141         modelclock_t get_next_seq_num();
 142
 143         bool next_execution();
 144         ModelAction * check_current_action(ModelAction *curr);
 145         bool initialize_curr_action(ModelAction **curr);
 146         bool process_read(ModelAction *curr);
 147         bool process_write(ModelAction *curr, work_queue_t *work);
 148         bool process_fence(ModelAction *curr);
 149         bool process_mutex(ModelAction *curr);
 150         bool process_thread_action(ModelAction *curr);
 151         void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
 152         bool read_from(ModelAction *act, const ModelAction *rf);
 153         bool synchronize(const ModelAction *first, ModelAction *second);
 154
 155         template <typename T>
 156         bool check_recency(ModelAction *curr, const T *rf) const;
 157
 158         template <typename T, typename U>
 159         bool should_read_instead(const ModelAction *curr, const T *rf, const U *other_rf) const;
 160
 161         ModelAction * get_last_fence_conflict(ModelAction *act) const;
 162         ModelAction * get_last_conflict(ModelAction *act) const;
 163         void set_backtracking(ModelAction *act);
 164         bool set_latest_backtrack(ModelAction *act);
 165         Promise * pop_promise_to_resolve(const ModelAction *curr);
 166         bool resolve_promise(ModelAction *curr, Promise *promise,
 167                         work_queue_t *work);
 168         void compute_promises(ModelAction *curr);
 169         void compute_relseq_breakwrites(ModelAction *curr);
 170
 171         void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector *merge_cv);
 172         void mo_check_promises(const ModelAction *act, bool is_read_check);
 173         void thread_blocking_check_promises(Thread *blocker, Thread *waiting);
 174
 175         void check_curr_backtracking(ModelAction *curr);
 176         void add_action_to_lists(ModelAction *act);
 177         ModelAction * get_last_fence_release(thread_id_t tid) const;
 178         ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
 179         ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
 180         ModelAction * get_last_unlock(ModelAction *curr) const;
 181         void build_may_read_from(ModelAction *curr);
 182         ModelAction * process_rmw(ModelAction *curr);
 183
 184         template <typename rf_type>
 185         bool r_modification_order(ModelAction *curr, const rf_type *rf);
 186
 187         bool w_modification_order(ModelAction *curr, ModelVector<ModelAction *> *send_fv);
 188         void get_release_seq_heads(ModelAction *acquire, ModelAction *read, rel_heads_list_t *release_heads);
 189         bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
 190         void propagate_clockvector(ModelAction *acquire, work_queue_t *work);
 191         bool resolve_release_sequences(void *location, work_queue_t *work_queue);
 192         void add_future_value(const ModelAction *writer, ModelAction *reader);
 193         bool check_coherence_promise(const ModelAction *write, const ModelAction *read);
 194         ModelAction * get_uninitialized_action(const ModelAction *curr) const;
 195
 196         action_list_t action_trace;
 197         SnapVector<Thread *> thread_map;
 198
 199         /** Per-object list of actions. Maps an object (i.e., memory location)
 200          * to a trace of all actions performed on the object. */
 201         HashTable<const void *, action_list_t *, uintptr_t, 4> obj_map;
 202
 203         /** Per-object list of actions. Maps an object (i.e., memory location)
 204          * to a trace of all actions performed on the object. */
 205         HashTable<const void *, action_list_t *, uintptr_t, 4> condvar_waiters_map;
 206
 207         HashTable<void *, SnapVector<action_list_t> *, uintptr_t, 4> obj_thrd_map;
 208
 209         /**
 210          * @brief List of currently-pending promises
 211          *
 212          * Promises are sorted by the execution order of the read(s) which
 213          * created them
 214          */
 215         SnapVector<Promise *> promises;
 216         SnapVector<struct PendingFutureValue> futurevalues;
 217
 218         /**
 219          * List of pending release sequences. Release sequences might be
 220          * determined lazily as promises are fulfilled and modification orders
 221          * are established. Each entry in the list may only be partially
 222          * filled, depending on its pending status.
 223          */
 224         SnapVector<struct release_seq *> pending_rel_seqs;
 225
 226         SnapVector<ModelAction *> thrd_last_action;
 227         SnapVector<ModelAction *> thrd_last_fence_release;
 228         NodeStack * const node_stack;
 229
 230         /** A special model-checker Thread; used for associating with
 231          *  model-checker-related ModelAcitons */
 232         Thread *model_thread;
 233
 234         /** Private data members that should be snapshotted. They are grouped
 235          * together for efficiency and maintainability. */
 236         struct model_snapshot_members * const priv;
 237
 238         /**
 239          * @brief The modification order graph
 240          *
 241          * A directed acyclic graph recording observations of the modification
 242          * order on all the atomic objects in the system. This graph should
 243          * never contain any cycles, as that represents a violation of the
 244          * memory model (total ordering). This graph really consists of many
 245          * disjoint (unconnected) subgraphs, each graph corresponding to a
 246          * separate ordering on a distinct object.
 247          *
 248          * The edges in this graph represent the "ordered before" relation,
 249          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
 250          * <tt>b</tt>.
 251          */
 252         CycleGraph * const mo_graph;
 253
 254         Thread * action_select_next_thread(const ModelAction *curr) const;
 255 };
 256
 257 #endif /* __EXECUTION_H__ */