execution: improve documentation
[cdsspec-compiler.git] / model.h
diff --git a/model.h b/model.h
index fec8d1f1ea55bf331017f9817515cae7e0d93c34..77db6aa79569c9611d1e296fa5fa2b4134f6e584 100644 (file)
--- a/model.h
+++ b/model.h
@@ -5,45 +5,38 @@
 #ifndef __MODEL_H__
 #define __MODEL_H__
 
-#include <list>
-#include <vector>
 #include <cstddef>
-#include <ucontext.h>
+#include <inttypes.h>
 
-#include "schedule.h"
 #include "mymemory.h"
-#include "libthreads.h"
-#include "threads.h"
-#include "action.h"
-#include "clockvector.h"
 #include "hashtable.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;
-
-/**
- * Model checker parameter structure. Holds run-time configuration options for
- * the model checker.
- */
-struct model_params {
-       int maxreads;
-       int maxfuturedelay;
-};
-
-/**
- * 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;
+class Scheduler;
+class Thread;
+class ClockVector;
+class TraceAnalysis;
+class ModelExecution;
+class ModelAction;
+
+typedef SnapList<ModelAction *> action_list_t;
+
+/** @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 */
 };
 
 /** @brief The central structure for model-checking */
@@ -52,140 +45,70 @@ public:
        ModelChecker(struct model_params params);
        ~ModelChecker();
 
+       void run();
+
        /** @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();
+       const ModelExecution * get_execution() const { return execution; }
 
-       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()); }
+       int get_execution_number() const { return execution_number; }
 
-       thread_id_t get_next_id();
-       int get_num_threads();
-       modelclock_t get_next_seq_num();
+       Thread * get_thread(thread_id_t tid) const;
+       Thread * get_thread(const ModelAction *act) const;
 
-       /** @return The currently executing Thread. */
-       Thread * get_current_thread() { return scheduler->get_current_thread(); }
+       bool is_enabled(Thread *t) const;
+       bool is_enabled(thread_id_t tid) const;
 
-       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 *> *release_heads);
-       void finish_execution();
-       bool isfeasibleprefix();
-       void set_assert() {asserted=true;}
+       Thread * get_current_thread() const;
+
+       void switch_from_master(Thread *thread);
+       uint64_t switch_to_master(ModelAction *act);
+
+       bool assert_bug(const char *msg, ...);
+       void assert_user_bug(const char *msg);
+
+       const model_params params;
+       void add_trace_analysis(TraceAnalysis *a) {
+               trace_analyses.push_back(a);
+       }
 
        MEMALLOC
 private:
        /** The scheduler to use: tracks the running/ready Threads */
-       Scheduler *scheduler;
-       
-       bool thin_air_constraint_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;
+       Scheduler * const scheduler;
+       NodeStack * const node_stack;
+       ModelExecution *execution;
+
+       int execution_number;
+
+       unsigned int get_num_threads() const;
+
+       void execute_sleep_set();
+
+       bool next_execution();
+       bool should_terminate_execution();
 
-       /**
-        * 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 process_read(ModelAction *curr, Thread * th, bool second_part_of_rmw);
-
-       bool take_step();
-
-       void check_recency(ModelAction *curr, bool already_added);
-       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 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);
-       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 *> *release_heads) const;
-       bool resolve_release_sequences(void *location);
+
 
        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;
-
-       HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 > *obj_thrd_map;
-       std::vector<Promise *> *promises;
-
-       /**
-        * 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;
-
-       /**
-        * 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
-        */
-       unsigned int *lazy_sync_size;
-
-       std::vector<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;
-
-       /**
-        * @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;
+
+       ModelVector<TraceAnalysis *> trace_analyses;
+
+       /** @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;
+
+       friend void user_main_wrapper();
 };
 
 extern ModelChecker *model;