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 typedef SnapList<ModelAction *> action_list_t;
  23
  24 struct PendingFutureValue {
  25         PendingFutureValue(ModelAction *writer, ModelAction *reader) :
  26                 writer(writer), reader(reader)
  27         { }
  28         const ModelAction *writer;
  29         ModelAction *reader;
  30 };
  31
  32 /** @brief The central structure for model-checking */
  33 class ModelExecution {
  34 public:
  35         ModelExecution(ModelChecker *m, Scheduler *scheduler);
  36         ~ModelExecution();
  37
  38         struct model_params * get_params() const { return params; }
  39         void setParams(struct model_params * _params) {params = _params;}
  40
  41         Thread * take_step(ModelAction *curr);
  42
  43         void print_summary();
  44 #if SUPPORT_MOD_ORDER_DUMP
  45         void dumpGraph(char *filename);
  46 #endif
  47
  48         void add_thread(Thread *t);
  49         Thread * get_thread(thread_id_t tid) const;
  50         Thread * get_thread(const ModelAction *act) const;
  51
  52         uint32_t get_pthread_counter() { return pthread_counter; }
  53         void incr_pthread_counter() { pthread_counter++; }
  54         Thread * get_pthread(pthread_t pid);
  55
  56         bool is_enabled(Thread *t) const;
  57         bool is_enabled(thread_id_t tid) const;
  58
  59         thread_id_t get_next_id();
  60         unsigned int get_num_threads() const;
  61
  62         ClockVector * get_cv(thread_id_t tid) const;
  63         ModelAction * get_parent_action(thread_id_t tid) const;
  64
  65         ModelAction * get_last_action(thread_id_t tid) const;
  66
  67         bool check_action_enabled(ModelAction *curr);
  68
  69         void assert_bug(const char *msg);
  70
  71         bool have_bug_reports() const;
  72
  73         SnapVector<bug_message *> * get_bugs() const;
  74
  75         bool has_asserted() const;
  76         void set_assert();
  77         bool is_complete_execution() const;
  78
  79         bool is_deadlocked() const;
  80
  81         action_list_t * get_action_trace() { return &action_trace; }
  82         Fuzzer * getFuzzer();
  83         CycleGraph * const get_mo_graph() { return mo_graph; }
  84         HashTable<pthread_cond_t *, cdsc::snapcondition_variable *, uintptr_t, 4> * getCondMap() {return &cond_map;}
  85         HashTable<pthread_mutex_t *, cdsc::snapmutex *, uintptr_t, 4> * getMutexMap() {return &mutex_map;}
  86         ModelAction * check_current_action(ModelAction *curr);
  87
  88         SnapVector<func_id_list_t> * get_thrd_func_list() { return &thrd_func_list; }
  89         SnapVector<uint32_t> * get_thrd_last_entered_func() { return &thrd_last_entered_func; }
  90         SnapVector< SnapList<action_list_t *> *> * get_thrd_func_act_lists() { return &thrd_func_act_lists; }
  91         bool isFinished() {return isfinished;}
  92         void setFinished() {isfinished = true;}
  93
  94         void restore_last_seq_num();
  95 #ifdef TLS
  96         pthread_key_t getPthreadKey() {return pthreadkey;}
  97 #endif
  98         SNAPSHOTALLOC
  99 private:
 100         int get_execution_number() const;
 101         bool mo_may_allow(const ModelAction *writer, const ModelAction *reader);
 102         bool should_wake_up(const ModelAction *curr, const Thread *thread) const;
 103         void wake_up_sleeping_actions(ModelAction *curr);
 104         modelclock_t get_next_seq_num();
 105         bool next_execution();
 106         bool initialize_curr_action(ModelAction **curr);
 107         bool process_read(ModelAction *curr, SnapVector<ModelAction *> * rf_set);
 108         void process_write(ModelAction *curr);
 109         bool process_fence(ModelAction *curr);
 110         bool process_mutex(ModelAction *curr);
 111         void process_thread_action(ModelAction *curr);
 112         void read_from(ModelAction *act, ModelAction *rf);
 113         bool synchronize(const ModelAction *first, ModelAction *second);
 114         void add_uninit_action_to_lists(ModelAction *act);
 115         void add_action_to_lists(ModelAction *act);
 116         void add_normal_write_to_lists(ModelAction *act);
 117         void add_write_to_lists(ModelAction *act);
 118         ModelAction * get_last_fence_release(thread_id_t tid) const;
 119         ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
 120         ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
 121         ModelAction * get_last_unlock(ModelAction *curr) const;
 122         SnapVector<ModelAction *> * build_may_read_from(ModelAction *curr);
 123         ModelAction * process_rmw(ModelAction *curr);
 124         bool r_modification_order(ModelAction *curr, const ModelAction *rf, SnapVector<const ModelAction *> *priorset, bool *canprune, bool check_only = false);
 125         void w_modification_order(ModelAction *curr);
 126         ClockVector * get_hb_from_write(ModelAction *rf) const;
 127         ModelAction * get_uninitialized_action(ModelAction *curr) const;
 128         ModelAction * convertNonAtomicStore(void*);
 129
 130 #ifdef TLS
 131         pthread_key_t pthreadkey;
 132 #endif
 133         ModelChecker *model;
 134         struct model_params * params;
 135
 136         /** The scheduler to use: tracks the running/ready Threads */
 137         Scheduler * const scheduler;
 138
 139         SnapVector<Thread *> thread_map;
 140         SnapVector<Thread *> pthread_map;
 141         uint32_t pthread_counter;
 142
 143         action_list_t action_trace;
 144
 145         /** Per-object list of actions. Maps an object (i.e., memory location)
 146          * to a trace of all actions performed on the object.
 147          * Used only for SC fences, unlocks, & wait.
 148          */
 149         HashTable<const void *, action_list_t *, uintptr_t, 2> obj_map;
 150
 151         /** Per-object list of actions. Maps an object (i.e., memory location)
 152          * to a trace of all actions performed on the object. */
 153         HashTable<const void *, action_list_t *, uintptr_t, 2> condvar_waiters_map;
 154
 155         /** Per-object list of actions that each thread performed. */
 156         HashTable<const void *, SnapVector<action_list_t> *, uintptr_t, 2> obj_thrd_map;
 157
 158         /** Per-object list of writes that each thread performed. */
 159         HashTable<const void *, SnapVector<action_list_t> *, uintptr_t, 2> obj_wr_thrd_map;
 160
 161         HashTable<const void *, ModelAction *, uintptr_t, 4> obj_last_sc_map;
 162
 163
 164         HashTable<pthread_mutex_t *, cdsc::snapmutex *, uintptr_t, 4> mutex_map;
 165         HashTable<pthread_cond_t *, cdsc::snapcondition_variable *, uintptr_t, 4> cond_map;
 166
 167         /**
 168          * List of pending release sequences. Release sequences might be
 169          * determined lazily as promises are fulfilled and modification orders
 170          * are established. Each entry in the list may only be partially
 171          * filled, depending on its pending status.
 172          */
 173
 174         SnapVector<ModelAction *> thrd_last_action;
 175         SnapVector<ModelAction *> thrd_last_fence_release;
 176
 177         /** A special model-checker Thread; used for associating with
 178          *  model-checker-related ModelAcitons */
 179         Thread *model_thread;
 180
 181         /** Private data members that should be snapshotted. They are grouped
 182          * together for efficiency and maintainability. */
 183         struct model_snapshot_members * const priv;
 184
 185         /**
 186          * @brief The modification order graph
 187          *
 188          * A directed acyclic graph recording observations of the modification
 189          * order on all the atomic objects in the system. This graph should
 190          * never contain any cycles, as that represents a violation of the
 191          * memory model (total ordering). This graph really consists of many
 192          * disjoint (unconnected) subgraphs, each graph corresponding to a
 193          * separate ordering on a distinct object.
 194          *
 195          * The edges in this graph represent the "ordered before" relation,
 196          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
 197          * <tt>b</tt>.
 198          */
 199         CycleGraph * const mo_graph;
 200
 201         Fuzzer * fuzzer;
 202
 203         Thread * action_select_next_thread(const ModelAction *curr) const;
 204         bool paused_by_fuzzer(const ModelAction * act) const;
 205
 206         /* thrd_func_list stores a list of function ids for each thread.
 207          * Each element in thrd_func_list stores the functions that
 208          * thread i has entered and yet to exit from
 209          *
 210          * This data structure is handled by ModelHistory
 211          */
 212         SnapVector<func_id_list_t> thrd_func_list;
 213         SnapVector<uint32_t> thrd_last_entered_func;
 214
 215         /* Keeps track of atomic actions that thread i has performed in some
 216          * function. Index of SnapVector is thread id. SnapList simulates
 217          * the call stack.
 218          */
 219         SnapVector< SnapList<action_list_t *> *> thrd_func_act_lists;
 220         bool isfinished;
 221 };
 222
 223 #endif  /* __EXECUTION_H__ */