Add patchAPI/PatchCommon.h

dyninst · Apr 3, 2024 · bb2cdef · bb2cdef
1 parent 5e5e0d8
commit bb2cdef
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 30 deletions.
diff --git a/docs/patchAPI/developer/API.rst b/docs/patchAPI/developer/API.rst
@@ -10,4 +10,5 @@ PatchAPI
 
   AddrSpace.h
   ParseCallback.h
-  PatchCFG.h
+  PatchCFG.h
+  PatchCommon.h
diff --git a/docs/patchAPI/developer/PatchCommon.h.rst b/docs/patchAPI/developer/PatchCommon.h.rst
@@ -0,0 +1,41 @@
+.. _`sec:PatchCommon.h`:
+
+PatchCommon.h
+#############
+
+.. cpp:namespace:: Dyninst::PatchAPI
+
+.. cpp:type:: std::set<Point*> PointSet
+.. cpp:type:: PointSet::iterator PointIter
+.. cpp:type:: boost::shared_ptr<Instance> InstancePtr
+.. cpp:type:: std::set<InstancePtr> InstanceSet
+.. cpp:type:: std::list<InstancePtr> InstanceList
+.. cpp:type:: boost::shared_ptr<PatchMgr> PatchMgrPtr
+.. cpp:type:: boost::shared_ptr<Snippet> SnippetPtr
+.. cpp:type:: std::map<PatchFunction*, PatchFunction*> FuncModMap
+
+  Maps a PatchFunction to another PatchFunction.
+
+.. cpp:type:: std::map<PatchFunction*, std::pair<PatchFunction*, std::string> > FuncWrapMap
+
+.. cpp:type:: std::map<PatchBlock*, std::map<PatchFunction*, PatchFunction*> > CallModMap
+
+  | This is a little complex, so let me explain my logic.
+  |
+  | Map from B -> F_c -> F
+  |
+  |   B identifies a call site
+  |
+  |   F_c identifies an (optional) function context for the replacement
+  |     If F_c is not specified, we use NULL
+  |
+  |   F specifies the replacement callee
+  |     If we want to remove the call entirely, also use NULL
+
+.. cpp:type:: std::set<ParseAPI::CodeObject*> CodeObjectSet
+
+.. cpp:type:: std::set<ParseAPI::CodeSource*> CodeSourceSet
+
+.. c:macro:: patchapi_debug
+
+  Set ``DYNINST_DEBUG_PATCHAPI`` in your environment to enable.
diff --git a/docs/patchAPI/public/API.rst b/docs/patchAPI/public/API.rst
@@ -14,9 +14,8 @@ PatchAPI
   Instrumenter.h
   PatchCallback.h
   PatchCFG.h
-  PatchCommon.h
   PatchMgr.h
   PatchModifier.h
   PatchObject.h
   Point.h
-  Snippet.h
+  Snippet.h
diff --git a/docs/patchAPI/public/PatchCommon.h.rst b/docs/patchAPI/public/PatchCommon.h.rst
diff --git a/patchAPI/h/PatchCommon.h b/patchAPI/h/PatchCommon.h
@@ -30,7 +30,6 @@
 #ifndef PATCHAPI_H_COMMON_H_
 #define PATCHAPI_H_COMMON_H_
 
-// C++
 #include <string>
 #include <string.h>
 #include <utility>
@@ -87,13 +86,6 @@ typedef boost::shared_ptr<Snippet> SnippetPtr;
 typedef std::map<PatchFunction*, PatchFunction*> FuncModMap;
 typedef std::map<PatchFunction*, std::pair<PatchFunction*, std::string> > FuncWrapMap;
 
-// This is a little complex, so let me explain my logic
-// Map from B -> F_c -> F
-// B identifies a call site
-// F_c identifies an (optional) function context for the replacement
-//   ... if F_c is not specified, we use NULL
-// F specifies the replacement callee; if we want to remove the call entirely,
-// also use NULL
 typedef std::map<PatchBlock*, std::map<PatchFunction*, PatchFunction*> > CallModMap;
 
 typedef std::set<ParseAPI::CodeObject*> CodeObjectSet;