summaryrefslogtreecommitdiff
path: root/python/vyos/utils/system.py
blob: fca93d1188489e28d882d593aa7fb410f7832851 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Copyright 2023-2024 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library.  If not, see <http://www.gnu.org/licenses/>.

import os
from subprocess import run

def sysctl_read(name: str) -> str:
    """Read and return current value of sysctl() option

    Args:
        name (str): sysctl key name

    Returns:
        str: sysctl key value
    """
    tmp = run(['sysctl', '-nb', name], capture_output=True)
    return tmp.stdout.decode()

def sysctl_write(name: str, value: str | int) -> bool:
    """Change value via sysctl()

    Args:
        name (str): sysctl key name
        value (str | int): sysctl key value

    Returns:
        bool: True if changed, False otherwise
    """
    # convert other types to string before comparison
    if not isinstance(value, str):
        value = str(value)
    # do not change anything if a value is already configured
    if sysctl_read(name) == value:
        return True
    # return False if sysctl call failed
    if run(['sysctl', '-wq', f'{name}={value}']).returncode != 0:
        return False
    # compare old and new values
    # sysctl may apply value, but its actual value will be
    # different from requested
    if sysctl_read(name) == value:
        return True
    # False in other cases
    return False

def sysctl_apply(sysctl_dict: dict[str, str], revert: bool = True) -> bool:
    """Apply sysctl values.

    Args:
        sysctl_dict (dict[str, str]): dictionary with sysctl keys with values
        revert (bool, optional): Revert to original values if new were not
        applied. Defaults to True.

    Returns:
        bool: True if all params configured properly, False in other cases
    """
    # get current values
    sysctl_original: dict[str, str] = {}
    for key_name in sysctl_dict.keys():
        sysctl_original[key_name] = sysctl_read(key_name)
    # apply new values and revert in case one of them was not applied
    for key_name, value in sysctl_dict.items():
        if not sysctl_write(key_name, value):
            if revert:
                sysctl_apply(sysctl_original, revert=False)
            return False
    # everything applied
    return True

def find_device_file(device):
    """ Recurively search /dev for the given device file and return its full path.
        If no device file was found 'None' is returned """
    from fnmatch import fnmatch

    for root, dirs, files in os.walk('/dev'):
        for basename in files:
            if fnmatch(basename, device):
                return os.path.join(root, basename)

    return None

def load_as_module(name: str, path: str):
    import importlib.util

    spec = importlib.util.spec_from_file_location(name, path)
    mod = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(mod)
    return mod

def load_as_module_source(name: str, path: str):
    """ Necessary modification of load_as_module for files without *.py
    extension """
    import importlib.util
    from importlib.machinery import SourceFileLoader

    loader = SourceFileLoader(name, path)
    spec = importlib.util.spec_from_loader(name, loader)
    mod = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(mod)
    return mod

def get_uptime_seconds():
    """ Returns system uptime in seconds """
    from re import search
    from vyos.utils.file import read_file

    data = read_file("/proc/uptime")
    seconds = search(r"([0-9\.]+)\s", data).group(1)
    res  = int(float(seconds))

    return res

def get_load_averages():
    """ Returns load averages for 1, 5, and 15 minutes as a dict """
    from re import search
    from vyos.utils.file import read_file
    from vyos.utils.cpu import get_core_count

    data = read_file("/proc/loadavg")
    matches = search(r"\s*(?P<one>[0-9\.]+)\s+(?P<five>[0-9\.]+)\s+(?P<fifteen>[0-9\.]+)\s*", data)

    core_count = get_core_count()

    res = {}
    res[1]  = float(matches["one"]) / core_count
    res[5]  = float(matches["five"]) / core_count
    res[15] = float(matches["fifteen"]) / core_count

    return res