| 1 |
# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 |
# SPDX-License-Identifier: LGPL-2.1-or-later |
| 3 |
|
| 4 |
import contextlib |
| 5 |
import os |
| 6 |
|
| 7 |
from drgn import NULL, cast |
| 8 |
from drgn.helpers.linux.fs import fget |
| 9 |
from drgn.helpers.linux.kernfs import ( |
| 10 |
kernfs_children, |
| 11 |
kernfs_name, |
| 12 |
kernfs_parent, |
| 13 |
kernfs_path, |
| 14 |
kernfs_root, |
| 15 |
kernfs_walk, |
| 16 |
) |
| 17 |
from drgn.helpers.linux.pid import find_task |
| 18 |
from tests.linux_kernel import LinuxKernelTestCase |
| 19 |
|
| 20 |
|
| 21 |
class TestKernfs(LinuxKernelTestCase): |
| 22 |
@classmethod |
| 23 |
def kernfs_node_from_fd(cls, fd): |
| 24 |
file = fget(find_task(cls.prog, os.getpid()), fd) |
| 25 |
return cast("struct kernfs_node *", file.f_inode.i_private) |
| 26 |
|
| 27 |
def test_kernfs_parent(self): |
| 28 |
with contextlib.ExitStack() as exit_stack: |
| 29 |
fd = os.open("/sys/kernel/vmcoreinfo", os.O_RDONLY) |
| 30 |
exit_stack.callback(os.close, fd) |
| 31 |
dfd = os.open("/sys/kernel", os.O_RDONLY) |
| 32 |
exit_stack.callback(os.close, dfd) |
| 33 |
self.assertEqual( |
| 34 |
kernfs_parent(self.kernfs_node_from_fd(fd)), |
| 35 |
self.kernfs_node_from_fd(dfd), |
| 36 |
) |
| 37 |
|
| 38 |
def test_kernfs_root(self): |
| 39 |
# Since Linux kernel commit 6138f3451516, "sysfs_root" is ambiguous. |
| 40 |
# Ensure we resolve the symbol from sysfs (mount.c). |
| 41 |
expected_root = self.prog.object("sysfs_root", filename="mount.c") |
| 42 |
for path in ("/sys", "/sys/kernel", "/sys/kernel/vmcoreinfo"): |
| 43 |
with self.subTest(path=path): |
| 44 |
fd = os.open(path, os.O_RDONLY) |
| 45 |
try: |
| 46 |
self.assertEqual( |
| 47 |
kernfs_root(self.kernfs_node_from_fd(fd)), |
| 48 |
expected_root, |
| 49 |
) |
| 50 |
finally: |
| 51 |
os.close(fd) |
| 52 |
|
| 53 |
def test_kernfs_name(self): |
| 54 |
with open("/sys/kernel/vmcoreinfo", "r") as f: |
| 55 |
kn = self.kernfs_node_from_fd(f.fileno()) |
| 56 |
self.assertEqual(kernfs_name(kn), b"vmcoreinfo") |
| 57 |
|
| 58 |
def test_kernfs_path(self): |
| 59 |
with open("/sys/kernel/vmcoreinfo", "r") as f: |
| 60 |
kn = self.kernfs_node_from_fd(f.fileno()) |
| 61 |
self.assertEqual(kernfs_path(kn), b"/kernel/vmcoreinfo") |
| 62 |
|
| 63 |
def test_kernfs_walk(self): |
| 64 |
fds = [] |
| 65 |
try: |
| 66 |
for path in ("/sys", "/sys/kernel", "/sys/kernel/vmcoreinfo"): |
| 67 |
fds.append(os.open(path, os.O_RDONLY)) |
| 68 |
kns = [self.kernfs_node_from_fd(fd) for fd in fds] |
| 69 |
self.assertEqual(kernfs_walk(kns[0], ""), kns[0]) |
| 70 |
self.assertEqual(kernfs_walk(kns[0], "/"), kns[0]) |
| 71 |
self.assertEqual(kernfs_walk(kns[0], "kernel"), kns[1]) |
| 72 |
self.assertEqual(kernfs_walk(kns[0], "kernel/vmcoreinfo"), kns[2]) |
| 73 |
self.assertEqual( |
| 74 |
kernfs_walk(kns[0], "kernel/foobar"), |
| 75 |
NULL(self.prog, "struct kernfs_node *"), |
| 76 |
) |
| 77 |
self.assertEqual( |
| 78 |
kernfs_walk(kns[0], "kernel/foo/bar"), |
| 79 |
NULL(self.prog, "struct kernfs_node *"), |
| 80 |
) |
| 81 |
finally: |
| 82 |
for fd in fds: |
| 83 |
os.close(fd) |
| 84 |
|
| 85 |
def test_kernfs_walk_follow_symlinks(self): |
| 86 |
fds = [] |
| 87 |
path = "/sys/block" |
| 88 |
if not os.path.exists(path): |
| 89 |
self.skipTest(f"{path} does not exist") |
| 90 |
try: |
| 91 |
fd = os.open(path, os.O_RDONLY) |
| 92 |
fds.append(fd) |
| 93 |
kn = self.kernfs_node_from_fd(fd) |
| 94 |
with os.scandir(path) as entries: |
| 95 |
entry = next((e for e in entries if e.is_symlink()), None) |
| 96 |
if not entry: |
| 97 |
self.skipTest(f"No symlink entries found under {path}") |
| 98 |
sub_path = os.path.join(entry.path, "subsystem") |
| 99 |
fd = os.open(sub_path, os.O_RDONLY) |
| 100 |
fds.append(fd) |
| 101 |
target_kn = self.kernfs_node_from_fd(fd) |
| 102 |
rel_path = os.path.join(entry.name, "subsystem") |
| 103 |
self.assertEqual( |
| 104 |
kernfs_walk(kn, rel_path), |
| 105 |
target_kn, |
| 106 |
) |
| 107 |
self.assertNotEqual( |
| 108 |
kernfs_walk(kn, rel_path, False), |
| 109 |
target_kn, |
| 110 |
) |
| 111 |
finally: |
| 112 |
for fd in fds: |
| 113 |
os.close(fd) |
| 114 |
|
| 115 |
def test_kernfs_children(self): |
| 116 |
path = b"/sys/kernel" |
| 117 |
fd = os.open(path, os.O_RDONLY) |
| 118 |
try: |
| 119 |
parent_dev = os.fstat(fd).st_dev |
| 120 |
kn = self.kernfs_node_from_fd(fd) |
| 121 |
self.assertCountEqual( |
| 122 |
[kernfs_name(child) for child in kernfs_children(kn)], os.listdir(path) |
| 123 |
) |
| 124 |
|
| 125 |
for child in kernfs_children(kn): |
| 126 |
child_fd = os.open( |
| 127 |
b"/sys/" + kernfs_path(child), os.O_PATH | os.O_NOFOLLOW |
| 128 |
) |
| 129 |
try: |
| 130 |
if os.fstat(child_fd).st_dev == parent_dev: |
| 131 |
self.assertEqual(child, self.kernfs_node_from_fd(child_fd)) |
| 132 |
finally: |
| 133 |
os.close(child_fd) |
| 134 |
finally: |
| 135 |
os.close(fd) |
| 136 |
|
| 137 |
# Check that calling kernfs_children() on a non-directory raises an |
| 138 |
# exception |
| 139 |
path = b"/sys/kernel/vmcoreinfo" |
| 140 |
fd = os.open(path, os.O_RDONLY) |
| 141 |
try: |
| 142 |
kn = self.kernfs_node_from_fd(fd) |
| 143 |
with self.assertRaises(ValueError) as context: |
| 144 |
kernfs_children(kn) |
| 145 |
self.assertEqual(str(context.exception), "not a directory") |
| 146 |
finally: |
| 147 |
os.close(fd) |