traceanalysis: rename to remove '_'
[model-checker.git] / model.h
diff --git a/model.h b/model.h
index 0af3425deefa1743fd03ca99c055678c26f48e22..d5b0e76196b4fac41150d6638fc838ba8b38eeb9 100644 (file)
--- a/model.h
+++ b/model.h
@@ -5,9 +5,7 @@
 #ifndef __MODEL_H__
 #define __MODEL_H__
 
-#include "stl_wrappers.h"
 #include <cstddef>
-#include <ucontext.h>
 #include <inttypes.h>
 
 #include "mymemory.h"
@@ -15,6 +13,9 @@
 #include "workqueue.h"
 #include "config.h"
 #include "modeltypes.h"
+#include "stl-model.h"
+#include "context.h"
+#include "params.h"
 
 /* Forward declaration */
 class Node;
@@ -24,44 +25,12 @@ class Promise;
 class Scheduler;
 class Thread;
 class ClockVector;
+class TraceAnalysis;
 struct model_snapshot_members;
 
 /** @brief Shorthand for a list of release sequence heads */
-typedef model_vector< const ModelAction * > rel_heads_list_t;
-
-typedef snap_list< ModelAction * > action_list_t;
-
-/**
- * Model checker parameter structure. Holds run-time configuration options for
- * the model checker.
- */
-struct model_params {
-       int maxreads;
-       int maxfuturedelay;
-       bool yieldon;
-       unsigned int fairwindow;
-       unsigned int enabledcount;
-       unsigned int bound;
-       unsigned int uninitvalue;
-
-       /** @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 ModelVector<const ModelAction *> rel_heads_list_t;
+typedef SnapList<ModelAction *> action_list_t;
 
 /** @brief Model checker execution stats */
 struct execution_stats {
@@ -73,9 +42,11 @@ struct execution_stats {
 };
 
 struct PendingFutureValue {
-       PendingFutureValue(ModelAction *writer, ModelAction *act) : writer(writer), act(act) { }
+       PendingFutureValue(ModelAction *writer, ModelAction *reader) :
+               writer(writer), reader(reader)
+       { }
        const ModelAction *writer;
-       ModelAction *act;
+       ModelAction *reader;
 };
 
 /** @brief Records information regarding a single pending release sequence */
@@ -92,7 +63,7 @@ struct release_seq {
        /** @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;
+       SnapVector<const ModelAction *> writes;
 };
 
 /** @brief The central structure for model-checking */
@@ -111,8 +82,6 @@ public:
        void dumpGraph(char *filename) const;
 #endif
 
-       void add_thread(Thread *t);
-       void remove_thread(Thread *t);
        Thread * get_thread(thread_id_t tid) const;
        Thread * get_thread(const ModelAction *act) const;
        int get_promise_number(const Promise *promise) const;
@@ -132,20 +101,29 @@ public:
        void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector *merge_cv);
        bool isfeasibleprefix() const;
 
-       bool assert_bug(const char *msg);
+       bool assert_bug(const char *msg, ...);
        void assert_user_bug(const char *msg);
 
        const model_params params;
        Node * get_curr_node() const;
+       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 * const scheduler;
 
+       void add_thread(Thread *t);
+
        bool sleep_can_read_from(ModelAction *curr, const ModelAction *write);
-       bool thin_air_constraint_may_allow(const ModelAction *writer, const ModelAction *reader);
+       bool thin_air_constraint_may_allow(const ModelAction *writer, const ModelAction *reader) const;
        bool mo_may_allow(const ModelAction *writer, const ModelAction *reader);
+       bool promises_may_allow(const ModelAction *writer, const ModelAction *reader) const;
        bool has_asserted() const;
        void set_assert();
        void set_bad_synchronization();
@@ -168,6 +146,7 @@ private:
        bool check_action_enabled(ModelAction *curr);
 
        Thread * take_step(ModelAction *curr);
+       bool should_terminate_execution();
 
        template <typename T>
        bool check_recency(ModelAction *curr, const T *rf) const;
@@ -183,8 +162,8 @@ private:
        bool set_latest_backtrack(ModelAction *act);
        ModelAction * get_next_backtrack();
        void reset_to_initial_state();
-       int get_promise_to_resolve(const ModelAction *curr) const;
-       bool resolve_promise(ModelAction *curr, unsigned int promise_idx);
+       Promise * pop_promise_to_resolve(const ModelAction *curr);
+       bool resolve_promise(ModelAction *curr, Promise *promise);
        void compute_promises(ModelAction *curr);
        void compute_relseq_breakwrites(ModelAction *curr);
 
@@ -193,7 +172,6 @@ private:
 
        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_fence_release(thread_id_t tid) const;
        ModelAction * get_last_seq_cst_write(ModelAction *curr) const;
        ModelAction * get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const;
@@ -204,7 +182,7 @@ private:
        template <typename rf_type>
        bool r_modification_order(ModelAction *curr, const rf_type *rf);
 
-       bool w_modification_order(ModelAction *curr, std::vector< ModelAction *, ModelAlloc<ModelAction *> > *send_fv);
+       bool w_modification_order(ModelAction *curr, ModelVector<ModelAction *> *send_fv);
        void get_release_seq_heads(ModelAction *acquire, ModelAction *read, rel_heads_list_t *release_heads);
        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);
@@ -223,17 +201,13 @@ private:
         * to a trace of all actions performed on the object. */
        HashTable<const void *, action_list_t *, uintptr_t, 4> * const 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> * const 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> * const condvar_waiters_map;
 
-       HashTable<void *, snap_vector<action_list_t> *, uintptr_t, 4 > * const obj_thrd_map;
-       snap_vector< Promise * > * const promises;
-       snap_vector< struct PendingFutureValue > * const futurevalues;
+       HashTable<void *, SnapVector<action_list_t> *, uintptr_t, 4 > * const obj_thrd_map;
+       SnapVector<Promise *> * const promises;
+       SnapVector<struct PendingFutureValue> * const futurevalues;
 
        /**
         * List of pending release sequences. Release sequences might be
@@ -241,11 +215,13 @@ private:
         * are established. Each entry in the list may only be partially
         * filled, depending on its pending status.
         */
-       snap_vector< struct release_seq * > * const pending_rel_seqs;
+       SnapVector<struct release_seq *> * const pending_rel_seqs;
 
-       snap_vector< ModelAction * > * const thrd_last_action;
-       snap_vector< ModelAction * > * const thrd_last_fence_release;
+       SnapVector<ModelAction *> * const thrd_last_action;
+       SnapVector<ModelAction *> * const thrd_last_fence_release;
        NodeStack * const node_stack;
+       ModelVector<TraceAnalysis *> * trace_analyses;
+
 
        /** Private data members that should be snapshotted. They are grouped
         * together for efficiency and maintainability. */
@@ -274,12 +250,12 @@ private:
        /** @brief The cumulative execution stats */
        struct execution_stats stats;
        void record_stats();
-
+       void run_trace_analyses();
        void print_infeasibility(const char *prefix) const;
        bool is_feasible_prefix_ignore_relseq() const;
        bool is_infeasible() const;
        bool is_deadlocked() const;
-       bool is_circular_wait(const Thread *t) const;
+       bool too_many_steps() const;
        bool is_complete_execution() const;
        bool have_bug_reports() const;
        void print_bugs() const;