97e9849f0bbb441c5af72999e3453bc9adbe5745
[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 <list>
9 #include <map>
10 #include <vector>
11 #include <cstddef>
12 #include <ucontext.h>
13
14 #include "schedule.h"
15 #include "mymemory.h"
16 #include <utility>
17 #include "libthreads.h"
18 #include "libatomic.h"
19 #include "threads.h"
20 #include "action.h"
21 #include "clockvector.h"
22
23 /* Forward declaration */
24 class NodeStack;
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         void print_summary(void);
46         Thread * schedule_next_thread();
47
48         int add_thread(Thread *t);
49         void remove_thread(Thread *t);
50         Thread * get_thread(thread_id_t tid) { return (*thread_map)[id_to_int(tid)]; }
51
52         thread_id_t get_next_id();
53         int get_num_threads();
54         modelclock_t get_next_seq_num();
55
56         int switch_to_master(ModelAction *act);
57         ClockVector * get_cv(thread_id_t tid);
58         bool next_execution();
59
60         MEMALLOC
61 private:
62         int next_thread_id;
63         modelclock_t used_sequence_numbers;
64         int num_executions;
65
66         /**
67          * Stores the ModelAction for the current thread action.  Call this
68          * immediately before switching from user- to system-context to pass
69          * data between them.
70          * @param act The ModelAction created by the user-thread action
71          */
72         void set_current_action(ModelAction *act) { current_action = act; }
73
74         ModelAction * get_last_conflict(ModelAction *act);
75         void set_backtracking(ModelAction *act);
76         thread_id_t get_next_replay_thread();
77         ModelAction * get_next_backtrack();
78         void reset_to_initial_state();
79
80         void add_action_to_lists(ModelAction *act);
81         ModelAction * get_last_action(thread_id_t tid);
82         ModelAction * get_parent_action(thread_id_t tid);
83         void build_reads_from_past(ModelAction *curr);
84
85         ModelAction *current_action;
86         ModelAction *diverge;
87         thread_id_t nextThread;
88
89         ucontext_t *system_context;
90         action_list_t *action_trace;
91         std::map<int, Thread *> *thread_map;
92         std::map<void *, std::vector<action_list_t> > *obj_thrd_map;
93         std::vector<ModelAction *> *thrd_last_action;
94         NodeStack *node_stack;
95         ModelAction *next_backtrack;
96 };
97
98 extern ModelChecker *model;
99
100 #endif /* __MODEL_H__ */