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         ModelAction *writer;
  71         ModelAction *act;
  72 };
  73
  74 /** @brief Records information regarding a single pending release sequence */
  75 struct release_seq {
  76         /** @brief The acquire operation */
  77         ModelAction *acquire;
  78         /** @brief The head of the RMW chain from which 'acquire' reads; may be
  79          *  equal to 'release' */
  80         const ModelAction *rf;
  81         /** @brief The head of the potential longest release sequence chain */
  82         const ModelAction *release;
  83         /** @brief The write(s) that may break the release sequence */
  84         std::vector<const ModelAction *> writes;
  85 };
  86
  87 /** @brief The central structure for model-checking */
  88 class ModelChecker {
  89 public:
  90         ModelChecker(struct model_params params);
  91         ~ModelChecker();
  92
  93         void run();
  94
  95         /** @returns the context for the main model-checking system thread */
  96         ucontext_t * get_system_context() { return &system_context; }
  97
  98         void print_summary() const;
  99 #if SUPPORT_MOD_ORDER_DUMP
 100         void dumpGraph(char *filename);
 101 #endif
 102
 103         void add_thread(Thread *t);
 104         void remove_thread(Thread *t);
 105         Thread * get_thread(thread_id_t tid) const;
 106         Thread * get_thread(ModelAction *act) const;
 107
 108         bool is_enabled(Thread *t) const;
 109         bool is_enabled(thread_id_t tid) const;
 110
 111         thread_id_t get_next_id();
 112         unsigned int get_num_threads() const;
 113         Thread * get_current_thread() const;
 114
 115         int switch_to_master(ModelAction *act);
 116         ClockVector * get_cv(thread_id_t tid) const;
 117         ModelAction * get_parent_action(thread_id_t tid) const;
 118         void check_promises_thread_disabled();
 119         void mo_check_promises(thread_id_t tid, const ModelAction *write);
 120         void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector * merge_cv);
 121         void get_release_seq_heads(ModelAction *act, rel_heads_list_t *release_heads);
 122         bool isfeasibleprefix() const;
 123
 124         bool assert_bug(const char *msg);
 125         void assert_user_bug(const char *msg);
 126
 127         void set_bad_synchronization();
 128
 129         const model_params params;
 130         Node * get_curr_node() const;
 131
 132         MEMALLOC
 133 private:
 134         /** The scheduler to use: tracks the running/ready Threads */
 135         Scheduler *scheduler;
 136
 137         bool sleep_can_read_from(ModelAction * curr, const ModelAction *write);
 138         bool thin_air_constraint_may_allow(const ModelAction * writer, const ModelAction *reader);
 139         bool mo_may_allow(const ModelAction * writer, const ModelAction *reader);
 140         bool has_asserted() const;
 141         void set_assert();
 142         bool promises_expired() const;
 143         void execute_sleep_set();
 144         void wake_up_sleeping_actions(ModelAction * curr);
 145         modelclock_t get_next_seq_num();
 146
 147         bool next_execution();
 148         void set_current_action(ModelAction *act);
 149         Thread * check_current_action(ModelAction *curr);
 150         bool initialize_curr_action(ModelAction **curr);
 151         bool process_read(ModelAction *curr, bool second_part_of_rmw);
 152         bool process_write(ModelAction *curr);
 153         bool process_mutex(ModelAction *curr);
 154         bool process_thread_action(ModelAction *curr);
 155         void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
 156         bool check_action_enabled(ModelAction *curr);
 157
 158         bool take_step();
 159
 160         void check_recency(ModelAction *curr, const ModelAction *rf);
 161         ModelAction * get_last_conflict(ModelAction *act);
 162         void set_backtracking(ModelAction *act);
 163         Thread * get_next_thread(ModelAction *curr);
 164         ModelAction * get_next_backtrack();
 165         void reset_to_initial_state();
 166         bool resolve_promises(ModelAction *curr);
 167         void compute_promises(ModelAction *curr);
 168         void compute_relseq_breakwrites(ModelAction *curr);
 169
 170         void check_curr_backtracking(ModelAction * curr);
 171         void add_action_to_lists(ModelAction *act);
 172         ModelAction * get_last_action(thread_id_t tid) const;
 173         ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
 174         ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
 175         ModelAction * get_last_unlock(ModelAction *curr) const;
 176         void build_reads_from_past(ModelAction *curr);
 177         ModelAction * process_rmw(ModelAction *curr);
 178         void post_r_modification_order(ModelAction *curr, const ModelAction *rf);
 179         bool r_modification_order(ModelAction *curr, const ModelAction *rf);
 180         bool w_modification_order(ModelAction *curr);
 181         bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
 182         bool resolve_release_sequences(void *location, work_queue_t *work_queue);
 183
 184         ModelAction *diverge;
 185         ModelAction *earliest_diverge;
 186
 187         ucontext_t system_context;
 188         action_list_t *action_trace;
 189         HashTable<int, Thread *, int> *thread_map;
 190
 191         /** Per-object list of actions. Maps an object (i.e., memory location)
 192          * to a trace of all actions performed on the object. */
 193         HashTable<const void *, action_list_t *, uintptr_t, 4> *obj_map;
 194
 195         /** Per-object list of actions. Maps an object (i.e., memory location)
 196          * to a trace of all actions performed on the object. */
 197         HashTable<const void *, action_list_t *, uintptr_t, 4> *lock_waiters_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> *condvar_waiters_map;
 202
 203         HashTable<void *, std::vector<action_list_t> *, uintptr_t, 4 > *obj_thrd_map;
 204         std::vector< Promise *, SnapshotAlloc<Promise *> > *promises;
 205         std::vector< struct PendingFutureValue, SnapshotAlloc<struct PendingFutureValue> > *futurevalues;
 206
 207         /**
 208          * List of pending release sequences. Release sequences might be
 209          * determined lazily as promises are fulfilled and modification orders
 210          * are established. Each entry in the list may only be partially
 211          * filled, depending on its pending status.
 212          */
 213         std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> > *pending_rel_seqs;
 214
 215         std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > *thrd_last_action;
 216         NodeStack *node_stack;
 217
 218         /** Private data members that should be snapshotted. They are grouped
 219          * together for efficiency and maintainability. */
 220         struct model_snapshot_members *priv;
 221
 222         /** A special model-checker Thread; used for associating with
 223          *  model-checker-related ModelAcitons */
 224         Thread *model_thread;
 225
 226         /**
 227          * @brief The modification order graph
 228          *
 229          * A directed acyclic graph recording observations of the modification
 230          * order on all the atomic objects in the system. This graph should
 231          * never contain any cycles, as that represents a violation of the
 232          * memory model (total ordering). This graph really consists of many
 233          * disjoint (unconnected) subgraphs, each graph corresponding to a
 234          * separate ordering on a distinct object.
 235          *
 236          * The edges in this graph represent the "ordered before" relation,
 237          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
 238          * <tt>b</tt>.
 239          */
 240         CycleGraph *mo_graph;
 241
 242         /** @brief The cumulative execution stats */
 243         struct execution_stats stats;
 244         void record_stats();
 245
 246         bool is_feasible_prefix_ignore_relseq() const;
 247         bool is_infeasible_ignoreRMW() const;
 248         bool is_infeasible() const;
 249         bool is_deadlocked() const;
 250         bool is_complete_execution() const;
 251         bool have_bug_reports() const;
 252         void print_bugs() const;
 253         void print_execution(bool printbugs) const;
 254         void print_stats() const;
 255
 256         friend void user_main_wrapper();
 257 };
 258
 259 extern ModelChecker *model;
 260
 261 #endif /* __MODEL_H__ */