Add patchAPI/src/PatchFunction.C

dyninst · Apr 3, 2024 · d4f3857 · d4f3857
1 parent f05b5ff
commit d4f3857
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/docs/patchAPI/developer/PatchCFG.h.rst b/docs/patchAPI/developer/PatchCFG.h.rst
@@ -38,14 +38,23 @@ PatchCFG.h
   .. cpp:function:: protected void removeBlock(PatchBlock *)
   .. cpp:function:: protected void addBlock(PatchBlock *)
   .. cpp:function:: protected void splitBlock(PatchBlock *first, PatchBlock *second)
+
+    The "first" block should already be in the function.
+
   .. cpp:function:: protected void destroyPoints()
 
     Destroy points for this block and then each containing function's context specific points for the
     block.
 
   .. cpp:function:: protected void destroyBlockPoints(PatchBlock *block)
+
+    Removes block points from ``points_`` and ``blockPoints_``.
+
   .. cpp:function:: protected void invalidateBlocks()
   .. cpp:function:: protected void getLoopsByNestingLevel(vector<PatchLoop*>& lbb, bool outerMostOnly)
+
+    Returns the loop objects that exist in the control flow graph.
+
   .. cpp:function:: protected void createLoops()
   .. cpp:function:: protected void createLoopHierarchy()
   .. cpp:function:: protected void fillDominatorInfo()

diff --git a/patchAPI/src/PatchFunction.C b/patchAPI/src/PatchFunction.C
@@ -332,7 +332,6 @@ bool PatchFunction::findInsnPoints(Point::Type type,
       return false;
 }
 
-// remove block points from points_ and blockPoints_
 void PatchFunction::destroyBlockPoints(PatchBlock *block)
 {
     PatchCallback *cb = obj()->cb();
@@ -519,7 +518,6 @@ PatchCallback *PatchFunction::cb() const {
    return obj_->cb();
 }
 
-// the "first" block should already be in the function
 void PatchFunction::splitBlock(PatchBlock *first, PatchBlock *second)
 {
    // 1) add second block to the function
@@ -818,9 +816,6 @@ PatchLoopTreeNode* PatchFunction::getLoopTree() {
   return _loop_root;
 }
 
-// this methods returns the loop objects that exist in the control flow
-// grap. It returns a set. And if there are no loops, then it returns the empty
-// set. not NULL.
 void PatchFunction::getLoopsByNestingLevel(vector<PatchLoop*>& lbb, bool outerMostOnly)
 {
   if (_loop_analyzed == false) {
@@ -839,15 +834,12 @@ void PatchFunction::getLoopsByNestingLevel(vector<PatchLoop*>& lbb, bool outerMo
   return;
 }
 
-
-// get all the loops in this flow graph
 bool PatchFunction::getLoops(vector<PatchLoop*>& lbb)
 {
   getLoopsByNestingLevel(lbb, false);
   return true;
 }
 
-// get the outermost loops in this flow graph
 bool PatchFunction::getOuterLoops(vector<PatchLoop*>& lbb)
 {
   getLoopsByNestingLevel(lbb, true);