This is the machine-state Reference Manual, version 1.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 05:50:51 2025 GMT+0.
machine-state/machine-state.asdmachine-state/package.lispmachine-state/protocol.lispmachine-state/windows.lispmachine-state/posix.lispmachine-state/darwin.lispmachine-state/bsd.lispmachine-state/freebsd.lispmachine-state/openbsd.lispmachine-state/linux.lispmachine-state/nx.lispmachine-state/mezzano.lispmachine-state/documentation.lispThe main system appears first, followed by any subsystem dependency.
machine-stateRetrieve machine state information about CPU time, memory usage, etc.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/shinmera/machine-state.git)
zlib
1.2.0
trivial-features (system).
documentation-utils (system).
cffi (system)., for feature (:not :mezzano)
bordeaux-threads (system)., for feature (:not (:and :sbcl :openbsd :32-bit))
pathname-utils (system).
com-on (system)., for feature :windows
package.lisp (file).
protocol.lisp (file).
windows.lisp (file).
posix.lisp (file).
darwin.lisp (file).
bsd.lisp (file).
freebsd.lisp (file).
openbsd.lisp (file).
linux.lisp (file).
nx.lisp (file).
mezzano.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
machine-state/machine-state.asdmachine-state/package.lispmachine-state/protocol.lispmachine-state/windows.lispmachine-state/posix.lispmachine-state/darwin.lispmachine-state/bsd.lispmachine-state/freebsd.lispmachine-state/openbsd.lispmachine-state/linux.lispmachine-state/nx.lispmachine-state/mezzano.lispmachine-state/documentation.lispmachine-state/protocol.lisppackage.lisp (file).
machine-state (system).
gc-room (function).
gc-time (function).
gpu-info (function).
gpu-room (function).
gpu-time (function).
query-failed (condition).
stack-room (function).
static-room (function).
arch-type (function).
define-implementation (macro).
define-protocol-fun (macro).
fail (function).
find-symbol* (function).
os-type (function).
machine-state/windows.lisp(:or :windows :win32)
protocol.lisp (file).
machine-state (system).
machine-state/posix.lisp(:and (:not :openbsd) (:or :posix :linux :darwin :bsd))
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-cores (function).
machine-room (function).
machine-uptime (function).
network-info (function).
process-info (function).
process-priority (function).
(setf process-priority) (function).
process-time (function).
thread-core-mask (function).
(setf thread-core-mask) (function).
thread-priority (function).
(setf thread-priority) (function).
thread-time (function).
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
errno (symbol macro).
posix-call (macro).
posix-call0 (macro).
rusage-idrss (function).
(setf rusage-idrss) (function).
rusage-inblock (function).
(setf rusage-inblock) (function).
rusage-isrss (function).
(setf rusage-isrss) (function).
rusage-ixrss (function).
(setf rusage-ixrss) (function).
rusage-majflt (function).
(setf rusage-majflt) (function).
rusage-maxrss (function).
(setf rusage-maxrss) (function).
rusage-minflt (function).
(setf rusage-minflt) (function).
rusage-msgrcv (function).
(setf rusage-msgrcv) (function).
rusage-msgsnd (function).
(setf rusage-msgsnd) (function).
rusage-nivcsw (function).
(setf rusage-nivcsw) (function).
rusage-nsignals (function).
(setf rusage-nsignals) (function).
rusage-nswap (function).
(setf rusage-nswap) (function).
rusage-nvcsw (function).
(setf rusage-nvcsw) (function).
rusage-oublock (function).
(setf rusage-oublock) (function).
rusage-stime (function).
(setf rusage-stime) (function).
rusage-tclass (class).
rusage-utime (function).
(setf rusage-utime) (function).
strerror (function).
sysinfo-_pad (function).
(setf sysinfo-_pad) (function).
sysinfo-buffer-ram (function).
(setf sysinfo-buffer-ram) (function).
sysinfo-free-high (function).
(setf sysinfo-free-high) (function).
sysinfo-free-ram (function).
(setf sysinfo-free-ram) (function).
sysinfo-free-swap (function).
(setf sysinfo-free-swap) (function).
sysinfo-loads (function).
(setf sysinfo-loads) (function).
sysinfo-memory-unit (function).
(setf sysinfo-memory-unit) (function).
sysinfo-processes (function).
(setf sysinfo-processes) (function).
sysinfo-shared-ram (function).
(setf sysinfo-shared-ram) (function).
sysinfo-tclass (class).
sysinfo-total-high (function).
(setf sysinfo-total-high) (function).
sysinfo-total-ram (function).
(setf sysinfo-total-ram) (function).
sysinfo-total-swap (function).
(setf sysinfo-total-swap) (function).
sysinfo-uptime (function).
(setf sysinfo-uptime) (function).
timeval-sec (function).
(setf timeval-sec) (function).
timeval-tclass (class).
timeval-usec (function).
(setf timeval-usec) (function).
with-thread-handle (macro).
machine-state/darwin.lisp:darwin
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-state/bsd.lisp(:and :bsd (:not :darwin))
darwin.lisp (file).
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-state/freebsd.lisp:freebsd
bsd.lisp (file).
darwin.lisp (file).
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-state/openbsd.lisp:openbsd
freebsd.lisp (file).
bsd.lisp (file).
darwin.lisp (file).
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-state/linux.lisp:linux
openbsd.lisp (file).
freebsd.lisp (file).
bsd.lisp (file).
darwin.lisp (file).
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-battery (function).
machine-core-info (function).
machine-info (function).
machine-time (function).
network-address (function).
network-devices (function).
network-io-bytes (function).
process-io-bytes (function).
process-room (function).
storage-device (function).
storage-device-path (function).
storage-io-bytes (function).
storage-room (function).
do-proc (macro).
find-mount-root (function).
ifaddrs-addr (function).
(setf ifaddrs-addr) (function).
ifaddrs-bcast (function).
(setf ifaddrs-bcast) (function).
ifaddrs-data (function).
(setf ifaddrs-data) (function).
ifaddrs-flags (function).
(setf ifaddrs-flags) (function).
ifaddrs-name (function).
(setf ifaddrs-name) (function).
ifaddrs-netmask (function).
(setf ifaddrs-netmask) (function).
ifaddrs-next (function).
(setf ifaddrs-next) (function).
ifaddrs-tclass (class).
ipv4-str (function).
ipv6-str (function).
pathname-force-file (function).
prefix-p (function).
self (function).
sockaddr4-addr (function).
(setf sockaddr4-addr) (function).
sockaddr4-family (function).
(setf sockaddr4-family) (function).
sockaddr4-port (function).
(setf sockaddr4-port) (function).
sockaddr4-tclass (class).
sockaddr6-addr (function).
(setf sockaddr6-addr) (function).
sockaddr6-family (function).
(setf sockaddr6-family) (function).
sockaddr6-flow-info (function).
(setf sockaddr6-flow-info) (function).
sockaddr6-port (function).
(setf sockaddr6-port) (function).
sockaddr6-scope-id (function).
(setf sockaddr6-scope-id) (function).
sockaddr6-tclass (class).
stat-dev (function).
(setf stat-dev) (function).
stat-mode (function).
(setf stat-mode) (function).
stat-tclass (class).
statvfs-bavail (function).
(setf statvfs-bavail) (function).
statvfs-bfree (function).
(setf statvfs-bfree) (function).
statvfs-blocks (function).
(setf statvfs-blocks) (function).
statvfs-bsize (function).
(setf statvfs-bsize) (function).
statvfs-favail (function).
(setf statvfs-favail) (function).
statvfs-ffree (function).
(setf statvfs-ffree) (function).
statvfs-files (function).
(setf statvfs-files) (function).
statvfs-flag (function).
(setf statvfs-flag) (function).
statvfs-frsize (function).
(setf statvfs-frsize) (function).
statvfs-fsid (function).
(setf statvfs-fsid) (function).
statvfs-namemax (function).
(setf statvfs-namemax) (function).
statvfs-tclass (class).
with-proc (macro).
machine-state/nx.lisp:nx
linux.lisp (file).
openbsd.lisp (file).
freebsd.lisp (file).
bsd.lisp (file).
darwin.lisp (file).
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-state/mezzano.lisp:mezzano
nx.lisp (file).
linux.lisp (file).
openbsd.lisp (file).
freebsd.lisp (file).
bsd.lisp (file).
darwin.lisp (file).
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-state/documentation.lispmezzano.lisp (file).
nx.lisp (file).
linux.lisp (file).
openbsd.lisp (file).
freebsd.lisp (file).
bsd.lisp (file).
darwin.lisp (file).
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
Packages are listed by definition order.
org.shirakumo.machine-statecommon-lisp.
gc-room (function).
gc-time (function).
gpu-info (function).
gpu-room (function).
gpu-time (function).
machine-battery (function).
machine-core-info (function).
machine-cores (function).
machine-info (function).
machine-room (function).
machine-time (function).
machine-uptime (function).
network-address (function).
network-devices (function).
network-info (function).
network-io-bytes (function).
process-info (function).
process-io-bytes (function).
process-priority (function).
(setf process-priority) (function).
process-room (function).
process-time (function).
query-failed (condition).
stack-room (function).
static-room (function).
storage-device (function).
storage-device-path (function).
storage-io-bytes (function).
storage-room (function).
thread-core-mask (function).
(setf thread-core-mask) (function).
thread-priority (function).
(setf thread-priority) (function).
thread-time (function).
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
arch-type (function).
define-implementation (macro).
define-protocol-fun (macro).
do-proc (macro).
errno (symbol macro).
fail (function).
find-mount-root (function).
find-symbol* (function).
ifaddrs-addr (function).
(setf ifaddrs-addr) (function).
ifaddrs-bcast (function).
(setf ifaddrs-bcast) (function).
ifaddrs-data (function).
(setf ifaddrs-data) (function).
ifaddrs-flags (function).
(setf ifaddrs-flags) (function).
ifaddrs-name (function).
(setf ifaddrs-name) (function).
ifaddrs-netmask (function).
(setf ifaddrs-netmask) (function).
ifaddrs-next (function).
(setf ifaddrs-next) (function).
ifaddrs-tclass (class).
ipv4-str (function).
ipv6-str (function).
os-type (function).
pathname-force-file (function).
posix-call (macro).
posix-call0 (macro).
prefix-p (function).
rusage-idrss (function).
(setf rusage-idrss) (function).
rusage-inblock (function).
(setf rusage-inblock) (function).
rusage-isrss (function).
(setf rusage-isrss) (function).
rusage-ixrss (function).
(setf rusage-ixrss) (function).
rusage-majflt (function).
(setf rusage-majflt) (function).
rusage-maxrss (function).
(setf rusage-maxrss) (function).
rusage-minflt (function).
(setf rusage-minflt) (function).
rusage-msgrcv (function).
(setf rusage-msgrcv) (function).
rusage-msgsnd (function).
(setf rusage-msgsnd) (function).
rusage-nivcsw (function).
(setf rusage-nivcsw) (function).
rusage-nsignals (function).
(setf rusage-nsignals) (function).
rusage-nswap (function).
(setf rusage-nswap) (function).
rusage-nvcsw (function).
(setf rusage-nvcsw) (function).
rusage-oublock (function).
(setf rusage-oublock) (function).
rusage-stime (function).
(setf rusage-stime) (function).
rusage-tclass (class).
rusage-utime (function).
(setf rusage-utime) (function).
self (function).
sockaddr4-addr (function).
(setf sockaddr4-addr) (function).
sockaddr4-family (function).
(setf sockaddr4-family) (function).
sockaddr4-port (function).
(setf sockaddr4-port) (function).
sockaddr4-tclass (class).
sockaddr6-addr (function).
(setf sockaddr6-addr) (function).
sockaddr6-family (function).
(setf sockaddr6-family) (function).
sockaddr6-flow-info (function).
(setf sockaddr6-flow-info) (function).
sockaddr6-port (function).
(setf sockaddr6-port) (function).
sockaddr6-scope-id (function).
(setf sockaddr6-scope-id) (function).
sockaddr6-tclass (class).
stat-dev (function).
(setf stat-dev) (function).
stat-mode (function).
(setf stat-mode) (function).
stat-tclass (class).
statvfs-bavail (function).
(setf statvfs-bavail) (function).
statvfs-bfree (function).
(setf statvfs-bfree) (function).
statvfs-blocks (function).
(setf statvfs-blocks) (function).
statvfs-bsize (function).
(setf statvfs-bsize) (function).
statvfs-favail (function).
(setf statvfs-favail) (function).
statvfs-ffree (function).
(setf statvfs-ffree) (function).
statvfs-files (function).
(setf statvfs-files) (function).
statvfs-flag (function).
(setf statvfs-flag) (function).
statvfs-frsize (function).
(setf statvfs-frsize) (function).
statvfs-fsid (function).
(setf statvfs-fsid) (function).
statvfs-namemax (function).
(setf statvfs-namemax) (function).
statvfs-tclass (class).
strerror (function).
sysinfo-_pad (function).
(setf sysinfo-_pad) (function).
sysinfo-buffer-ram (function).
(setf sysinfo-buffer-ram) (function).
sysinfo-free-high (function).
(setf sysinfo-free-high) (function).
sysinfo-free-ram (function).
(setf sysinfo-free-ram) (function).
sysinfo-free-swap (function).
(setf sysinfo-free-swap) (function).
sysinfo-loads (function).
(setf sysinfo-loads) (function).
sysinfo-memory-unit (function).
(setf sysinfo-memory-unit) (function).
sysinfo-processes (function).
(setf sysinfo-processes) (function).
sysinfo-shared-ram (function).
(setf sysinfo-shared-ram) (function).
sysinfo-tclass (class).
sysinfo-total-high (function).
(setf sysinfo-total-high) (function).
sysinfo-total-ram (function).
(setf sysinfo-total-ram) (function).
sysinfo-total-swap (function).
(setf sysinfo-total-swap) (function).
sysinfo-uptime (function).
(setf sysinfo-uptime) (function).
timeval-sec (function).
(setf timeval-sec) (function).
timeval-tclass (class).
timeval-usec (function).
(setf timeval-usec) (function).
with-proc (macro).
with-thread-handle (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns information about the battery charge state, if any.
Returns three values:
Current charge
Full charge
Charging state:
:CHARGING
:DISCHARGING
:FULL
NIL
If no battery is attached or the function is unsupported,
0.0d0
0.0d0
NIL
are returned.
Returns information about the host machine’s processor.
Returns four values:
The name of the vendor of the processor as a string
The name of the model of the processor as a string
The name of the architecture as a keyword:
:X86
:AMD64
:ARM
:ARM64
:RISCV
:RISCV64
:PPC
:SPARC
NIL
The version of the architecture as a string
If the function is unsupported,
"Unknown"
"Unknown"
NIL
"Unknown"
are returned.
See MACHINE-INFO
See PROCESS-INFO
See GPU-INFO
See NETWORK-INFO
Returns the number of cores available on the machine.
If the function is unsupported a constant 1 is returned.
See THREAD-CORE-MASK
Returns information about the host machine.
Returns four values:
The name of the vendor of the machine (or motherboard) as a string
The name of the model of the machine (or motherboard) as a string
The name of the operating system of the machine as a keyword:
:WINDOWS
:LINUX
:DARWIN
:ANDROID
:IOS
:NETBSD
:FREEBSD
:OPENBSD
:BEOS
:SOLARIS
:REACT
:PLAN9
:MEZZANO
:NX
NIL
The version of the operating system as a string
If the function is unsupported,
"Unknown"
"Unknown"
NIL
"Unknown"
are returned.
See MACHINE-CORE-INFO
See PROCESS-INFO
See GPU-INFO
See NETWORK-INFO
Returns the machine’s primary memory usage statistics.
Returns two values:
The number of physical bytes occupied
The total number of physical bytes available
If the function is unsupported a constant 0 is returned for all
values.
See PROCESS-ROOM
See GC-ROOM
See GPU-ROOM
See STATIC-ROOM
See STACK-ROOM
See STORAGE-ROOM
Returns the amount of time spent processing.
Core may be T for an aggregate of all cores, or an integer of the core number.
Returns two values:
The time spent idle in seconds
The total time spent in seconds
If the function is unsupported a constant 0.0d0 is returned.
See MACHINE-CORES
Returns the number of seconds since the machine was started up.
If the function is unsupported a constant 0 is returned.
Returns information about a network device’s addresses.
Returns three values:
The device’s MAC address as a string or NIL
The device’s IPv4 address as a string or NIL
The device’s IPv6 address as a string or NIL
If the function is unsupported,
NIL
NIL
NIL
are returned.
See NETWORK-DEVICES
See NETWORK-INFO
Returns a list of network device names.
If the function is unsupported an empty list is returned.
See NETWORK-IO-BYTES
See NETWORK-ADDRESS
Returns information about the machine’s network state.
Returns one value:
The hostname of the machine as a string
If the function is unsupported,
NIL
is returned.
See MACHINE-INFO
See MACHINE-CORE-INFO
See PROCESS-INFO
See GPU-INFO
Returns the number of bytes of IO performed on the network device.
The argument may either be the system name of the device as a string
or T to get an aggregate of all attached devices.
Returns three values:
The total number of IO bytes performed.
The bytes read.
The bytes written.
If the function is unsupported a constant 0 is returned.
See NETWORK-DEVICES
See PROCESS-IO-BYTES
See STORAGE-IO-BYTES
Returns information about the current process.
Returns four values:
The path to the executable as a pathname
The current working directory as a pathname
The running user as a string or NIL
The running group as a string or NIL
If the function is unsupported,
*default-pathname-defaults*
*default-pathname-defaults*
"Unknown"
"Unknown"
are returned.
See MACHINE-INFO
See MACHINE-CORE-INFO
See GPU-INFO
See NETWORK-INFO
Returns the number of bytes of IO performed by the process.
Returns three values:
The total number of IO bytes performed.
The bytes read.
The bytes written.
IO in this context refers to any activity to external devices such as
drives, networking, etc.
If the function is unsupported a constant 0 is returned for all
values.
See STORAGE-IO-BYTES
See NETWORK-IO-BYTES
Accessor to the scheduler priority of the process.
The priority can be one of the following values, in ascending order of
importance:
:IDLE
:LOW
:NORMAL
:HIGH
:REALTIME
If the function is unsupported :NORMAL is returned in all cases.
When setting this place, the *actual* priority of the process is
returned, which may differ from the one you tried to set.
See THREAD-PRIORITY
Returns the process’ memory usage statistics.
This includes foreign memory usage.
Returns the number of bytes occupied.
If the function is unsupported a constant 0 is returned.
See MACHINE-ROOM
See GC-ROOM
See GPU-ROOM
See STATIC-ROOM
See STACK-ROOM
See STORAGE-ROOM
Returns the amount of processing time spent by this process in seconds.
This does not include time spent in the kernel.
If the function is unsupported a constant 0.0d0 is returned.
See MACHINE-TIME
See THREAD-TIME
See GC-TIME
See GPU-TIME
Return the system device name of the device backing the path.
Returns the device name as a string if it can be found and signals a
QUERY-FAILED error otherwise.
See STORAGE-DEVICE-PATH
See STORAGE-ROOM
See STORAGE-IO-BYTES
Return a path which the storage device is backing if any.
Returns the path as a directory pathname if it can be found and
signals a QUERY-FAILED error otherwise.
See STORAGE-DEVICE
See STORAGE-ROOM
See STORAGE-IO-BYTES
Returns the number of bytes of IO performed on the storage device.
The argument may either be a pathname to a file on the device to
query, the system provided name for the device, or T to get an
aggregate of all attached devices.
Returns three values:
The total number of IO bytes performed.
The bytes read.
The bytes written.
If the function is unsupported a constant 0 is returned.
See STORAGE-DEVICE
See STORAGE-DEVICE-PATH
See NETWORK-IO-BYTES
See PROCESS-IO-BYTES
Return file system storage usage statistics.
The argument may either be a pathname to a file on the device to
query, or the system provided name for the device.
Returns two values:
The number of free bytes
The total number of bytes available
See STORAGE-DEVICE
See STORAGE-DEVICE-PATH
See MACHINE-ROOM
See PROCESS-ROOM
See GC-ROOM
See GPU-ROOM
See STATIC-ROOM
See STACK-ROOM
Accessor to the CPU core affinity mask of the thread.
The mask is a bitfield where each set bit in the integer designates a
core that the thread may be executed on. For compatibility reasons
only integers up to 64 bits are supported.
Thread may be T for the current thread, or a BT:THREAD.
If the function is unsupported a constant of all 1s is returned.
When setting this place, the *actual* affinity mask of the thread is
returned, which may differ from the one you tried to set.
See MACHINE-CORES
Accessor to the scheduler priority of the thread.
The priority can be one of the following values, in ascending order of
importance:
:IDLE
:LOW
:NORMAL
:HIGH
:REALTIME
Thread may be T for the current thread, or a BT:THREAD.
If the function is unsupported :NORMAL is returned in all cases.
When setting this place, the *actual* priority of the thread is
returned, which may differ from the one you tried to set.
See PROCESS-PRIORITY
Returns the amount of processing time spent by this thread in seconds.
This does not include time spent in the kernel.
Thread may be T for the current thread, or a BT:THREAD.
If the function is unsupported a constant 0.0d0 is returned.
See MACHINE-TIME
See PROCESS-TIME
See GC-TIME
See GPU-TIME
Error signalled if a query should fail for some reason.
This condition is *NOT* signalled if the function is simply unsupported. It is however signalled if an OS call failed for some reason such as lack of access permissions.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
A D F G I M N O P R S T W |
|---|
| Jump to: | %
(
A D F G I M N O P R S T W |
|---|
| Jump to: | E F M S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| E | |||
errno: | Private symbol macros | ||
| | |||
| F | |||
function: | Public conditions | ||
| | |||
| M | |||
message: | Public conditions | ||
| | |||
| S | |||
Slot, function: | Public conditions | ||
Slot, message: | Public conditions | ||
Symbol Macro, errno: | Private symbol macros | ||
| | |||
| Jump to: | E F M S |
|---|
| Jump to: | B C D F I L M N O P Q R S T W |
|---|
| Jump to: | B C D F I L M N O P Q R S T W |
|---|