Update parseAPI/h/InstructionAdapter.h

dyninst · Apr 3, 2024 · b57352a · b57352a
1 parent 27811a8
commit b57352a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/docs/parseAPI/public/InstructionAdapter.h.rst b/docs/parseAPI/public/InstructionAdapter.h.rst
@@ -30,6 +30,8 @@ InstructionAdapter.h
   .. cpp:function:: void reset(Address start, ParseAPI::CodeObject *o, ParseAPI::CodeRegion *r,\
                                InstructionSource *isrc, ParseAPI::Block *)
 
+    Reset to just-constructed state
+
   .. cpp:function:: virtual const InstructionAPI::Instruction& getInstruction() const = 0
   .. cpp:function:: virtual bool hasCFT() const = 0
   .. cpp:function:: virtual size_t getSize() const = 0
@@ -38,6 +40,8 @@ InstructionAdapter.h
   .. cpp:function:: virtual bool isAbort() const = 0
   .. cpp:function:: virtual bool isGarbageInsn() const = 0
 
+    True for insns indicative of bad parse, for defensive mode
+
   .. cpp:function:: virtual void getNewEdges(std::vector<std::pair<Address,ParseAPI::EdgeTypeEnum>>& outEdges,\
                                              ParseAPI::Function* context, ParseAPI::Block* currBlk,unsigned int num_insns,\
                                              dyn_hash_map<Address, std::string> *pltFuncs, const std::set<Address> &) const = 0
@@ -70,6 +74,9 @@ InstructionAdapter.h
   .. cpp:function:: virtual bool isInterruptOrSyscall() const = 0
   .. cpp:function:: virtual bool isCall() const = 0
   .. cpp:function:: virtual bool isReturnAddrSave(Address &ret_addr) const = 0
+
+    Ret_addr holds the return address pushed in the stack using mflr at function entry.
+
   .. cpp:function:: virtual bool isTailCall(const ParseAPI::Function *, ParseAPI::EdgeTypeEnum type, unsigned int num_insns,\
                                             const std::set<Address> &) const = 0
 
diff --git a/parseAPI/h/InstructionAdapter.h b/parseAPI/h/InstructionAdapter.h
@@ -65,18 +65,16 @@ class InstructionAdapter
         virtual ~InstructionAdapter() = default;
 	InstructionAdapter(const InstructionAdapter&) = default;
 
-    // Reset to just-constructed state
     void reset(Address start, ParseAPI::CodeObject *o,
         ParseAPI::CodeRegion *r, InstructionSource *isrc, ParseAPI::Block *);
 
-    // Implemented
     virtual const InstructionAPI::Instruction& getInstruction() const = 0;
     virtual bool hasCFT() const = 0;
     virtual size_t getSize() const = 0;
     virtual bool isFrameSetupInsn() const = 0;
     virtual bool isInvalidInsn() const = 0;
     virtual bool isAbort() const = 0;
-    virtual bool isGarbageInsn() const = 0; //true for insns indicative of bad parse, for defensive mode
+    virtual bool isGarbageInsn() const = 0;
     virtual void
             getNewEdges(std::vector<std::pair<Address,ParseAPI::EdgeTypeEnum> >&
             outEdges, 
@@ -111,7 +109,7 @@ const;
     virtual bool isBranch() const = 0;
     virtual bool isInterruptOrSyscall() const = 0;
     virtual bool isCall() const = 0;
-    virtual bool isReturnAddrSave(Address &ret_addr) const = 0; // ret_addr holds the return address pushed in the stack using mflr at function entry 
+    virtual bool isReturnAddrSave(Address &ret_addr) const = 0;
     virtual bool isTailCall(const ParseAPI::Function *, ParseAPI::EdgeTypeEnum type, unsigned int num_insns,
                             const std::set<Address> &) const = 0;
     protected: