This is the machine-state Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:55:29 2024 GMT+0.
The 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.0.0
trivial-features (system).
documentation-utils (system).
cffi (system).
bordeaux-threads (system).
pathname-utils (system).
com-on (system)., for feature :windows
package.lisp (file).
protocol.lisp (file).
windows.lisp (file).
posix.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/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-room (function).
gpu-time (function).
query-failed (condition).
stack-room (function).
static-room (function).
define-implementation (macro).
define-protocol-fun (macro).
machine-state/windows.lisp(:or :windows :win32)
protocol.lisp (file).
machine-state (system).
machine-state/posix.lisp(:or :posix :linux :darwin :bsd)
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-cores (function).
machine-room (function).
process-priority (function).
(setf process-priority) (function).
process-time (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).
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).
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).
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/linux.lisp:linux
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
process-io-bytes (function).
process-room (function).
with-proc (macro).
machine-state/nx.lisp:nx
linux.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).
posix.lisp (file).
windows.lisp (file).
protocol.lisp (file).
machine-state (system).
machine-state/documentation.lispmezzano.lisp (file).
nx.lisp (file).
linux.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-room (function).
gpu-time (function).
machine-cores (function).
machine-room (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-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).
define-implementation (macro).
define-protocol-fun (macro).
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).
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).
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 the number of cores available on the machine.
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 both
values.
See PROCESS-ROOM
See GC-ROOM
See GPU-ROOM
See STATIC-ROOM
See STACK-ROOM
See STORAGE-ROOM
Returns the number of bytes of IO performed by the process.
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.
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 THREAD-TIME
See GC-TIME
See GPU-TIME
Return file system storage usage statistics.
Returns two values:
The number of free bytes
The total number of bytes available
See MACHINE-ROOM
See PROCESS-ROOM
See GC-ROOM
See GPU-ROOM
See STATIC-ROOM
See STACK-ROOM
See STORAGE-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.
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 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.
| Jump to: | %
(
D F G M P R S T W |
|---|
| Jump to: | %
(
D F G M 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: | C D F L M N O P Q R S T W |
|---|
| Jump to: | C D F L M N O P Q R S T W |
|---|