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
  19 /* Forward declaration */
  20 class Node;
  21 class NodeStack;
  22 class CycleGraph;
  23 class Promise;
  24 class Scheduler;
  25 class Thread;
  26 class ClockVector;
  27 class TraceAnalysis;
  28 class ModelExecution;
  29 class ModelAction;
  30
  31 typedef SnapList<ModelAction *> action_list_t;
  32
  33 /** @brief Model checker execution stats */
  34 struct execution_stats {
  35         int num_total; /**< @brief Total number of executions */
  36         int num_infeasible; /**< @brief Number of infeasible executions */
  37         int num_buggy_executions; /** @brief Number of buggy executions */
  38         int num_complete; /**< @brief Number of feasible, non-buggy, complete executions */
  39         int num_redundant; /**< @brief Number of redundant, aborted executions */
  40 };
  41
  42 /** @brief The central structure for model-checking */
  43 class ModelChecker {
  44 public:
  45         ModelChecker(struct model_params params);
  46         ~ModelChecker();
  47
  48         void run();
  49
  50         /** Restart the model checker, intended for pluggins. */
  51         void restart();
  52
  53         /** Exit the model checker, intended for pluggins. */
  54         void exit_model_checker();
  55
  56         /** Check the exit_flag. */
  57         bool get_exit_flag() const { return exit_flag; }
  58
  59         /** @returns the context for the main model-checking system thread */
  60         ucontext_t * get_system_context() { return &system_context; }
  61
  62         ModelExecution * get_execution() const { return execution; }
  63
  64         int get_execution_number() const { return execution_number; }
  65
  66         Thread * get_thread(thread_id_t tid) const;
  67         Thread * get_thread(const ModelAction *act) const;
  68
  69         Thread * get_current_thread() const;
  70
  71         void switch_from_master(Thread *thread);
  72         uint64_t switch_to_master(ModelAction *act);
  73
  74         bool assert_bug(const char *msg, ...);
  75         void assert_user_bug(const char *msg);
  76
  77         const model_params params;
  78         void add_trace_analysis(TraceAnalysis *a) {     trace_analyses.push_back(a); }
  79         void set_inspect_plugin(TraceAnalysis *a) {     inspect_plugin=a;       }
  80         MEMALLOC
  81 private:
  82         /** Flag indicates whether to restart the model checker. */
  83         bool restart_flag;
  84         /** Flag indicates whether to exit the model checker. */
  85         bool exit_flag;
  86
  87         /** The scheduler to use: tracks the running/ready Threads */
  88         Scheduler * const scheduler;
  89         NodeStack * const node_stack;
  90         ModelExecution *execution;
  91
  92         int execution_number;
  93
  94         unsigned int get_num_threads() const;
  95
  96         void execute_sleep_set();
  97
  98         bool next_execution();
  99         bool should_terminate_execution();
 100
 101         Thread * get_next_thread();
 102         void reset_to_initial_state();
 103
 104
 105         ModelAction *diverge;
 106         ModelAction *earliest_diverge;
 107
 108         ucontext_t system_context;
 109
 110         ModelVector<TraceAnalysis *> trace_analyses;
 111
 112         /** @bref Implement restart. */
 113         void do_restart();
 114         /** @bref Plugin that can inspect new actions. */
 115         TraceAnalysis *inspect_plugin;
 116         /** @brief The cumulative execution stats */
 117         struct execution_stats stats;
 118         void record_stats();
 119         void run_trace_analyses();
 120         void print_bugs() const;
 121         void print_execution(bool printbugs) const;
 122         void print_stats() const;
 123
 124         friend void user_main_wrapper();
 125 };
 126
 127 extern ModelChecker *model;
 128
 129 #endif /* __MODEL_H__ */