projects
/
c11tester.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
9e438bd
)
cyclegraph: improve comments, use initializer list
author
Brian Norris
<banorris@uci.edu>
Tue, 14 Aug 2012 22:25:11 +0000
(15:25 -0700)
committer
Brian Norris
<banorris@uci.edu>
Tue, 14 Aug 2012 22:28:25 +0000
(15:28 -0700)
cyclegraph.cc
patch
|
blob
|
history
cyclegraph.h
patch
|
blob
|
history
diff --git
a/cyclegraph.cc
b/cyclegraph.cc
index f060a00e74362b6f9df99649ffd844f7e416d4b9..1eb1add33fc255e4f53e9044b3d3850b422668dd 100644
(file)
--- a/
cyclegraph.cc
+++ b/
cyclegraph.cc
@@
-2,15
+2,21
@@
#include "action.h"
/** Initializes a CycleGraph object. */
#include "action.h"
/** Initializes a CycleGraph object. */
-CycleGraph::CycleGraph() {
- hasCycles=false;
+CycleGraph::CycleGraph() :
+ hasCycles(false)
+{
}
}
+/** CycleGraph destructor */
CycleGraph::~CycleGraph() {
}
CycleGraph::~CycleGraph() {
}
-/** Returns the CycleNode for a given ModelAction. */
-CycleNode * CycleGraph::getNode(const ModelAction * action) {
+/**
+ * @brief Returns the CycleNode corresponding to a given ModelAction
+ * @param action The ModelAction to find a node for
+ * @return The CycleNode paired with this action
+ */
+CycleNode * CycleGraph::getNode(const ModelAction *action) {
CycleNode *node=actionToNode.get(action);
if (node==NULL) {
node=new CycleNode(action);
CycleNode *node=actionToNode.get(action);
if (node==NULL) {
node=new CycleNode(action);
@@
-20,8
+26,10
@@
CycleNode * CycleGraph::getNode(const ModelAction * action) {
}
/**
}
/**
- * Adds an edge between two ModelActions. The ModelAction to happens after the
- * ModelAction from.
+ * Adds an edge between two ModelActions. The ModelAction @a to is ordered
+ * after the ModelAction @a from.
+ * @param to The edge points to this ModelAction
+ * @param from The edge comes from this ModelAction
*/
void CycleGraph::addEdge(const ModelAction *to, const ModelAction *from) {
CycleNode *fromnode=getNode(from);
*/
void CycleGraph::addEdge(const ModelAction *to, const ModelAction *from) {
CycleNode *fromnode=getNode(from);
@@
-52,7
+60,7
@@
void CycleGraph::addEdge(const ModelAction *to, const ModelAction *from) {
* can occur in between the rmw and the from action. Only one RMW
* action can read from a given write.
*/
* can occur in between the rmw and the from action. Only one RMW
* action can read from a given write.
*/
-void CycleGraph::addRMWEdge(const ModelAction *rmw, const ModelAction *
from) {
+void CycleGraph::addRMWEdge(const ModelAction *rmw, const ModelAction *from) {
CycleNode *fromnode=getNode(from);
CycleNode *rmwnode=getNode(rmw);
CycleNode *fromnode=getNode(from);
CycleNode *rmwnode=getNode(rmw);
@@
-74,7
+82,12
@@
void CycleGraph::addRMWEdge(const ModelAction *rmw, const ModelAction * from) {
}
}
-/** Checks whether the first CycleNode can reach the second one. */
+/**
+ * Checks whether one CycleNode can reach another.
+ * @param from The CycleNode from which to begin exploration
+ * @param to The CycleNode to reach
+ * @return True, @a from can reach @a to; otherwise, false
+ */
bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
std::vector<CycleNode *> queue;
HashTable<CycleNode *, CycleNode *, uintptr_t, 4> discovered;
bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
std::vector<CycleNode *> queue;
HashTable<CycleNode *, CycleNode *, uintptr_t, 4> discovered;
@@
-98,34
+111,46
@@
bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
return false;
}
return false;
}
-/**
R
eturns whether a CycleGraph contains cycles. */
+/**
@r
eturns whether a CycleGraph contains cycles. */
bool CycleGraph::checkForCycles() {
return hasCycles;
}
bool CycleGraph::checkForCycles() {
return hasCycles;
}
-/** Constructor for a CycleNode. */
-CycleNode::CycleNode(const ModelAction *modelaction) {
- action=modelaction;
- hasRMW=NULL;
+/**
+ * Constructor for a CycleNode.
+ * @param modelaction The ModelAction for this node
+ */
+CycleNode::CycleNode(const ModelAction *modelaction) :
+ action(modelaction),
+ hasRMW(NULL)
+{
}
}
-/**
R
eturns a vector of the edges from a CycleNode. */
+/**
@r
eturns a vector of the edges from a CycleNode. */
std::vector<CycleNode *> * CycleNode::getEdges() {
return &edges;
}
std::vector<CycleNode *> * CycleNode::getEdges() {
return &edges;
}
-/** Adds an edge to a CycleNode. */
-void CycleNode::addEdge(CycleNode * node) {
+/**
+ * Adds an edge from this CycleNode to another CycleNode.
+ * @param node The node to which we add a directed edge
+ */
+void CycleNode::addEdge(CycleNode *node) {
edges.push_back(node);
}
edges.push_back(node);
}
-/**
Get the RMW CycleNode that reads from the current CycleNode.
*/
-CycleNode* CycleNode::getRMW() {
+/**
@returns the RMW CycleNode that reads from the current CycleNode
*/
+CycleNode
* CycleNode::getRMW() {
return hasRMW;
}
return hasRMW;
}
-/** Set a RMW action node that reads from the current CycleNode. */
-bool CycleNode::setRMW(CycleNode * node) {
+/**
+ * Set a RMW action node that reads from the current CycleNode.
+ * @param node The RMW that reads from the current node
+ * @return True, if this node already was read by another RMW; false otherwise
+ * @see CycleGraph::addRMWEdge
+ */
+bool CycleNode::setRMW(CycleNode *node) {
CycleNode * oldhasRMW=hasRMW;
hasRMW=node;
return (oldhasRMW!=NULL);
CycleNode * oldhasRMW=hasRMW;
hasRMW=node;
return (oldhasRMW!=NULL);
diff --git
a/cyclegraph.h
b/cyclegraph.h
index 5cf709324a863d51e4ec45956093600460495232..d0258d180f6e60546bc9619b1b3f56c86bda33de 100644
(file)
--- a/
cyclegraph.h
+++ b/
cyclegraph.h
@@
-23,11
+23,17
@@
class CycleGraph {
private:
CycleNode * getNode(const ModelAction *);
private:
CycleNode * getNode(const ModelAction *);
+
+ /** @brief A table for mapping ModelActions to CycleNodes */
HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
+
bool checkReachable(CycleNode *from, CycleNode *to);
bool checkReachable(CycleNode *from, CycleNode *to);
+
+ /** @brief A flag: true if this graph contains cycles */
bool hasCycles;
};
bool hasCycles;
};
+/** @brief A node within a CycleGraph; corresponds to one ModelAction */
class CycleNode {
public:
CycleNode(const ModelAction *action);
class CycleNode {
public:
CycleNode(const ModelAction *action);
@@
-37,8
+43,14
@@
class CycleNode {
CycleNode* getRMW();
private:
CycleNode* getRMW();
private:
+ /** @brief The ModelAction that this node represents */
const ModelAction *action;
const ModelAction *action;
+
+ /** @brief The edges leading out from this node */
std::vector<CycleNode *> edges;
std::vector<CycleNode *> edges;
+
+ /** Pointer to a RMW node that reads from this node, or NULL, if none
+ * exists */
CycleNode * hasRMW;
};
CycleNode * hasRMW;
};