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 "schedule.h"
  14 #include "mymemory.h"
  15 #include "libthreads.h"
  16 #include "threads.h"
  17 #include "action.h"
  18 #include "clockvector.h"
  19 #include "hashtable.h"
  20
  21 /* Forward declaration */
  22 class NodeStack;
  23 class CycleGraph;
  24 class Promise;
  25
  26 /**
  27  * Model checker parameter structure. Holds run-time configuration options for
  28  * the model checker.
  29  */
  30 struct model_params {
  31 };
  32
  33 /**
  34  * Structure for holding small ModelChecker members that should be snapshotted
  35  */
  36 struct model_snapshot_members {
  37         ModelAction *current_action;
  38         int next_thread_id;
  39         modelclock_t used_sequence_numbers;
  40         Thread *nextThread;
  41         ModelAction *next_backtrack;
  42 };
  43
  44 /** @brief The central structure for model-checking */
  45 class ModelChecker {
  46 public:
  47         ModelChecker(struct model_params params);
  48         ~ModelChecker();
  49
  50         /** @returns the context for the main model-checking system thread */
  51         ucontext_t * get_system_context() { return &system_context; }
  52
  53         /** Prints an execution summary with trace information. */
  54         void print_summary();
  55
  56         void add_thread(Thread *t);
  57         void remove_thread(Thread *t);
  58         Thread * get_thread(thread_id_t tid) { return thread_map->get(id_to_int(tid)); }
  59
  60         thread_id_t get_next_id();
  61         int get_num_threads();
  62         modelclock_t get_next_seq_num();
  63
  64         /** @return The currently executing Thread. */
  65         Thread * get_current_thread() { return scheduler->get_current_thread(); }
  66
  67         int switch_to_master(ModelAction *act);
  68         ClockVector * get_cv(thread_id_t tid);
  69         ModelAction * get_parent_action(thread_id_t tid);
  70         bool next_execution();
  71         bool isfeasible();
  72         bool isfinalfeasible();
  73         void check_promises(ClockVector *old_cv, ClockVector * merge_cv);
  74         void get_release_seq_heads(ModelAction *act,
  75                         std::vector<const ModelAction *> *release_heads);
  76
  77         void finish_execution();
  78         bool isfeasibleprefix();
  79         void set_assert() {asserted=true;}
  80
  81         MEMALLOC
  82 private:
  83         /** The scheduler to use: tracks the running/ready Threads */
  84         Scheduler *scheduler;
  85
  86         bool has_asserted() {return asserted;}
  87         void reset_asserted() {asserted=false;}
  88         int num_executions;
  89
  90         const model_params params;
  91
  92         /**
  93          * Stores the ModelAction for the current thread action.  Call this
  94          * immediately before switching from user- to system-context to pass
  95          * data between them.
  96          * @param act The ModelAction created by the user-thread action
  97          */
  98         void set_current_action(ModelAction *act) { priv->current_action = act; }
  99         Thread * check_current_action(ModelAction *curr);
 100
 101         bool take_step();
 102
 103         ModelAction * get_last_conflict(ModelAction *act);
 104         void set_backtracking(ModelAction *act);
 105         Thread * get_next_replay_thread();
 106         ModelAction * get_next_backtrack();
 107         void reset_to_initial_state();
 108         bool resolve_promises(ModelAction *curr);
 109         void compute_promises(ModelAction *curr);
 110
 111         void add_action_to_lists(ModelAction *act);
 112         ModelAction * get_last_action(thread_id_t tid);
 113         ModelAction * get_last_seq_cst(const void *location);
 114         void build_reads_from_past(ModelAction *curr);
 115         ModelAction * process_rmw(ModelAction *curr);
 116         void post_r_modification_order(ModelAction *curr, const ModelAction *rf);
 117         bool r_modification_order(ModelAction *curr, const ModelAction *rf);
 118         bool w_modification_order(ModelAction *curr);
 119         bool release_seq_head(const ModelAction *rf,
 120                         std::vector<const ModelAction *> *release_heads) const;
 121         bool resolve_release_sequences(void *location);
 122
 123         ModelAction *diverge;
 124
 125         ucontext_t system_context;
 126         action_list_t *action_trace;
 127         HashTable<int, Thread *, int> *thread_map;
 128
 129         /** Per-object list of actions. Maps an object (i.e., memory location)
 130          * to a trace of all actions performed on the object. */
 131         HashTable<const void *, action_list_t, uintptr_t, 4> *obj_map;
 132
 133         HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 > *obj_thrd_map;
 134         std::vector<Promise *> *promises;
 135
 136         /**
 137          * Collection of lists of objects that might synchronize with one or
 138          * more release sequence. Release sequences might be determined lazily
 139          * as promises are fulfilled and modification orders are established.
 140          * This structure maps its lists by object location. Each ModelAction
 141          * in the lists should be an acquire operation.
 142          */
 143         HashTable<void *, std::list<ModelAction *>, uintptr_t, 4> *lazy_sync_with_release;
 144
 145         std::vector<ModelAction *> *thrd_last_action;
 146         NodeStack *node_stack;
 147
 148         /** Private data members that should be snapshotted. They are grouped
 149          * together for efficiency and maintainability. */
 150         struct model_snapshot_members *priv;
 151
 152         /**
 153          * @brief The modification order graph
 154          *
 155          * A directed acyclic graph recording observations of the modification
 156          * order on all the atomic objects in the system. This graph should
 157          * never contain any cycles, as that represents a violation of the
 158          * memory model (total ordering). This graph really consists of many
 159          * disjoint (unconnected) subgraphs, each graph corresponding to a
 160          * separate ordering on a distinct object.
 161          *
 162          * The edges in this graph represent the "ordered before" relation,
 163          * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
 164          * <tt>b</tt>.
 165          */
 166         CycleGraph *mo_graph;
 167         bool failed_promise;
 168         bool asserted;
 169 };
 170
 171 extern ModelChecker *model;
 172
 173 #endif /* __MODEL_H__ */