Source code for xonsh.xoreutils.uptime

Provides a cross-platform way to figure out the system uptime.

Should work on damned near any operating system you can realistically expect
to be asked to write Python code for.
If this module is invoked as a stand-alone script, it will print the current
uptime in a human-readable format, or display an error message if it can't,
to standard output.

This file was forked from the uptime project:
Copyright (c) 2012, Koen Crolla, All rights reserved.
import contextlib
import ctypes
import functools
import os
import struct
import sys
import time

import xonsh.lazyimps as xlimps
import xonsh.platform as xp

def _boot_time_osx() -> "float|None":
    """Returns the uptime on mac / darwin."""
    bt = xlimps.macutils.sysctlbyname(b"kern.boottime", return_str=False)
    if len(bt) == 4:
        bt = struct.unpack_from("@hh", bt)
    elif len(bt) == 8:
        bt = struct.unpack_from("@ii", bt)
    elif len(bt) == 16:
        bt = struct.unpack_from("@qq", bt)
        raise ValueError("length of boot time not understood: " + repr(bt))
    bt = bt[0] + bt[1] * 1e-6
    if bt == 0.0:
        return None
    return bt

def _boot_time_linux() -> "float|None":
    """A way to figure out the boot time directly on Linux."""
    # from the answer here -
    bt_flag = getattr(time, "CLOCK_BOOTTIME", None)
    if bt_flag is not None:
        return time.clock_gettime(bt_flag)
        with open("/proc/stat") as f:
            for line in f:
                if line.startswith("btime"):
                    return float(line.split()[1])
    except (OSError, IndexError):
        return None

def _boot_time_amiga() -> "float|None":
    """Returns uptime in seconds or None, on AmigaOS."""
        return os.stat("RAM:").st_ctime
    except (NameError, OSError):
        return None

def _boot_time_beos() -> "float|None":
    """Returns uptime in seconds on None, on BeOS/Haiku."""
    if not hasattr(xp.LIBC, "system_time"):
        return None
    xp.LIBC.system_time.restype = ctypes.c_int64
    return time.time() - (xp.LIBC.system_time() / 1000000.0)

def _boot_time_bsd() -> "float|None":
    """Returns uptime in seconds or None, on BSD (including OS X)."""
    with contextlib.suppress(Exception):
        ut_flag = getattr(time, "CLOCK_UPTIME", None)
        if ut_flag is not None:
            ut = time.clock_gettime(ut_flag)
            return time.time() - ut

    if not hasattr(xp.LIBC, "sysctlbyname"):
        # Not BSD.
        return None
    # Determine how much space we need for the response.
    sz = ctypes.c_uint(0)
    xp.LIBC.sysctlbyname(b"kern.boottime", None, ctypes.byref(sz), None, 0)
    if sz.value != struct.calcsize("@LL"):
        # Unexpected, let's give up.
        return None
    # For real now.
    buf = ctypes.create_string_buffer(sz.value)
    xp.LIBC.sysctlbyname(b"kern.boottime", buf, ctypes.byref(sz), None, 0)
    sec, usec = struct.unpack_from("@LL", buf.raw)
    # OS X disagrees what that second value is.
    if usec > 1000000:
        usec = 0.0
    return sec + usec / 1000000.0

