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 /** @brief The central structure for model-checking */
  27 class ModelChecker {
  28 public:
  29         ModelChecker();
  30         ~ModelChecker();
  31
  32         /** The scheduler to use: tracks the running/ready Threads */
  33         Scheduler *scheduler;
  34
  35         /** Stores the context for the main model-checking system thread (call
  36          * once)
  37          * @param ctxt The system context structure
  38          */
  39         void set_system_context(ucontext_t *ctxt) { system_context = ctxt; }
  40
  41         /** @returns the context for the main model-checking system thread */
  42         ucontext_t * get_system_context(void) { return system_context; }
  43
  44         void check_current_action(void);
  45
  46         /**
  47          * Prints an execution summary with trace information.
  48          * @param feasible Formats outputting according to whether or not the
  49          * current trace is feasible. Defaults to feasible = true.
  50          */
  51         void print_summary(bool feasible = true);
  52
  53         Thread * schedule_next_thread();
  54
  55         int add_thread(Thread *t);
  56         void remove_thread(Thread *t);
  57         Thread * get_thread(thread_id_t tid) { return thread_map->get(id_to_int(tid)); }
  58
  59         thread_id_t get_next_id();
  60         int get_num_threads();
  61         modelclock_t get_next_seq_num();
  62
  63         int switch_to_master(ModelAction *act);
  64         ClockVector * get_cv(thread_id_t tid);
  65         bool next_execution();
  66         bool isfeasible();
  67         bool isfinalfeasible();
  68         void check_promises(ClockVector *old_cv, ClockVector * merge_cv);
  69
  70         MEMALLOC
  71 private:
  72         int next_thread_id;
  73         modelclock_t used_sequence_numbers;
  74         int num_executions;
  75
  76         /**
  77          * Stores the ModelAction for the current thread action.  Call this
  78          * immediately before switching from user- to system-context to pass
  79          * data between them.
  80          * @param act The ModelAction created by the user-thread action
  81          */
  82         void set_current_action(ModelAction *act) { current_action = act; }
  83
  84         ModelAction * get_last_conflict(ModelAction *act);
  85         void set_backtracking(ModelAction *act);
  86         thread_id_t get_next_replay_thread();
  87         ModelAction * get_next_backtrack();
  88         void reset_to_initial_state();
  89         void resolve_promises(ModelAction *curr);
  90         void compute_promises(ModelAction *curr);
  91
  92         void add_action_to_lists(ModelAction *act);
  93         ModelAction * get_last_action(thread_id_t tid);
  94         ModelAction * get_parent_action(thread_id_t tid);
  95         ModelAction * get_last_seq_cst(const void *location);
  96         void build_reads_from_past(ModelAction *curr);
  97         ModelAction * process_rmw(ModelAction * curr);
  98         void post_r_modification_order(ModelAction * curr, const ModelAction *rf);
  99         void r_modification_order(ModelAction * curr, const ModelAction *rf);
 100         void w_modification_order(ModelAction * curr);
 101
 102         ModelAction *current_action;
 103         ModelAction *diverge;
 104         thread_id_t nextThread;
 105
 106         ucontext_t *system_context;
 107         action_list_t *action_trace;
 108         HashTable<int, Thread *, int> *thread_map;
 109
 110         /** Per-object list of actions. Maps an object (i.e., memory location)
 111          * to a trace of all actions performed on the object. */
 112         HashTable<const void *, action_list_t, uintptr_t, 4> *obj_map;
 113
 114         HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 > *obj_thrd_map;
 115         std::vector<Promise *> * promises;
 116         std::vector<ModelAction *> *thrd_last_action;
 117         NodeStack *node_stack;
 118         ModelAction *next_backtrack;
 119         CycleGraph * cyclegraph;
 120         bool failed_promise;
 121 };
 122
 123 extern ModelChecker *model;
 124
 125 #endif /* __MODEL_H__ */