Production grade, very easy to use, procfs parsing library in C++. Used in production by S&P 500 tech companies and startups!

NEW Basic parsing of sysfs (Additional sysfs feature requests are welcome!)

Build

Run cmake . && make

Currently supported CMake configuration flags:

• CMAKE_BUILD_TYPE=<Debug|Release>: Standard CMake flags to control build type (DEFAULT: Debug)
• pfs_BUILD_SHARED_LIBS=<ON|OFF>: ON to compile a shared library. OFF to compile a static library (DEFAULT: Inherit BUILD_SHARE_LIBS, which is OFF by default))
• pfs_BUILD_ASAN=<ON|OFF>: ON to enable address sanitizer (DEFAULT: OFF)
• pfs_BUILD_COVERAGE=<ON|OFF>: ON to enable coverage instrumentation (DEFAULT: OFF)
• pfs_BUILD_SAMPLES=<ON|OFF>: ON to build the sample programs (DEFAULT: ON)
• pfs_BUILD_TESTS=<ON|OFF>: ON to build the tests (DEFAULT: ON)

You can pass any number of those to the cmake command: cmake -D<CONFIG_FLAG>=<VALUE> .

NOTE: After running cmake for the first time, some values are cached in CMakeCache.txt and will not change when running cmake for a second time with different flags.

Build using clang

If you prefer using clang, just configure the compiler while running cmake:

CXX=<clang++> CC=<clang> cmake .

After that, just use make as always.

Code Coverage

Generate a coverage report is via Docker:

./docker/docker-pfs coverage

This builds the project with coverage instrumentation, runs all tests, and produces:

• A text summary printed to the terminal
• An HTML report at ./coverage/index.html

Integrate

• Compile as a shared or static library.
• Add the contents of /lib into your link directories
• Add the contents of /include into your include directories. That’s it, you are good to go.

Use CMake’s find_package()

Option #1: make install (Preferred way)

After building the project, you can install it locally using make install. In your project’s CMake file, you can then add the following snippet, and CMake will handle the rest:

find_package (pfs REQUIRED)
...
# Somewhere along the file you define your target
add_<library|executable> (<your-target> ...)
...
target_link_libraries (<your-target> pfs)

NOTE: CMake generates an install_manifest.txt file to track all the created files, this will help you uninstall the library if you need to do so.

Option #2: Without make install

Build the pfs project. No need to call make install. In your project’s CMake file, you can then add the following snippet:

find_package (pfs REQUIRED)
...
# Somewhere along the file you define your target
add_<library|executable> (<your-target> ...)
...
target_link_libraries (<your-target> -L${pfs_LIBRARY_DIR} ${pfs_LIBRARIES})
target_include_directories (<your-target> [PUBLIC|PRIVATE] ${pfs_INCLUDE_DIRS})

Features

• Parsing system-wide information from files directly under /procfs. See procfs.hpp for all the supported files.
• Parsing per-task (processes and threads) information from files under /procfs/[task-id]/. See task.hpp for all the supported files.
• Parsing network information from files under /procfs/net (which is an alias to /procfs/self/net nowadays)
• NEW Parsing of basic disk information from sysfs/block (Additional sysfs feature requests are welcome!)

Requirements

• The library requires C++11 or newer
• The library aims to support Linux kernel versions >= 2.6.32.

Notes

General notes

File truncated at 100 lines see the full file