def _boot_time_minix():
    """Returns uptime in seconds or None, on MINIX."""
        with open("/proc/uptime") as f:
            up = float(
        return time.time() - up
    except (OSError, ValueError):
        return None

def _boot_time_plan9():
    """Returns uptime in seconds or None, on Plan 9."""
    # Apparently Plan 9 only has Python 2.2, which I'm not prepared to
    # support. Maybe some Linuxes implement /dev/time, though, someone was
    # talking about it somewhere.
        # The time file holds one 32-bit number representing the sec-
        # onds since start of epoch and three 64-bit numbers, repre-
        # senting nanoseconds since start of epoch, clock ticks, and
        # clock frequency.
        #  -- cons(3)
        with open("/dev/time") as f:
            s, ns, ct, cf =
        return time.time() - (float(ct) / float(cf))
    except (OSError, ValueError):
        return None

def _boot_time_solaris():
    """Returns uptime in seconds or None, on Solaris."""
        kstat = ctypes.CDLL("")
    except (AttributeError, OSError):
        return None

    _BOOTTIME = None
    # kstat doesn't have uptime, but it does have boot time.
    # Unfortunately, getting at it isn't perfectly straightforward.
    # First, let's pretend to be kstat.h

    # Constant
    KSTAT_STRLEN = 31  # According to every kstat.h I could find.

    # Data structures
    class anon_union(ctypes.Union):
        # The ``value'' union in kstat_named_t actually has a bunch more
        # members, but we're only using it for boot_time, so we only need
        # the padding and the one we're actually using.
        _fields_ = [("c", ctypes.c_char * 16), ("time", ctypes.c_int)]

    class kstat_named_t(ctypes.Structure):
        _fields_ = [
            ("name", ctypes.c_char * KSTAT_STRLEN),
            ("data_type", ctypes.c_char),
            ("value", anon_union),

    # Function signatures
    kstat.kstat_open.restype = ctypes.c_void_p
    kstat.kstat_lookup.restype = ctypes.c_void_p
    kstat.kstat_lookup.argtypes = [
    kstat.kstat_read.restype = ctypes.c_int
    kstat.kstat_read.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
    kstat.kstat_data_lookup.restype = ctypes.POINTER(kstat_named_t)
    kstat.kstat_data_lookup.argtypes = [ctypes.c_void_p, ctypes.c_char_p]

    # Now, let's do something useful.
    # Initialise kstat control structure.
    kc = kstat.kstat_open()
    if not kc:
        return None
    # We're looking for unix:0:system_misc:boot_time.
    ksp = kstat.kstat_lookup(kc, "unix", 0, "system_misc")
    if ksp and kstat.kstat_read(kc, ksp, None) != -1:
        data = kstat.kstat_data_lookup(ksp, "boot_time")
        if data:
            _BOOTTIME = data.contents.value.time
    # Clean-up.
    return _BOOTTIME

def _boot_time_syllable():
    """Returns uptime in seconds or None, on Syllable."""
        return os.stat("/dev/pty/mst/pty0").st_mtime
    except (NameError, OSError):
        return None

def _boot_time_windows():
    Returns uptime in seconds or None, on Windows. Warning: may return
    incorrect answers after 49.7 days on versions older than Vista.
    uptime = None
    if hasattr(xp.LIBC, "GetTickCount64"):
        # Vista/Server 2008 or later.
        xp.LIBC.GetTickCount64.restype = ctypes.c_uint64
        uptime = xp.LIBC.GetTickCount64() / 1000.0
    if hasattr(xp.LIBC, "GetTickCount"):
        # WinCE and Win2k or later; gives wrong answers after 49.7 days.
        xp.LIBC.GetTickCount.restype = ctypes.c_uint32
        uptime = xp.LIBC.GetTickCount() / 1000.0
    if uptime:
        return time.time() - uptime
    return None

def _boot_time_monotonic():
    if hasattr(time, "CLOCK_MONOTONIC"):
        # this will work on unix systems
        monotime = time.clock_gettime(time.CLOCK_MONOTONIC)
        monotime = time.time()
    return time.time() - monotime

def _get_boot_time_func():
    plat = sys.platform
    if plat.startswith(("amiga", "aros12")):
        return _boot_time_amiga
    if plat.startswith(("beos5", "haiku1")):
        return _boot_time_beos
    if plat.startswith(("cygwin", "linux")):
        # "cygwin", "linux","linux-armv71": "linux2"
        return _boot_time_linux
    if plat.startswith("minix3"):
        return _boot_time_minix
    if plat.startswith("darwin"):
        return _boot_time_osx
    if plat.startswith("sunos5"):
        return _boot_time_solaris
    if plat.startswith("syllable"):
        return _boot_time_syllable

    # tried with all unix stuff
    if plat.startswith("win"):
        return _boot_time_windows

    # fallback
    return _boot_time_monotonic

[docs]def uptime(args): """Returns uptime in seconds if even remotely possible, or None if not.""" bt = boottime() return str(time.time() - bt)
[docs]@functools.lru_cache(None) def boottime() -> "float": """Returns boot time if remotely possible, or None if not.""" func = _get_boot_time_func() btime = func() if btime is None: return _boot_time_monotonic() return btime
[docs]def main(args=None): from xonsh.xoreutils.util import run_alias run_alias("uptime", args)
if __name__ == "__main__": main()