add macos support

.github/workflows/rust.yml

@@ -14,13 +14,24 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest, macOS-latest]
         rust: [stable, nightly]
     steps:
       - uses: actions/checkout@v2
       - uses: hecrj/setup-rust-action@v1
         with:
           rust-version: ${{ matrix.rust }}
+          components: 'rustfmt, clippy'
       - run: cargo build --verbose
       - name: Run tests
         run: cargo test --verbose -- --nocapture
+      - run: cargo clippy
+  check-formatting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: hecrj/setup-rust-action@v1
+        with:
+          rust-version: stable
+          components: 'rustfmt'
+      - run: cargo fmt -- --check

Cargo.toml

@@ -3,7 +3,10 @@ name = "simple-process-stats"
 description = "Get memory usage and CPU time on Linux and Windows"
 license = "MIT"
 version = "0.1.0"
+keywords = ["process", "cpu", "memory", "linux", "windows", "macos"]
+categories = ["api-bindings", "asynchronous", "os", "os:linux-apis", "os:macos-apis", "os:windows-apis"]
 repository = "https://github.com/robotty/simple-process-stats"
+readme = "README.md"
 authors = ["Ruben Anders <[email protected]>"]
 edition = "2018"
 
@@ -20,5 +23,9 @@ procfs = "0.8.0"
 libc = "0.2.72"
 tokio = { version = "0.2.21", features = ["fs"] }
 
+[target.'cfg(target_os = "macos")'.dependencies]
+darwin-libproc = "0.2.0"
+libc = "0.2.72"
+
 [dev-dependencies]
 tokio = { version = "0.2.21", features = ["rt-core", "macros"] }

README.md

@@ -1,8 +1,8 @@
 # simple-process-stats
 
-A small Rust library to get memory usage and elapsed CPU time.
+A small library to get memory usage and elapsed CPU time.
 
-* Supports Windows and Linux.
+* Supports Windows, Linux and macOS.
 * Async interface, uses `tokio::fs` for file operations
 
 ```rust
@@ -20,3 +20,5 @@ println!("{:?}", process_stats);
 On Linux, this library reads `/proc/self/stat` and uses the `sysconf` libc function.
 
 On Windows, the library uses `GetCurrentProcess` combined with `GetProcessTimes` and `K32GetProcessMemoryInfo`.
+
+On macOS, this library uses `proc_pidinfo` from `libproc` (and current process ID is determined via `libc`).

src/lib.rs

@@ -1,6 +1,9 @@
+#![deny(clippy::all)]
+#![deny(clippy::cargo)]
+
 //! A small library to get memory usage and elapsed CPU time.
 //!
-//! * Supports Windows and Linux.
+//! * Supports Windows, Linux and macOS.
 //! * Async interface, uses `tokio::fs` for file operations
 //!
 //! ```rust
@@ -21,9 +24,13 @@
 //! On Linux, this library reads `/proc/self/stat` and uses the `sysconf` libc function.
 //!
 //! On Windows, the library uses `GetCurrentProcess` combined with `GetProcessTimes` and `K32GetProcessMemoryInfo`.
+//!
+//! On macOS, this library uses `proc_pidinfo` from `libproc` (and current process ID is determined via `libc`).
 
 #[cfg(target_os = "linux")]
 mod linux;
+#[cfg(target_os = "macos")]
+mod macos;
 #[cfg(target_os = "windows")]
 mod windows;
 
@@ -54,6 +61,12 @@ impl ProcessStats {
     pub async fn get() -> Result<ProcessStats, Error> {
         linux::get_info().await
     }
+
+    /// Get the statistics using the OS-specific method.
+    #[cfg(target_os = "macos")]
+    pub async fn get() -> Result<ProcessStats, Error> {
+        macos::get_info()
+    }
 }
 
 /// An error that occurred while trying to get the process stats.

src/macos.rs

@@ -0,0 +1,34 @@
+use crate::{Error, ProcessStats};
+use std::time::Duration;
+
+pub fn get_info() -> Result<ProcessStats, Error> {
+    let pid = unsafe { libc::getpid() };
+    let proc_info = darwin_libproc::task_info(pid).map_err(Error::SystemCall)?;
+
+    Ok(ProcessStats {
+        memory_usage_bytes: proc_info.pti_resident_size,
+        cpu_time_user: Duration::from_nanos(proc_info.pti_total_user),
+        cpu_time_kernel: Duration::from_nanos(proc_info.pti_total_system),
+    })
+}
+
+#[cfg(test)]
+pub mod tests {
+    use crate::macos;
+
+    #[test]
+    pub fn test_no_error() {
+        #[no_mangle]
+        fn spin_for_a_bit() {
+            let mut _a = 0;
+            for _i in 0..9999999 {
+                _a += 1;
+            }
+        }
+
+        // to get some nonzero number for cpu_time_user
+        spin_for_a_bit();
+
+        dbg!(macos::get_info().unwrap());
+    }
+}