Add proccontrol/codegen.h

dyninst · Apr 3, 2024 · 8d4cf6c · 8d4cf6c
1 parent 3955ed0
commit 8d4cf6c
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 7 deletions.
diff --git a/docs/proccontrol/developer/API.rst b/docs/proccontrol/developer/API.rst
@@ -10,6 +10,7 @@ Documentation for the internal classes of the ProccontrolAPI toolkit.
    :hidden:
    :maxdepth: 3
 
+   loadLibrary/API
    arm_process.h
    DecoderWindows.h
    Event.h
@@ -43,4 +44,3 @@ Documentation for the internal classes of the ProccontrolAPI toolkit.
    windows_process.h
    windows_thread.h
    x86_process.h
-   loadLibrary/API.rst
diff --git a/docs/proccontrol/developer/loadLibrary/codegen.h.rst b/docs/proccontrol/developer/loadLibrary/codegen.h.rst
@@ -1,5 +1,25 @@
 .. _`sec:codegen.h`:
 
 codegen.h
-=========
+#########
 
+.. cpp:namespace:: Dyninst::ProcControlAPI
+
+.. cpp:class:: Codegen
+
+  .. cpp:function:: Codegen(ProcControlAPI::Process *proc, std::string libname)
+  .. cpp:function:: bool generate()
+  .. cpp:function:: const Buffer &buffer()
+  .. cpp:function:: unsigned startOffset() const
+
+  .. cpp:function:: private Address buildLinuxArgStruct(Address libbase, unsigned mode)
+
+      Only available when ``os_linux`` is defined.
+
+  .. cpp:function:: private bool generateStackUnprotect(Address var, Address mprotect)
+
+      Only available when ``os_linux`` is defined.
+
+  .. cpp:member:: private std::map<Address, Address> toc_
+
+      PPC64 only, but it's handy to stash it here
diff --git a/proccontrol/src/loadLibrary/codegen.h b/proccontrol/src/loadLibrary/codegen.h
@@ -1,8 +1,3 @@
-// Codegen.h
-//
-// Interface class for generating a dlopen() call
-//
-
 #if !defined(_INJECTOR_CODEGEN_H_)
 #define _INJECTOR_CODEGEN_H_