+/** @file model.h
+ * @brief Core model checker.
+ */
+
#ifndef __MODEL_H__
#define __MODEL_H__
-#include <list>
-#include <map>
#include <cstddef>
+#include <inttypes.h>
+
+#include "mymemory.h"
+#include "hashtable.h"
+#include "config.h"
+#include "modeltypes.h"
+#include "stl-model.h"
+#include "context.h"
+#include "params.h"
+
+/* Forward declaration */
+class Node;
+class NodeStack;
+class CycleGraph;
+class Promise;
+class Scheduler;
+class Thread;
+class ClockVector;
+class TraceAnalysis;
+class ModelExecution;
+class ModelAction;
+
+typedef SnapList<ModelAction *> action_list_t;
+
+/** @brief Model checker execution stats */
+struct execution_stats {
+ int num_total; /**< @brief Total number of executions */
+ int num_infeasible; /**< @brief Number of infeasible executions */
+ int num_buggy_executions; /** @brief Number of buggy executions */
+ int num_complete; /**< @brief Number of feasible, non-buggy, complete executions */
+ int num_redundant; /**< @brief Number of redundant, aborted executions */
+};
-#include "schedule.h"
-#include "libthreads.h"
-#include "libatomic.h"
-#include "threads.h"
-#include "tree.h"
+/** @brief The central structure for model-checking */
+class ModelChecker {
+public:
+ ModelChecker(struct model_params params);
+ ~ModelChecker();
-#define VALUE_NONE -1
+ void run();
-typedef enum action_type {
- THREAD_CREATE,
- THREAD_YIELD,
- THREAD_JOIN,
- ATOMIC_READ,
- ATOMIC_WRITE
-} action_type_t;
+ /** Restart the model checker, intended for pluggins. */
+ void restart();
-typedef std::list<class ModelAction *> action_list_t;
+ /** Exit the model checker, intended for pluggins. */
+ void exit_model_checker();
-class ModelAction {
-public:
- ModelAction(action_type_t type, memory_order order, void *loc, int value);
- void print(void);
+ /** Check the exit_flag. */
+ bool get_exit_flag() const { return exit_flag; }
- thread_id_t get_tid() { return tid; }
- action_type get_type() { return type; }
- memory_order get_mo() { return order; }
- void * get_location() { return location; }
+ /** @returns the context for the main model-checking system thread */
+ ucontext_t * get_system_context() { return &system_context; }
- TreeNode * get_node() { return node; }
- void set_node(TreeNode *n) { node = n; }
-private:
- action_type type;
- memory_order order;
- void *location;
- thread_id_t tid;
- int value;
- TreeNode *node;
-};
+ ModelExecution * get_execution() const { return execution; }
-class Backtrack {
-public:
- Backtrack(ModelAction *d, action_list_t *t) {
- diverge = d;
- actionTrace = t;
- iter = actionTrace->begin();
- }
- ModelAction * get_diverge() { return diverge; }
- action_list_t * get_trace() { return actionTrace; }
- void advance_state() { iter++; }
- ModelAction * get_state() {
- return iter == actionTrace->end() ? NULL : *iter;
- }
-private:
- ModelAction *diverge;
- action_list_t *actionTrace;
- /* points to position in actionTrace as we replay */
- action_list_t::iterator iter;
-};
+ int get_execution_number() const { return execution_number; }
-class ModelChecker {
-public:
- ModelChecker();
- ~ModelChecker();
- class Scheduler *scheduler;
- Thread *system_thread;
+ Thread * get_thread(thread_id_t tid) const;
+ Thread * get_thread(const ModelAction *act) const;
- void add_system_thread(Thread *t);
+ Thread * get_current_thread() const;
- void set_current_action(ModelAction *act) { current_action = act; }
- void check_current_action(void);
- void print_trace(void);
- Thread * schedule_next_thread();
+ void switch_from_master(Thread *thread);
+ uint64_t switch_to_master(ModelAction *act);
- int add_thread(Thread *t);
- Thread * get_thread(thread_id_t tid) { return thread_map[tid]; }
+ bool assert_bug(const char *msg, ...);
+ void assert_user_bug(const char *msg);
- int get_next_id();
+ const model_params params;
+ void add_trace_analysis(TraceAnalysis *a) { trace_analyses.push_back(a); }
+ void set_inspect_plugin(TraceAnalysis *a) { inspect_plugin=a; }
+ MEMALLOC
+private:
+ /** Flag indicates whether to restart the model checker. */
+ bool restart_flag;
+ /** Flag indicates whether to exit the model checker. */
+ bool exit_flag;
+
+ /** The scheduler to use: tracks the running/ready Threads */
+ Scheduler * const scheduler;
+ NodeStack * const node_stack;
+ ModelExecution *execution;
+
+ int execution_number;
+
+ unsigned int get_num_threads() const;
- int switch_to_master(ModelAction *act);
+ void execute_sleep_set();
bool next_execution();
-private:
- int used_thread_id;
- int num_executions;
-
- ModelAction * get_last_conflict(ModelAction *act);
- void set_backtracking(ModelAction *act);
- thread_id_t advance_backtracking_state();
- thread_id_t get_next_replay_thread();
-
- class ModelAction *current_action;
- Backtrack *exploring;
- thread_id_t nextThread;
-
- action_list_t *action_trace;
- std::map<thread_id_t, class Thread *> thread_map;
- class TreeNode *rootNode, *currentNode;
- std::list<class Backtrack *> backtrack_list;
+ bool should_terminate_execution();
+
+ Thread * get_next_thread();
+ void reset_to_initial_state();
+
+
+ ModelAction *diverge;
+ ModelAction *earliest_diverge;
+
+ ucontext_t system_context;
+
+ ModelVector<TraceAnalysis *> trace_analyses;
+
+ /** @bref Implement restart. */
+ void do_restart();
+ /** @bref Plugin that can inspect new actions. */
+ TraceAnalysis *inspect_plugin;
+ /** @brief The cumulative execution stats */
+ struct execution_stats stats;
+ void record_stats();
+ void run_trace_analyses();
+ void print_bugs() const;
+ void print_execution(bool printbugs) const;
+ void print_stats() const;
+
+ friend void user_main_wrapper();
};
extern ModelChecker *model;
-int thread_switch_to_master(ModelAction *act);
-
#endif /* __MODEL_H__ */
projects / model-checker.git / blobdiff