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
|
# Copyright (c) Meta Platforms, Inc. and affiliates.
# SPDX-License-Identifier: LGPL-2.1-or-later
import os
import random
import unittest
from _drgn_util.platform import NORMALIZED_MACHINE_NAME
from drgn import FaultError, Object
from drgn.helpers.experimental.kmodify import (
call_function,
pass_pointer,
write_memory,
write_object,
)
from tests.linux_kernel import LinuxKernelTestCase, skip_unless_have_test_kmod
skip_unless_have_kmodify = unittest.skipUnless(
NORMALIZED_MACHINE_NAME == "x86_64",
f"kmodify is not implemented for {NORMALIZED_MACHINE_NAME}",
)
@skip_unless_have_test_kmod
@skip_unless_have_kmodify
class TestCallFunction(LinuxKernelTestCase):
def assert_called(self, name, args, expected_return_value=None):
if expected_return_value is None:
expected_return_value = Object(self.prog, "void")
before = self.prog[f"drgn_kmodify_test_{name}_called"].read_()
return_value = call_function(self.prog["drgn_kmodify_test_" + name], *args)
self.assertEqual(
self.prog[f"drgn_kmodify_test_{name}_called"].read_(),
before + 1,
)
self.assertIdentical(return_value, expected_return_value)
def assert_returns(self, name, expected_return_value):
self.assert_called(name, (), expected_return_value)
def test_void_return(self):
self.assert_returns("void_return", Object(self.prog, "void"))
def test_integer_returns(self):
for name, return_value in (
("signed_char", Object(self.prog, "signed char", -66)),
("unsigned_char", Object(self.prog, "unsigned char", 200)),
("short", Object(self.prog, "short", -666)),
("unsigned_short", Object(self.prog, "unsigned short", 7777)),
("int", Object(self.prog, "int", -12345)),
("unsigned_int", Object(self.prog, "unsigned int", 54321)),
("long", Object(self.prog, "long", -2468013579)),
("unsigned_long", Object(self.prog, "unsigned long", 4000000000)),
("long_long", Object(self.prog, "long long", -9080706050403020100)),
(
"unsigned_long_long",
Object(self.prog, "unsigned long long", 12345678909876543210),
),
):
with self.subTest(name=name):
self.assert_returns(name + "_return", return_value)
def test_integer_args(self):
self.assert_called(
"signed_args",
(
Object(self.prog, "signed char", -66),
Object(self.prog, "short", -666),
Object(self.prog, "int", -12345),
Object(self.prog, "long", -2468013579),
Object(self.prog, "long long", -9080706050403020100),
),
)
self.assert_called(
"unsigned_args",
(
Object(self.prog, "unsigned char", 200),
Object(self.prog, "unsigned short", 7777),
Object(self.prog, "unsigned int", 54321),
Object(self.prog, "unsigned long", 4000000000),
Object(self.prog, "unsigned long long", 12345678909876543210),
),
)
def test_integer_literal_args(self):
self.assert_called(
"signed_args",
(
-66,
-666,
-12345,
-2468013579,
-9080706050403020100,
),
)
self.assert_called(
"unsigned_args",
(
200,
7777,
54321,
4000000000,
12345678909876543210,
),
)
def test_many_args(self):
self.assert_called(
"many_args",
(
48,
-66,
-666,
-12345,
-2468013579,
-9080706050403020100,
200,
7777,
54321,
4000000000,
12345678909876543210,
),
)
def test_enum_returns(self):
self.assert_returns(
"enum_return", Object(self.prog, "enum drgn_kmodify_enum", 2)
)
def test_enum_args(self):
args = (
self.prog["DRGN_KMODIFY_ONE"],
pass_pointer(Object(self.prog, "enum drgn_kmodify_enum", 2)),
)
self.assert_called("enum_args", args)
self.assertIdentical(
args[1].object, Object(self.prog, "enum drgn_kmodify_enum", 3)
)
def test_pointer_returns(self):
self.assert_returns(
"pointer_return", self.prog["drgn_kmodify_test_ptr"].read_()
)
def test_pointer_args(self):
self.assert_called(
"pointer_args", (self.prog["drgn_kmodify_test_ptr"].read_(),)
)
def test_string_args(self):
for msg, f in (
("str", lambda t, s: s),
("bytes", lambda t, s: s.encode()),
(
"array",
lambda t, s: Object(
self.prog,
self.prog.array_type(self.prog.type(t), len(s) + 1),
s.encode(),
),
),
("str pointer", lambda t, s: pass_pointer(s)),
("bytes pointer", lambda t, s: pass_pointer(s.encode())),
(
"array pointer",
lambda t, s: pass_pointer(
Object(
self.prog,
self.prog.array_type(self.prog.type(t), len(s) + 1),
s.encode(),
)
),
),
(
"pointer",
lambda t, s: self.prog[f"drgn_kmodify_test_{t.replace(' ', '_')}_str"],
),
):
with self.subTest(msg):
self.assert_called(
"string_args",
(
f("char", "Hello"),
f("signed char", ", "),
f("unsigned char", "world"),
f("const char", "!"),
),
)
def test_integer_out_params(self):
args = [
pass_pointer(Object(self.prog, "signed char", -66)),
pass_pointer(Object(self.prog, "short", -666)),
pass_pointer(-12345),
pass_pointer(Object(self.prog, "long", -2468013579)),
pass_pointer(Object(self.prog, "long long", -9080706050403020100)),
]
self.assert_called("integer_out_params", args)
self.assertIdentical(
[ptr.object for ptr in args],
[
Object(self.prog, "signed char", 33),
Object(self.prog, "short", 333),
Object(self.prog, "int", 23456),
Object(self.prog, "long", 2222222222),
Object(self.prog, "long long", 9090909090909090909),
],
)
def test_array_out_params(self):
arg = pass_pointer(Object(self.prog, "long [3]", [1, 2, 3]))
self.assert_called("array_out_params", (arg,))
self.assertIdentical(arg.object, Object(self.prog, "long [3]", [2, 3, 5]))
def test_array_out_params_extra(self):
arg = pass_pointer(Object(self.prog, "long [4]", [1, 2, 3, 100]))
self.assert_called("array_out_params", (arg,))
self.assertIdentical(arg.object, Object(self.prog, "long [4]", [2, 3, 5, 100]))
def test_array_out_params_inferred(self):
self.assert_called(
"array_out_params", (Object(self.prog, "long [3]", [1, 2, 3]),)
)
def test_many_out_params(self):
args = [
pass_pointer(Object(self.prog, "char", 48)),
pass_pointer(Object(self.prog, "signed char", -66)),
pass_pointer(Object(self.prog, "short", -666)),
pass_pointer(Object(self.prog, "int", -12345)),
pass_pointer(Object(self.prog, "long", -2468013579)),
pass_pointer(Object(self.prog, "long long", -9080706050403020100)),
pass_pointer(Object(self.prog, "unsigned char", 200)),
pass_pointer(Object(self.prog, "unsigned short", 7777)),
pass_pointer(Object(self.prog, "unsigned int", 54321)),
pass_pointer(Object(self.prog, "unsigned long", 4000000000)),
pass_pointer(Object(self.prog, "unsigned long long", 12345678909876543210)),
]
self.assert_called("many_out_params", args)
self.assertIdentical(
[arg.object for arg in args],
[
Object(self.prog, "char", 16),
Object(self.prog, "signed char", -22),
Object(self.prog, "short", -222),
Object(self.prog, "int", -4115),
Object(self.prog, "long", -822671193),
Object(self.prog, "long long", -3026902016801006700),
Object(self.prog, "unsigned char", 66),
Object(self.prog, "unsigned short", 2592),
Object(self.prog, "unsigned int", 18107),
Object(self.prog, "unsigned long", 1333333333),
Object(self.prog, "unsigned long long", 4115226303292181070),
],
)
@skip_unless_have_test_kmod
@skip_unless_have_kmodify
class TestWriteMemory(LinuxKernelTestCase):
def test_write_memory(self):
buf = os.urandom(16)
write_memory(self.prog, self.prog["drgn_kmodify_test_memory"].address_, buf)
self.assertEqual(
self.prog.read(self.prog["drgn_kmodify_test_memory"].address_, len(buf)),
buf,
)
def test_fault(self):
self.assertRaises(FaultError, write_memory, self.prog, 0, b"asdf")
@skip_unless_have_test_kmod
@skip_unless_have_kmodify
class TestWriteObject(LinuxKernelTestCase):
def test_python_value(self):
value = random.randrange(2**31)
write_object(self.prog["drgn_kmodify_test_int"], value)
self.assertEqual(self.prog["drgn_kmodify_test_int"].value_(), value)
def test_object_value(self):
value = random.randrange(2**31)
write_object(
self.prog["drgn_kmodify_test_int"], Object(self.prog, "long", value)
)
self.assertEqual(self.prog["drgn_kmodify_test_int"].value_(), value)
def test_pointer_dereference(self):
value = random.randrange(2**31)
write_object(
self.prog["drgn_kmodify_test_int"].address_of_(), value, dereference=True
)
self.assertEqual(self.prog["drgn_kmodify_test_int"].value_(), value)
def test_pointer_no_dereference(self):
write_object(
self.prog["drgn_kmodify_test_int_ptr"],
self.prog["drgn_kmodify_test_int"].address_of_(),
dereference=False,
)
self.assertEqual(
self.prog["drgn_kmodify_test_int_ptr"],
self.prog["drgn_kmodify_test_int"].address_of_(),
)
write_object(self.prog["drgn_kmodify_test_int_ptr"], 0, dereference=False)
self.assertEqual(self.prog["drgn_kmodify_test_int_ptr"].value_(), 0)
def test_pointer_ambiguous(self):
self.assertRaisesRegex(
TypeError,
"use dereference",
write_object,
self.prog["drgn_kmodify_test_int_ptr"],
0,
)
def test_not_pointer(self):
self.assertRaisesRegex(
TypeError,
"not a pointer",
write_object,
self.prog["drgn_kmodify_test_int"],
0,
dereference=True,
)
|
