machine state

Table of Contents

System Information

Definition Index

• ORG.SHIRAKUMO.MACHINE-STATE

  No documentation provided.

  • EXTERNAL CONDITION

    QUERY-FAILED

    Source

    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.

  • EXTERNAL FUNCTION

    GC-ROOM

    Source

    Returns the GC's memory usage statistics.
    
    This does not include foreign memory usage.
    
    Returns two values:
      The number of free bytes
      The total number of bytes available
    
    If the function is unsupported a constant 0 is returned for both
    values.
    
    See MACHINE-ROOM
    See PROCESS-ROOM
    See GPU-ROOM
    See STATIC-ROOM
    See STACK-ROOM
    See STORAGE-ROOM

  • EXTERNAL FUNCTION

    GC-TIME

    Source

    Returns the amount of processing time spent in the GC.
    
    If the function is unsupported a constant 0.0d0 is returned.
    
    See MACHINE-TIME
    See PROCESS-TIME
    See GC-TIME
    See GPU-TIME
    See THREAD-TIME

  • EXTERNAL FUNCTION

    GPU-INFO

    Source

    Returns information about the graphics card.
    
    Returns three values:
       The vendor of the graphics card as a keyword:
         :NVIDIA
         :AMD (formerly ATI)
         :INTEL
         and others
      The model of the graphics card as a string
      The version of OpenGL and/or graphics card driver as a string
    
    If the function is unsupported,
      NIL
      "Unknown"
      "Unknown"
    are returned.
    
    You may want to load the machine-state/opengl library to make this
    function useful. In that case, it will only work if an OpenGL context
    is current to this thread.
    
    See MACHINE-INFO
    See MACHINE-CORE-INFO
    See PROCESS-INFO
    See NETWORK-INFO

  • EXTERNAL FUNCTION

    GPU-ROOM

    Source

    Returns the GPU's memory usage statistics.
    
    Returns two values:
      The number of free bytes
      The total number of bytes available
    
    If the function is unsupported a constant 0 is returned for both
    values.
    
    You may want to load the machine-state/opengl library to make this
    function useful. In that case, it will only work if an OpenGL context
    is current to this thread.
    
    See MACHINE-ROOM
    See PROCESS-ROOM
    See GC-ROOM
    See STATIC-ROOM
    See STACK-ROOM
    See STORAGE-ROOM

  • EXTERNAL FUNCTION

    GPU-TIME

    Source

    Returns the amount of processing time spent on the GPU by this process.
    
    If the function is unsupported a constant 0.0d0 is returned.
    
    You may want to load the machine-state/opengl library to make this
    function useful. In that case, it will only work if an OpenGL context
    is current to this thread.
    
    See PROCESS-TIME
    See GC-TIME
    See MACHINE-TIME
    See THREAD-TIME

  • EXTERNAL FUNCTION

    MACHINE-BATTERY

    Source

    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.

  • EXTERNAL FUNCTION

    MACHINE-CORE-INFO

    Source

    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

  • EXTERNAL FUNCTION

    MACHINE-CORES

    Source

    Returns the number of cores available on the machine.
    
    If the function is unsupported a constant 1 is returned.
    
    See THREAD-CORE-MASK

  • EXTERNAL FUNCTION

    MACHINE-INFO

    Source

    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

  • EXTERNAL FUNCTION

    MACHINE-ROOM

    Source

    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

  • EXTERNAL FUNCTION

    MACHINE-TIME

    • CORE

    Source

    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

  • EXTERNAL FUNCTION

    MACHINE-UPTIME

    Source

    Returns the number of seconds since the machine was started up.
    
    If the function is unsupported a constant 0 is returned.

  • EXTERNAL FUNCTION

    NETWORK-ADDRESS

    • DEVICE

    Source

    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

  • EXTERNAL FUNCTION

    NETWORK-DEVICES

    Source

    Returns a list of network device names.
    
    If the function is unsupported an empty list is returned.
    
    See NETWORK-IO-BYTES
    See NETWORK-ADDRESS

  • EXTERNAL FUNCTION

    NETWORK-INFO

    Source

    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

  • EXTERNAL FUNCTION

    NETWORK-IO-BYTES

    • DEVICE

    Source

    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

  • EXTERNAL FUNCTION

    PROCESS-INFO

    Source

    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

  • EXTERNAL FUNCTION

    PROCESS-IO-BYTES

    Source

    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

  • EXTERNAL FUNCTION

    PROCESS-PRIORITY

    Source

    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

  • EXTERNAL FUNCTION

    (SETF PROCESS-PRIORITY)

    • PRIORITY

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    PROCESS-ROOM

    Source

    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

  • EXTERNAL FUNCTION

    PROCESS-TIME

    Source

    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

  • EXTERNAL FUNCTION

    STACK-ROOM

    Source

    Return the stack usage statistics.
    
    Returns two values:
      The number of free stack bytes
      The total stack space available
    
    See MACHINE-ROOM
    See PROCESS-ROOM
    See GC-ROOM
    See GPU-ROOM
    See STATIC-ROOM
    See STORAGE-ROOM

  • EXTERNAL FUNCTION

    STATIC-ROOM

    Source

    Returns the static space size as an integer.
    
    If the function is unsupported zero is returned.
    
    See MACHINE-ROOM
    See PROCESS-ROOM
    See GC-ROOM
    See GPU-ROOM
    See STACK-ROOM
    See STORAGE-ROOM

  • EXTERNAL FUNCTION

    STORAGE-DEVICE

    • PATH

    Source

    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

  • EXTERNAL FUNCTION

    STORAGE-DEVICE-PATH

    • DEVICE

    Source

    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

  • EXTERNAL FUNCTION

    STORAGE-IO-BYTES

    • DEVICE

    Source

    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

  • EXTERNAL FUNCTION

    STORAGE-ROOM

    • PATH

    Source

    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

  • EXTERNAL FUNCTION

    THREAD-CORE-MASK

    • THREAD

    Source

    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

  • EXTERNAL FUNCTION

    (SETF THREAD-CORE-MASK)

    • MASK
    • THREAD

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    THREAD-PRIORITY

    • THREAD

    Source

    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

  • EXTERNAL FUNCTION

    (SETF THREAD-PRIORITY)

    • THREAD
    • PRIORITY

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    THREAD-TIME

    • THREAD

    Source

    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