proccontrol init

dyninst · Apr 3, 2024 · 4955f7b · 4955f7b
1 parent 5dcbf0e
commit 4955f7b
Show file tree

Hide file tree

Showing 43 changed files with 4,021 additions and 1 deletion.
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,6 +20,9 @@ to more effectively use different aspects of binary analysis for building their
   A C-like language for enabling rapid creation of Dyninst mutators without the need to specify API-level
   interactions.
 
+:ref:`sec:proccontrolapi-intro`
+   An API and library for controlling processes
+
 .. _main-support:
 
 -------
@@ -66,7 +69,8 @@ Developed by
    :name: toolkit-overviews
    :hidden:
    :maxdepth: 3
-
+
+   proccontrol/overview
    usertools/DynC/overview
 
 .. toctree::
@@ -82,6 +86,22 @@ Developed by
    examples/memory_access
    examples/retee
 
+.. toctree::
+   :caption: toolkit api docs
+   :name: apis
+   :hidden:
+   :maxdepth: 2
+
+   proccontrol/public/API
+
+.. toctree::
+   :caption: developer docs
+   :name: dev-docs
+   :hidden:
+   :maxdepth: 3
+
+   proccontrol/developer/API
+
 .. toctree::
    :caption: advanced
    :name: advanced

diff --git a/docs/proccontrol/developer/API.rst b/docs/proccontrol/developer/API.rst
@@ -0,0 +1,39 @@
+==============
+ProcControlAPI
+==============
+
+Documentation for the internal classes of the ProccontrolAPI toolkit.
+
+.. toctree::
+   :caption: Developer API
+   :name: proccontrol-developer-api
+   :hidden:
+   :maxdepth: 3
+
+   arm_process.h
+   DecoderWindows.h
+   freebsd.h
+   GeneratorWindows.h
+   int_event.h
+   int_handler.h
+   int_process.h
+   int_thread_db.h
+   irpc.h
+   linux.h
+   memcache.h
+   mmapalloc.h
+   notify_pipe.h
+   ppc_process.h
+   processplat.h
+   procpool.h
+   proc_service_wrapper.h
+   resp.h
+   response.h
+   snippets.h
+   sysv.h
+   unix.h
+   windows_handler.h
+   windows_process.h
+   windows_thread.h
+   x86_process.h
+   loadLibrary/API.rst
diff --git a/docs/proccontrol/developer/DecoderWindows.h.rst b/docs/proccontrol/developer/DecoderWindows.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:DecoderWindows.h`:
+
+DecoderWindows.h
+================
+
diff --git a/docs/proccontrol/developer/GeneratorWindows.h.rst b/docs/proccontrol/developer/GeneratorWindows.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:GeneratorWindows.h`:
+
+GeneratorWindows.h
+==================
+
diff --git a/docs/proccontrol/developer/arm_process.h.rst b/docs/proccontrol/developer/arm_process.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:arm_process.h`:
+
+arm_process.h
+=============
+
diff --git a/docs/proccontrol/developer/freebsd.h.rst b/docs/proccontrol/developer/freebsd.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:freebsd.h`:
+
+freebsd.h
+=========
+
diff --git a/docs/proccontrol/developer/int_event.h.rst b/docs/proccontrol/developer/int_event.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:int_event.h`:
+
+int_event.h
+===========
+
diff --git a/docs/proccontrol/developer/int_handler.h.rst b/docs/proccontrol/developer/int_handler.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:int_handler.h`:
+
+int_handler.h
+=============
+
diff --git a/docs/proccontrol/developer/int_process.h.rst b/docs/proccontrol/developer/int_process.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:int_process.h`:
+
+int_process.h
+=============
+
diff --git a/docs/proccontrol/developer/int_thread_db.h.rst b/docs/proccontrol/developer/int_thread_db.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:int_thread_db.h`:
+
+int_thread_db.h
+===============
+
diff --git a/docs/proccontrol/developer/irpc.h.rst b/docs/proccontrol/developer/irpc.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:irpc.h`:
+
+irpc.h
+======
+
diff --git a/docs/proccontrol/developer/linux.h.rst b/docs/proccontrol/developer/linux.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:linux.h`:
+
+linux.h
+=======
+
diff --git a/docs/proccontrol/developer/loadLibrary/API.rst b/docs/proccontrol/developer/loadLibrary/API.rst
@@ -0,0 +1,14 @@
+===========
+loadLibrary
+===========
+
+Documentation for the internal classes of the ProccontrolAPI toolkit.
+
+.. toctree::
+   :caption: Developer API
+   :name: proccontrol-loadlibrary-dev-api
+   :hidden:
+   :maxdepth: 1
+
+   codegen.h
+   injector.h
diff --git a/docs/proccontrol/developer/loadLibrary/codegen.h.rst b/docs/proccontrol/developer/loadLibrary/codegen.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:codegen.h`:
+
+codegen.h
+=========
+
diff --git a/docs/proccontrol/developer/loadLibrary/injector.h.rst b/docs/proccontrol/developer/loadLibrary/injector.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:injector.h`:
+
+injector.h
+==========
+
diff --git a/docs/proccontrol/developer/memcache.h.rst b/docs/proccontrol/developer/memcache.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:memcache.h`:
+
+memcache.h
+==========
+
diff --git a/docs/proccontrol/developer/mmapalloc.h.rst b/docs/proccontrol/developer/mmapalloc.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:mmapalloc.h`:
+
+mmapalloc.h
+===========
+
diff --git a/docs/proccontrol/developer/notify_pipe.h.rst b/docs/proccontrol/developer/notify_pipe.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:notify_pipe.h`:
+
+notify_pipe.h
+=============
+
diff --git a/docs/proccontrol/developer/ppc_process.h.rst b/docs/proccontrol/developer/ppc_process.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:ppc_process.h`:
+
+ppc_process.h
+=============
+
diff --git a/docs/proccontrol/developer/proc_service_wrapper.h.rst b/docs/proccontrol/developer/proc_service_wrapper.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:proc_service_wrapper.h`:
+
+proc_service_wrapper.h
+======================
+
diff --git a/docs/proccontrol/developer/processplat.h.rst b/docs/proccontrol/developer/processplat.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:processplat.h`:
+
+processplat.h
+=============
+
diff --git a/docs/proccontrol/developer/procpool.h.rst b/docs/proccontrol/developer/procpool.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:procpool.h`:
+
+procpool.h
+==========
+
diff --git a/docs/proccontrol/developer/resp.h.rst b/docs/proccontrol/developer/resp.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:resp.h`:
+
+resp.h
+======
+
diff --git a/docs/proccontrol/developer/response.h.rst b/docs/proccontrol/developer/response.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:response.h`:
+
+response.h
+==========
+
diff --git a/docs/proccontrol/developer/snippets.h.rst b/docs/proccontrol/developer/snippets.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:snippets.h`:
+
+snippets.h
+==========
+
diff --git a/docs/proccontrol/developer/sysv.h.rst b/docs/proccontrol/developer/sysv.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:sysv.h`:
+
+sysv.h
+======
+
diff --git a/docs/proccontrol/developer/unix.h.rst b/docs/proccontrol/developer/unix.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:unix.h`:
+
+unix.h
+======
+
diff --git a/docs/proccontrol/developer/windows_handler.h.rst b/docs/proccontrol/developer/windows_handler.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:windows_handler.h`:
+
+windows_handler.h
+=================
+
diff --git a/docs/proccontrol/developer/windows_process.h.rst b/docs/proccontrol/developer/windows_process.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:windows_process.h`:
+
+windows_process.h
+=================
+
diff --git a/docs/proccontrol/developer/windows_thread.h.rst b/docs/proccontrol/developer/windows_thread.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:windows_thread.h`:
+
+windows_thread.h
+================
+
diff --git a/docs/proccontrol/developer/x86_process.h.rst b/docs/proccontrol/developer/x86_process.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:x86_process.h`:
+
+x86_process.h
+=============
+