4dbe557222c40a0a7d92fb55227a202d54f069f6
[c11tester.git] / 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         /** @returns the context for the main model-checking system thread */
51         ucontext_t * get_system_context() { return &system_context; }
52
53         const ModelExecution * get_execution() const { return execution; }
54
55         Thread * get_thread(thread_id_t tid) const;
56         Thread * get_thread(const ModelAction *act) const;
57
58         bool is_enabled(Thread *t) const;
59         bool is_enabled(thread_id_t tid) const;
60
61         thread_id_t get_next_id();
62         unsigned int get_num_threads() const;
63         Thread * get_current_thread() const;
64
65         void switch_from_master(Thread *thread);
66         uint64_t switch_to_master(ModelAction *act);
67         void check_promises_thread_disabled();
68
69         bool assert_bug(const char *msg, ...);
70         void assert_user_bug(const char *msg);
71
72         const model_params params;
73         void add_trace_analysis(TraceAnalysis *a) {
74                 trace_analyses->push_back(a);
75         }
76
77         action_list_t * get_actions_on_obj(void * obj, thread_id_t tid);
78         ModelAction * get_last_action(thread_id_t tid) const;
79
80         MEMALLOC
81 private:
82         /** The scheduler to use: tracks the running/ready Threads */
83         Scheduler * const scheduler;
84         NodeStack * const node_stack;
85         ModelExecution *execution;
86
87         void execute_sleep_set();
88
89         bool next_execution();
90         bool should_terminate_execution();
91
92         Thread * get_next_thread();
93         void reset_to_initial_state();
94
95
96         ModelAction *diverge;
97         ModelAction *earliest_diverge;
98
99         ucontext_t system_context;
100
101         ModelVector<TraceAnalysis *> * trace_analyses;
102
103         /** @brief The cumulative execution stats */
104         struct execution_stats stats;
105         void record_stats();
106         void run_trace_analyses();
107         void print_bugs() const;
108         void print_execution(bool printbugs) const;
109         void print_stats() const;
110
111         friend void user_main_wrapper();
112 };
113
114 extern ModelChecker *model;
115
116 #endif /* __MODEL_H__ */