Debian Codegraph @

tests/linux_kernel/helpers/test_sysfs.py

raw
1 # (C) Copyright IBM Corp. 2026
2 # SPDX-License-Identifier: LGPL-2.1-or-later
3
4 import os
5
6 from drgn import NULL
7 from drgn.helpers.linux.sysfs import (
8 kobject_path,
9 sysfs_listdir,
10 sysfs_lookup,
11 sysfs_lookup_kobject,
12 sysfs_lookup_node,
13 )
14 from tests.linux_kernel import LinuxKernelTestCase
15
16
17 class TestSysfs(LinuxKernelTestCase):
18 @classmethod
19 def kernfs_node_from_fd(cls, fd):
20 import os
21
22 from drgn import cast
23 from drgn.helpers.linux.fs import fget
24 from drgn.helpers.linux.pid import find_task
25
26 file = fget(find_task(cls.prog, os.getpid()), fd)
27 return cast("struct kernfs_node *", file.f_inode.i_private)
28
29 def test_sysfs_lookup_node(self):
30 fds = []
31 try:
32 for path in ("/sys", "/sys/kernel", "/sys/kernel/vmcoreinfo"):
33 fds.append(os.open(path, os.O_RDONLY))
34
35 kns = [self.kernfs_node_from_fd(fd) for fd in fds]
36
37 self.assertEqual(sysfs_lookup_node(self.prog, ""), kns[0])
38 self.assertEqual(sysfs_lookup_node(self.prog, "/sys"), kns[0])
39 self.assertEqual(sysfs_lookup_node(self.prog, "/sys/"), kns[0])
40
41 self.assertEqual(sysfs_lookup_node(self.prog, "kernel"), kns[1])
42 self.assertEqual(sysfs_lookup_node(self.prog, "/sys/kernel"), kns[1])
43 self.assertEqual(
44 sysfs_lookup_node(self.prog, "sys/kernel"),
45 NULL(self.prog, "struct kernfs_node *"),
46 )
47
48 self.assertEqual(sysfs_lookup_node(self.prog, "kernel/vmcoreinfo"), kns[2])
49 self.assertEqual(
50 sysfs_lookup_node(self.prog, "/sys/kernel/vmcoreinfo"), kns[2]
51 )
52 self.assertEqual(
53 sysfs_lookup_node(self.prog, "sys/kernel/vmcoreinfo"),
54 NULL(self.prog, "struct kernfs_node *"),
55 )
56
57 self.assertEqual(
58 sysfs_lookup_node(self.prog, "/kernel"),
59 NULL(self.prog, "struct kernfs_node *"),
60 )
61 self.assertEqual(
62 sysfs_lookup_node(self.prog, "kernel/foobar"),
63 NULL(self.prog, "struct kernfs_node *"),
64 )
65
66 finally:
67 for fd in fds:
68 os.close(fd)
69
70 def test_sysfs_lookup_kobject(self):
71 kernel_kobj = self.prog["kernel_kobj"]
72
73 self.assertEqual(
74 sysfs_lookup_kobject(self.prog, ""), NULL(self.prog, "struct kobject *")
75 )
76 self.assertEqual(
77 sysfs_lookup_kobject(self.prog, "/sys"), NULL(self.prog, "struct kobject *")
78 )
79 self.assertEqual(
80 sysfs_lookup_kobject(self.prog, "/sys/"),
81 NULL(self.prog, "struct kobject *"),
82 )
83
84 self.assertEqual(sysfs_lookup_kobject(self.prog, "kernel"), kernel_kobj)
85 self.assertEqual(sysfs_lookup_kobject(self.prog, "/sys/kernel"), kernel_kobj)
86
87 self.assertEqual(
88 sysfs_lookup_kobject(self.prog, "kernel/vmcoreinfo"), kernel_kobj
89 )
90 self.assertEqual(
91 sysfs_lookup_kobject(self.prog, "/sys/kernel/vmcoreinfo"), kernel_kobj
92 )
93
94 self.assertEqual(
95 sysfs_lookup_kobject(self.prog, "kernel"),
96 sysfs_lookup_kobject(self.prog, "kernel/vmcoreinfo"),
97 )
98
99 self.assertEqual(
100 sysfs_lookup_kobject(self.prog, "sys/kernel"),
101 NULL(self.prog, "struct kobject *"),
102 )
103 self.assertEqual(
104 sysfs_lookup_kobject(self.prog, "sys/kernel/vmcoreinfo"),
105 NULL(self.prog, "struct kobject *"),
106 )
107 self.assertEqual(
108 sysfs_lookup_kobject(self.prog, "/"),
109 NULL(self.prog, "struct kobject *"),
110 )
111 self.assertEqual(
112 sysfs_lookup_kobject(self.prog, "/kernel"),
113 NULL(self.prog, "struct kobject *"),
114 )
115 self.assertEqual(
116 sysfs_lookup_kobject(self.prog, "kernel/foobar"),
117 NULL(self.prog, "struct kobject *"),
118 )
119
120 def test_sysfs_lookup(self):
121 kernel_kobj = self.prog["kernel_kobj"]
122
123 self.assertEqual(
124 sysfs_lookup(self.prog, ""), NULL(self.prog, "struct kobject *")
125 )
126 self.assertEqual(
127 sysfs_lookup(self.prog, "/sys"), NULL(self.prog, "struct kobject *")
128 )
129 self.assertEqual(
130 sysfs_lookup(self.prog, "/sys/"), NULL(self.prog, "struct kobject *")
131 )
132
133 self.assertEqual(sysfs_lookup(self.prog, "kernel"), kernel_kobj)
134 self.assertEqual(sysfs_lookup(self.prog, "/sys/kernel"), kernel_kobj)
135
136 self.assertEqual(sysfs_lookup(self.prog, "kernel/vmcoreinfo"), kernel_kobj)
137 self.assertEqual(sysfs_lookup(self.prog, "/sys/kernel/vmcoreinfo"), kernel_kobj)
138
139 self.assertEqual(
140 sysfs_lookup(self.prog, "kernel"),
141 sysfs_lookup(self.prog, "kernel/vmcoreinfo"),
142 )
143
144 self.assertEqual(
145 sysfs_lookup(self.prog, "sys/kernel"),
146 NULL(self.prog, "struct kobject *"),
147 )
148 self.assertEqual(
149 sysfs_lookup(self.prog, "sys/kernel/vmcoreinfo"),
150 NULL(self.prog, "struct kobject *"),
151 )
152 self.assertEqual(
153 sysfs_lookup(self.prog, "/kernel"), NULL(self.prog, "struct kobject *")
154 )
155 self.assertEqual(
156 sysfs_lookup(self.prog, "kernel/foobar"),
157 NULL(self.prog, "struct kobject *"),
158 )
159
160 # Device case
161 if "device_ktype" in self.prog:
162 path = "/sys/block"
163 if os.path.exists(path):
164 with os.scandir(path) as entries:
165 entry = next((e for e in entries if e.is_dir()), None)
166 if entry:
167 dev = sysfs_lookup(self.prog, entry.path[5:])
168 self.assertTrue(dev)
169 self.assertEqual(dev.type_.type_name(), "struct device *")
170
171 # Module case
172 if "module_ktype" in self.prog:
173 path = "/sys/module"
174 if os.path.exists(path):
175 with os.scandir(path) as entries:
176 entry = next((e for e in entries if e.is_dir()), None)
177 if entry:
178 mod = sysfs_lookup(self.prog, entry.path[5:])
179 self.assertTrue(mod)
180 self.assertEqual(
181 mod.type_.type_name(), "struct module_kobject *"
182 )
183
184 # Driver case
185 if "driver_ktype" in self.prog:
186 path = "/sys/bus"
187 if os.path.exists(path):
188 with os.scandir(path) as buses:
189 bus = next((b for b in buses if b.is_dir()), None)
190 if bus:
191 drv_dir = os.path.join(bus.path, "drivers")
192 if os.path.exists(drv_dir):
193 with os.scandir(drv_dir) as drivers:
194 drv = next((d for d in drivers if d.is_dir()), None)
195 if drv:
196 driver = sysfs_lookup(self.prog, drv.path[5:])
197 self.assertTrue(driver)
198 self.assertEqual(
199 driver.type_.type_name(),
200 "struct device_driver *",
201 )
202
203 # Class case
204 if "class_ktype" in self.prog:
205 path = "/sys/class"
206 if os.path.exists(path):
207 with os.scandir(path) as entries:
208 entry = next((e for e in entries if e.is_dir()), None)
209 if entry:
210 cls = sysfs_lookup(self.prog, entry.path[5:])
211 self.assertTrue(cls)
212 self.assertIn("struct class *", cls.type_.type_name())
213
214 # Bus case
215 if "bus_ktype" in self.prog:
216 path = "/sys/bus"
217 if os.path.exists(path):
218 with os.scandir(path) as entries:
219 entry = next((e for e in entries if e.is_dir()), None)
220 if entry:
221 bus = sysfs_lookup(self.prog, entry.path[5:])
222 self.assertTrue(bus)
223 self.assertIn("struct bus_type *", bus.type_.type_name())
224
225 def test_sysfs_listdir(self):
226 expected = os.listdir(b"/sys/kernel")
227
228 self.assertCountEqual(sysfs_listdir(self.prog, "kernel"), expected)
229 self.assertCountEqual(sysfs_listdir(self.prog, "/sys/kernel"), expected)
230
231 self.assertRaisesRegex(
232 ValueError, r": not found$", sysfs_listdir, self.prog, "sys/kernel"
233 )
234 self.assertRaisesRegex(
235 ValueError, r": not found$", sysfs_listdir, self.prog, "kernel/foobar"
236 )
237 self.assertRaisesRegex(
238 ValueError, "not a directory", sysfs_listdir, self.prog, "kernel/vmcoreinfo"
239 )
240
241 def test_kobject_path(self):
242 self.assertEqual(kobject_path(self.prog["kernel_kobj"]), b"/sys/kernel")