From: Brian Norris <banorris@uci.edu>
Date: Thu, 7 Feb 2013 00:51:12 +0000 (-0800)
Subject: promise: update comments/names to reflect usage
X-Git-Tag: oopsla2013~273
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=commitdiff_plain;h=5bd87a4163897f385459b8744f3d6e322b9f5d3e

promise: update comments/names to reflect usage

is_compatible() and is_compatible_exclusive() do not require a store as
an argument; they can just as well use a load
---

diff --git a/promise.cc b/promise.cc
index ea5e7e6..69197cb 100644
--- a/promise.cc
+++ b/promise.cc
@@ -78,21 +78,23 @@ bool Promise::has_failed() const
 }
 
 /**
- * @param write A store which could satisfy this Promise
- * @return True if the store can satisfy this Promise; false otherwise
+ * @brief Check if an action's thread and location are compatible for resolving
+ * this promise
+ * @param act The action to check against
+ * @return True if we are compatible; false otherwise
  */
-bool Promise::is_compatible(const ModelAction *write) const
+bool Promise::is_compatible(const ModelAction *act) const
 {
-	return thread_is_available(write->get_tid()) && read->same_var(write);
+	return thread_is_available(act->get_tid()) && read->same_var(act);
 }
 
 /**
- * @brief Check if a promise is compatible with a store and is exclusive to its
- * thread
- * @param write The store to check against
+ * @brief Check if an action's thread and location are compatible for resolving
+ * this promise, and that the promise is thread-exclusive
+ * @param act The action to check against
  * @return True if we are compatible and exclusive; false otherwise
  */
-bool Promise::is_compatible_exclusive(const ModelAction *write) const
+bool Promise::is_compatible_exclusive(const ModelAction *act) const
 {
-	return get_num_available_threads() == 1 && is_compatible(write);
+	return get_num_available_threads() == 1 && is_compatible(act);
 }
diff --git a/promise.h b/promise.h
index 178b86e..852fe71 100644
--- a/promise.h
+++ b/promise.h
@@ -41,8 +41,8 @@ class Promise {
 	void set_write(const ModelAction *act) { write = act; }
 	const ModelAction * get_write() const { return write; }
 	int get_num_available_threads() const { return num_available_threads; }
-	bool is_compatible(const ModelAction *write) const;
-	bool is_compatible_exclusive(const ModelAction *write) const;
+	bool is_compatible(const ModelAction *act) const;
+	bool is_compatible_exclusive(const ModelAction *act) const;
 
 	void print() const;