X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=model.h;h=96c1ec78a60ca343400c309b2e756ae53fb39967;hb=ea4611c1fc3b580020afbc04d531e4bc10fcca9c;hp=dea744c8bda1e6f61ab1b4173ae45e0bd5291ba8;hpb=0e9020d6d5a4e0570d1001b07393d080de8bb318;p=model-checker.git diff --git a/model.h b/model.h index dea744c..96c1ec7 100644 --- a/model.h +++ b/model.h @@ -5,29 +5,94 @@ #ifndef __MODEL_H__ #define __MODEL_H__ -#include #include #include #include +#include -#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 Node; class NodeStack; class CycleGraph; class Promise; +class Scheduler; +class Thread; +class ClockVector; +struct model_snapshot_members; + +/** @brief Shorthand for a list of release sequence heads */ +typedef std::vector< const ModelAction *, ModelAlloc > rel_heads_list_t; + +typedef std::list< ModelAction *, SnapshotAlloc > 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; +}; + +/** @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 { + PendingFutureValue(ModelAction *writer, ModelAction *act) : writer(writer), act(act) { } + const ModelAction *writer; + ModelAction *act; +}; + +/** @brief Records information regarding a single pending release sequence */ +struct release_seq { + /** @brief The acquire operation */ + ModelAction *acquire; + /** @brief The read operation that may read from a release sequence; + * may be the same as acquire, or else an earlier action in the same + * thread (i.e., when 'acquire' is a fence-acquire) */ + const ModelAction *read; + /** @brief The head of the RMW chain from which 'read' 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 writes; }; /** @brief The central structure for model-checking */ @@ -36,100 +101,164 @@ 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(); - - Thread * schedule_next_thread(); + void print_summary() const; +#if SUPPORT_MOD_ORDER_DUMP + void dumpGraph(char *filename) const; +#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(thread_id_t tid) const; + Thread * get_thread(const ModelAction *act) const; + int get_promise_number(const Promise *promise) const; + + bool is_enabled(Thread *t) const; + bool is_enabled(thread_id_t tid) const; thread_id_t get_next_id(); - int get_num_threads(); - modelclock_t get_next_seq_num(); + unsigned int get_num_threads() const; + Thread * get_current_thread() const; - /** @return The currently executing Thread. */ - Thread * get_current_thread() { return scheduler->get_current_thread(); } + void switch_from_master(Thread *thread); + uint64_t switch_to_master(ModelAction *act); + ClockVector * get_cv(thread_id_t tid) const; + ModelAction * get_parent_action(thread_id_t tid) const; + void check_promises_thread_disabled(); + void check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector *merge_cv); + bool isfeasibleprefix() const; - int switch_to_master(ModelAction *act); - ClockVector * get_cv(thread_id_t tid); - bool next_execution(); - bool isfeasible(); - bool isfinalfeasible(); - void check_promises(ClockVector *old_cv, ClockVector * merge_cv); - void get_release_seq_heads(ModelAction *act, - std::vector *release_heads); + bool assert_bug(const char *msg); + void assert_user_bug(const char *msg); - void finish_execution(); + const model_params params; + Node * get_curr_node() const; MEMALLOC private: /** The scheduler to use: tracks the running/ready Threads */ - Scheduler *scheduler; + Scheduler * const scheduler; - int next_thread_id; - modelclock_t used_sequence_numbers; - int num_executions; + 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() const; + void set_assert(); + void set_bad_synchronization(); + bool promises_expired() const; + void execute_sleep_set(); + bool should_wake_up(const ModelAction *curr, const Thread *thread) const; + void wake_up_sleeping_actions(ModelAction *curr); + modelclock_t get_next_seq_num(); - const model_params params; + bool next_execution(); + ModelAction * check_current_action(ModelAction *curr); + bool initialize_curr_action(ModelAction **curr); + bool process_read(ModelAction *curr); + bool process_write(ModelAction *curr); + bool process_fence(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 read_from(ModelAction *act, const ModelAction *rf); + bool check_action_enabled(ModelAction *curr); - /** - * 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) { current_action = act; } - void check_current_action(); + Thread * take_step(ModelAction *curr); + + template + bool check_recency(ModelAction *curr, const T *rf) const; - bool take_step(); + template + bool should_read_instead(const ModelAction *curr, const T *rf, const U *other_rf) const; - ModelAction * get_last_conflict(ModelAction *act); + ModelAction * get_last_fence_conflict(ModelAction *act) const; + ModelAction * get_last_conflict(ModelAction *act) const; void set_backtracking(ModelAction *act); - thread_id_t get_next_replay_thread(); + Thread * action_select_next_thread(const ModelAction *curr) const; + Thread * get_next_thread(); + bool set_latest_backtrack(ModelAction *act); ModelAction * get_next_backtrack(); void reset_to_initial_state(); - void resolve_promises(ModelAction *curr); + int get_promise_to_resolve(const ModelAction *curr) const; + bool resolve_promise(ModelAction *curr, unsigned int promise_idx); void compute_promises(ModelAction *curr); + void compute_relseq_breakwrites(ModelAction *curr); + void mo_check_promises(const ModelAction *act, bool is_read_check); + void thread_blocking_check_promises(Thread *blocker, Thread *waiting); + + void check_curr_backtracking(ModelAction *curr); void add_action_to_lists(ModelAction *act); - ModelAction * get_last_action(thread_id_t tid); - ModelAction * get_parent_action(thread_id_t tid); - ModelAction * get_last_seq_cst(const void *location); - void build_reads_from_past(ModelAction *curr); + 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; + ModelAction * get_last_unlock(ModelAction *curr) const; + void build_may_read_from(ModelAction *curr); ModelAction * process_rmw(ModelAction *curr); - void post_r_modification_order(ModelAction *curr, const ModelAction *rf); - void r_modification_order(ModelAction *curr, const ModelAction *rf); - void w_modification_order(ModelAction *curr); - bool release_seq_head(const ModelAction *rf, - std::vector *release_heads) const; - ModelAction *current_action; + template + bool r_modification_order(ModelAction *curr, const rf_type *rf); + + bool w_modification_order(ModelAction *curr, std::vector< ModelAction *, ModelAlloc > *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); + void add_future_value(const ModelAction *writer, ModelAction *reader); + + ModelAction * get_uninitialized_action(const ModelAction *curr) const; + ModelAction *diverge; - thread_id_t nextThread; + ModelAction *earliest_diverge; ucontext_t system_context; - action_list_t *action_trace; - HashTable *thread_map; + action_list_t * const action_trace; + HashTable * const 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 *obj_map; + HashTable * const obj_map; - HashTable, uintptr_t, 4 > *obj_thrd_map; - std::vector *promises; - std::vector *thrd_last_action; - NodeStack *node_stack; - ModelAction *next_backtrack; + /** Per-object list of actions. Maps an object (i.e., memory location) + * to a trace of all actions performed on the object. */ + HashTable * 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 condvar_waiters_map; + + HashTable *, uintptr_t, 4 > * const obj_thrd_map; + std::vector< Promise *, SnapshotAlloc > * const promises; + std::vector< struct PendingFutureValue, SnapshotAlloc > * const 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 > * const pending_rel_seqs; + + std::vector< ModelAction *, SnapshotAlloc > * const thrd_last_action; + std::vector< ModelAction *, SnapshotAlloc > * const thrd_last_fence_release; + NodeStack * const node_stack; + + /** Private data members that should be snapshotted. They are grouped + * together for efficiency and maintainability. */ + struct model_snapshot_members * const priv; + + /** A special model-checker Thread; used for associating with + * model-checker-related ModelAcitons */ + Thread *model_thread; /** * @brief The modification order graph * - * A direceted acyclic graph recording observations of the modification + * 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 @@ -140,9 +269,24 @@ private: * such that a --> b means a was ordered before * b. */ - CycleGraph *mo_graph; + CycleGraph * const mo_graph; + + /** @brief The cumulative execution stats */ + struct execution_stats stats; + void record_stats(); + + 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 is_complete_execution() const; + bool have_bug_reports() const; + void print_bugs() const; + void print_execution(bool printbugs) const; + void print_stats() const; - bool failed_promise; + friend void user_main_wrapper(); }; extern ModelChecker *model;