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