Add dyninstAPI/DynCommon.h

dyninst · Apr 3, 2024 · b62284b · b62284b
1 parent ca66f69
commit b62284b
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 5 deletions.
diff --git a/docs/dyninstAPI/developer/Relocation/DynInstrumenter.h.rst b/docs/dyninstAPI/developer/Relocation/DynInstrumenter.h.rst
@@ -4,3 +4,74 @@ DynInstrumenter.h
 #################
 
 .. cpp:namespace:: Dyninst::Relocation
+
+.. cpp:class:: DynInstrumenter : public Dyninst::PatchAPI::Instrumenter
+
+  .. cpp:function:: DynInstrumenter()
+  .. cpp:function:: virtual ~DynInstrumenter()
+  .. cpp:function:: virtual bool run()
+  .. cpp:function:: virtual bool undo()
+  .. cpp:function:: virtual bool isInstrumentable(PatchFunction*)
+
+.. cpp:class:: DynInsertSnipCommand : public Command
+
+  Dyninst-specific Insert Snippet Command
+
+  .. cpp:function:: DynInsertSnipCommand(instPoint* pt, callOrder order, AstNodePtr ast, bool recursive)
+  .. cpp:function:: static DynInsertSnipCommand* create(instPoint* pt, callOrder order, AstNodePtr ast, bool recursive)
+  .. cpp:function:: virtual ~DynInsertSnipCommand()
+  .. cpp:function:: Instance::Ptr inst()
+  .. cpp:function:: virtual bool run()
+  .. cpp:function:: virtual bool undo()
+  .. cpp:member:: protected Instance::Ptr inst_
+
+.. cpp:class:: DynRemoveSnipCommand : public Command
+
+  Dyninst-specific Remove Snippet Command
+
+  .. cpp:function:: DynRemoveSnipCommand(Instance::Ptr inst)
+  .. cpp:function:: static DynRemoveSnipCommand* create(Instance::Ptr inst)
+  .. cpp:function:: virtual ~DynRemoveSnipCommand()
+  .. cpp:function:: virtual bool run()
+  .. cpp:function:: virtual bool undo()
+  .. cpp:member:: protected Instance::Ptr inst_
+
+.. cpp:class:: DynReplaceFuncCommand : public Command
+
+  Dyninst-specific Function Replacement
+
+  .. cpp:function:: DynReplaceFuncCommand(AddressSpace* as, func_instance* old_func, func_instance* new_func)
+  .. cpp:function:: static DynReplaceFuncCommand* create(AddressSpace* as, func_instance* old_func, func_instance* new_func)
+  .. cpp:function:: virtual ~DynReplaceFuncCommand()
+  .. cpp:function:: virtual bool run()
+  .. cpp:function:: virtual bool undo()
+  .. cpp:member:: protected AddressSpace* as_
+  .. cpp:member:: protected func_instance *old_func_
+  .. cpp:member:: protected func_instance *new_func_
+
+.. cpp:class:: DynModifyCallCommand : public Command
+
+  Dyninst-specific Modify Function call
+
+  .. cpp:function:: DynModifyCallCommand(AddressSpace* as, block_instance* block, func_instance* new_func, func_instance* context)
+  .. cpp:function:: static DynModifyCallCommand* create(AddressSpace* as, block_instance* block, func_instance* new_func, func_instance* context)
+  .. cpp:function:: virtual ~DynModifyCallCommand()
+  .. cpp:function:: virtual bool run()
+  .. cpp:function:: virtual bool undo()
+  .. cpp:member:: protected AddressSpace* as_
+  .. cpp:member:: protected block_instance *block_
+  .. cpp:member:: protected func_instance *new_func_
+  .. cpp:member:: protected func_instance *context_
+
+.. cpp:class:: DynRemoveCallCommand : public Command
+
+  Dyninst-specific Remove Function call
+
+  .. cpp:function:: DynRemoveCallCommand(AddressSpace* as, block_instance* block, func_instance* context)
+  .. cpp:function:: static DynRemoveCallCommand* create(AddressSpace* as, block_instance* block, func_instance* context)
+  .. cpp:function:: virtual ~DynRemoveCallCommand()
+  .. cpp:function:: virtual bool run()
+  .. cpp:function:: virtual bool undo()
+  .. cpp:member:: protected AddressSpace* as_
+  .. cpp:member:: protected block_instance *block_
+  .. cpp:member:: protected func_instance *context_
diff --git a/dyninstAPI/src/Relocation/DynInstrumenter.h b/dyninstAPI/src/Relocation/DynInstrumenter.h
@@ -56,7 +56,6 @@ class DynInstrumenter : public Dyninst::PatchAPI::Instrumenter {
 
 };
 
-/* Dyninst-specific Insert Snippet Command  */
 class DynInsertSnipCommand : public Command {
   public:
     DynInsertSnipCommand(instPoint* pt, callOrder order,
@@ -74,7 +73,6 @@ class DynInsertSnipCommand : public Command {
     Instance::Ptr inst_;
 };
 
-/* Dyninst-specific Remove Snippet Command  */
 class DynRemoveSnipCommand : public Command {
   public:
       DynRemoveSnipCommand(Instance::Ptr inst);
@@ -88,7 +86,6 @@ class DynRemoveSnipCommand : public Command {
     Instance::Ptr inst_;
 };
 
-/* Dyninst-specific Function Replacement */
 class DynReplaceFuncCommand : public Command {
   public:
     DynReplaceFuncCommand(AddressSpace* as,
@@ -108,7 +105,6 @@ class DynReplaceFuncCommand : public Command {
     func_instance *new_func_;
 };
 
-/* Dyninst-specific Modify Function call */
 class DynModifyCallCommand : public Command {
   public:
     DynModifyCallCommand(AddressSpace* as,
@@ -131,7 +127,6 @@ class DynModifyCallCommand : public Command {
     func_instance *context_;
 };
 
-/* Dyninst-specific Remove Function call */
 class DynRemoveCallCommand : public Command {
   public:
     DynRemoveCallCommand(AddressSpace* as,