model.h

   1 /** @file model.h
   2  *  @brief Core model checker.
   3  */
   4
   5 #ifndef __MODEL_H__
   6 #define __MODEL_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 "context.h"
  17 #include "params.h"
  18 #include "classlist.h"
  19 #include "snapshot-interface.h"
  20
  21 #define ENTER_MODEL_FLAG (inside_model = 1)
  22 #define EXIT_MODEL_FLAG (inside_model = 0)
  23 #define GET_MODEL_FLAG (inside_model)
  24 #define RESTORE_MODEL_FLAG(f) (inside_model = f)
  25
  26 /** @brief Model checker execution stats */
  27 struct execution_stats {
  28         int num_total;  /**< @brief Total number of executions */
  29         int num_buggy_executions;       /** @brief Number of buggy executions */
  30         int num_complete;       /**< @brief Number of feasible, non-buggy, complete executions */
  31 };
  32
  33 /** @brief The central structure for model-checking */
  34 class ModelChecker {
  35 public:
  36         ModelChecker();
  37         ~ModelChecker();
  38         model_params * getParams();
  39
  40         /** Exit the model checker, intended for pluggins. */
  41         void exit_model_checker();
  42
  43         ModelExecution * get_execution() const { return execution; }
  44
  45         int get_execution_number() const { return execution_number; }
  46
  47         Thread * get_thread(thread_id_t tid) const;
  48         Thread * get_thread(const ModelAction *act) const;
  49
  50         Thread * get_current_thread() const;
  51         thread_id_t get_current_thread_id() const;
  52
  53         uint64_t switch_thread(ModelAction *act);
  54
  55         void assert_bug(const char *msg, ...);
  56
  57         void assert_user_bug(const char *msg);
  58
  59         model_params params;
  60         void add_trace_analysis(TraceAnalysis *a) {     trace_analyses.push_back(a); }
  61         void set_inspect_plugin(TraceAnalysis *a) {     inspect_plugin=a;       }
  62         void startChecker();
  63         Thread * getInitThread() {return init_thread;}
  64         Scheduler * getScheduler() {return scheduler;}
  65         MEMALLOC
  66 private:
  67         /** Snapshot id we return to restart. */
  68         snapshot_id snapshot;
  69
  70         /** The scheduler to use: tracks the running/ready Threads */
  71         Scheduler * const scheduler;
  72         ModelExecution *execution;
  73         Thread * init_thread;
  74
  75         int execution_number;
  76
  77         unsigned int curr_thread_num;
  78         Thread * chosen_thread;
  79         bool break_execution;
  80
  81         void startRunExecution(Thread *old);
  82         void finishRunExecution(Thread *old);
  83         Thread * getNextThread(Thread *old);
  84         bool handleChosenThread(Thread *old);
  85
  86         modelclock_t checkfree;
  87
  88         unsigned int get_num_threads() const;
  89
  90         void finish_execution(bool moreexecutions);
  91         bool should_terminate_execution();
  92
  93         Thread * get_next_thread();
  94         void reset_to_initial_state();
  95
  96         ModelVector<TraceAnalysis *> trace_analyses;
  97         char random_state[256];
  98
  99         /** @bref Plugin that can inspect new actions. */
 100         TraceAnalysis *inspect_plugin;
 101         /** @brief The cumulative execution stats */
 102         struct execution_stats stats;
 103         void record_stats();
 104         void run_trace_analyses();
 105         void print_bugs() const;
 106         void print_execution(bool printbugs) const;
 107         void print_stats() const;
 108 };
 109
 110 extern int inside_model;
 111 extern ModelChecker *model;
 112 void parse_options(struct model_params *params);
 113 void install_trace_analyses(ModelExecution *execution);
 114 void createModelIfNotExist();
 115
 116 #endif  /* __MODEL_H__ */