small changes
[c11tester.git] / model.h
diff --git a/model.h b/model.h
index 8ff9d375838b193bec751f9b7f0d419a89f07a8d..fd65c0503b0ecd32ff16536a601a12c5fb9fab68 100644 (file)
--- a/model.h
+++ b/model.h
 #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"
-
-/* Forward declaration */
-class NodeStack;
-class CycleGraph;
-class Promise;
-class Scheduler;
-class Thread;
-
-/** @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;
-};
-
-struct PendingFutureValue {
-       ModelAction *writer;
-       ModelAction * act;
-};
-
-/**
- * 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;
-};
-
-/** @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;
+#include "stl-model.h"
+#include "context.h"
+#include "params.h"
+#include "classlist.h"
+#include "snapshot-interface.h"
+
+/** @brief Model checker execution stats */
+struct execution_stats {
+       int num_total;  /**< @brief Total number of executions */
+       int num_buggy_executions;       /** @brief Number of buggy executions */
+       int num_complete;       /**< @brief Number of feasible, non-buggy, complete executions */
 };
 
 /** @brief The central structure for model-checking */
 class ModelChecker {
 public:
-       ModelChecker(struct model_params params);
+       ModelChecker();
        ~ModelChecker();
+       model_params * getParams();
+
+       /** Exit the model checker, intended for pluggins. */
+       void exit_model_checker();
 
-       /** @returns the context for the main model-checking system thread */
-       ucontext_t * get_system_context() { return &system_context; }
+       ModelExecution * get_execution() const { return execution; }
+       ModelHistory * get_history() const { return history; }
 
-       /** Prints an execution summary with trace information. */
-       void print_summary();
-#if SUPPORT_MOD_ORDER_DUMP
-       void dumpGraph(char *filename);
-#endif
+       int get_execution_number() const { return execution_number; }
 
-       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_id_t get_next_id();
-       unsigned int get_num_threads();
-       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 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();
-       void set_assert() {asserted=true;}
-
-       /** @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();
+       Thread * get_thread(const ModelAction *act) const;
+
+       Thread * get_current_thread() const;
+       thread_id_t get_current_thread_id() const;
 
+       uint64_t switch_thread(ModelAction *act);
+
+       void assert_bug(const char *msg, ...);
+
+       void assert_user_bug(const char *msg);
+
+       model_params params;
+       void add_trace_analysis(TraceAnalysis *a) {     trace_analyses.push_back(a); }
+       void set_inspect_plugin(TraceAnalysis *a) {     inspect_plugin=a;       }
+       void startChecker();
+       Thread * getInitThread() {return init_thread;}
+       Scheduler * getScheduler() {return scheduler;}
        MEMALLOC
 private:
+       /** Snapshot id we return to restart. */
+       snapshot_id snapshot;
+
        /** 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;
-       int num_feasible_executions;
-       bool promises_expired();
-       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; }
-       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 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();
+       Scheduler * const scheduler;
+       ModelHistory * history;
+       ModelExecution *execution;
+       Thread * init_thread;
+
+       int execution_number;
+
+       unsigned int curr_thread_num;
+       Thread * chosen_thread;
+       bool break_execution;
+
+       void startRunExecution(Thread *old);
+       void finishRunExecution(Thread *old);
+       Thread * getNextThread(Thread *old);
+       bool handleChosenThread(Thread *old);
+
+       modelclock_t checkfree;
+
+       unsigned int get_num_threads() const;
+
+       void finish_execution(bool moreexecutions);
+       bool should_terminate_execution();
+
+       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;
-       bool failed_promise;
-       bool too_many_reads;
-       bool asserted;
-       /** @brief Incorrectly-ordered synchronization was made */
-       bool bad_synchronization;
+
+       ModelVector<TraceAnalysis *> trace_analyses;
+       char random_state[256];
+
+       /** @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;
 };
 
 extern ModelChecker *model;
+void parse_options(struct model_params *params);
+void install_trace_analyses(ModelExecution *execution);
 
-#endif /* __MODEL_H__ */
+#endif /* __MODEL_H__ */