model.h

   1 /** @file model.h
   2  *  @brief Core model checker.
   3  */
   4
   5 #ifndef __MODEL_H__
   6 #define __MODEL_H__
   7
   8 #include <vector>
   9 #include <cstddef>
  10 #include <ucontext.h>
  11
  12 #include "mymemory.h"
  13 #include "action.h"
  14 #include "hashtable.h"
  15 #include "workqueue.h"
  16 #include "config.h"
  17 #include "modeltypes.h"
  18
  19 /* Forward declaration */
  20 class NodeStack;
  21 class CycleGraph;
  22 class Promise;
  23 class Scheduler;
  24 class Thread;
  25 struct model_snapshot_members;
  26
  27 /** @brief Shorthand for a list of release sequence heads */
  28 typedef std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > rel_heads_list_t;
  29
  30 /**
  31  * Model checker parameter structure. Holds run-time configuration options for
  32  * the model checker.
  33  */
  34 struct model_params {
  35         int maxreads;
  36         int maxfuturedelay;
  37         unsigned int fairwindow;
  38         unsigned int enabledcount;
  39         unsigned int bound;
  40
  41         /** @brief Maximum number of future values that can be sent to the same
  42          *  read */
  43         int maxfuturevalues;
  44
  45         /** @brief Only generate a new future value/expiration pair if the
  46          *  expiration time exceeds the existing one by more than the slop
  47          *  value */
  48         unsigned int expireslop;
  49
  50         /** @brief Verbosity (0 = quiet; 1 = noisy) */
  51         int verbose;
  52
  53         /** @brief Command-line argument count to pass to user program */
  54         int argc;
  55
  56         /** @brief Command-line arguments to pass to user program */
  57         char **argv;
  58 };
  59
  60 /** @brief Model checker execution stats */
  61 struct execution_stats {
  62         int num_total; /**< @brief Total number of executions */
  63         int num_infeasible; /**< @brief Number of infeasible executions */
  64         int num_buggy_executions; /** @brief Number of buggy executions */
  65         int num_complete; /**< @brief Number of feasible, non-buggy, complete executions */
  66         int num_redundant; /**< @brief Number of redundant, aborted executions */
  67 };
  68
  69 struct PendingFutureValue {
  70         PendingFutureValue(ModelAction *writer, ModelAction *act) : writer(writer), act(act) { }
  71         const ModelAction *writer;
  72         ModelAction *act;
  73 };
  74
  75 /** @brief Records information regarding a single pending release sequence */
  76 struct release_seq {
  77         /** @brief The acquire operation */
  78         ModelAction *acquire;
  79         /** @brief The read operation that may read from a release sequence;
  80          *  may be the same as acquire, or else an earlier action in the same
  81          *  thread (i.e., when 'acquire' is a fence-acquire) */
  82         const ModelAction *read;
  83         /** @brief The head of the RMW chain from which 'read' reads; may be
  84          *  equal to 'release' */
  85         const ModelAction *rf;
  86         /** @brief The head of the potential longest release sequence chain */
  87         const ModelAction *release;
  88         /** @brief The write(s) that may break the release sequence */
  89         std::vector<const ModelAction *> writes;
  90 };
  91
  92 /** @brief The central structure for model-checking */
  93 class ModelChecker {
  94 public:
  95         ModelChecker(struct model_params params);
  96         ~ModelChecker();
  97
  98         void run();
  99
 100         /** @returns the context for the main model-checking system thread */
 101         ucontext_t * get_system_context() { return &system_context; }
 102
 103         void print_summary() const;
 104 #if SUPPORT_MOD_ORDER_DUMP
 105         void dumpGraph(char *filename) const;
 106 #endif
 107
 108         void add_thread(Thread *t);
 109         void remove_thread(Thread *t);
 110         Thread * get_thread(thread_id_t tid) const;
 111         Thread * get_thread(const ModelAction *act) const;
 112
 113         bool is_enabled(Thread *t) const;
 114         bool is_enabled(thread_id_t tid) const;
 115
 116         thread_id_t get_next_id();
 117         unsigned int get_num_threads() const;
 118         Thread * get_current_thread() const;
 119
 120         uint64_t switch_to_master(ModelAction *act);
 121         ClockVector * get_cv(thread_id_t tid) const;
 122         ModelAction * get_parent_action(thread_id_t tid) const;
 123         void check_promises_thread_disabled();
 124         void mo_check_promises(const ModelAction *act, bool is_read_check);
 125         void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector *merge_cv);
 126         bool isfeasibleprefix() const;
 127
 128         bool assert_bug(const char *msg);
 129         void assert_user_bug(const char *msg);
 130
 131         const model_params params;
 132         Node * get_curr_node() const;
 133
 134         MEMALLOC
 135 private:
 136         /** The scheduler to use: tracks the running/ready Threads */
 137         Scheduler *scheduler;
 138
 139         bool sleep_can_read_from(ModelAction *curr, const ModelAction *write);
 140         bool thin_air_constraint_may_allow(const ModelAction *writer, const ModelAction *reader);
 141         bool mo_may_allow(const ModelAction *writer, const ModelAction *reader);
 142         bool has_asserted() const;
 143         void set_assert();
 144         void set_bad_synchronization();
 145         bool promises_expired() const;
 146         void execute_sleep_set();
 147         void wake_up_sleeping_actions(ModelAction *curr);
 148         modelclock_t get_next_seq_num();
 149
 150         bool next_execution();
 151         ModelAction * check_current_action(ModelAction *curr);
 152         bool initialize_curr_action(ModelAction **curr);
 153         bool process_read(ModelAction *curr, bool second_part_of_rmw);
 154         bool process_write(ModelAction *curr);
 155         bool process_fence(ModelAction *curr);
 156         bool process_mutex(ModelAction *curr);
 157         bool process_thread_action(ModelAction *curr);
 158         void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
 159         bool read_from(ModelAction *act, const ModelAction *rf);
 160         bool check_action_enabled(ModelAction *curr);
 161
 162         Thread * take_step(ModelAction *curr);
 163
 164         void check_recency(ModelAction *curr, const ModelAction *rf);
 165         ModelAction * get_last_conflict(ModelAction *act);
 166         void set_backtracking(ModelAction *act);
 167         Thread * get_next_thread(ModelAction *curr);
 168         bool set_latest_backtrack(ModelAction *act);
 169         ModelAction * get_next_backtrack();
 170         void reset_to_initial_state();
 171         bool resolve_promises(ModelAction *curr);
 172         void compute_promises(ModelAction *curr);
 173         void compute_relseq_breakwrites(ModelAction *curr);
 174
 175         void check_curr_backtracking(ModelAction *curr);
 176         void add_action_to_lists(ModelAction *act);
 177         ModelAction * get_last_action(thread_id_t tid) const;
 178         ModelAction * get_last_fence_release(thread_id_t tid) const;
 179         ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
 180         ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
 181         ModelAction * get_last_unlock(ModelAction *curr) const;
 182         void build_reads_from_past(ModelAction *curr);
 183         ModelAction * process_rmw(ModelAction *curr);
 184
 185         template <typename rf_type>
 186         bool r_modification_order(ModelAction *curr, const rf_type *rf);
 187
 188         bool w_modification_order(ModelAction *curr);
 189         void get_release_seq_heads(ModelAction *acquire, ModelAction *read, rel_heads_list_t *release_heads);
 190         bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
 191         bool resolve_release_sequences(void *location, work_queue_t *work_queue);
 192         void add_future_value(const ModelAction *writer, ModelAction *reader);
 193
 194         ModelAction * new_uninitialized_action(void *location) const;
 195
 196         ModelAction *diverge;
 197         ModelAction *earliest_diverge;
 198
 199         ucontext_t system_context;
 200         action_list_t *action_trace;
 201         HashTable<int, Thread *, int> *thread_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> *obj_map;
 206
 207         /** Per-object list of actions. Maps an object (i.e., memory location)
 208          * to a trace of all actions performed on the object. */
 209         HashTable<const void *, action_list_t *, uintptr_t, 4> *lock_waiters_map;
 210
 211         /** Per-object list of actions. Maps an object (i.e., memory location)
 212          * to a trace of all actions performed on the object. */
 213         HashTable<const void *, action_list_t *, uintptr_t, 4> *condvar_waiters_map;
 214
 215         HashTable<void *, std::vector<action_list_t> *, uintptr_t, 4 > *obj_thrd_map;
 216         std::vector< Promise *, SnapshotAlloc<Promise *> > *promises;
 217         std::vector< struct PendingFutureValue, SnapshotAlloc<struct PendingFutureValue> > *futurevalues;
 218
 219         /**
 220          * List of pending release sequences. Release sequences might be
 221          * determined lazily as promises are fulfilled and modification orders
 222          * are established. Each entry in the list may only be partially
 223          * filled, depending on its pending status.
 224          */
 225         std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> > *pending_rel_seqs;
 226
 227         std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > *thrd_last_action;
 228         std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > *thrd_last_fence_release;
 229         NodeStack *node_stack;
 230
 231         /** Private data members that should be snapshotted. They are grouped
 232          * together for efficiency and maintainability. */
 233         struct model_snapshot_members *priv;
 234
 235         /** A special model-checker Thread; used for associating with
 236          *  model-checker-related ModelAcitons */
 237         Thread *model_thread;
 238
 239         /**
 240          * @brief The modification order graph
 241          *
 242          * A directed acyclic graph recording observations of the modification
 243          * order on all the atomic objects in the system. This graph should
 244          * never contain any cycles, as that represents a violation of the
 245          * memory model (total ordering). This graph really consists of many
 246          * disjoint (unconnected) subgraphs, each graph corresponding to a
 247          * separate ordering on a distinct object.
 248          *
 249          * The edges in this graph represent the "ordered before" relation,
 250          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
 251          * <tt>b</tt>.
 252          */
 253         CycleGraph *mo_graph;
 254
 255         /** @brief The cumulative execution stats */
 256         struct execution_stats stats;
 257         void record_stats();
 258
 259         void print_infeasibility(const char *prefix) const;
 260         bool is_feasible_prefix_ignore_relseq() const;
 261         bool is_infeasible() const;
 262         bool is_deadlocked() const;
 263         bool is_complete_execution() const;
 264         bool have_bug_reports() const;
 265         void print_bugs() const;
 266         void print_execution(bool printbugs) const;
 267         void print_stats() const;
 268
 269         friend void user_main_wrapper();
 270 };
 271
 272 extern ModelChecker *model;
 273
 274 #endif /* __MODEL_H__ */