model: add get_execution() interface
[model-checker.git] / model.h
diff --git a/model.h b/model.h
index e4cefd1eccae8d4aa4313baa2c987583e92dac57..3f9e6c2ea8867338dedea119acc698cd8458dcd3 100644 (file)
--- a/model.h
+++ b/model.h
@@ -5,58 +5,30 @@
 #ifndef __MODEL_H__
 #define __MODEL_H__
 
-#include <list>
-#include <vector>
 #include <cstddef>
-#include <ucontext.h>
+#include <inttypes.h>
 
 #include "mymemory.h"
-#include "action.h"
 #include "hashtable.h"
-#include "workqueue.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;
-struct model_snapshot_members;
+class ClockVector;
+class TraceAnalysis;
+class ModelExecution;
+class ModelAction;
 
-/** @brief Shorthand for a list of release sequence heads */
-typedef std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > rel_heads_list_t;
-
-/**
- * Model checker parameter structure. Holds run-time configuration options for
- * the model checker.
- */
-struct model_params {
-       int maxreads;
-       int maxfuturedelay;
-       unsigned int fairwindow;
-       unsigned int enabledcount;
-       unsigned int bound;
-
-       /** @brief Maximum number of future values that can be sent to the same
-        *  read */
-       int maxfuturevalues;
-
-       /** @brief Only generate a new future value/expiration pair if the
-        *  expiration time exceeds the existing one by more than the slop
-        *  value */
-       unsigned int expireslop;
-
-       /** @brief Verbosity (0 = quiet; 1 = noisy) */
-       int verbose;
-
-       /** @brief Command-line argument count to pass to user program */
-       int argc;
-
-       /** @brief Command-line arguments to pass to user program */
-       char **argv;
-};
+typedef SnapList<ModelAction *> action_list_t;
 
 /** @brief Model checker execution stats */
 struct execution_stats {
@@ -67,24 +39,6 @@ struct execution_stats {
        int num_redundant; /**< @brief Number of redundant, aborted executions */
 };
 
-struct PendingFutureValue {
-       ModelAction *writer;
-       ModelAction *act;
-};
-
-/** @brief Records information regarding a single pending release sequence */
-struct release_seq {
-       /** @brief The acquire operation */
-       ModelAction *acquire;
-       /** @brief The head of the RMW chain from which 'acquire' reads; may be
-        *  equal to 'release' */
-       const ModelAction *rf;
-       /** @brief The head of the potential longest release sequence chain */
-       const ModelAction *release;
-       /** @brief The write(s) that may break the release sequence */
-       std::vector<const ModelAction *> writes;
-};
-
 /** @brief The central structure for model-checking */
 class ModelChecker {
 public:
@@ -96,159 +50,64 @@ public:
        /** @returns the context for the main model-checking system thread */
        ucontext_t * get_system_context() { return &system_context; }
 
-       void print_summary() const;
-#if SUPPORT_MOD_ORDER_DUMP
-       void dumpGraph(char *filename);
-#endif
+       const ModelExecution * get_execution() const { return execution; }
 
-       void add_thread(Thread *t);
-       void remove_thread(Thread *t);
        Thread * get_thread(thread_id_t tid) const;
-       Thread * get_thread(ModelAction *act) const;
+       Thread * get_thread(const ModelAction *act) const;
+       int get_promise_number(const Promise *promise) const;
 
        bool is_enabled(Thread *t) const;
        bool is_enabled(thread_id_t tid) const;
 
        thread_id_t get_next_id();
        unsigned int get_num_threads() const;
-       Thread * get_current_thread();
+       Thread * get_current_thread() const;
 
-       int switch_to_master(ModelAction *act);
-       ClockVector * get_cv(thread_id_t tid);
-       ModelAction * get_parent_action(thread_id_t tid);
-       bool isfinalfeasible() const;
+       void switch_from_master(Thread *thread);
+       uint64_t switch_to_master(ModelAction *act);
+       ClockVector * get_cv(thread_id_t tid) const;
+       ModelAction * get_parent_action(thread_id_t tid) const;
        void check_promises_thread_disabled();
-       void mo_check_promises(thread_id_t tid, const ModelAction *write);
-       void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector * merge_cv);
-       void get_release_seq_heads(ModelAction *act, rel_heads_list_t *release_heads);
        bool isfeasibleprefix() const;
 
-       bool assert_bug(const char *msg);
+       bool assert_bug(const char *msg, ...);
        void assert_user_bug(const char *msg);
 
-       void set_bad_synchronization();
-
        const model_params params;
-       Node * get_curr_node();
+       void add_trace_analysis(TraceAnalysis *a) {
+               trace_analyses->push_back(a);
+       }
+
+       action_list_t * get_actions_on_obj(void * obj, thread_id_t tid);
+       ModelAction * get_last_action(thread_id_t tid) const;
 
        MEMALLOC
 private:
        /** The scheduler to use: tracks the running/ready Threads */
-       Scheduler *scheduler;
+       Scheduler * const scheduler;
+       NodeStack * const node_stack;
+       ModelExecution *execution;
 
-       bool sleep_can_read_from(ModelAction * curr, const ModelAction *write);
-       bool thin_air_constraint_may_allow(const ModelAction * writer, const ModelAction *reader);
-       bool mo_may_allow(const ModelAction * writer, const ModelAction *reader);
-       bool has_asserted() const;
-       void set_assert();
-       bool promises_expired() const;
        void execute_sleep_set();
-       void wake_up_sleeping_actions(ModelAction * curr);
-       modelclock_t get_next_seq_num();
 
        bool next_execution();
-       void set_current_action(ModelAction *act);
-       Thread * check_current_action(ModelAction *curr);
-       bool initialize_curr_action(ModelAction **curr);
-       bool process_read(ModelAction *curr, bool second_part_of_rmw);
-       bool process_write(ModelAction *curr);
-       bool process_mutex(ModelAction *curr);
-       bool process_thread_action(ModelAction *curr);
-       void process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue);
-       bool check_action_enabled(ModelAction *curr);
+       bool should_terminate_execution();
 
