model: add "# redundant" stat
[c11tester.git] / model.h
diff --git a/model.h b/model.h
index bd8791964baee4982c058c05c42d3678a7f621da..15516e267cfbb9b7c8947ed8d550926e59de8a98 100644 (file)
--- a/model.h
+++ b/model.h
 #include <cstddef>
 #include <ucontext.h>
 
-#include "schedule.h"
 #include "mymemory.h"
-#include "libthreads.h"
-#include "threads.h"
 #include "action.h"
-#include "clockvector.h"
 #include "hashtable.h"
+#include "workqueue.h"
+#include "config.h"
+#include "modeltypes.h"
 
 /* Forward declaration */
 class NodeStack;
 class CycleGraph;
 class Promise;
+class Scheduler;
+class Thread;
+struct model_snapshot_members;
+
+/** @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
@@ -30,26 +35,48 @@ class Promise;
 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 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 */
 };
 
 struct PendingFutureValue {
-       uint64_t value;
-       modelclock_t expiration;
-       ModelAction * act;
+       ModelAction *writer;
+       ModelAction *act;
 };
 
-/**
- * Structure for holding small ModelChecker members that should be snapshotted
- */
-struct model_snapshot_members {
-       ModelAction *current_action;
-       int next_thread_id;
-       modelclock_t used_sequence_numbers;
-       Thread *nextThread;
-       ModelAction *next_backtrack;
-
-       /** @see ModelChecker::lazy_sync_size */
-       unsigned int lazy_sync_size;
+/** @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 */
@@ -61,60 +88,80 @@ public:
        /** @returns the context for the main model-checking system thread */
        ucontext_t * get_system_context() { return &system_context; }
 
-       /** Prints an execution summary with trace information. */
-       void print_summary();
+       void print_summary() const;
+#if SUPPORT_MOD_ORDER_DUMP
+       void dumpGraph(char *filename);
+#endif
 
        void add_thread(Thread *t);
        void remove_thread(Thread *t);
-       Thread * get_thread(thread_id_t tid) { return thread_map->get(id_to_int(tid)); }
-       Thread * get_thread(ModelAction *act) { return get_thread(act->get_tid()); }
+       Thread * get_thread(thread_id_t tid) const;
+       Thread * get_thread(ModelAction *act) const;
 
-       thread_id_t get_next_id();
-       int get_num_threads();
-       modelclock_t get_next_seq_num();
+       bool is_enabled(Thread *t) const;
+       bool is_enabled(thread_id_t tid) const;
 
-       /** @return The currently executing Thread. */
-       Thread * get_current_thread() { return scheduler->get_current_thread(); }
+       thread_id_t get_next_id();
+       unsigned int get_num_threads() const;
+       Thread * get_current_thread();
 
        int switch_to_master(ModelAction *act);
        ClockVector * get_cv(thread_id_t tid);
        ModelAction * get_parent_action(thread_id_t tid);
        bool next_execution();
-       bool isfeasible();
-       bool isfeasibleotherthanRMW();
-       bool isfinalfeasible();
-       void check_promises(ClockVector *old_cv, ClockVector * merge_cv);
-       void get_release_seq_heads(ModelAction *act,
-                       std::vector< const ModelAction *, MyAlloc<const ModelAction *> > *release_heads);
+       bool isfeasible() const;
+       bool isfeasibleotherthanRMW() const;
+       bool isfinalfeasible() 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);
        void finish_execution();
-       bool isfeasibleprefix();
+       bool isfeasibleprefix() const;
+
+       bool assert_bug(const char *msg);
+       void assert_user_bug(const char *msg);
+
        void set_assert() {asserted=true;}
+       bool is_deadlocked() const;
+       bool is_complete_execution() const;
+       void print_stats() const;
+
+       /** @brief Alert the model-checker that an incorrectly-ordered
+        * synchronization was made */
+       void set_bad_synchronization() { bad_synchronization = true; }
+
+       const model_params params;
+       Node * get_curr_node();
 
        MEMALLOC
 private:
        /** The scheduler to use: tracks the running/ready Threads */
        Scheduler *scheduler;
 
+       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() {return asserted;}
        void reset_asserted() {asserted=false;}
-       int num_executions;
-       bool promises_expired();
-       const model_params params;
+       bool promises_expired() const;
+       void execute_sleep_set();
+       void wake_up_sleeping_actions(ModelAction * curr);
+       modelclock_t get_next_seq_num();
 
-       /**
-        * Stores the ModelAction for the current thread action.  Call this
-        * immediately before switching from user- to system-context to pass
-        * data between them.
-        * @param act The ModelAction created by the user-thread action
-        */
-       void set_current_action(ModelAction *act) { priv->current_action = act; }
+       void set_current_action(ModelAction *act);
        Thread * check_current_action(ModelAction *curr);
-       bool process_read(ModelAction *curr, Thread * th, bool second_part_of_rmw);
+       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 take_step();
 
-       void check_recency(ModelAction *curr, bool already_added);
+       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);
@@ -122,21 +169,23 @@ private:
        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);
-       ModelAction * get_last_seq_cst(const void *location);
+       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_head(const ModelAction *rf,
-                       std::vector< const ModelAction *, MyAlloc<const ModelAction *> > *release_heads) const;
-       bool resolve_release_sequences(void *location);
+       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;
@@ -144,36 +193,39 @@ private:
 
        /** 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;
+       HashTable<const void *, action_list_t *, uintptr_t, 4> *obj_map;
 
-       HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 > *obj_thrd_map;
-       std::vector<Promise *> *promises;
-       std::vector<struct PendingFutureValue> *futurevalues;
+       /** 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;
 
-       /**
-        * Collection of lists of objects that might synchronize with one or
-        * more release sequence. Release sequences might be determined lazily
-        * as promises are fulfilled and modification orders are established.
-        * This structure maps its lists by object location. Each ModelAction
-        * in the lists should be an acquire operation.
-        */
-       HashTable<void *, std::list<ModelAction *>, uintptr_t, 4> *lazy_sync_with_release;
+       /** 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;
 
        /**
-        * Represents the total size of the
-        * ModelChecker::lazy_sync_with_release lists. This count should be
-        * snapshotted, so it is actually a pointer to a location within
-        * ModelChecker::priv
+        * 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.
         */
-       unsigned int *lazy_sync_size;
+       std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> > *pending_rel_seqs;
 
-       std::vector<ModelAction *> *thrd_last_action;
+       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
         *
@@ -192,6 +244,16 @@ private:
        bool failed_promise;
        bool too_many_reads;
        bool asserted;
+       /** @brief Incorrectly-ordered synchronization was made */
+       bool bad_synchronization;
+
+       /** @brief The cumulative execution stats */
+       struct execution_stats stats;
+       void record_stats();
+
+       bool have_bug_reports() const;
+       void print_bugs() const;
+       void print_execution(bool printbugs) const;
 };
 
 extern ModelChecker *model;