Add support for proc_listpidspath() call added in 10.5

Author: andrewdavidmackenzie

Cargo.toml

@@ -17,6 +17,11 @@ libc = "^0.2.62"
 name = "libproc"
 path = "src/lib.rs"
 
+[features]
+default = ["macosx_10_5", "macosx_10_7"]
+macosx_10_5 = []
+macosx_10_7 = ["macosx_10_5"]
+
 [[bin]]
 name = "procinfo"
 path = "src/procinfo.rs"

README.md

@@ -75,7 +75,25 @@ pub fn kmsgbuf() -> Result<String, String>
 - `dmesg` is a version of dmesg implemented in rust that uses libproc-rs.
 
 # Platforms
-Mac OS X and work started on Linux.
+Mac OS X and Linux.
+
+## Mac OS X Versions
+Calls were aded to libproc in Mac OS X 10.5 and again in 10.7. 
+This library can be compiled to not include those calls by using rust `features`
+to enable/disable support for those versions.
+
+The default build for Mac OS 10.7 or later includes both.
+See 
+```toml
+[features]
+default = ["macosx_10_5", "macosx_10_7"]
+``` 
+in `Cargo.toml`
+
+To build for versions prior to Mac OS 10.5 disable the default features by passing `--no-default-features` to `cargo`.
+
+To build for Mac OS X 10.5 (or 10.6) you can enable that feature alone using
+`--no-default-features --features "macosx_10_5"` 
 
 # Build and Test
 `cargo test` should build and test as usual for rust projects.

src/libproc/proc_pid.rs

@@ -28,7 +28,7 @@ use crate::libproc::work_queue_info::WorkQueueInfo;
 #[cfg(target_os = "linux")]
 use self::libc::{c_char, readlink};
 #[cfg(target_os = "macos")]
-use self::libc::{c_int, c_void};
+use self::libc::{c_int, c_void, c_char};
 
 // Since we cannot access C macros for constants from Rust - I have had to redefine this, based on Apple's source code
 // See http://opensource.apple.com/source/Libc/Libc-594.9.4/darwin/libproc.c
@@ -137,19 +137,28 @@ impl ListPIDInfo for ListThreads {
 extern {
     fn proc_listpids(proc_type: u32, typeinfo: u32, buffer: *mut c_void, buffersize: u32) -> c_int;
 
-    fn proc_pidinfo(pid: c_int, flavor: c_int, arg: u64, buffer: *mut c_void, buffersize: c_int) -> c_int;
-
     fn proc_name(pid: c_int, buffer: *mut c_void, buffersize: u32) -> c_int;
 
+    fn proc_pidpath(pid: c_int, buffer: *mut c_void, buffersize: u32) -> c_int;
+
+    fn proc_listpidspath(proc_type: u32, typeinfo: u32,
+                         path: * const c_char, pathflags: u32,
+                         buffer: *mut c_void, buffersize: u32) -> c_int;
+
     fn proc_regionfilename(pid: c_int, address: u64, buffer: *mut c_void, buffersize: u32) -> c_int;
 
-    fn proc_pidpath(pid: c_int, buffer: *mut c_void, buffersize: u32) -> c_int;
+    fn proc_pidinfo(pid: c_int, flavor: c_int, arg: u64, buffer: *mut c_void, buffersize: c_int) -> c_int;
 
     fn proc_libversion(major: *mut c_int, minor: *mut c_int) -> c_int;
 }
 
+//int proc_listallpids(void * buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_1);
+//int proc_listpgrppids(pid_t pgrpid, void * buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_1);
+//int proc_listchildpids(pid_t ppid, void * buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_1);
+//int proc_pidfileportinfo(int pid, uint32_t fileport, int flavor, void *buffer, int buffersize) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
+
 
-/// Returns the PIDs of the processes active that match the ProcType passed in
+/// Returns the PIDs of the active processes that match the ProcType passed in
 ///
 /// # Examples
 ///
@@ -214,6 +223,53 @@ pub fn listpids(proc_types: ProcType) -> Result<Vec<u32>, String> {
     }
 }
 
+// proc_listpidspath
+// Search through the current processes looking for open file references which match
+// a specified path or volume.
+//
+//       @param type types of processes to be searched (see proc_listpids)
+//       @param typeinfo adjunct information for type
+//       @param path file or volume path
+//       @param pathflags flags to control which files should be considered
+//               during the process search.
+//       @param buffer a C array of int-sized values to be filled with
+//               process identifiers that hold an open file reference
+//               matching the specified path or volume.  Pass NULL to
+//               obtain the minimum buffer size needed to hold the
+//               currently active processes.
+//       @param buffersize the size (in bytes) of the provided buffer.
+//       @result the number of bytes of data returned in the provided buffer;
+//               -1 if an error was encountered;
+#[cfg(target_os = "macos")]
+#[cfg(feature = "macosx_10_5")]
+pub fn listpidspath(proc_types: ProcType, path: String) -> Result<Vec<u32>, String> {
+    let buffer_size = unsafe {
+        proc_listpidspath(proc_types as u32, 0, path.as_ptr() as * const c_char, 0, ptr::null_mut(), 0)
+    };
+    if buffer_size <= 0 {
+        return Err(helpers::get_errno_with_message(buffer_size));
+    }
+
+    let capacity = buffer_size as usize / mem::size_of::<u32>();
+    let mut pids: Vec<u32> = Vec::with_capacity(capacity);
+    let buffer_ptr = pids.as_mut_ptr() as *mut c_void;
+
+    let ret = unsafe {
+        proc_listpidspath(proc_types as u32, 0, path.as_ptr() as * const c_char, 0, buffer_ptr, buffer_size as u32)
+    };
+
+    if ret <= 0 {
+        Err(helpers::get_errno_with_message(ret))
+    } else {
+        let items_count = ret as usize / mem::size_of::<u32>() - 1;
+        unsafe {
+            pids.set_len(items_count);
+        }
+
+        Ok(pids)
+    }
+}
+
 /// Get info about a process
 ///
 /// arg - is "heavily not documented" and need to look at code for each flavour
@@ -621,9 +677,8 @@ mod test {
 
     #[test]
     fn listpids_test() {
-        if let Ok(pids) = listpids(ProcType::ProcAllPIDS) {
-            assert!(pids.len() > 1);
-        }
+        let pids = listpids(ProcType::ProcAllPIDS).unwrap();
+        assert!(pids.len() > 1);
     }
 
     #[test]
@@ -699,4 +754,12 @@ mod test {
             assert!(procfile_field("/proc/1/status", "invalid").is_err());
         }
     }
+
+    #[test]
+    #[cfg(target_os = "macos")]
+    #[cfg(feature = "macosx_10_5")]
+    fn listpidspath_test() {
+        let pids = super::listpidspath(ProcType::ProcAllPIDS, "/".into()).unwrap();
+        assert!(pids.len() > 1);
+    }
 }