Add common/freebsdKludges.C

dyninst · Apr 3, 2024 · b5b66ad · b5b66ad
1 parent c63a77d
commit b5b66ad
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 12 deletions.
diff --git a/common/src/freebsdKludges.C b/common/src/freebsdKludges.C
@@ -45,18 +45,8 @@ using std::map;
 std::string P_cplus_demangle( const std::string &symbol, bool includeTypes )
 {
     return symbol_demangle_with_cache(symbol, includeTypes);
-} /* end P_cplus_demangle() */
-
-// Process Information Queries //
-// No procfs mounted by default -- need to rely on sysctl //
+}
 
-/*
- * Gets the full path of the executable for the specified process
- *
- * pid  The pid for the process
- *
- * Returns the full path (caller is responsible for free'ing)
- */
 char *sysctl_getExecPathname(pid_t pid) {
     int mib[4];
     mib[0] = CTL_KERN;
@@ -215,7 +205,6 @@ lwpid_t sysctl_getInitialLWP(pid_t pid) {
     return ret;
 }
 
-// returns true if the process is running
 bool sysctl_getRunningStates(pid_t pid, map<Dyninst::LWP, bool> &runningStates) {
     size_t length;
     struct kinfo_proc *procInfo = getProcInfo(pid, length, true);

diff --git a/docs/common/developer/freebsdKludges.h.rst b/docs/common/developer/freebsdKludges.h.rst
@@ -5,11 +5,23 @@ freebsdKludges.h
 
 .. cpp:namespace:: freebsd
 
+**Process Information Queries**
+
+No procfs mounted by default -- need to rely on sysctl
+
 .. cpp:function:: int sysctl_computeAddrWidth(pid_t pid)
 .. cpp:function:: char *sysctl_getExecPathname(pid_t pid)
+
+  Gets the full path of the executable for the specified process
+  ``pid``  The pid for the process
+  Returns the full path (caller is responsible for freeing)
+
 .. cpp:function:: bool sysctl_findProcLWPs(pid_t pid, std::vector<pid_t> &lwps)
 .. cpp:function:: lwpid_t sysctl_getInitialLWP(pid_t pid)
 .. cpp:function:: bool sysctl_getRunningStates(pid_t pid, std::map<Dyninst::LWP, bool> &runningStates)
+
+  returns true if the process is running
+
 .. cpp:function:: map_entries *getVMMaps(int pid, unsigned &maps_size)
 .. cpp:function:: bool PtraceBulkRead(Dyninst::Address inTraced, unsigned size, void *inSelf, int pid)
 .. cpp:function:: bool PtraceBulkWrite(Dyninst::Address inTraced, unsigned size, const void *inSelf, int pid)