X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=model.h;h=3ef6ee3c6c90e4ae96eb6a7ac646de02648cfc85;hb=f6d2ca10d64791d283db4786e7333770c003eb56;hp=2097d2916d5891c499b01a3d72ea085eb936e184;hpb=406f1cb90432538087e2c66ad2b081fe2f9928f8;p=model-checker.git diff --git a/model.h b/model.h index 2097d29..3ef6ee3 100644 --- a/model.h +++ b/model.h @@ -1,95 +1,251 @@ +/** @file model.h + * @brief Core model checker. + */ + #ifndef __MODEL_H__ #define __MODEL_H__ #include -#include - -#include "schedule.h" -#include "libthreads.h" -#include "libatomic.h" -#include "threads.h" -#include "tree.h" - -#define VALUE_NONE -1 - -typedef enum action_type { - THREAD_CREATE, - THREAD_YIELD, - THREAD_JOIN, - ATOMIC_READ, - ATOMIC_WRITE -} action_type_t; - -typedef std::list action_list_t; - -class ModelAction { -public: - ModelAction(action_type_t type, memory_order order, void *loc, int value); - void print(void); +#include +#include +#include + +#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 > 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; + + /** @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; +}; - thread_id_t get_tid() { return tid; } - action_type get_type() { return type; } - memory_order get_mo() { return order; } - void *get_location() { return location; } +struct PendingFutureValue { + ModelAction *writer; + ModelAction * act; +}; - TreeNode *get_node() { return node; } - void set_node(TreeNode *n) { node = n; } -private: - action_type type; - memory_order order; - void *location; - thread_id_t tid; - int value; - TreeNode *node; +/** + * 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; }; -class Backtrack { -public: - Backtrack(ModelAction *d, action_list_t *t) { - diverge = d; - actionTrace = t; - //currentIterator = actionTrace->getFirst(); - } - ModelAction *get_diverge() { return diverge; } - action_list_t *get_trace() { return actionTrace; } -private: - ModelAction *diverge; - /* unused for now; will be used when re-exploring this path? */ - //MyListElement *currentIterator; - action_list_t *actionTrace; +/** @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 writes; }; +/** @brief The central structure for model-checking */ class ModelChecker { public: - ModelChecker(); + ModelChecker(struct model_params params); ~ModelChecker(); - class Scheduler *scheduler; - Thread *system_thread; - void add_system_thread(Thread *t); + /** @returns the context for the main model-checking system thread */ + ucontext_t * get_system_context() { return &system_context; } - void set_current_action(ModelAction *act) { current_action = act; } - ModelAction *get_last_conflict(ModelAction *act); - void check_current_action(void); - void set_backtracking(ModelAction *act); - void print_trace(void); + /** Prints an execution summary with trace information. */ + void print_summary(); +#if SUPPORT_MOD_ORDER_DUMP + void dumpGraph(char *filename); +#endif - int add_thread(Thread *t); - Thread *get_thread(thread_id_t tid) { return thread_map[tid]; } + void add_thread(Thread *t); + void remove_thread(Thread *t); + Thread * get_thread(thread_id_t tid) const; + Thread * get_thread(ModelAction *act) const; - void assign_id(Thread *t); + 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_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(); + 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(); + + MEMALLOC private: - int used_thread_id; - class ModelAction *current_action; + /** 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(); + 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; - std::map thread_map; - class TreeNode *rootNode, *currentNode; + HashTable *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; + + /** Per-object list of actions. Maps an object (i.e., memory location) + * to a trace of all actions performed on the object. */ + HashTable *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 *condvar_waiters_map; + + HashTable, uintptr_t, 4 > *obj_thrd_map; + std::vector< Promise *, SnapshotAlloc > *promises; + std::vector< struct PendingFutureValue, SnapshotAlloc > *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 > *pending_rel_seqs; + + std::vector< ModelAction *, SnapshotAlloc > *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 a --> b means a was ordered before + * b. + */ + CycleGraph *mo_graph; + bool failed_promise; + bool too_many_reads; + bool asserted; + /** @brief Incorrectly-ordered synchronization was made */ + bool bad_synchronization; }; extern ModelChecker *model; -int thread_switch_to_master(ModelAction *act); - #endif /* __MODEL_H__ */