model: add "# redundant" stat
[c11tester.git] / model.h
diff --git a/model.h b/model.h
index 8316f04bd7aef32986f3d54f31dd1ca8afdca090..15516e267cfbb9b7c8947ed8d550926e59de8a98 100644 (file)
--- a/model.h
+++ b/model.h
@@ -23,6 +23,7 @@ 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;
@@ -36,23 +37,33 @@ struct model_params {
        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;
 };
 
-struct PendingFutureValue {
-       uint64_t value;
-       modelclock_t expiration;
-       ModelAction * act;
+/** @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 */
 };
 
-/**
- * Structure for holding small ModelChecker members that should be snapshotted
- */
-struct model_snapshot_members {
-       ModelAction *current_action;
-       unsigned int next_thread_id;
-       modelclock_t used_sequence_numbers;
-       Thread *nextThread;
-       ModelAction *next_backtrack;
+struct PendingFutureValue {
+       ModelAction *writer;
+       ModelAction *act;
 };
 
 /** @brief Records information regarding a single pending release sequence */
@@ -77,8 +88,7 @@ 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
@@ -88,30 +98,41 @@ public:
        Thread * get_thread(thread_id_t tid) const;
        Thread * get_thread(ModelAction *act) 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();
+       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();
+       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;
-       Scheduler * get_scheduler() { return scheduler;}
+       Node * get_curr_node();
 
        MEMALLOC
 private:
@@ -120,24 +141,17 @@ private:
 
        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;
-       int num_feasible_executions;
-       bool promises_expired();
+       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);
-       ModelAction * initialize_curr_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);
@@ -169,7 +183,6 @@ private:
        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);
-       void do_complete_join(ModelAction *join);
 
        ModelAction *diverge;
        ModelAction *earliest_diverge;
@@ -180,13 +193,17 @@ 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;
+
+       /** 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> *lock_waiters_map;
+       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;
+       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;
 
@@ -229,6 +246,14 @@ private:
        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;