File: test_sys.py

package info (click to toggle)
drgn 0.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 7,852 kB
  • sloc: python: 74,992; ansic: 54,589; awk: 423; makefile: 351; sh: 99
file content (409 lines) | stat: -rw-r--r-- 14,815 bytes parent folder | download
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
# Copyright (c) Meta Platforms, Inc. and affiliates.
# SPDX-License-Identifier: LGPL-2.1-or-later

import contextlib
import ctypes
import gzip
import mmap
import os
from pathlib import Path
import re
import unittest

from _drgn_util.platform import NORMALIZED_MACHINE_NAME
from drgn import Object, Symbol
from tests.linux_kernel import (
    IOCB_CMD_PREAD,
    IOCB_CMD_PWRITE,
    io_destroy,
    io_setup,
    io_submit,
    iocb,
    possible_cpus,
    skip_unless_have_test_kmod,
)
from tests.linux_kernel.crash_commands import CrashCommandTestCase
from tests.linux_kernel.helpers.test_irq import proc_irq_smp_affinity_list


class TestSys(CrashCommandTestCase):
    def test_sys(self):
        cmd = self.check_crash_command("sys")
        for field in (
            "KERNEL",
            "DUMPFILE",
            "CPUS",
            "DATE",
            "UPTIME",
            "LOAD AVERAGE",
            "TASKS",
            "NODENAME",
            "RELEASE",
            "VERSION",
            "MACHINE",
            "MEMORY",
        ):
            self.assertRegex(cmd.stdout, rf"(?m)^\s*{field}:")

        for variable in (
            "kernel",
            "taints",
            "dumpfile",
            "cpus",
            "offline_cpus",
            "timestamp",
            "uptime_",
            "load_average",
            "num_tasks",
            "nodename",
            "release",
            "version",
            "machine",
            "memory",
        ):
            self.assertIn(variable, cmd.drgn_option.globals)

    def test_sys_config(self):
        try:
            with gzip.open("/proc/config.gz", "rt") as f:
                expected = f.read()
        except FileNotFoundError:
            self.skipTest("kernel not built with CONFIG_IKCONFIG_PROC")

        cmd = self.check_crash_command("sys config")
        self.assertEqual(cmd.stdout, expected)
        self.assertIn("kconfig", cmd.drgn_option.globals)


