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 typedef SnapList<ModelAction *> action_list_t;
  22
  23 /** @brief Model checker execution stats */
  24 struct execution_stats {
  25         int num_total;  /**< @brief Total number of executions */
  26         int num_buggy_executions;       /** @brief Number of buggy executions */
  27         int num_complete;       /**< @brief Number of feasible, non-buggy, complete executions */
  28 };
  29
  30 /** @brief The central structure for model-checking */
  31 class ModelChecker {
  32 public:
  33         ModelChecker();
  34         ~ModelChecker();
  35         model_params * getParams();
  36         void run();
  37
  38         /** Exit the model checker, intended for pluggins. */
  39         void exit_model_checker();
  40
  41         /** @returns the context for the main model-checking system thread */
  42         ucontext_t * get_system_context() { return &system_context; }
  43
  44         ModelExecution * get_execution() const { return execution; }
  45         ModelHistory * get_history() const { return history; }
  46
  47         int get_execution_number() const { return execution_number; }
  48
  49         Thread * get_thread(thread_id_t tid) const;
  50         Thread * get_thread(const ModelAction *act) const;
  51
  52         Thread * get_current_thread() const;
  53
  54         void switch_from_master(Thread *thread);
  55         uint64_t switch_to_master(ModelAction *act);
  56         uint64_t switch_thread(ModelAction *act);
  57
  58         void startRunExecution(Thread *old);
  59         void finishRunExecution(Thread *old);
  60         void consumeAction();
  61         void chooseThread(ModelAction *act, Thread *thr);
  62         Thread * getNextThread();
  63         void handleChosenThread(Thread *old);
  64         void handleNewValidThread(Thread *old, Thread *next);
  65
  66         void assert_bug(const char *msg, ...);
  67
  68         void assert_user_bug(const char *msg);
  69
  70         model_params params;
  71         void add_trace_analysis(TraceAnalysis *a) {     trace_analyses.push_back(a); }
  72         void set_inspect_plugin(TraceAnalysis *a) {     inspect_plugin=a;       }
  73         void startChecker();
  74         Thread * getInitThread() {return init_thread;}
  75         Scheduler * getScheduler() {return scheduler;}
  76         MEMALLOC
  77 private:
  78         /** Snapshot id we return to restart. */
  79         snapshot_id snapshot;
  80
  81         /** The scheduler to use: tracks the running/ready Threads */
  82         Scheduler * const scheduler;
  83         ModelHistory * history;
  84         ModelExecution *execution;
  85         Thread * init_thread;
  86
  87         int execution_number;
  88
  89         unsigned int curr_thread_num;
  90
  91         Thread * chosen_thread;
  92
  93         bool thread_chosen;
  94         bool break_execution;
  95
  96         modelclock_t checkfree;
  97
  98         unsigned int get_num_threads() const;
  99
 100         void finish_execution(bool moreexecutions);
 101         bool should_terminate_execution();
 102
 103         Thread * get_next_thread();
 104         void reset_to_initial_state();
 105
 106         ucontext_t system_context;
 107
 108         ModelVector<TraceAnalysis *> trace_analyses;
 109
 110         /** @bref Plugin that can inspect new actions. */
 111         TraceAnalysis *inspect_plugin;
 112         /** @brief The cumulative execution stats */
 113         struct execution_stats stats;
 114         void record_stats();
 115         void run_trace_analyses();
 116         void print_bugs() const;
 117         void print_execution(bool printbugs) const;
 118         void print_stats() const;
 119 };
 120
 121 extern ModelChecker *model;
 122 void parse_options(struct model_params *params);
 123 void install_trace_analyses(ModelExecution *execution);
 124
 125 #endif  /* __MODEL_H__ */