Add dyninstAPI/os.h

dyninst · Apr 3, 2024 · 41181b6 · 41181b6
1 parent bf8e9b7
commit 41181b6
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 8 deletions.
diff --git a/docs/dyninstAPI/developer/os.h.rst b/docs/dyninstAPI/developer/os.h.rst
@@ -3,3 +3,26 @@
 os.h
 ####
 
+This should enforce the abstract OS operations
+
+.. cpp:class:: OS
+
+  .. cpp:function:: static void osTraceMe(void)
+  .. cpp:function:: static void osDisconnect(void)
+  .. cpp:function:: static bool osKill(int)
+  .. cpp:function:: static void make_tempfile(char *)
+  .. cpp:function:: static bool execute_file(char *)
+  .. cpp:function:: static void unlink(char *)
+  .. cpp:function:: static bool executableExists(const std::string &file)
+  .. cpp:function:: static void get_sigaction_names(std::vector<std::string> &names)
+
+
+Temporary prototype for a remote debugging BPatch interface.
+
+.. cpp:namespace:: dev
+
+.. cpp:function:: bool OS_isConnected(void)
+.. cpp:function:: bool OS_connect(BPatch_remoteHost &remote)
+.. cpp:function:: bool OS_getPidList(BPatch_remoteHost &remote, BPatch_Vector<unsigned int> &tlist)
+.. cpp:function:: bool OS_getPidInfo(BPatch_remoteHost &remote, unsigned int pid, std::string &pidStr)
+.. cpp:function:: bool OS_disconnect(BPatch_remoteHost &remote)
diff --git a/dyninstAPI/src/os.h b/dyninstAPI/src/os.h
@@ -33,13 +33,6 @@
 #ifndef _OS_HDR
 #define _OS_HDR
 
-/*
- * This is an initial attempt at providing an OS abstraction for paradynd
- * I am doing this so I can compile paradynd on solaris
- *
- * This should enforce the abstract OS operations
- */ 
-
 #if defined(i386_unknown_nt4_0) 
 #include "dyninstAPI/src/pdwinnt.h"
 
@@ -66,7 +59,6 @@ class OS {
   static void get_sigaction_names(std::vector<std::string> &names);
 };
 
-// Temporary prototype for a remote debugging BPatch interface.
 #include "dyninstAPI/h/BPatch.h"
 bool OS_isConnected(void);
 bool OS_connect(BPatch_remoteHost &remote);