class TestDev(CrashCommandTestCase):
    def test_no_args(self):
        cmd = self.check_crash_command("dev")
        with open("/proc/devices", "r") as f:
            for line in f:
                if line.isspace() or line in (
                    "Character devices:\n",
                    "Block devices:\n",
                ):
                    continue
                match = re.fullmatch(r"\s*([0-9]+)\s+(.*)\n", line)
                self.assertRegex(
                    cmd.stdout, rf"(?m)^\s*{match.group(1)}\s+{match.group(2)}"
                )

        for variable in ("cdev", "operations", "disk"):
            with self.subTest(variable=variable):
                self.assertIsInstance(cmd.drgn_option.globals[variable], Object)
        self.assertIn("major", cmd.drgn_option.globals)

    def test_ioports(self):
        cmd = self.check_crash_command("dev -i")
        lines = iter(cmd.stdout.splitlines())
        # Skip the header and root resource.
        next(lines)
        next(lines)
        with open("/proc/ioports", "r") as f:
            for output_line, file_line in zip(lines, f):
                output_match = re.fullmatch(
                    r"\s*[0-9a-f]+\s+([0-9a-f]+)-([0-9a-f]+)\s+(.*)", output_line
                )
                file_match = re.fullmatch(
                    r"\s*([0-9a-f]+)-([0-9a-f]+)\s*:\s*(.*)\n", file_line
                )
                self.assertEqual(
                    (
                        int(output_match.group(1), 16),
                        int(output_match.group(2), 16),
                        output_match.group(3),
                    ),
                    (
                        int(file_match.group(1), 16),
                        int(file_match.group(2), 16),
                        file_match.group(3),
                    ),
                )

        for variable in ("resource", "start", "end", "name"):
            with self.subTest(variable=variable):
                self.assertIsInstance(cmd.drgn_option.globals[variable], Object)

    def test_pci(self):
        cmd = self.check_crash_command("dev -p")
        for path in Path("/sys/bus/pci/devices").iterdir():
            self.assertIn(path.name, cmd.stdout)

        self.assertIsInstance(cmd.drgn_option.globals["root_bus"], Object)
        self.assertIsInstance(cmd.drgn_option.globals["busname"], str)
        # Everything else is a local variable in a recursive function.

    @skip_unless_have_test_kmod
    def test_disks(self):
        cmd_d_while_idle = self.check_crash_command("dev -d", mode="capture")
        cmd_D_while_idle = self.check_crash_command("dev -D", mode="capture")

        with contextlib.ExitStack() as exit_stack:
            fd = os.open("/dev/drgntestb0", os.O_RDWR | os.O_DIRECT)
            exit_stack.callback(os.close, fd)

            major = os.major(os.fstat(fd).st_rdev)

            map = exit_stack.enter_context(
                mmap.mmap(-1, 2 * mmap.PAGESIZE, mmap.MAP_PRIVATE)
            )

            iocbs = (iocb * 2)()
            iocbs[0].aio_lio_opcode = IOCB_CMD_PWRITE
            iocbs[0].aio_fildes = fd
            iocbs[0].aio_buf = ctypes.addressof(ctypes.c_char.from_buffer(map))
            iocbs[0].aio_nbytes = mmap.PAGESIZE
            iocbs[0].aio_offset = mmap.PAGESIZE

            iocbs[1].aio_lio_opcode = IOCB_CMD_PREAD
            iocbs[1].aio_fildes = fd
            iocbs[1].aio_buf = ctypes.addressof(
                ctypes.c_char.from_buffer(map, mmap.PAGESIZE)
            )
            iocbs[1].aio_nbytes = mmap.PAGESIZE
            iocbs[1].aio_offset = 3 * mmap.PAGESIZE

            ctx_id = io_setup(len(iocbs))
            exit_stack.callback(io_destroy, ctx_id)

            truant = Path("/sys/block/drgntestb0/truant")
            truant.write_text("1\n")
            exit_stack.callback(truant.write_text, "0\n")

            io_submit(ctx_id, iocbs)

            cmd_d_while_busy = self.check_crash_command("dev -d")
            cmd_D_while_busy = self.check_crash_command("dev -D", mode="capture")

        self.assertIn("drgntestb0", cmd_d_while_idle.stdout)
        self.assertNotIn("drgntestb0", cmd_D_while_idle.stdout)
        for cmd in (cmd_d_while_busy, cmd_D_while_busy):
            self.assertRegex(
                cmd.stdout,
                rf"(?m)^\s*{major}\s+[0-9a-f]+\s+drgntestb0\s+[0-9a-f]+\s+2\s+1\s+1\s*$",
            )

        for cmd in (cmd_d_while_idle, cmd_D_while_idle, cmd_D_while_busy):
            self.assertEqual(
                cmd.drgn_option.stdout, cmd_d_while_busy.drgn_option.stdout
            )

        cmd = cmd_d_while_busy
        for variable in ("disk", "major", "queue"):
            with self.subTest(variable=variable):
                self.assertIsInstance(cmd.drgn_option.globals[variable], Object)
        self.assertIsInstance(cmd.drgn_option.globals["name"], bytes)
        for variable in ("read", "write", "total"):
            with self.subTest(variable=variable):
                self.assertIsInstance(cmd.drgn_option.globals[variable], int)


def nr_irqs():
    with open("/proc/stat", "r") as f:
        for line in f:
            if line.startswith("intr "):
                return len(line.split()) - 2


def nr_softirqs():
    with open("/proc/stat", "r") as f:
        for line in f:
            if line.startswith("softirq "):
                return len(line.split()) - 2


