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 "config.h"
  14 #include "modeltypes.h"
  15 #include "stl-model.h"
  16 #include "params.h"
  17 #include "mypthread.h"
  18 #include "mutex.h"
  19 #include <condition_variable>
  20 #include "classlist.h"
  21
  22 /** @brief Shorthand for a list of release sequence heads */
  23 typedef ModelVector<const ModelAction *> rel_heads_list_t;
  24 typedef SnapList<ModelAction *> action_list_t;
  25
  26 struct PendingFutureValue {
  27         PendingFutureValue(ModelAction *writer, ModelAction *reader) :
  28                 writer(writer), reader(reader)
  29         { }
  30         const ModelAction *writer;
  31         ModelAction *reader;
  32 };
  33
  34 /** @brief Records information regarding a single pending release sequence */
  35 struct release_seq {
  36         /** @brief The acquire operation */
  37         ModelAction *acquire;
  38         /** @brief The read operation that may read from a release sequence;
  39          *  may be the same as acquire, or else an earlier action in the same
  40          *  thread (i.e., when 'acquire' is a fence-acquire) */
  41         const ModelAction *read;
  42         /** @brief The head of the RMW chain from which 'read' reads; may be
  43          *  equal to 'release' */
  44         const ModelAction *rf;
  45         /** @brief The head of the potential longest release sequence chain */
  46         const ModelAction *release;
  47         /** @brief The write(s) that may break the release sequence */
  48         SnapVector<const ModelAction *> writes;
  49 };
  50
  51 /** @brief The central structure for model-checking */
  52 class ModelExecution {
  53 public:
  54         ModelExecution(ModelChecker *m,
  55                                                                  Scheduler *scheduler,
  56                                                                  NodeStack *node_stack);
  57         ~ModelExecution();
  58
  59         struct model_params * get_params() const { return params; }
  60         void setParams(struct model_params * _params) {params = _params;}
  61
  62         Thread * take_step(ModelAction *curr);
  63
  64         void print_summary() const;
  65 #if SUPPORT_MOD_ORDER_DUMP
  66         void dumpGraph(char *filename) const;
  67 #endif
  68
  69         void add_thread(Thread *t);
  70         Thread * get_thread(thread_id_t tid) const;
  71         Thread * get_thread(const ModelAction *act) const;
  72
  73         uint32_t get_pthread_counter() { return pthread_counter; }
  74         void incr_pthread_counter() { pthread_counter++; }
  75         Thread * get_pthread(pthread_t pid);
  76
  77         bool is_enabled(Thread *t) const;
  78         bool is_enabled(thread_id_t tid) const;
  79
  80         thread_id_t get_next_id();
  81         unsigned int get_num_threads() const;
  82
  83         ClockVector * get_cv(thread_id_t tid) const;
  84         ModelAction * get_parent_action(thread_id_t tid) const;
  85         bool isfeasibleprefix() const;
  86
  87         action_list_t * get_actions_on_obj(void * obj, thread_id_t tid) const;
  88         ModelAction * get_last_action(thread_id_t tid) const;
  89
  90         bool check_action_enabled(ModelAction *curr);
  91
  92         bool assert_bug(const char *msg);
  93         bool have_bug_reports() const;
  94         SnapVector<bug_message *> * get_bugs() const;
  95
  96         bool has_asserted() const;
  97         void set_assert();
  98         bool is_complete_execution() const;
  99
 100         void print_infeasibility(const char *prefix) const;
 101         bool is_infeasible() const;
 102         bool is_deadlocked() const;
 103
 104         action_list_t * get_action_trace() { return &action_trace; }
 105         Fuzzer * getFuzzer();
 106         CycleGraph * const get_mo_graph() { return mo_graph; }
 107         HashTable<pthread_cond_t *, cdsc::condition_variable *, uintptr_t, 4> * getCondMap() {return &cond_map;}
 108         HashTable<pthread_mutex_t *, cdsc::mutex *, uintptr_t, 4> * getMutexMap() {return &mutex_map;}
 109
 110         SNAPSHOTALLOC
 111 private:
 112         int get_execution_number() const;
 113
 114         ModelChecker *model;
 115
 116         struct model_params * params;
 117
 118         /** The scheduler to use: tracks the running/ready Threads */
 119         Scheduler * const scheduler;
 120
 121         bool mo_may_allow(const ModelAction *writer, const ModelAction *reader);
 122         void set_bad_synchronization();
 123         bool should_wake_up(const ModelAction *curr, const Thread *thread) const;
 124         void wake_up_sleeping_actions(ModelAction *curr);
 125         modelclock_t get_next_seq_num();
 126
 127         bool next_execution();
 128         ModelAction * check_current_action(ModelAction *curr);
 129         bool initialize_curr_action(ModelAction **curr);
 130         void process_read(ModelAction *curr, SnapVector<ModelAction *> * rf_set);
 131         void process_write(ModelAction *curr);
 132         bool process_fence(ModelAction *curr);
 133         bool process_mutex(ModelAction *curr);
 134
 135         bool process_thread_action(ModelAction *curr);
 136         bool read_from(ModelAction *act, const ModelAction *rf);
 137         bool synchronize(const ModelAction *first, ModelAction *second);
 138
 139         void add_action_to_lists(ModelAction *act);
 140         ModelAction * get_last_fence_release(thread_id_t tid) const;
 141         ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
 142         ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
 143         ModelAction * get_last_unlock(ModelAction *curr) const;
 144         SnapVector<ModelAction *> * build_may_read_from(ModelAction *curr);
 145         ModelAction * process_rmw(ModelAction *curr);
 146
 147         bool r_modification_order(ModelAction *curr, const ModelAction *rf, SnapVector<const ModelAction *> *priorset);
 148         void w_modification_order(ModelAction *curr);
 149         void get_release_seq_heads(ModelAction *acquire, ModelAction *read, rel_heads_list_t *release_heads);
 150         bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads) const;
 151         ModelAction * get_uninitialized_action(const ModelAction *curr) const;
 152
 153         action_list_t action_trace;
 154         SnapVector<Thread *> thread_map;
 155         SnapVector<Thread *> pthread_map;
 156         uint32_t pthread_counter;
 157
 158         /** Per-object list of actions. Maps an object (i.e., memory location)
 159          * to a trace of all actions performed on the object. */
 160         HashTable<const void *, action_list_t *, uintptr_t, 4> obj_map;
 161
 162         /** Per-object list of actions. Maps an object (i.e., memory location)
 163          * to a trace of all actions performed on the object. */
 164         HashTable<const void *, action_list_t *, uintptr_t, 4> condvar_waiters_map;
 165
 166         HashTable<void *, SnapVector<action_list_t> *, uintptr_t, 4> obj_thrd_map;
 167
 168         HashTable<pthread_mutex_t *, cdsc::mutex *, uintptr_t, 4> mutex_map;
 169         HashTable<pthread_cond_t *, cdsc::condition_variable *, uintptr_t, 4> cond_map;
 170
 171         /**
 172          * List of pending release sequences. Release sequences might be
 173          * determined lazily as promises are fulfilled and modification orders
 174          * are established. Each entry in the list may only be partially
 175          * filled, depending on its pending status.
 176          */
 177
 178         SnapVector<ModelAction *> thrd_last_action;
 179         SnapVector<ModelAction *> thrd_last_fence_release;
 180         NodeStack * const node_stack;
 181
 182         /** A special model-checker Thread; used for associating with
 183          *  model-checker-related ModelAcitons */
 184         Thread *model_thread;
 185
 186         /** Private data members that should be snapshotted. They are grouped
 187          * together for efficiency and maintainability. */
 188         struct model_snapshot_members * const priv;
 189
 190         /**
 191          * @brief The modification order graph
 192          *
 193          * A directed acyclic graph recording observations of the modification
 194          * order on all the atomic objects in the system. This graph should
 195          * never contain any cycles, as that represents a violation of the
 196          * memory model (total ordering). This graph really consists of many
 197          * disjoint (unconnected) subgraphs, each graph corresponding to a
 198          * separate ordering on a distinct object.
 199          *
 200          * The edges in this graph represent the "ordered before" relation,
 201          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
 202          * <tt>b</tt>.
 203          */
 204         CycleGraph * const mo_graph;
 205
 206         Fuzzer * fuzzer;
 207
 208         Thread * action_select_next_thread(const ModelAction *curr) const;
 209 };
 210
 211 #endif  /* __EXECUTION_H__ */