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
  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
  42 struct PendingFutureValue {
  43         ModelAction *writer;
  44         ModelAction * act;
  45 };
  46
  47 /**
  48  * Structure for holding small ModelChecker members that should be snapshotted
  49  */
  50 struct model_snapshot_members {
  51         ModelAction *current_action;
  52         unsigned int next_thread_id;
  53         modelclock_t used_sequence_numbers;
  54         Thread *nextThread;
  55         ModelAction *next_backtrack;
  56 };
  57
  58 /** @brief Records information regarding a single pending release sequence */
  59 struct release_seq {
  60         /** @brief The acquire operation */
  61         ModelAction *acquire;
  62         /** @brief The head of the RMW chain from which 'acquire' reads; may be
  63          *  equal to 'release' */
  64         const ModelAction *rf;
  65         /** @brief The head of the potential longest release sequence chain */
  66         const ModelAction *release;
  67         /** @brief The write(s) that may break the release sequence */
  68         std::vector<const ModelAction *> writes;
  69 };
  70
  71 /** @brief The central structure for model-checking */
  72 class ModelChecker {
  73 public:
  74         ModelChecker(struct model_params params);
  75         ~ModelChecker();
  76
  77         /** @returns the context for the main model-checking system thread */
  78         ucontext_t * get_system_context() { return &system_context; }
  79
  80         /** Prints an execution summary with trace information. */
  81         void print_summary();
  82 #if SUPPORT_MOD_ORDER_DUMP
  83         void dumpGraph(char *filename);
  84 #endif
  85
  86         void add_thread(Thread *t);
  87         void remove_thread(Thread *t);
  88         Thread * get_thread(thread_id_t tid) const;
  89         Thread * get_thread(ModelAction *act) const;
  90
  91         thread_id_t get_next_id();
  92         unsigned int get_num_threads();
  93         Thread * get_current_thread();
  94
  95         int switch_to_master(ModelAction *act);
  96         ClockVector * get_cv(thread_id_t tid);
  97         ModelAction * get_parent_action(thread_id_t tid);
  98         bool next_execution();
  99         bool isfeasible();
 100         bool isfeasibleotherthanRMW();
 101         bool isfinalfeasible();
 102         void check_promises_thread_disabled();
 103         void mo_check_promises(thread_id_t tid, const ModelAction *write);
 104         void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector * merge_cv);
 105         void get_release_seq_heads(ModelAction *act, rel_heads_list_t *release_heads);
 106         void finish_execution();
 107         bool isfeasibleprefix();
 108         void set_assert() {asserted=true;}
 109
 110         /** @brief Alert the model-checker that an incorrectly-ordered
 111          * synchronization was made */
 112         void set_bad_synchronization() { bad_synchronization = true; }
 113
 114         const model_params params;
 115         Scheduler * get_scheduler() { return scheduler;}
 116         Node * get_curr_node();
 117
 118         MEMALLOC
 119 private:
 120         /** The scheduler to use: tracks the running/ready Threads */
 121         Scheduler *scheduler;
 122
 123         bool sleep_can_read_from(ModelAction * curr, const ModelAction *write);
 124         bool thin_air_constraint_may_allow(const ModelAction * writer, const ModelAction *reader);
 125         bool mo_may_allow(const ModelAction * writer, const ModelAction *reader);
 126         bool has_asserted() {return asserted;}
 127         void reset_asserted() {asserted=false;}
 128         int num_executions;
 129         int num_feasible_executions;
 130         bool promises_expired();
 131         void execute_sleep_set();
 132         void wake_up_sleeping_actions(ModelAction * curr);
 133         modelclock_t get_next_seq_num();
 134
 135         /**
 136          * Stores the ModelAction for the current thread action.  Call this
 137          * immediately before switching from user- to system-context to pass
 138          * data between them.
 139          * @param act The ModelAction created by the user-thread action
 140          */
 141         void set_current_action(ModelAction *act) { priv->current_action = act; }
 142         Thread * check_current_action(ModelAction *curr);
 143         bool initialize_curr_action(ModelAction **curr);
 144         bool process_read(ModelAction *curr, bool second_part_of_rmw);
 145         bool process_write(ModelAction *curr);
 146         bool process_mutex(ModelAction *curr);
 147         bool process_thread_action(ModelAction *curr);
 148         void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
 149         bool check_action_enabled(ModelAction *curr);
 150
 151         bool take_step();
 152
 153         void check_recency(ModelAction *curr, const ModelAction *rf);
 154         ModelAction * get_last_conflict(ModelAction *act);
 155         void set_backtracking(ModelAction *act);
 156         Thread * get_next_thread(ModelAction *curr);
 157         ModelAction * get_next_backtrack();
 158         void reset_to_initial_state();
 159         bool resolve_promises(ModelAction *curr);
 160         void compute_promises(ModelAction *curr);
 161         void compute_relseq_breakwrites(ModelAction *curr);
 162
 163         void check_curr_backtracking(ModelAction * curr);
 164         void add_action_to_lists(ModelAction *act);
 165         ModelAction * get_last_action(thread_id_t tid) const;
 166         ModelAction * get_last_seq_cst(ModelAction *curr) const;
 167         ModelAction * get_last_unlock(ModelAction *curr) const;
 168         void build_reads_from_past(ModelAction *curr);
 169         ModelAction * process_rmw(ModelAction *curr);
 170         void post_r_modification_order(ModelAction *curr, const ModelAction *rf);
 171         bool r_modification_order(ModelAction *curr, const ModelAction *rf);
 172         bool w_modification_order(ModelAction *curr);
 173         bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
 174         bool resolve_release_sequences(void *location, work_queue_t *work_queue);
 175
 176         ModelAction *diverge;
 177         ModelAction *earliest_diverge;
 178
 179         ucontext_t system_context;
 180         action_list_t *action_trace;
 181         HashTable<int, Thread *, int> *thread_map;
 182
 183         /** Per-object list of actions. Maps an object (i.e., memory location)
 184          * to a trace of all actions performed on the object. */
 185         HashTable<const void *, action_list_t, uintptr_t, 4> *obj_map;
 186
 187         /** Per-object list of actions. Maps an object (i.e., memory location)
 188          * to a trace of all actions performed on the object. */
 189         HashTable<const void *, action_list_t, uintptr_t, 4> *lock_waiters_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> *condvar_waiters_map;
 194
 195         HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 > *obj_thrd_map;
 196         std::vector< Promise *, SnapshotAlloc<Promise *> > *promises;
 197         std::vector< struct PendingFutureValue, SnapshotAlloc<struct PendingFutureValue> > *futurevalues;
 198
 199         /**
 200          * List of pending release sequences. Release sequences might be
 201          * determined lazily as promises are fulfilled and modification orders
 202          * are established. Each entry in the list may only be partially
 203          * filled, depending on its pending status.
 204          */
 205         std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> > *pending_rel_seqs;
 206
 207         std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > *thrd_last_action;
 208         NodeStack *node_stack;
 209
 210         /** Private data members that should be snapshotted. They are grouped
 211          * together for efficiency and maintainability. */
 212         struct model_snapshot_members *priv;
 213
 214         /** A special model-checker Thread; used for associating with
 215          *  model-checker-related ModelAcitons */
 216         Thread *model_thread;
 217
 218         /**
 219          * @brief The modification order graph
 220          *
 221          * A directed acyclic graph recording observations of the modification
 222          * order on all the atomic objects in the system. This graph should
 223          * never contain any cycles, as that represents a violation of the
 224          * memory model (total ordering). This graph really consists of many
 225          * disjoint (unconnected) subgraphs, each graph corresponding to a
 226          * separate ordering on a distinct object.
 227          *
 228          * The edges in this graph represent the "ordered before" relation,
 229          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
 230          * <tt>b</tt>.
 231          */
 232         CycleGraph *mo_graph;
 233         bool failed_promise;
 234         bool too_many_reads;
 235         bool asserted;
 236         /** @brief Incorrectly-ordered synchronization was made */
 237         bool bad_synchronization;
 238 };
 239
 240 extern ModelChecker *model;
 241
 242 #endif /* __MODEL_H__ */