This is a library for getting information about running processes for Mac OS X and Linux.
Add it to your project's Cargo.toml
:
libproc = "0.14.4"
And then use it in your code:
use libproc::libproc::proc_pid;
match proc_pid::pidpath(pid) {
Ok(path) => println!("PID {}: has path {}", pid, path),
Err(err) => writeln!(&mut std::io::stderr(), "Error: {}", err).unwrap()
}
You can find the latest published release on crates.io
You can find the browseable docs for the latest release on docs.rs.
NOTE: master
branch (code and docs) can differ from those docs prior to a new release.
The minimum rust version required, by version:
This is tested in CI and must pass.
The Github Actions CI test libproc-rs
on :
rust versions:
stable
(must pass)beta
(must pass)1.72.0
(currently the minimum rust version supported) (must pass)nightly
(allowed to fail) on the following platforms:
ubuntu-latest
macos-12
(Monterey) (Intel)macos-13
(Ventura) (Intel)macos-14
(Sonoma) (Arm64)Two simple examples are included to show libproc-rs working.
procinfo
that takes a PID as an optional argument (uses it's own pid if none supplied) and returns
information about the process on stdoutdmesg
is a version of dmesg implemented in rust that uses libproc-rs.These can be ran thus:
sudo cargo run --example procinfo
or
sudo cargo run --example dmesg
You are welcome to fork this repo and make a pull request, or write an issue.
I am exploring the ideas around Open Source Software funding from RadWorks Foundation via the Drips Project
This project is in Drips here
See the list of issues. I put the "help wanted" label where I need help from others.
If you're feeling lucky today, start with make
that will run clippy
, test
and will build docs also.
If you want to stay "pure rust" : cargo test
will build and test as usual.
However, as some functions need to be run as root
to work, CI tests are run as root
.
So, when developing in local it's best if you use sudo cargo test
.
[!NOTE] This can get you into permissions problems when switching back and for
between using cargo test
and sudo cargo test
.
To fix that run sudo cargo clean
and then build or test as you prefer.
In order to have tests pass when run as root
or not, some tests need to check if they are root
at run-time (using our own am_root()
function is handy) and avoid failing if not run as root
.
act
to run GH Actions locallyIf you develop on macos but want to ensure code builds and tests pass on linux while making changes, you can use the act tool to run the Github Actions Workflows on the test matrix.
Just install act
(brew install act
on macOS) (previously install docker if you don't have it already,
and make sure the daemon is running) then run act push
. You can test a subset of the rust
and os versions of the matrix with something like act push --matrix os:ubuntu-latest
If you want to test locally as much of the test matrix as possible (different OS and
versions of rust), that you can use make matrix
. On macos, if you have act
installed, it will use it to run the linux part of the matrix.
Newer versions of bindgen
have improved the detection of clang
and hence macos header files.
If you also have llvm/clang installed directly or via brew
this may cause the build to fail saying it
cannot find libproc.h
. This can be fixed by setting CLANG_PATH="/usr/bin/clang"
so that bindgen
detects the Xcode version and hence can fidn the correct header files.
This code is licensed under MIT license (see LICENCE).