X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=model.h;h=5473e52c2c78b3613ca5f0013c29f5a41f895dd4;hb=4e707deed378c162acd933d7d7b7c190d341543a;hp=d3b42053fcee011ed32e47df7fef9822aadd144d;hpb=02792abf9399d1dca2fab7bc511f09e934d05f1d;p=c11tester.git diff --git a/model.h b/model.h index d3b42053..5473e52c 100644 --- a/model.h +++ b/model.h @@ -1,72 +1,251 @@ +/** @file model.h + * @brief Core model checker. + */ + #ifndef __MODEL_H__ #define __MODEL_H__ #include -#include #include #include #include -#include "schedule.h" #include "mymemory.h" -#include -#include "libthreads.h" -#include "libatomic.h" -#include "threads.h" #include "action.h" +#include "hashtable.h" +#include "workqueue.h" +#include "config.h" +#include "modeltypes.h" /* Forward declaration */ -class TreeNode; -class Backtrack; +class NodeStack; +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 > 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; + + /** @brief Verbosity (0 = quiet; 1 = noisy) */ + int verbose; +}; + +/** @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 { + ModelAction *writer; + ModelAction *act; +}; + +/** @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; - void set_system_context(ucontext_t *ctxt) { system_context = ctxt; } - ucontext_t * get_system_context(void) { return system_context; } + /** @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; } - void check_current_action(void); - void print_summary(void); - Thread * schedule_next_thread(); + void print_summary() const; +#if SUPPORT_MOD_ORDER_DUMP + void dumpGraph(char *filename); +#endif - int add_thread(Thread *t); + void add_thread(Thread *t); void remove_thread(Thread *t); - Thread * get_thread(thread_id_t tid) { return thread_map[id_to_int(tid)]; } + 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(); - int get_next_seq_num(); + 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(); - MEMALLOC -private: - int next_thread_id; - int used_sequence_numbers; - int num_executions; + 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() const; - ModelAction * get_last_conflict(ModelAction *act); - void set_backtracking(ModelAction *act); - thread_id_t advance_backtracking_state(); - thread_id_t get_next_replay_thread(); - Backtrack * get_next_backtrack(); - void reset_to_initial_state(); + bool assert_bug(const char *msg); + void assert_user_bug(const char *msg); + + bool is_deadlocked() const; + bool is_complete_execution() const; + void print_stats() const; - void print_list(action_list_t *list); + void set_bad_synchronization(); - class ModelAction *current_action; - Backtrack *exploring; - thread_id_t nextThread; + const model_params params; + Node * get_curr_node(); - ucontext_t *system_context; + MEMALLOC +private: + /** 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() const; + void set_assert(); + bool promises_expired() const; + void execute_sleep_set(); + void wake_up_sleeping_actions(ModelAction * curr); + modelclock_t get_next_seq_num(); + + void set_current_action(ModelAction *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, MyAlloc< std::pair< const int, class Thread * > > > thread_map; - class TreeNode *rootNode, *currentNode; - std::list > backtrack_list; + 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; + + /** @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;