-       bool take_step();
-
-       void check_recency(ModelAction *curr, const ModelAction *rf);
-       ModelAction * get_last_conflict(ModelAction *act);
-       void set_backtracking(ModelAction *act);
-       Thread * get_next_thread(ModelAction *curr);
-       ModelAction * get_next_backtrack();
+       Thread * get_next_thread();
        void reset_to_initial_state();
-       bool resolve_promises(ModelAction *curr);
-       void compute_promises(ModelAction *curr);
-       void compute_relseq_breakwrites(ModelAction *curr);
 
-       void check_curr_backtracking(ModelAction * curr);
-       void add_action_to_lists(ModelAction *act);
-       ModelAction * get_last_action(thread_id_t tid) const;
-       ModelAction * get_last_seq_cst(ModelAction *curr) const;
-       ModelAction * get_last_unlock(ModelAction *curr) const;
-       void build_reads_from_past(ModelAction *curr);
-       ModelAction * process_rmw(ModelAction *curr);
-       void post_r_modification_order(ModelAction *curr, const ModelAction *rf);
-       bool r_modification_order(ModelAction *curr, const ModelAction *rf);
-       bool w_modification_order(ModelAction *curr);
-       bool release_seq_heads(const ModelAction *rf, rel_heads_list_t *release_heads, struct release_seq *pending) const;
-       bool resolve_release_sequences(void *location, work_queue_t *work_queue);
 
        ModelAction *diverge;
        ModelAction *earliest_diverge;
 
        ucontext_t system_context;
-       action_list_t *action_trace;
-       HashTable<int, Thread *, int> *thread_map;
-
-       /** Per-object list of actions. Maps an object (i.e., memory location)
-        * to a trace of all actions performed on the object. */
-       HashTable<const void *, action_list_t *, uintptr_t, 4> *obj_map;
-
-       /** Per-object list of actions. Maps an object (i.e., memory location)
-        * to a trace of all actions performed on the object. */
-       HashTable<const void *, action_list_t *, uintptr_t, 4> *lock_waiters_map;
-
-       /** Per-object list of actions. Maps an object (i.e., memory location)
-        * to a trace of all actions performed on the object. */
-       HashTable<const void *, action_list_t *, uintptr_t, 4> *condvar_waiters_map;
 
-       HashTable<void *, std::vector<action_list_t> *, uintptr_t, 4 > *obj_thrd_map;
-       std::vector< Promise *, SnapshotAlloc<Promise *> > *promises;
-       std::vector< struct PendingFutureValue, SnapshotAlloc<struct PendingFutureValue> > *futurevalues;
-
-       /**
-        * List of pending release sequences. Release sequences might be
-        * determined lazily as promises are fulfilled and modification orders
-        * are established. Each entry in the list may only be partially
-        * filled, depending on its pending status.
-        */
-       std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> > *pending_rel_seqs;
-
-       std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > *thrd_last_action;
-       NodeStack *node_stack;
-
-       /** Private data members that should be snapshotted. They are grouped
-        * together for efficiency and maintainability. */
-       struct model_snapshot_members *priv;
-
-       /** A special model-checker Thread; used for associating with
-        *  model-checker-related ModelAcitons */
-       Thread *model_thread;
-
-       /**
-        * @brief The modification order graph
-        *
-        * A directed acyclic graph recording observations of the modification
-        * order on all the atomic objects in the system. This graph should
-        * never contain any cycles, as that represents a violation of the
-        * memory model (total ordering). This graph really consists of many
-        * disjoint (unconnected) subgraphs, each graph corresponding to a
-        * separate ordering on a distinct object.
-        *
-        * The edges in this graph represent the "ordered before" relation,
-        * such that <tt>a --> b</tt> means <tt>a</tt> was ordered before
-        * <tt>b</tt>.
-        */
-       CycleGraph *mo_graph;
+       ModelVector<TraceAnalysis *> * trace_analyses;
 
        /** @brief The cumulative execution stats */
        struct execution_stats stats;
        void record_stats();
-
-       bool isfeasibleotherthanRMW() const;
-       bool isfeasible() const;
-       bool is_deadlocked() const;
-       bool is_complete_execution() const;
-       bool have_bug_reports() const;
+       void run_trace_analyses();
        void print_bugs() const;
        void print_execution(bool printbugs) const;
        void print_stats() const;