class TestIrq(CrashCommandTestCase):
    def _test_irq_common(self, cmd):
        for path in Path("/sys/kernel/irq").iterdir():
            expected = (path / "actions").read_text().rstrip("\n")
            if expected:
                irq = int(path.name)
                break
        else:
            self.skipTest("IRQ with action not found")

        action = expected.partition(",")[0]
        self.assertRegex(cmd.stdout, rf'(?m)^\s*{irq}.*"{re.escape(action)}"')

        self.assertIn("for_each_irq_desc()", cmd.drgn_option.stdout)
        self.assertIsInstance(cmd.drgn_option.globals["irq"], int)
        for variable in ("irq_desc", "action", "name"):
            with self.subTest(variable=variable):
                self.assertIsInstance(cmd.drgn_option.globals[variable], Object)

    def test_irq(self):
        cmd = self.check_crash_command("irq")

        irqs = [int(x) for x in re.findall(r"^\s*([0-9]+)", cmd.stdout, flags=re.M)]
        self.assertEqual(irqs, list(range(nr_irqs())))

        self._test_irq_common(cmd)

    def test_used(self):
        cmd = self.check_crash_command("irq -u")

        irqs = [int(x) for x in re.findall(r"^\s*([0-9]+)", cmd.stdout, flags=re.M)]
        expected = [int(path.name) for path in Path("/sys/kernel/irq").iterdir()]
        expected.sort()
        self.assertEqual(irqs, expected)

        self._test_irq_common(cmd)

    def test_number(self):
        numbers = []
        for path in Path("/sys/kernel/irq").iterdir():
            numbers.append(int(path.name))
            if len(numbers) >= 2:
                break
        numbers.reverse()

        cmd = self.check_crash_command(f"irq {' '.join([str(x) for x in numbers])}")

        irqs = [int(x) for x in re.findall(r"^\s*([0-9]+)", cmd.stdout, flags=re.M)]
        self.assertEqual(irqs, numbers)

        self.assertIn("irq_to_desc(", cmd.drgn_option.stdout)
        self.assertIsInstance(cmd.drgn_option.globals["irq"], int)
        # Omit "name" since the IRQs we chose may not have any actions with
        # names.
        for variable in ("irq_desc", "action"):
            with self.subTest(variable=variable):
                self.assertIsInstance(cmd.drgn_option.globals[variable], Object)

    def test_invalid_number(self):
        number = nr_irqs()
        # The drgn code would fault on a NULL irq_desc, so just compile it.
        cmd = self.check_crash_command(f"irq {number}", mode="compile")
        self.assertEqual(cmd.stdout, f"irq: invalid IRQ number: {number}\n")

    @unittest.skipUnless(NORMALIZED_MACHINE_NAME == "x86_64", "machine is not x86_64")
    def test_idt(self):
        cmd = self.check_crash_command("irq -d")

        vecs = [int(x) for x in re.findall(r"^\s*\[([0-9]+)\]", cmd.stdout, flags=re.M)]
        self.assertEqual(vecs, list(range(256)))

        self.assertRegex(cmd.stdout, r"(?m)^\s*\[3\] .*int3")

        self.assertIsInstance(cmd.drgn_option.globals["vec"], int)
        for variable in ("gate", "func"):
            with self.subTest(variable=variable):
                self.assertIsInstance(cmd.drgn_option.globals[variable], Object)
        self.assertIsInstance(cmd.drgn_option.globals["sym"], Symbol)

    def test_softirqs(self):
        cmd = self.check_crash_command("irq -b")

        vecs = [int(x) for x in re.findall(r"^\s*\[([0-9]+)\]", cmd.stdout, flags=re.M)]
        self.assertEqual(vecs, list(range(nr_softirqs())))

        self.assertRegex(cmd.stdout, r"(?m)^\s*\[[0-9]+\] .*<\w+\>\s*$")

        self.assertIsInstance(cmd.drgn_option.globals["vec"], int)
        self.assertIsInstance(cmd.drgn_option.globals["action"], Object)
        self.assertIsInstance(cmd.drgn_option.globals["sym"], Symbol)

    def test_affinity(self):
        cmd = self.check_crash_command("irq -a")

        proc_path = Path("/proc/irq")
        expected = [
            (
                int(path.name),
                proc_irq_smp_affinity_list(proc_path / path.name).rstrip("\n"),
            )
            for path in Path("/sys/kernel/irq").iterdir()
            if (path / "actions").read_text().rstrip("\n")
        ]
        expected.sort()
        actual = [
            (int(irq), affinity)
            for irq, affinity in re.findall(
                r"^\s*([0-9]+).*\s(\S+)\s*$", cmd.stdout, flags=re.M
            )
        ]
        self.assertEqual(actual, expected)

        self.assertIsInstance(cmd.drgn_option.globals["irq"], int)
        for variable in ("irq_desc", "affinity"):
            with self.subTest(variable=variable):
                self.assertIsInstance(cmd.drgn_option.globals[variable], Object)
        self.assertIsInstance(cmd.drgn_option.globals["names"], list)
        self.assertIsInstance(cmd.drgn_option.globals["affinity_list"], str)

    def test_stats(self):
        cmd = self.check_crash_command("irq -s")

        expected = [
            int(path.name)
            for path in Path("/sys/kernel/irq").iterdir()
            if (path / "actions").read_text().rstrip("\n")
        ]
        expected.sort()
        num_possible_cpus = len(possible_cpus())
        actual = [
            int(irq)
            for irq in re.findall(
                rf"^\s*([0-9]+):(?:\s+[0-9]+){{{num_possible_cpus}}}",
                cmd.stdout,
                flags=re.M,
            )
        ]
        self.assertEqual(actual, expected)

        self.assertIsInstance(cmd.drgn_option.globals["irq"], int)
        self.assertIsInstance(cmd.drgn_option.globals["irq_desc"], Object)
        self.assertIsInstance(cmd.drgn_option.globals["names"], list)
        self.assertIn("chip_name", cmd.drgn_option.globals)
        self.assertIsInstance(cmd.drgn_option.globals["count"], int)

    def test_stats_cpu(self):
        cpu = max(possible_cpus())
        cmd = self.check_crash_command(f"irq -s -c {cpu}")

        expected = [
            int(path.name)
            for path in Path("/sys/kernel/irq").iterdir()
            if (path / "actions").read_text().rstrip("\n")
        ]
        expected.sort()
        actual = [
            int(irq)
            for irq in re.findall(r"^\s*([0-9]+):\s+[0-9]+", cmd.stdout, flags=re.M)
        ]
        self.assertEqual(actual, expected)

        self.assertEqual(cmd.drgn_option.globals["cpu"], cpu)
        self.assertIsInstance(cmd.drgn_option.globals["irq"], int)
        self.assertIsInstance(cmd.drgn_option.globals["irq_desc"], Object)
        self.assertIsInstance(cmd.drgn_option.globals["names"], list)
        self.assertIn("chip_name", cmd.drgn_option.globals)
        self.assertIsInstance(cmd.drgn_option.globals["count"], int)


class TestLog(CrashCommandTestCase):
    def test_no_args(self):
        cmd = self.check_crash_command("log")

        self.assertRegex(cmd.stdout, r"^\[\s*[0-9]+\.[0-9]+\] .")

        self.assertIn("get_dmesg()", cmd.drgn_option.stdout)
        self.assertIsInstance(cmd.drgn_option.globals["dmesg"], bytes)

    def test_t(self):
        cmd = self.check_crash_command("log -t")

        self.assertRegex(cmd.stdout, r"^[^[]")

        self.assertIn("get_dmesg(timestamps=False)", cmd.drgn_option.stdout)
        self.assertIsInstance(cmd.drgn_option.globals["dmesg"], bytes)

    def test_T(self):
        cmd = self.check_crash_command("log -T")

        self.assertRegex(cmd.stdout, r"^\[[A-Z]")

        self.assertIn('get_dmesg(timestamps="human")', cmd.drgn_option.stdout)
        self.assertIsInstance(cmd.drgn_option.globals["dmesg"], bytes)