| 1 |
# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 |
# SPDX-License-Identifier: LGPL-2.1-or-later |
| 3 |
|
| 4 |
import os |
| 5 |
import re |
| 6 |
import shutil |
| 7 |
import unittest.mock |
| 8 |
|
| 9 |
from drgn import Object |
| 10 |
from drgn.commands import CommandArgumentError, CommandError |
| 11 |
from drgn.commands._crash.common import crash_get_context |
| 12 |
from drgn.helpers.linux.pid import find_task |
| 13 |
from tests.linux_kernel.crash_commands import CrashCommandTestCase |
| 14 |
|
| 15 |
|
| 16 |
class TestSet(CrashCommandTestCase): |
| 17 |
def test_no_options(self): |
| 18 |
cmd = self.check_crash_command("set") |
| 19 |
self.assertIn("CPU:", cmd.stdout) |
| 20 |
for name in "task", "pid", "comm", "thread_info", "cpu", "state": |
| 21 |
self.assertIn(name, cmd.drgn_option.globals) |
| 22 |
|
| 23 |
def test_pid(self): |
| 24 |
cmd = self.check_crash_command("set 1") |
| 25 |
self.assertIn("PID: 1", cmd.stdout) |
| 26 |
self.assertEqual(crash_get_context(self.prog).pid.value_(), 1) |
| 27 |
self.assertEqual(cmd.drgn_option.globals["task"].pid, 1) |
| 28 |
|
| 29 |
def test_task(self): |
| 30 |
cmd = self.check_crash_command(f"set {hex(self.prog['init_task'].address_)}") |
| 31 |
self.assertIn("PID: 0", cmd.stdout) |
| 32 |
self.assertEqual( |
| 33 |
crash_get_context(self.prog), self.prog["init_task"].address_of_() |
| 34 |
) |
| 35 |
self.assertEqual( |
| 36 |
cmd.drgn_option.globals["task"], self.prog["init_task"].address_of_() |
| 37 |
) |
| 38 |
|
| 39 |
def test_cpu(self): |
| 40 |
cpu = os.cpu_count() - 1 |
| 41 |
old_affinity = os.sched_getaffinity(0) |
| 42 |
os.sched_setaffinity(0, (cpu,)) |
| 43 |
try: |
| 44 |
cmd = self.check_crash_command(f"set -c {cpu}") |
| 45 |
finally: |
| 46 |
os.sched_setaffinity(0, old_affinity) |
| 47 |
self.assertIn(f"PID: {os.getpid()}", cmd.stdout) |
| 48 |
task = find_task(self.prog, os.getpid()) |
| 49 |
self.assertEqual(crash_get_context(self.prog), task) |
| 50 |
self.assertEqual(cmd.drgn_option.globals["task"], task) |
| 51 |
|
| 52 |
def test_panic(self): |
| 53 |
cmd = self.check_crash_command("set -p") |
| 54 |
task = find_task(self.prog, os.getpid()) |
| 55 |
self.assertIn(f"PID: {os.getpid()}", cmd.stdout) |
| 56 |
self.assertEqual( |
| 57 |
crash_get_context(self.prog), find_task(self.prog, os.getpid()) |
| 58 |
) |
| 59 |
self.assertEqual(cmd.drgn_option.globals["task"], task) |
| 60 |
|
| 61 |
def test_foreach(self): |
| 62 |
self.run_crash_command(f"set {hex(self.prog['init_task'].address_)}") |
| 63 |
cmd = self.check_crash_command(f"foreach 1 {os.getpid()} set") |
| 64 |
# Task information gets printed twice (once in the header and once in |
| 65 |
# the sys format). |
| 66 |
self.assertEqual(len(re.findall(r"\bPID: 1\b", cmd.stdout)), 2) |
| 67 |
self.assertEqual(len(re.findall(rf"\bPID: {os.getpid()}\b", cmd.stdout)), 2) |
| 68 |
# foreach set shouldn't change the context. |
| 69 |
self.assertEqual( |
| 70 |
crash_get_context(self.prog), self.prog["init_task"].address_of_() |
| 71 |
) |
| 72 |
|
| 73 |
for variable in ("task", "pid", "comm", "thread_info"): |
| 74 |
with self.subTest(variable=variable): |
| 75 |
self.assertIsInstance(cmd.drgn_option.globals[variable], Object) |
| 76 |
self.assertIsInstance(cmd.drgn_option.globals["cpu"], int) |
| 77 |
self.assertIsInstance(cmd.drgn_option.globals["state"], str) |
| 78 |
|
| 79 |
def test_scroll_on_off(self): |
| 80 |
try: |
| 81 |
old_crash_scroll = self.prog.config["crash_scroll"] |
| 82 |
except KeyError: |
| 83 |
self.addCleanup(self.prog.config.pop, "crash_scroll", None) |
| 84 |
else: |
| 85 |
self.addCleanup( |
| 86 |
self.prog.config.__setitem__, "crash_scroll", old_crash_scroll |
| 87 |
) |
| 88 |
|
| 89 |
cmd = self.run_crash_command("set scroll on") |
| 90 |
self.assertIn("scroll: on", cmd.stdout) |
| 91 |
cmd = self.run_crash_command("set scroll") |
| 92 |
self.assertIn("scroll: on", cmd.stdout) |
| 93 |
|
| 94 |
cmd = self.run_crash_command("set scroll off") |
| 95 |
self.assertIn("scroll: off", cmd.stdout) |
| 96 |
cmd = self.run_crash_command("set scroll") |
| 97 |
self.assertIn("scroll: off", cmd.stdout) |
| 98 |
|
| 99 |
def test_scroll_less_more(self): |
| 100 |
try: |
| 101 |
old_crash_pager = self.prog.config["crash_pager"] |
| 102 |
except KeyError: |
| 103 |
self.addCleanup(self.prog.config.pop, "crash_pager", None) |
| 104 |
else: |
| 105 |
self.addCleanup( |
| 106 |
self.prog.config.__setitem__, "crash_pager", old_crash_pager |
| 107 |
) |
| 108 |
|
| 109 |
def only_less(cmd): |
| 110 |
if cmd == "less": |
| 111 |
return "/usr/bin/less" |
| 112 |
elif cmd == "more": |
| 113 |
return None |
| 114 |
else: |
| 115 |
return unittest.mock.DEFAULT |
| 116 |
|
| 117 |
with unittest.mock.patch( |
| 118 |
"shutil.which", side_effect=only_less, wraps=shutil.which |
| 119 |
): |
| 120 |
self.prog.config.pop("crash_pager", None) |
| 121 |
cmd = self.run_crash_command("set scroll") |
| 122 |
self.assertIn("/usr/bin/less", cmd.stdout) |
| 123 |
|
| 124 |
cmd = self.run_crash_command("set scroll less") |
| 125 |
self.assertIn("/usr/bin/less", cmd.stdout) |
| 126 |
cmd = self.run_crash_command("set scroll") |
| 127 |
self.assertIn("/usr/bin/less", cmd.stdout) |
| 128 |
|
| 129 |
with self.assertRaisesRegex(CommandError, "pager not found"): |
| 130 |
self.run_crash_command("set scroll more") |
| 131 |
|
| 132 |
def only_more(cmd): |
| 133 |
if cmd == "less": |
| 134 |
return None |
| 135 |
elif cmd == "more": |
| 136 |
return "/bin/more" |
| 137 |
else: |
| 138 |
return unittest.mock.DEFAULT |
| 139 |
|
| 140 |
with unittest.mock.patch( |
| 141 |
"shutil.which", side_effect=only_more, wraps=shutil.which |
| 142 |
): |
| 143 |
self.prog.config.pop("crash_pager", None) |
| 144 |
cmd = self.run_crash_command("set scroll") |
| 145 |
self.assertIn("/bin/more", cmd.stdout) |
| 146 |
|
| 147 |
cmd = self.run_crash_command("set scroll more") |
| 148 |
self.assertIn("/bin/more", cmd.stdout) |
| 149 |
cmd = self.run_crash_command("set scroll") |
| 150 |
self.assertIn("/bin/more", cmd.stdout) |
| 151 |
|
| 152 |
with self.assertRaisesRegex(CommandError, "pager not found"): |
| 153 |
self.run_crash_command("set scroll less") |
| 154 |
|
| 155 |
def neither(cmd): |
| 156 |
if cmd == "less" or cmd == "more": |
| 157 |
return None |
| 158 |
else: |
| 159 |
return unittest.mock.DEFAULT |
| 160 |
|
| 161 |
with unittest.mock.patch( |
| 162 |
"shutil.which", side_effect=neither, wraps=shutil.which |
| 163 |
): |
| 164 |
self.prog.config.pop("crash_pager", None) |
| 165 |
cmd = self.run_crash_command("set scroll") |
| 166 |
self.assertIn("scroll: off (pager not found)", cmd.stdout) |
| 167 |
|
| 168 |
with self.assertRaisesRegex(CommandError, "pager not found"): |
| 169 |
self.run_crash_command("set scroll less") |
| 170 |
with self.assertRaisesRegex(CommandError, "pager not found"): |
| 171 |
self.run_crash_command("set scroll more") |
| 172 |
|
| 173 |
def test_radix(self): |
| 174 |
self.addCleanup(self.prog.config.pop, "crash_radix", None) |
| 175 |
|
| 176 |
cmd = self.run_crash_command("set radix 10") |
| 177 |
self.assertIn("output radix: 10 (decimal)", cmd.stdout) |
| 178 |
cmd = self.run_crash_command("set radix") |
| 179 |
self.assertIn("output radix: 10 (decimal)", cmd.stdout) |
| 180 |
|
| 181 |
cmd = self.run_crash_command("set radix 16") |
| 182 |
self.assertIn("output radix: 16 (hex)", cmd.stdout) |
| 183 |
cmd = self.run_crash_command("set radix") |
| 184 |
self.assertIn("output radix: 16 (hex)", cmd.stdout) |
| 185 |
|
| 186 |
def test_radix_invalid(self): |
| 187 |
self.assertRaisesRegex( |
| 188 |
CommandArgumentError, |
| 189 |
"invalid value for radix", |
| 190 |
self.run_crash_command, |
| 191 |
"set radix 0", |
| 192 |
) |
| 193 |
self.assertRaisesRegex( |
| 194 |
CommandArgumentError, |
| 195 |
"invalid value for radix", |
| 196 |
self.run_crash_command, |
| 197 |
"set radix sixty", |
| 198 |
) |