Crate procfs_core

This crate provides to an interface into the linux procfs filesystem, usually mounted at /proc.

This is a pseudo-filesystem which is available on most every linux system and provides an interface to kernel data structures.

Kernel support

Not all fields/data are available in each kernel. Some fields were added in specific kernel releases, and other fields are only present in certain kernel configuration options are enabled. These are represented as Option fields in this crate.

This crate aims to support all 2.6 kernels (and newer). WSL2 is also supported.

Documentation

In almost all cases, the documentation is taken from the proc.5 manual page. This means that sometimes the style of writing is not very “rusty”, or may do things like reference related files (instead of referencing related structs). Contributions to improve this are welcome.

Panicing

While previous versions of the library could panic, this current version aims to be panic-free in a many situations as possible. Whenever the procfs crate encounters a bug in its own parsing code, it will return an InternalError error. This should be considered a bug and should be reported. If you encounter a panic, please report that as well.

Cargo features

The following cargo features are available:

• chrono – Default. Optional. This feature enables a few methods that return values as DateTime objects.
• backtrace – Optional. This feature lets you get a stack trace whenever an InternalError is raised.

Examples

Examples can be found in the various modules shown below, or in the examples folder of the code repository.

Re-exports

• pub use sys::kernel::Version as KernelVersion;

Modules

• keyring
  Functions related to the in-kernel key management and retention facility
• net
  Information about the networking layer.
• prelude
  Extension traits useful for importing wholesale.
• process
  Functions and structs related to process information
• sys
  Sysctl is a means of configuring certain aspects of the kernel at run-time, and the /proc/sys/ directory is there so that you don’t even need special tools to do it!

Structs

• CGroupController
  Container group controller information.
• CGroupControllers
  Container group controller information.
• CpuInfo
  Represents the data from /proc/cpuinfo.
• CpuPressure
  CPU pressure information
• CpuTime
  The amount of time, measured in ticks, the CPU has been in specific states
• DiskStat
  Disk IO stat information
• DiskStats
  A list of disk stats.
• ExplicitSystemInfo
  A convenience stuct implementing SystemInfoInterface with explicitly-specified values.
• InternalError
  An internal error in the procfs crate
• IoPressure
  IO pressure information
• Iomem
• KernelCmdline
  A list of the arguments passed to the Linux kernel at boot time.
• KernelConfig
  The kernel configuration.
• KernelModule
  Details about a loaded kernel module
• KernelModules
  A set of loaded kernel modules
• KernelStats
  Kernel/system statistics, from /proc/stat
• LoadAverage
  Load average figures.
• Lock
  Details about an individual file lock
• Locks
  Details about file locks
• Meminfo
  This struct reports statistics about memory usage on the system, based on the /proc/meminfo file.
• MemoryPressure
  Memory pressure information
• MountEntry
  A mountpoint entry under /proc/mounts
• PhysicalMemoryMap
• PressureRecord
  Pressure stall information for either CPU, memory, or IO.
• ProcessCGroup
  Information about a process cgroup
• ProcessCGroups
  Information about process cgroups.
• SharedMemorySegments
  A set of shared memory segments parsed from /proc/sysvipc/shm
• Shm
  A shared memory segment parsed from /proc/sysvipc/shm Relation with crate::process::MMapPath::Vsys
• Uptime
  The uptime of the system, based on the /proc/uptime file.
• VmStat
  Various virtual memory statistics

Enums

• ConfigSetting
  Possible values for a kernel config option
• LockKind
  The kind of a lock (read or write)
• LockMode
  The mode of a lock (advisory or mandatory)
• LockType
  The type of a file lock
• ProcError
  The various error conditions in the procfs crate.

Traits

• FromBufRead
  Types which can be parsed from a BufRead implementation.
• FromBufReadSI
  Types which can be parsed from a BufRead implementation and system info.
• FromRead
  Types which can be parsed from a Read implementation.
• FromReadSI
  Types which can be parsed from a Read implementation and system info.
• FromStrRadix
• ProcErrorExt
  Extensions for dealing with ProcErrors.
• SystemInfoInterface
  Auxiliary system information interface.
• WithSystemInfo
  Values which can provide an output given the SystemInfo.

Type Definitions

• ProcResult
  The main error type for the procfs crate.
• SystemInfo
  Auxiliary system information.