model.h

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