1875bfd52SKees Cook // SPDX-License-Identifier: GPL-2.0
2875bfd52SKees Cook /*
3875bfd52SKees Cook * Runtime test cases for CONFIG_FORTIFY_SOURCE that aren't expected to
4875bfd52SKees Cook * Oops the kernel on success. (For those, see drivers/misc/lkdtm/fortify.c)
5875bfd52SKees Cook *
6875bfd52SKees Cook * For corner cases with UBSAN, try testing with:
7875bfd52SKees Cook *
8875bfd52SKees Cook * ./tools/testing/kunit/kunit.py run --arch=x86_64 \
9875bfd52SKees Cook * --kconfig_add CONFIG_FORTIFY_SOURCE=y \
10875bfd52SKees Cook * --kconfig_add CONFIG_UBSAN=y \
11875bfd52SKees Cook * --kconfig_add CONFIG_UBSAN_TRAP=y \
12875bfd52SKees Cook * --kconfig_add CONFIG_UBSAN_BOUNDS=y \
13875bfd52SKees Cook * --kconfig_add CONFIG_UBSAN_LOCAL_BOUNDS=y \
14875bfd52SKees Cook * --make_options LLVM=1 fortify
15875bfd52SKees Cook */
16875bfd52SKees Cook #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17875bfd52SKees Cook
18875bfd52SKees Cook #include <kunit/test.h>
19*9124a264SKees Cook #include <linux/device.h>
20*9124a264SKees Cook #include <linux/slab.h>
21875bfd52SKees Cook #include <linux/string.h>
22*9124a264SKees Cook #include <linux/vmalloc.h>
23875bfd52SKees Cook
24875bfd52SKees Cook static const char array_of_10[] = "this is 10";
25875bfd52SKees Cook static const char *ptr_of_11 = "this is 11!";
26875bfd52SKees Cook static char array_unknown[] = "compiler thinks I might change";
27875bfd52SKees Cook
known_sizes_test(struct kunit * test)28875bfd52SKees Cook static void known_sizes_test(struct kunit *test)
29875bfd52SKees Cook {
30875bfd52SKees Cook KUNIT_EXPECT_EQ(test, __compiletime_strlen("88888888"), 8);
31875bfd52SKees Cook KUNIT_EXPECT_EQ(test, __compiletime_strlen(array_of_10), 10);
32875bfd52SKees Cook KUNIT_EXPECT_EQ(test, __compiletime_strlen(ptr_of_11), 11);
33875bfd52SKees Cook
34875bfd52SKees Cook KUNIT_EXPECT_EQ(test, __compiletime_strlen(array_unknown), SIZE_MAX);
35875bfd52SKees Cook /* Externally defined and dynamically sized string pointer: */
3606c1c49dSKees Cook KUNIT_EXPECT_EQ(test, __compiletime_strlen(test->name), SIZE_MAX);
37875bfd52SKees Cook }
38875bfd52SKees Cook
39875bfd52SKees Cook /* This is volatile so the optimizer can't perform DCE below. */
40875bfd52SKees Cook static volatile int pick;
41875bfd52SKees Cook
42875bfd52SKees Cook /* Not inline to keep optimizer from figuring out which string we want. */
want_minus_one(int pick)43875bfd52SKees Cook static noinline size_t want_minus_one(int pick)
44875bfd52SKees Cook {
45875bfd52SKees Cook const char *str;
46875bfd52SKees Cook
47875bfd52SKees Cook switch (pick) {
48875bfd52SKees Cook case 1:
49875bfd52SKees Cook str = "4444";
50875bfd52SKees Cook break;
51875bfd52SKees Cook case 2:
52875bfd52SKees Cook str = "333";
53875bfd52SKees Cook break;
54875bfd52SKees Cook default:
55875bfd52SKees Cook str = "1";
56875bfd52SKees Cook break;
57875bfd52SKees Cook }
58875bfd52SKees Cook return __compiletime_strlen(str);
59875bfd52SKees Cook }
60875bfd52SKees Cook
control_flow_split_test(struct kunit * test)61875bfd52SKees Cook static void control_flow_split_test(struct kunit *test)
62875bfd52SKees Cook {
63875bfd52SKees Cook KUNIT_EXPECT_EQ(test, want_minus_one(pick), SIZE_MAX);
64875bfd52SKees Cook }
65875bfd52SKees Cook
66*9124a264SKees Cook #define KUNIT_EXPECT_BOS(test, p, expected, name) \
67*9124a264SKees Cook KUNIT_EXPECT_EQ_MSG(test, __builtin_object_size(p, 1), \
68*9124a264SKees Cook expected, \
69*9124a264SKees Cook "__alloc_size() not working with __bos on " name "\n")
70*9124a264SKees Cook
71*9124a264SKees Cook #if !__has_builtin(__builtin_dynamic_object_size)
72*9124a264SKees Cook #define KUNIT_EXPECT_BDOS(test, p, expected, name) \
73*9124a264SKees Cook /* Silence "unused variable 'expected'" warning. */ \
74*9124a264SKees Cook KUNIT_EXPECT_EQ(test, expected, expected)
75*9124a264SKees Cook #else
76*9124a264SKees Cook #define KUNIT_EXPECT_BDOS(test, p, expected, name) \
77*9124a264SKees Cook KUNIT_EXPECT_EQ_MSG(test, __builtin_dynamic_object_size(p, 1), \
78*9124a264SKees Cook expected, \
79*9124a264SKees Cook "__alloc_size() not working with __bdos on " name "\n")
80*9124a264SKees Cook #endif
81*9124a264SKees Cook
82*9124a264SKees Cook /* If the execpted size is a constant value, __bos can see it. */
83*9124a264SKees Cook #define check_const(_expected, alloc, free) do { \
84*9124a264SKees Cook size_t expected = (_expected); \
85*9124a264SKees Cook void *p = alloc; \
86*9124a264SKees Cook KUNIT_EXPECT_TRUE_MSG(test, p != NULL, #alloc " failed?!\n"); \
87*9124a264SKees Cook KUNIT_EXPECT_BOS(test, p, expected, #alloc); \
88*9124a264SKees Cook KUNIT_EXPECT_BDOS(test, p, expected, #alloc); \
89*9124a264SKees Cook free; \
90*9124a264SKees Cook } while (0)
91*9124a264SKees Cook
92*9124a264SKees Cook /* If the execpted size is NOT a constant value, __bos CANNOT see it. */
93*9124a264SKees Cook #define check_dynamic(_expected, alloc, free) do { \
94*9124a264SKees Cook size_t expected = (_expected); \
95*9124a264SKees Cook void *p = alloc; \
96*9124a264SKees Cook KUNIT_EXPECT_TRUE_MSG(test, p != NULL, #alloc " failed?!\n"); \
97*9124a264SKees Cook KUNIT_EXPECT_BOS(test, p, SIZE_MAX, #alloc); \
98*9124a264SKees Cook KUNIT_EXPECT_BDOS(test, p, expected, #alloc); \
99*9124a264SKees Cook free; \
100*9124a264SKees Cook } while (0)
101*9124a264SKees Cook
102*9124a264SKees Cook /* Assortment of constant-value kinda-edge cases. */
103*9124a264SKees Cook #define CONST_TEST_BODY(TEST_alloc) do { \
104*9124a264SKees Cook /* Special-case vmalloc()-family to skip 0-sized allocs. */ \
105*9124a264SKees Cook if (strcmp(#TEST_alloc, "TEST_vmalloc") != 0) \
106*9124a264SKees Cook TEST_alloc(check_const, 0, 0); \
107*9124a264SKees Cook TEST_alloc(check_const, 1, 1); \
108*9124a264SKees Cook TEST_alloc(check_const, 128, 128); \
109*9124a264SKees Cook TEST_alloc(check_const, 1023, 1023); \
110*9124a264SKees Cook TEST_alloc(check_const, 1025, 1025); \
111*9124a264SKees Cook TEST_alloc(check_const, 4096, 4096); \
112*9124a264SKees Cook TEST_alloc(check_const, 4097, 4097); \
113*9124a264SKees Cook } while (0)
114*9124a264SKees Cook
115*9124a264SKees Cook static volatile size_t zero_size;
116*9124a264SKees Cook static volatile size_t unknown_size = 50;
117*9124a264SKees Cook
118*9124a264SKees Cook #if !__has_builtin(__builtin_dynamic_object_size)
119*9124a264SKees Cook #define DYNAMIC_TEST_BODY(TEST_alloc) \
120*9124a264SKees Cook kunit_skip(test, "Compiler is missing __builtin_dynamic_object_size() support\n")
121*9124a264SKees Cook #else
122*9124a264SKees Cook #define DYNAMIC_TEST_BODY(TEST_alloc) do { \
123*9124a264SKees Cook size_t size = unknown_size; \
124*9124a264SKees Cook \
125*9124a264SKees Cook /* \
126*9124a264SKees Cook * Expected size is "size" in each test, before it is then \
127*9124a264SKees Cook * internally incremented in each test. Requires we disable \
128*9124a264SKees Cook * -Wunsequenced. \
129*9124a264SKees Cook */ \
130*9124a264SKees Cook TEST_alloc(check_dynamic, size, size++); \
131*9124a264SKees Cook /* Make sure incrementing actually happened. */ \
132*9124a264SKees Cook KUNIT_EXPECT_NE(test, size, unknown_size); \
133*9124a264SKees Cook } while (0)
134*9124a264SKees Cook #endif
135*9124a264SKees Cook
136*9124a264SKees Cook #define DEFINE_ALLOC_SIZE_TEST_PAIR(allocator) \
137*9124a264SKees Cook static void alloc_size_##allocator##_const_test(struct kunit *test) \
138*9124a264SKees Cook { \
139*9124a264SKees Cook CONST_TEST_BODY(TEST_##allocator); \
140*9124a264SKees Cook } \
141*9124a264SKees Cook static void alloc_size_##allocator##_dynamic_test(struct kunit *test) \
142*9124a264SKees Cook { \
143*9124a264SKees Cook DYNAMIC_TEST_BODY(TEST_##allocator); \
144*9124a264SKees Cook }
145*9124a264SKees Cook
146*9124a264SKees Cook #define TEST_kmalloc(checker, expected_size, alloc_size) do { \
147*9124a264SKees Cook gfp_t gfp = GFP_KERNEL | __GFP_NOWARN; \
148*9124a264SKees Cook void *orig; \
149*9124a264SKees Cook size_t len; \
150*9124a264SKees Cook \
151*9124a264SKees Cook checker(expected_size, kmalloc(alloc_size, gfp), \
152*9124a264SKees Cook kfree(p)); \
153*9124a264SKees Cook checker(expected_size, \
154*9124a264SKees Cook kmalloc_node(alloc_size, gfp, NUMA_NO_NODE), \
155*9124a264SKees Cook kfree(p)); \
156*9124a264SKees Cook checker(expected_size, kzalloc(alloc_size, gfp), \
157*9124a264SKees Cook kfree(p)); \
158*9124a264SKees Cook checker(expected_size, \
159*9124a264SKees Cook kzalloc_node(alloc_size, gfp, NUMA_NO_NODE), \
160*9124a264SKees Cook kfree(p)); \
161*9124a264SKees Cook checker(expected_size, kcalloc(1, alloc_size, gfp), \
162*9124a264SKees Cook kfree(p)); \
163*9124a264SKees Cook checker(expected_size, kcalloc(alloc_size, 1, gfp), \
164*9124a264SKees Cook kfree(p)); \
165*9124a264SKees Cook checker(expected_size, \
166*9124a264SKees Cook kcalloc_node(1, alloc_size, gfp, NUMA_NO_NODE), \
167*9124a264SKees Cook kfree(p)); \
168*9124a264SKees Cook checker(expected_size, \
169*9124a264SKees Cook kcalloc_node(alloc_size, 1, gfp, NUMA_NO_NODE), \
170*9124a264SKees Cook kfree(p)); \
171*9124a264SKees Cook checker(expected_size, kmalloc_array(1, alloc_size, gfp), \
172*9124a264SKees Cook kfree(p)); \
173*9124a264SKees Cook checker(expected_size, kmalloc_array(alloc_size, 1, gfp), \
174*9124a264SKees Cook kfree(p)); \
175*9124a264SKees Cook checker(expected_size, \
176*9124a264SKees Cook kmalloc_array_node(1, alloc_size, gfp, NUMA_NO_NODE), \
177*9124a264SKees Cook kfree(p)); \
178*9124a264SKees Cook checker(expected_size, \
179*9124a264SKees Cook kmalloc_array_node(alloc_size, 1, gfp, NUMA_NO_NODE), \
180*9124a264SKees Cook kfree(p)); \
181*9124a264SKees Cook checker(expected_size, __kmalloc(alloc_size, gfp), \
182*9124a264SKees Cook kfree(p)); \
183*9124a264SKees Cook checker(expected_size, \
184*9124a264SKees Cook __kmalloc_node(alloc_size, gfp, NUMA_NO_NODE), \
185*9124a264SKees Cook kfree(p)); \
186*9124a264SKees Cook \
187*9124a264SKees Cook orig = kmalloc(alloc_size, gfp); \
188*9124a264SKees Cook KUNIT_EXPECT_TRUE(test, orig != NULL); \
189*9124a264SKees Cook checker((expected_size) * 2, \
190*9124a264SKees Cook krealloc(orig, (alloc_size) * 2, gfp), \
191*9124a264SKees Cook kfree(p)); \
192*9124a264SKees Cook orig = kmalloc(alloc_size, gfp); \
193*9124a264SKees Cook KUNIT_EXPECT_TRUE(test, orig != NULL); \
194*9124a264SKees Cook checker((expected_size) * 2, \
195*9124a264SKees Cook krealloc_array(orig, 1, (alloc_size) * 2, gfp), \
196*9124a264SKees Cook kfree(p)); \
197*9124a264SKees Cook orig = kmalloc(alloc_size, gfp); \
198*9124a264SKees Cook KUNIT_EXPECT_TRUE(test, orig != NULL); \
199*9124a264SKees Cook checker((expected_size) * 2, \
200*9124a264SKees Cook krealloc_array(orig, (alloc_size) * 2, 1, gfp), \
201*9124a264SKees Cook kfree(p)); \
202*9124a264SKees Cook \
203*9124a264SKees Cook len = 11; \
204*9124a264SKees Cook /* Using memdup() with fixed size, so force unknown length. */ \
205*9124a264SKees Cook if (!__builtin_constant_p(expected_size)) \
206*9124a264SKees Cook len += zero_size; \
207*9124a264SKees Cook checker(len, kmemdup("hello there", len, gfp), kfree(p)); \
208*9124a264SKees Cook } while (0)
209*9124a264SKees Cook DEFINE_ALLOC_SIZE_TEST_PAIR(kmalloc)
210*9124a264SKees Cook
211*9124a264SKees Cook /* Sizes are in pages, not bytes. */
212*9124a264SKees Cook #define TEST_vmalloc(checker, expected_pages, alloc_pages) do { \
213*9124a264SKees Cook gfp_t gfp = GFP_KERNEL | __GFP_NOWARN; \
214*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
215*9124a264SKees Cook vmalloc((alloc_pages) * PAGE_SIZE), vfree(p)); \
216*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
217*9124a264SKees Cook vzalloc((alloc_pages) * PAGE_SIZE), vfree(p)); \
218*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
219*9124a264SKees Cook __vmalloc((alloc_pages) * PAGE_SIZE, gfp), vfree(p)); \
220*9124a264SKees Cook } while (0)
221*9124a264SKees Cook DEFINE_ALLOC_SIZE_TEST_PAIR(vmalloc)
222*9124a264SKees Cook
223*9124a264SKees Cook /* Sizes are in pages (and open-coded for side-effects), not bytes. */
224*9124a264SKees Cook #define TEST_kvmalloc(checker, expected_pages, alloc_pages) do { \
225*9124a264SKees Cook gfp_t gfp = GFP_KERNEL | __GFP_NOWARN; \
226*9124a264SKees Cook size_t prev_size; \
227*9124a264SKees Cook void *orig; \
228*9124a264SKees Cook \
229*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
230*9124a264SKees Cook kvmalloc((alloc_pages) * PAGE_SIZE, gfp), \
231*9124a264SKees Cook vfree(p)); \
232*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
233*9124a264SKees Cook kvmalloc_node((alloc_pages) * PAGE_SIZE, gfp, NUMA_NO_NODE), \
234*9124a264SKees Cook vfree(p)); \
235*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
236*9124a264SKees Cook kvzalloc((alloc_pages) * PAGE_SIZE, gfp), \
237*9124a264SKees Cook vfree(p)); \
238*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
239*9124a264SKees Cook kvzalloc_node((alloc_pages) * PAGE_SIZE, gfp, NUMA_NO_NODE), \
240*9124a264SKees Cook vfree(p)); \
241*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
242*9124a264SKees Cook kvcalloc(1, (alloc_pages) * PAGE_SIZE, gfp), \
243*9124a264SKees Cook vfree(p)); \
244*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
245*9124a264SKees Cook kvcalloc((alloc_pages) * PAGE_SIZE, 1, gfp), \
246*9124a264SKees Cook vfree(p)); \
247*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
248*9124a264SKees Cook kvmalloc_array(1, (alloc_pages) * PAGE_SIZE, gfp), \
249*9124a264SKees Cook vfree(p)); \
250*9124a264SKees Cook checker((expected_pages) * PAGE_SIZE, \
251*9124a264SKees Cook kvmalloc_array((alloc_pages) * PAGE_SIZE, 1, gfp), \
252*9124a264SKees Cook vfree(p)); \
253*9124a264SKees Cook \
254*9124a264SKees Cook prev_size = (expected_pages) * PAGE_SIZE; \
255*9124a264SKees Cook orig = kvmalloc(prev_size, gfp); \
256*9124a264SKees Cook KUNIT_EXPECT_TRUE(test, orig != NULL); \
257*9124a264SKees Cook checker(((expected_pages) * PAGE_SIZE) * 2, \
258*9124a264SKees Cook kvrealloc(orig, prev_size, \
259*9124a264SKees Cook ((alloc_pages) * PAGE_SIZE) * 2, gfp), \
260*9124a264SKees Cook kvfree(p)); \
261*9124a264SKees Cook } while (0)
262*9124a264SKees Cook DEFINE_ALLOC_SIZE_TEST_PAIR(kvmalloc)
263*9124a264SKees Cook
264*9124a264SKees Cook #define TEST_devm_kmalloc(checker, expected_size, alloc_size) do { \
265*9124a264SKees Cook gfp_t gfp = GFP_KERNEL | __GFP_NOWARN; \
266*9124a264SKees Cook const char dev_name[] = "fortify-test"; \
267*9124a264SKees Cook struct device *dev; \
268*9124a264SKees Cook void *orig; \
269*9124a264SKees Cook size_t len; \
270*9124a264SKees Cook \
271*9124a264SKees Cook /* Create dummy device for devm_kmalloc()-family tests. */ \
272*9124a264SKees Cook dev = root_device_register(dev_name); \
273*9124a264SKees Cook KUNIT_ASSERT_FALSE_MSG(test, IS_ERR(dev), \
274*9124a264SKees Cook "Cannot register test device\n"); \
275*9124a264SKees Cook \
276*9124a264SKees Cook checker(expected_size, devm_kmalloc(dev, alloc_size, gfp), \
277*9124a264SKees Cook devm_kfree(dev, p)); \
278*9124a264SKees Cook checker(expected_size, devm_kzalloc(dev, alloc_size, gfp), \
279*9124a264SKees Cook devm_kfree(dev, p)); \
280*9124a264SKees Cook checker(expected_size, \
281*9124a264SKees Cook devm_kmalloc_array(dev, 1, alloc_size, gfp), \
282*9124a264SKees Cook devm_kfree(dev, p)); \
283*9124a264SKees Cook checker(expected_size, \
284*9124a264SKees Cook devm_kmalloc_array(dev, alloc_size, 1, gfp), \
285*9124a264SKees Cook devm_kfree(dev, p)); \
286*9124a264SKees Cook checker(expected_size, \
287*9124a264SKees Cook devm_kcalloc(dev, 1, alloc_size, gfp), \
288*9124a264SKees Cook devm_kfree(dev, p)); \
289*9124a264SKees Cook checker(expected_size, \
290*9124a264SKees Cook devm_kcalloc(dev, alloc_size, 1, gfp), \
291*9124a264SKees Cook devm_kfree(dev, p)); \
292*9124a264SKees Cook \
293*9124a264SKees Cook orig = devm_kmalloc(dev, alloc_size, gfp); \
294*9124a264SKees Cook KUNIT_EXPECT_TRUE(test, orig != NULL); \
295*9124a264SKees Cook checker((expected_size) * 2, \
296*9124a264SKees Cook devm_krealloc(dev, orig, (alloc_size) * 2, gfp), \
297*9124a264SKees Cook devm_kfree(dev, p)); \
298*9124a264SKees Cook \
299*9124a264SKees Cook len = 4; \
300*9124a264SKees Cook /* Using memdup() with fixed size, so force unknown length. */ \
301*9124a264SKees Cook if (!__builtin_constant_p(expected_size)) \
302*9124a264SKees Cook len += zero_size; \
303*9124a264SKees Cook checker(len, devm_kmemdup(dev, "Ohai", len, gfp), \
304*9124a264SKees Cook devm_kfree(dev, p)); \
305*9124a264SKees Cook \
306*9124a264SKees Cook device_unregister(dev); \
307*9124a264SKees Cook } while (0)
308*9124a264SKees Cook DEFINE_ALLOC_SIZE_TEST_PAIR(devm_kmalloc)
309*9124a264SKees Cook
310875bfd52SKees Cook static struct kunit_case fortify_test_cases[] = {
311875bfd52SKees Cook KUNIT_CASE(known_sizes_test),
312875bfd52SKees Cook KUNIT_CASE(control_flow_split_test),
313*9124a264SKees Cook KUNIT_CASE(alloc_size_kmalloc_const_test),
314*9124a264SKees Cook KUNIT_CASE(alloc_size_kmalloc_dynamic_test),
315*9124a264SKees Cook KUNIT_CASE(alloc_size_vmalloc_const_test),
316*9124a264SKees Cook KUNIT_CASE(alloc_size_vmalloc_dynamic_test),
317*9124a264SKees Cook KUNIT_CASE(alloc_size_kvmalloc_const_test),
318*9124a264SKees Cook KUNIT_CASE(alloc_size_kvmalloc_dynamic_test),
319*9124a264SKees Cook KUNIT_CASE(alloc_size_devm_kmalloc_const_test),
320*9124a264SKees Cook KUNIT_CASE(alloc_size_devm_kmalloc_dynamic_test),
321875bfd52SKees Cook {}
322875bfd52SKees Cook };
323875bfd52SKees Cook
324875bfd52SKees Cook static struct kunit_suite fortify_test_suite = {
325875bfd52SKees Cook .name = "fortify",
326875bfd52SKees Cook .test_cases = fortify_test_cases,
327875bfd52SKees Cook };
328875bfd52SKees Cook
329875bfd52SKees Cook kunit_test_suite(fortify_test_suite);
330875bfd52SKees Cook
331875bfd52SKees Cook MODULE_LICENSE("GPL");
332