Add SCFence analysis

[model-checker.git] / model.h

diff --git a/model.h b/model.h
index 8614563abd16314098c3a621cb7b73e54baede12..94483536cf4e7468346417c7d7ad87887ecaac9e 100644 (file)
--- a/model.h
+++ b/model.h
@@ -1,71 +1,127 @@
+/** @file model.h
+ *  @brief Core model checker.
+ */
+
 #ifndef __MODEL_H__
 #define __MODEL_H__
 
-#include <list>
-#include <map>
 #include <cstddef>
-#include <ucontext.h>
+#include <inttypes.h>
 
-#include "schedule.h"
 #include "mymemory.h"
-#include <utility>
-#include "libthreads.h"
-#include "libatomic.h"
-#include "threads.h"
-#include "action.h"
+#include "hashtable.h"
+#include "config.h"
+#include "modeltypes.h"
+#include "stl-model.h"
+#include "context.h"
+#include "params.h"
 
 /* Forward declaration */
-class TreeNode;
-class Backtrack;
+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 */
+};
 
+/** @brief The central structure for model-checking */
 class ModelChecker {
 public:
-       ModelChecker();
+       ModelChecker(struct model_params params);
        ~ModelChecker();
-       class Scheduler *scheduler;
 
-       void set_system_context(ucontext_t *ctxt) { system_context = ctxt; }
-       ucontext_t * get_system_context(void) { return system_context; }
+       void run();
 
-       void set_current_action(ModelAction *act) { current_action = act; }
-       void check_current_action(void);
-       void print_summary(void);
-       Thread * schedule_next_thread();
+       /** Restart the model checker, intended for pluggins. */
+       void restart();
 
-       int add_thread(Thread *t);
-       void remove_thread(Thread *t);
-       Thread * get_thread(thread_id_t tid) { return thread_map[id_to_int(tid)]; }
+       /** Exit the model checker, intended for pluggins. */
+       void exit_model_checker();
 
-       thread_id_t get_next_id();
-       int get_next_seq_num();
+       /** Check the exit_flag. */
+       bool get_exit_flag() const { return exit_flag; }
 
-       int switch_to_master(ModelAction *act);
+       /** @returns the context for the main model-checking system thread */
+       ucontext_t * get_system_context() { return &system_context; }
 
-       bool next_execution();
-  MEMALLOC
+       ModelExecution * get_execution() const { return execution; }
+
+       int get_execution_number() const { return execution_number; }
+
+       Thread * get_thread(thread_id_t tid) const;
+       Thread * get_thread(const ModelAction *act) const;
+
+       Thread * get_current_thread() const;
+
+       void switch_from_master(Thread *thread);
+       uint64_t switch_to_master(ModelAction *act);
+
+       bool assert_bug(const char *msg, ...);
+       void assert_user_bug(const char *msg);
+
+       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:
-       int next_thread_id;
-       int used_sequence_numbers;
-       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();
-       Backtrack * get_next_backtrack();
+       /** 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;
+
+       void execute_sleep_set();
+
+       bool next_execution();
+       bool should_terminate_execution();
+
+       Thread * get_next_thread();
        void reset_to_initial_state();
 
-       void print_list(action_list_t *list);
 
-       class ModelAction *current_action;
-       Backtrack *exploring;
-       thread_id_t nextThread;
+       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;
 
-       ucontext_t *system_context;
-       action_list_t *action_trace;
-       std::map<int, class Thread *, std::less< int >, MyAlloc< std::pair< const int, class Thread * > > > thread_map;
-       class TreeNode *rootNode, *currentNode;
-       std::list<class Backtrack *, MyAlloc< class Backtrack * > > backtrack_list;
+       friend void user_main_wrapper();
 };
 
 extern ModelChecker *model;