X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=action.h;h=30c8a35b80ed7681ce74bc5388c0667b9b4e4fec;hb=82a487f5efd48d3ec5f35a72e826100371731506;hp=c069cab3a3c5c3a7e6804498a2f6262b753a6f20;hpb=1d6c949fef3b5da936f8499dde464f8df634267a;p=model-checker.git

diff --git a/action.h b/action.h
index c069cab..30c8a35 100644
--- a/action.h
+++ b/action.h
@@ -1,55 +1,115 @@
+/** @file action.h
+ *  @brief Models actions taken by threads.
+ */
+
 #ifndef __ACTION_H__
 #define __ACTION_H__
 
 #include <list>
+#include <cstddef>
+
 #include "threads.h"
 #include "libatomic.h"
 #include "mymemory.h"
+#include "clockvector.h"
+
 #define VALUE_NONE -1
 
+/** @brief Represents an action type, identifying one of several types of
+ * ModelAction */
 typedef enum action_type {
-	THREAD_CREATE,
-	THREAD_YIELD,
-	THREAD_JOIN,
-	ATOMIC_READ,
-	ATOMIC_WRITE
+	THREAD_CREATE,        /**< A thread creation action */
+	THREAD_START,         /**< First action in each thread */
+	THREAD_YIELD,         /**< A thread yield action */
+	THREAD_JOIN,          /**< A thread join action */
+	ATOMIC_READ,          /**< An atomic read action */
+	ATOMIC_WRITE,         /**< An atomic write action */
+	ATOMIC_RMW,           /**< An atomic read-modify-write action */
+	ATOMIC_INIT           /**< Initialization of an atomic object (e.g.,
+	                       *   atomic_init()) */
 } action_type_t;
 
 /* Forward declaration */
-class TreeNode;
+class Node;
+class ClockVector;
 
+/**
+ * The ModelAction class encapsulates an atomic action.
+ */
 class ModelAction {
 public:
-	ModelAction(action_type_t type, memory_order order, void *loc, int value);
-	void print(void);
-
-	thread_id_t get_tid() { return tid; }
-	action_type get_type() { return type; }
-	memory_order get_mo() { return order; }
-	void * get_location() { return location; }
-	int get_seq_number() { return seq_number; }
-
-	TreeNode * get_node() { return node; }
-	void set_node(TreeNode *n) { node = n; }
-
-	bool is_read();
-	bool is_write();
-	bool is_acquire();
-	bool is_release();
-	bool same_var(ModelAction *act);
-	bool same_thread(ModelAction *act);
-	bool is_dependent(ModelAction *act);
-  MEMALLOC
+	ModelAction(action_type_t type, memory_order order, void *loc, int value = VALUE_NONE);
+	~ModelAction();
+	void print(void) const;
+
+	thread_id_t get_tid() const { return tid; }
+	action_type get_type() const { return type; }
+	memory_order get_mo() const { return order; }
+	void * get_location() const { return location; }
+	modelclock_t get_seq_number() const { return seq_number; }
+	int get_value() const { return value; }
+	const ModelAction * get_reads_from() const { return reads_from; }
+
+	Node * get_node() const { return node; }
+	void set_node(Node *n) { node = n; }
+
+	bool is_read() const;
+	bool is_write() const;
+	bool is_rmw() const;
+	bool is_initialization() const;
+	bool is_acquire() const;
+	bool is_release() const;
+	bool is_seqcst() const;
+	bool same_var(const ModelAction *act) const;
+	bool same_thread(const ModelAction *act) const;
+	bool is_synchronizing(const ModelAction *act) const;
+
+	void create_cv(const ModelAction *parent = NULL);
+	ClockVector * get_cv() const { return cv; }
+	void read_from(const ModelAction *act);
+
+	bool happens_before(const ModelAction *act) const;
+
+	inline bool operator <(const ModelAction& act) const {
+		return get_seq_number() < act.get_seq_number();
+	}
+	inline bool operator >(const ModelAction& act) const {
+		return get_seq_number() > act.get_seq_number();
+	}
+
+	MEMALLOC
 private:
+
+	/** Type of action (read, write, thread create, thread yield, thread join) */
 	action_type type;
+
+	/** The memory order for this operation. */
 	memory_order order;
+
+	/** A pointer to the memory location for this action. */
 	void *location;
+
+	/** The thread id that performed this action. */
 	thread_id_t tid;
+
+	/** The value read or written (if RMW, then the value written). This
+	 * should probably be something longer. */
 	int value;
-	TreeNode *node;
-	int seq_number;
+
+	/** The action that this action reads from. Only valid for reads */
+	const ModelAction *reads_from;
+
+	/** A back reference to a Node in NodeStack, if this ModelAction is
+	 * saved on the NodeStack. */
+	Node *node;
+
+	modelclock_t seq_number;
+
+	/** The clock vector stored with this action; only needed if this
+	 * action is a store release? */
+	ClockVector *cv;
 };
 
-typedef std::list<class ModelAction *, MyAlloc< class ModelAction * > > action_list_t;
+typedef std::list<ModelAction *> action_list_t;
 
 #endif /* __ACTION_H__ */