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
|
# 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
def check_kmod(k_mod):
""" Common utility function to load required kernel modules on demand """
from vyos import ConfigError
from vyos.utils.process import call
if isinstance(k_mod, str):
k_mod = k_mod.split()
for module in k_mod:
if not os.path.exists(f'/sys/module/{module}'):
if call(f'modprobe {module}') != 0:
raise ConfigError(f'Loading Kernel module {module} failed')
def unload_kmod(k_mod):
""" Common utility function to unload required kernel modules on demand """
from vyos import ConfigError
from vyos.utils.process import call
if isinstance(k_mod, str):
k_mod = k_mod.split()
for module in k_mod:
if os.path.exists(f'/sys/module/{module}'):
if call(f'rmmod {module}') != 0:
raise ConfigError(f'Unloading Kernel module {module} failed')
def list_loaded_modules():
""" Returns the list of currently loaded kernel modules """
from os import listdir
return listdir('/sys/module/')
def get_module_data(module: str):
""" Retrieves information about a module """
from os import listdir
from os.path import isfile, dirname, basename, join
from vyos.utils.file import read_file
def _get_file(path):
# Some files inside some modules are not readable at all,
# we just skip them.
try:
return read_file(path)
except PermissionError:
return None
mod_path = join('/sys/module', module)
mod_data = {"name": module, "fields": {}, "parameters": {}}
for f in listdir(mod_path):
if f in ["sections", "notes", "uevent"]:
# The uevent file is not readable
# and module build info and memory layout
# in notes and sections generally aren't useful
# for anything but kernel debugging.
pass
elif f == "drivers":
# Drivers are dir symlinks,
# we just list them
drivers = listdir(join(mod_path, f))
if drivers:
mod_data["drivers"] = drivers
elif f == "holders":
# Holders (module that use this one)
# are always symlink to other modules.
# We only need the list.
holders = listdir(join(mod_path, f))
if holders:
mod_data["holders"] = holders
elif f == "parameters":
# Many modules keep their configuration
# in the "parameters" subdir.
ppath = join(mod_path, "parameters")
ps = listdir(ppath)
for p in ps:
data = _get_file(join(ppath, p))
if data:
mod_data["parameters"][p] = data
else:
# Everything else...
# There are standard fields like refcount and initstate,
# but many modules also keep custom information or settings
# in top-level fields.
# For now we don't separate well-known and custom fields.
if isfile(join(mod_path, f)):
data = _get_file(join(mod_path, f))
if data:
mod_data["fields"][f] = data
else:
raise RuntimeError(f"Unexpected directory inside module {module}: {f}")
return mod_data
def lsmod():
""" Returns information about all loaded modules.
Like lsmod(8), but more detailed.
"""
mods_data = []
for m in list_loaded_modules():
mods_data.append(get_module_data(m))
return mods_data
|
