Add dataflowAPI/SymEval.C

dyninst · Apr 3, 2024 · 3e4081a · 3e4081a
1 parent f7448ca
commit 3e4081a
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 16 deletions.
diff --git a/dataflowAPI/src/SymEval.C b/dataflowAPI/src/SymEval.C
@@ -166,18 +166,11 @@ void dfs(Node::Ptr source,
     (*ssit).second--;
 }
 
-/*
- * Optimal ordering for visiting the slicing
- * nodes during expansion; this is possible to do
- * because we have removed loops
- */
 class ExpandOrder {
     public:
         ExpandOrder() { }
         ~ExpandOrder() { }
 
-        // remove an element from the next-lowest queue
-        // and return it and its order
         pair<SliceNode::Ptr,int> pop_next()
         {
             SliceNode::Ptr rn = SliceNode::Ptr();
@@ -196,8 +189,6 @@ class ExpandOrder {
             return make_pair(rn,ro);
         }
 
-        // removes a node from the structure
-        // returns true if the node was there
         bool remove(SliceNode::Ptr n) {
             map<SliceNode::Ptr, int>::iterator it = order_map.find(n);
             if(it != order_map.end()) {
@@ -208,8 +199,6 @@ class ExpandOrder {
             return false;
         }
 
-        // places a node in the structure -- its
-        // order is computed
         void insert(SliceNode::Ptr n, bool force_done = false) {
             // compute the order of this node --- the number of its parents
             // not on the skipedges list and not done
@@ -235,8 +224,6 @@ class ExpandOrder {
                 done.insert(n);
         }
 
-        // Mark a node complete, updating its children.
-        // Removes the node from the data structure
         void mark_done(SliceNode::Ptr n) {
             // First pull all of the children of this node
             // that are not on the skip list
@@ -285,7 +272,6 @@ class ExpandOrder {
         set<SliceNode::Ptr> done;
 };
 
-// implements < , <= causes failures when used to sort Windows vectors
 bool vectorSort(SliceNode::Ptr ptr1, SliceNode::Ptr ptr2) {
 
     AssignmentPtr assign1 = ptr1->assign();
@@ -306,8 +292,6 @@ bool vectorSort(SliceNode::Ptr ptr1, SliceNode::Ptr ptr2) {
     }
 }
 
-// Do the previous, but use a Graph as a guide for
-// performing forward substitution on the AST results
 SymEval::Retval_t SymEval::expand(Dyninst::Graph::Ptr slice, DataflowAPI::Result_t &res) {
     bool failedTranslation = false;
     bool skippedInput = false;

diff --git a/docs/dataflowAPI/developer/SymEval.h.rst b/docs/dataflowAPI/developer/SymEval.h.rst
@@ -230,3 +230,36 @@ SymEval.h
     .. cpp:enumerator:: extendMSBOp
 
       Extend the most significant bit operation
+
+
+.. cpp:class:: ExpandOrder
+
+  Optimal ordering for visiting the slicing nodes during expansion this is possible
+  to do because we have removed loops
+
+  .. cpp:function:: ExpandOrder()
+  .. cpp:function:: ~ExpandOrder()
+  .. cpp:function:: pair<SliceNode::Ptr, int> pop_next()
+
+    remove an element from the next-lowest queue and return it and its order
+
+  .. cpp:function:: bool remove(SliceNode::Ptr n)
+
+    removes a node from the structure returns true if the node was there
+
+  .. cpp:function:: void insert(SliceNode::Ptr n, bool force_done = false)
+
+    places a node in the structure -- its order is computed
+
+  .. cpp:function:: void mark_done(SliceNode::Ptr n)
+
+    Mark a node complete, updating its children. Removes the node from the data structure
+
+  .. cpp:function:: bool is_done(SliceNode::Ptr n) const
+  .. cpp:function:: set<Edge::Ptr> &skipEdges()
+
+
+.. cpp:struct:: ExpandOrder::order_queue
+
+  .. cpp:member:: int order
+  .. cpp:member:: set<SliceNode::Ptr> nodes