1bc3cdd2957f1ddd531c92436fddbe5b9e00ae63
[linux-2.6-microblaze.git] / lib / test_kasan.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *
4  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
5  * Author: Andrey Ryabinin <a.ryabinin@samsung.com>
6  */
7
8 #include <linux/bitops.h>
9 #include <linux/delay.h>
10 #include <linux/kasan.h>
11 #include <linux/kernel.h>
12 #include <linux/mm.h>
13 #include <linux/mman.h>
14 #include <linux/module.h>
15 #include <linux/printk.h>
16 #include <linux/random.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/uaccess.h>
20 #include <linux/io.h>
21 #include <linux/vmalloc.h>
22
23 #include <asm/page.h>
24
25 #include <kunit/test.h>
26
27 #include "../mm/kasan/kasan.h"
28
29 #define OOB_TAG_OFF (IS_ENABLED(CONFIG_KASAN_GENERIC) ? 0 : KASAN_GRANULE_SIZE)
30
31 /*
32  * Some tests use these global variables to store return values from function
33  * calls that could otherwise be eliminated by the compiler as dead code.
34  */
35 void *kasan_ptr_result;
36 int kasan_int_result;
37
38 static struct kunit_resource resource;
39 static struct kunit_kasan_expectation fail_data;
40 static bool multishot;
41
42 /*
43  * Temporarily enable multi-shot mode. Otherwise, KASAN would only report the
44  * first detected bug and panic the kernel if panic_on_warn is enabled. For
45  * hardware tag-based KASAN also allow tag checking to be reenabled for each
46  * test, see the comment for KUNIT_EXPECT_KASAN_FAIL().
47  */
48 static int kasan_test_init(struct kunit *test)
49 {
50         if (!kasan_enabled()) {
51                 kunit_err(test, "can't run KASAN tests with KASAN disabled");
52                 return -1;
53         }
54
55         multishot = kasan_save_enable_multi_shot();
56         kasan_set_tagging_report_once(false);
57         fail_data.report_found = false;
58         kunit_add_named_resource(test, NULL, NULL, &resource,
59                                         "kasan_data", &fail_data);
60         return 0;
61 }
62
63 static void kasan_test_exit(struct kunit *test)
64 {
65         kasan_set_tagging_report_once(true);
66         kasan_restore_multi_shot(multishot);
67         KUNIT_EXPECT_FALSE(test, fail_data.report_found);
68 }
69
70 /**
71  * KUNIT_EXPECT_KASAN_FAIL() - check that the executed expression produces a
72  * KASAN report; causes a test failure otherwise. This relies on a KUnit
73  * resource named "kasan_data". Do not use this name for KUnit resources
74  * outside of KASAN tests.
75  *
76  * For hardware tag-based KASAN in sync mode, when a tag fault happens, tag
77  * checking is auto-disabled. When this happens, this test handler reenables
78  * tag checking. As tag checking can be only disabled or enabled per CPU,
79  * this handler disables migration (preemption).
80  *
81  * Since the compiler doesn't see that the expression can change the fail_data
82  * fields, it can reorder or optimize away the accesses to those fields.
83  * Use READ/WRITE_ONCE() for the accesses and compiler barriers around the
84  * expression to prevent that.
85  *
86  * In between KUNIT_EXPECT_KASAN_FAIL checks, fail_data.report_found is kept as
87  * false. This allows detecting KASAN reports that happen outside of the checks
88  * by asserting !fail_data.report_found at the start of KUNIT_EXPECT_KASAN_FAIL
89  * and in kasan_test_exit.
90  */
91 #define KUNIT_EXPECT_KASAN_FAIL(test, expression) do {                  \
92         if (IS_ENABLED(CONFIG_KASAN_HW_TAGS) &&                         \
93             !kasan_async_mode_enabled())                                \
94                 migrate_disable();                                      \
95         KUNIT_EXPECT_FALSE(test, READ_ONCE(fail_data.report_found));    \
96         barrier();                                                      \
97         expression;                                                     \
98         barrier();                                                      \
99         if (!READ_ONCE(fail_data.report_found)) {                       \
100                 KUNIT_FAIL(test, KUNIT_SUBTEST_INDENT "KASAN failure "  \
101                                 "expected in \"" #expression            \
102                                  "\", but none occurred");              \
103         }                                                               \
104         if (IS_ENABLED(CONFIG_KASAN_HW_TAGS)) {                         \
105                 if (READ_ONCE(fail_data.report_found))                  \
106                         kasan_enable_tagging_sync();                    \
107                 migrate_enable();                                       \
108         }                                                               \
109         WRITE_ONCE(fail_data.report_found, false);                      \
110 } while (0)
111
112 #define KASAN_TEST_NEEDS_CONFIG_ON(test, config) do {                   \
113         if (!IS_ENABLED(config))                                        \
114                 kunit_skip((test), "Test requires " #config "=y");      \
115 } while (0)
116
117 #define KASAN_TEST_NEEDS_CONFIG_OFF(test, config) do {                  \
118         if (IS_ENABLED(config))                                         \
119                 kunit_skip((test), "Test requires " #config "=n");      \
120 } while (0)
121
122 static void kmalloc_oob_right(struct kunit *test)
123 {
124         char *ptr;
125         size_t size = 128 - KASAN_GRANULE_SIZE - 5;
126
127         ptr = kmalloc(size, GFP_KERNEL);
128         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
129
130         /*
131          * An unaligned access past the requested kmalloc size.
132          * Only generic KASAN can precisely detect these.
133          */
134         if (IS_ENABLED(CONFIG_KASAN_GENERIC))
135                 KUNIT_EXPECT_KASAN_FAIL(test, ptr[size] = 'x');
136
137         /*
138          * An aligned access into the first out-of-bounds granule that falls
139          * within the aligned kmalloc object.
140          */
141         KUNIT_EXPECT_KASAN_FAIL(test, ptr[size + 5] = 'y');
142
143         /* Out-of-bounds access past the aligned kmalloc object. */
144         KUNIT_EXPECT_KASAN_FAIL(test, ptr[0] =
145                                         ptr[size + KASAN_GRANULE_SIZE + 5]);
146
147         kfree(ptr);
148 }
149
150 static void kmalloc_oob_left(struct kunit *test)
151 {
152         char *ptr;
153         size_t size = 15;
154
155         ptr = kmalloc(size, GFP_KERNEL);
156         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
157
158         KUNIT_EXPECT_KASAN_FAIL(test, *ptr = *(ptr - 1));
159         kfree(ptr);
160 }
161
162 static void kmalloc_node_oob_right(struct kunit *test)
163 {
164         char *ptr;
165         size_t size = 4096;
166
167         ptr = kmalloc_node(size, GFP_KERNEL, 0);
168         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
169
170         KUNIT_EXPECT_KASAN_FAIL(test, ptr[size] = 0);
171         kfree(ptr);
172 }
173
174 /*
175  * These kmalloc_pagealloc_* tests try allocating a memory chunk that doesn't
176  * fit into a slab cache and therefore is allocated via the page allocator
177  * fallback. Since this kind of fallback is only implemented for SLUB, these
178  * tests are limited to that allocator.
179  */
180 static void kmalloc_pagealloc_oob_right(struct kunit *test)
181 {
182         char *ptr;
183         size_t size = KMALLOC_MAX_CACHE_SIZE + 10;
184
185         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_SLUB);
186
187         ptr = kmalloc(size, GFP_KERNEL);
188         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
189
190         KUNIT_EXPECT_KASAN_FAIL(test, ptr[size + OOB_TAG_OFF] = 0);
191
192         kfree(ptr);
193 }
194
195 static void kmalloc_pagealloc_uaf(struct kunit *test)
196 {
197         char *ptr;
198         size_t size = KMALLOC_MAX_CACHE_SIZE + 10;
199
200         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_SLUB);
201
202         ptr = kmalloc(size, GFP_KERNEL);
203         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
204         kfree(ptr);
205
206         KUNIT_EXPECT_KASAN_FAIL(test, ptr[0] = 0);
207 }
208
209 static void kmalloc_pagealloc_invalid_free(struct kunit *test)
210 {
211         char *ptr;
212         size_t size = KMALLOC_MAX_CACHE_SIZE + 10;
213
214         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_SLUB);
215
216         ptr = kmalloc(size, GFP_KERNEL);
217         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
218
219         KUNIT_EXPECT_KASAN_FAIL(test, kfree(ptr + 1));
220 }
221
222 static void pagealloc_oob_right(struct kunit *test)
223 {
224         char *ptr;
225         struct page *pages;
226         size_t order = 4;
227         size_t size = (1UL << (PAGE_SHIFT + order));
228
229         /*
230          * With generic KASAN page allocations have no redzones, thus
231          * out-of-bounds detection is not guaranteed.
232          * See https://bugzilla.kernel.org/show_bug.cgi?id=210503.
233          */
234         KASAN_TEST_NEEDS_CONFIG_OFF(test, CONFIG_KASAN_GENERIC);
235
236         pages = alloc_pages(GFP_KERNEL, order);
237         ptr = page_address(pages);
238         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
239
240         KUNIT_EXPECT_KASAN_FAIL(test, ptr[size] = 0);
241         free_pages((unsigned long)ptr, order);
242 }
243
244 static void pagealloc_uaf(struct kunit *test)
245 {
246         char *ptr;
247         struct page *pages;
248         size_t order = 4;
249
250         pages = alloc_pages(GFP_KERNEL, order);
251         ptr = page_address(pages);
252         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
253         free_pages((unsigned long)ptr, order);
254
255         KUNIT_EXPECT_KASAN_FAIL(test, ptr[0] = 0);
256 }
257
258 static void kmalloc_large_oob_right(struct kunit *test)
259 {
260         char *ptr;
261         size_t size = KMALLOC_MAX_CACHE_SIZE - 256;
262
263         /*
264          * Allocate a chunk that is large enough, but still fits into a slab
265          * and does not trigger the page allocator fallback in SLUB.
266          */
267         ptr = kmalloc(size, GFP_KERNEL);
268         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
269
270         KUNIT_EXPECT_KASAN_FAIL(test, ptr[size] = 0);
271         kfree(ptr);
272 }
273
274 static void krealloc_more_oob_helper(struct kunit *test,
275                                         size_t size1, size_t size2)
276 {
277         char *ptr1, *ptr2;
278         size_t middle;
279
280         KUNIT_ASSERT_LT(test, size1, size2);
281         middle = size1 + (size2 - size1) / 2;
282
283         ptr1 = kmalloc(size1, GFP_KERNEL);
284         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr1);
285
286         ptr2 = krealloc(ptr1, size2, GFP_KERNEL);
287         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr2);
288
289         /* All offsets up to size2 must be accessible. */
290         ptr2[size1 - 1] = 'x';
291         ptr2[size1] = 'x';
292         ptr2[middle] = 'x';
293         ptr2[size2 - 1] = 'x';
294
295         /* Generic mode is precise, so unaligned size2 must be inaccessible. */
296         if (IS_ENABLED(CONFIG_KASAN_GENERIC))
297                 KUNIT_EXPECT_KASAN_FAIL(test, ptr2[size2] = 'x');
298
299         /* For all modes first aligned offset after size2 must be inaccessible. */
300         KUNIT_EXPECT_KASAN_FAIL(test,
301                 ptr2[round_up(size2, KASAN_GRANULE_SIZE)] = 'x');
302
303         kfree(ptr2);
304 }
305
306 static void krealloc_less_oob_helper(struct kunit *test,
307                                         size_t size1, size_t size2)
308 {
309         char *ptr1, *ptr2;
310         size_t middle;
311
312         KUNIT_ASSERT_LT(test, size2, size1);
313         middle = size2 + (size1 - size2) / 2;
314
315         ptr1 = kmalloc(size1, GFP_KERNEL);
316         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr1);
317
318         ptr2 = krealloc(ptr1, size2, GFP_KERNEL);
319         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr2);
320
321         /* Must be accessible for all modes. */
322         ptr2[size2 - 1] = 'x';
323
324         /* Generic mode is precise, so unaligned size2 must be inaccessible. */
325         if (IS_ENABLED(CONFIG_KASAN_GENERIC))
326                 KUNIT_EXPECT_KASAN_FAIL(test, ptr2[size2] = 'x');
327
328         /* For all modes first aligned offset after size2 must be inaccessible. */
329         KUNIT_EXPECT_KASAN_FAIL(test,
330                 ptr2[round_up(size2, KASAN_GRANULE_SIZE)] = 'x');
331
332         /*
333          * For all modes all size2, middle, and size1 should land in separate
334          * granules and thus the latter two offsets should be inaccessible.
335          */
336         KUNIT_EXPECT_LE(test, round_up(size2, KASAN_GRANULE_SIZE),
337                                 round_down(middle, KASAN_GRANULE_SIZE));
338         KUNIT_EXPECT_LE(test, round_up(middle, KASAN_GRANULE_SIZE),
339                                 round_down(size1, KASAN_GRANULE_SIZE));
340         KUNIT_EXPECT_KASAN_FAIL(test, ptr2[middle] = 'x');
341         KUNIT_EXPECT_KASAN_FAIL(test, ptr2[size1 - 1] = 'x');
342         KUNIT_EXPECT_KASAN_FAIL(test, ptr2[size1] = 'x');
343
344         kfree(ptr2);
345 }
346
347 static void krealloc_more_oob(struct kunit *test)
348 {
349         krealloc_more_oob_helper(test, 201, 235);
350 }
351
352 static void krealloc_less_oob(struct kunit *test)
353 {
354         krealloc_less_oob_helper(test, 235, 201);
355 }
356
357 static void krealloc_pagealloc_more_oob(struct kunit *test)
358 {
359         /* page_alloc fallback in only implemented for SLUB. */
360         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_SLUB);
361
362         krealloc_more_oob_helper(test, KMALLOC_MAX_CACHE_SIZE + 201,
363                                         KMALLOC_MAX_CACHE_SIZE + 235);
364 }
365
366 static void krealloc_pagealloc_less_oob(struct kunit *test)
367 {
368         /* page_alloc fallback in only implemented for SLUB. */
369         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_SLUB);
370
371         krealloc_less_oob_helper(test, KMALLOC_MAX_CACHE_SIZE + 235,
372                                         KMALLOC_MAX_CACHE_SIZE + 201);
373 }
374
375 /*
376  * Check that krealloc() detects a use-after-free, returns NULL,
377  * and doesn't unpoison the freed object.
378  */
379 static void krealloc_uaf(struct kunit *test)
380 {
381         char *ptr1, *ptr2;
382         int size1 = 201;
383         int size2 = 235;
384
385         ptr1 = kmalloc(size1, GFP_KERNEL);
386         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr1);
387         kfree(ptr1);
388
389         KUNIT_EXPECT_KASAN_FAIL(test, ptr2 = krealloc(ptr1, size2, GFP_KERNEL));
390         KUNIT_ASSERT_PTR_EQ(test, (void *)ptr2, NULL);
391         KUNIT_EXPECT_KASAN_FAIL(test, *(volatile char *)ptr1);
392 }
393
394 static void kmalloc_oob_16(struct kunit *test)
395 {
396         struct {
397                 u64 words[2];
398         } *ptr1, *ptr2;
399
400         /* This test is specifically crafted for the generic mode. */
401         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_GENERIC);
402
403         ptr1 = kmalloc(sizeof(*ptr1) - 3, GFP_KERNEL);
404         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr1);
405
406         ptr2 = kmalloc(sizeof(*ptr2), GFP_KERNEL);
407         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr2);
408
409         KUNIT_EXPECT_KASAN_FAIL(test, *ptr1 = *ptr2);
410         kfree(ptr1);
411         kfree(ptr2);
412 }
413
414 static void kmalloc_uaf_16(struct kunit *test)
415 {
416         struct {
417                 u64 words[2];
418         } *ptr1, *ptr2;
419
420         ptr1 = kmalloc(sizeof(*ptr1), GFP_KERNEL);
421         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr1);
422
423         ptr2 = kmalloc(sizeof(*ptr2), GFP_KERNEL);
424         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr2);
425         kfree(ptr2);
426
427         KUNIT_EXPECT_KASAN_FAIL(test, *ptr1 = *ptr2);
428         kfree(ptr1);
429 }
430
431 static void kmalloc_oob_memset_2(struct kunit *test)
432 {
433         char *ptr;
434         size_t size = 8;
435
436         ptr = kmalloc(size, GFP_KERNEL);
437         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
438
439         KUNIT_EXPECT_KASAN_FAIL(test, memset(ptr + 7 + OOB_TAG_OFF, 0, 2));
440         kfree(ptr);
441 }
442
443 static void kmalloc_oob_memset_4(struct kunit *test)
444 {
445         char *ptr;
446         size_t size = 8;
447
448         ptr = kmalloc(size, GFP_KERNEL);
449         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
450
451         KUNIT_EXPECT_KASAN_FAIL(test, memset(ptr + 5 + OOB_TAG_OFF, 0, 4));
452         kfree(ptr);
453 }
454
455
456 static void kmalloc_oob_memset_8(struct kunit *test)
457 {
458         char *ptr;
459         size_t size = 8;
460
461         ptr = kmalloc(size, GFP_KERNEL);
462         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
463
464         KUNIT_EXPECT_KASAN_FAIL(test, memset(ptr + 1 + OOB_TAG_OFF, 0, 8));
465         kfree(ptr);
466 }
467
468 static void kmalloc_oob_memset_16(struct kunit *test)
469 {
470         char *ptr;
471         size_t size = 16;
472
473         ptr = kmalloc(size, GFP_KERNEL);
474         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
475
476         KUNIT_EXPECT_KASAN_FAIL(test, memset(ptr + 1 + OOB_TAG_OFF, 0, 16));
477         kfree(ptr);
478 }
479
480 static void kmalloc_oob_in_memset(struct kunit *test)
481 {
482         char *ptr;
483         size_t size = 666;
484
485         ptr = kmalloc(size, GFP_KERNEL);
486         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
487
488         KUNIT_EXPECT_KASAN_FAIL(test, memset(ptr, 0, size + 5 + OOB_TAG_OFF));
489         kfree(ptr);
490 }
491
492 static void kmalloc_memmove_invalid_size(struct kunit *test)
493 {
494         char *ptr;
495         size_t size = 64;
496         volatile size_t invalid_size = -2;
497
498         ptr = kmalloc(size, GFP_KERNEL);
499         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
500
501         memset((char *)ptr, 0, 64);
502
503         KUNIT_EXPECT_KASAN_FAIL(test,
504                 memmove((char *)ptr, (char *)ptr + 4, invalid_size));
505         kfree(ptr);
506 }
507
508 static void kmalloc_uaf(struct kunit *test)
509 {
510         char *ptr;
511         size_t size = 10;
512
513         ptr = kmalloc(size, GFP_KERNEL);
514         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
515
516         kfree(ptr);
517         KUNIT_EXPECT_KASAN_FAIL(test, *(ptr + 8) = 'x');
518 }
519
520 static void kmalloc_uaf_memset(struct kunit *test)
521 {
522         char *ptr;
523         size_t size = 33;
524
525         ptr = kmalloc(size, GFP_KERNEL);
526         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
527
528         kfree(ptr);
529         KUNIT_EXPECT_KASAN_FAIL(test, memset(ptr, 0, size));
530 }
531
532 static void kmalloc_uaf2(struct kunit *test)
533 {
534         char *ptr1, *ptr2;
535         size_t size = 43;
536         int counter = 0;
537
538 again:
539         ptr1 = kmalloc(size, GFP_KERNEL);
540         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr1);
541
542         kfree(ptr1);
543
544         ptr2 = kmalloc(size, GFP_KERNEL);
545         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr2);
546
547         /*
548          * For tag-based KASAN ptr1 and ptr2 tags might happen to be the same.
549          * Allow up to 16 attempts at generating different tags.
550          */
551         if (!IS_ENABLED(CONFIG_KASAN_GENERIC) && ptr1 == ptr2 && counter++ < 16) {
552                 kfree(ptr2);
553                 goto again;
554         }
555
556         KUNIT_EXPECT_KASAN_FAIL(test, ptr1[40] = 'x');
557         KUNIT_EXPECT_PTR_NE(test, ptr1, ptr2);
558
559         kfree(ptr2);
560 }
561
562 static void kfree_via_page(struct kunit *test)
563 {
564         char *ptr;
565         size_t size = 8;
566         struct page *page;
567         unsigned long offset;
568
569         ptr = kmalloc(size, GFP_KERNEL);
570         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
571
572         page = virt_to_page(ptr);
573         offset = offset_in_page(ptr);
574         kfree(page_address(page) + offset);
575 }
576
577 static void kfree_via_phys(struct kunit *test)
578 {
579         char *ptr;
580         size_t size = 8;
581         phys_addr_t phys;
582
583         ptr = kmalloc(size, GFP_KERNEL);
584         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
585
586         phys = virt_to_phys(ptr);
587         kfree(phys_to_virt(phys));
588 }
589
590 static void kmem_cache_oob(struct kunit *test)
591 {
592         char *p;
593         size_t size = 200;
594         struct kmem_cache *cache;
595
596         cache = kmem_cache_create("test_cache", size, 0, 0, NULL);
597         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, cache);
598
599         p = kmem_cache_alloc(cache, GFP_KERNEL);
600         if (!p) {
601                 kunit_err(test, "Allocation failed: %s\n", __func__);
602                 kmem_cache_destroy(cache);
603                 return;
604         }
605
606         KUNIT_EXPECT_KASAN_FAIL(test, *p = p[size + OOB_TAG_OFF]);
607
608         kmem_cache_free(cache, p);
609         kmem_cache_destroy(cache);
610 }
611
612 static void kmem_cache_accounted(struct kunit *test)
613 {
614         int i;
615         char *p;
616         size_t size = 200;
617         struct kmem_cache *cache;
618
619         cache = kmem_cache_create("test_cache", size, 0, SLAB_ACCOUNT, NULL);
620         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, cache);
621
622         /*
623          * Several allocations with a delay to allow for lazy per memcg kmem
624          * cache creation.
625          */
626         for (i = 0; i < 5; i++) {
627                 p = kmem_cache_alloc(cache, GFP_KERNEL);
628                 if (!p)
629                         goto free_cache;
630
631                 kmem_cache_free(cache, p);
632                 msleep(100);
633         }
634
635 free_cache:
636         kmem_cache_destroy(cache);
637 }
638
639 static void kmem_cache_bulk(struct kunit *test)
640 {
641         struct kmem_cache *cache;
642         size_t size = 200;
643         char *p[10];
644         bool ret;
645         int i;
646
647         cache = kmem_cache_create("test_cache", size, 0, 0, NULL);
648         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, cache);
649
650         ret = kmem_cache_alloc_bulk(cache, GFP_KERNEL, ARRAY_SIZE(p), (void **)&p);
651         if (!ret) {
652                 kunit_err(test, "Allocation failed: %s\n", __func__);
653                 kmem_cache_destroy(cache);
654                 return;
655         }
656
657         for (i = 0; i < ARRAY_SIZE(p); i++)
658                 p[i][0] = p[i][size - 1] = 42;
659
660         kmem_cache_free_bulk(cache, ARRAY_SIZE(p), (void **)&p);
661         kmem_cache_destroy(cache);
662 }
663
664 static char global_array[10];
665
666 static void kasan_global_oob(struct kunit *test)
667 {
668         /*
669          * Deliberate out-of-bounds access. To prevent CONFIG_UBSAN_LOCAL_BOUNDS
670          * from failing here and panicking the kernel, access the array via a
671          * volatile pointer, which will prevent the compiler from being able to
672          * determine the array bounds.
673          *
674          * This access uses a volatile pointer to char (char *volatile) rather
675          * than the more conventional pointer to volatile char (volatile char *)
676          * because we want to prevent the compiler from making inferences about
677          * the pointer itself (i.e. its array bounds), not the data that it
678          * refers to.
679          */
680         char *volatile array = global_array;
681         char *p = &array[ARRAY_SIZE(global_array) + 3];
682
683         /* Only generic mode instruments globals. */
684         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_GENERIC);
685
686         KUNIT_EXPECT_KASAN_FAIL(test, *(volatile char *)p);
687 }
688
689 /* Check that ksize() makes the whole object accessible. */
690 static void ksize_unpoisons_memory(struct kunit *test)
691 {
692         char *ptr;
693         size_t size = 123, real_size;
694
695         ptr = kmalloc(size, GFP_KERNEL);
696         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
697         real_size = ksize(ptr);
698
699         /* This access shouldn't trigger a KASAN report. */
700         ptr[size] = 'x';
701
702         /* This one must. */
703         KUNIT_EXPECT_KASAN_FAIL(test, ptr[real_size] = 'y');
704
705         kfree(ptr);
706 }
707
708 /*
709  * Check that a use-after-free is detected by ksize() and via normal accesses
710  * after it.
711  */
712 static void ksize_uaf(struct kunit *test)
713 {
714         char *ptr;
715         int size = 128 - KASAN_GRANULE_SIZE;
716
717         ptr = kmalloc(size, GFP_KERNEL);
718         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
719         kfree(ptr);
720
721         KUNIT_EXPECT_KASAN_FAIL(test, ksize(ptr));
722         KUNIT_EXPECT_KASAN_FAIL(test, kasan_int_result = *ptr);
723         KUNIT_EXPECT_KASAN_FAIL(test, kasan_int_result = *(ptr + size));
724 }
725
726 static void kasan_stack_oob(struct kunit *test)
727 {
728         char stack_array[10];
729         /* See comment in kasan_global_oob. */
730         char *volatile array = stack_array;
731         char *p = &array[ARRAY_SIZE(stack_array) + OOB_TAG_OFF];
732
733         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_STACK);
734
735         KUNIT_EXPECT_KASAN_FAIL(test, *(volatile char *)p);
736 }
737
738 static void kasan_alloca_oob_left(struct kunit *test)
739 {
740         volatile int i = 10;
741         char alloca_array[i];
742         /* See comment in kasan_global_oob. */
743         char *volatile array = alloca_array;
744         char *p = array - 1;
745
746         /* Only generic mode instruments dynamic allocas. */
747         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_GENERIC);
748         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_STACK);
749
750         KUNIT_EXPECT_KASAN_FAIL(test, *(volatile char *)p);
751 }
752
753 static void kasan_alloca_oob_right(struct kunit *test)
754 {
755         volatile int i = 10;
756         char alloca_array[i];
757         /* See comment in kasan_global_oob. */
758         char *volatile array = alloca_array;
759         char *p = array + i;
760
761         /* Only generic mode instruments dynamic allocas. */
762         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_GENERIC);
763         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_STACK);
764
765         KUNIT_EXPECT_KASAN_FAIL(test, *(volatile char *)p);
766 }
767
768 static void kmem_cache_double_free(struct kunit *test)
769 {
770         char *p;
771         size_t size = 200;
772         struct kmem_cache *cache;
773
774         cache = kmem_cache_create("test_cache", size, 0, 0, NULL);
775         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, cache);
776
777         p = kmem_cache_alloc(cache, GFP_KERNEL);
778         if (!p) {
779                 kunit_err(test, "Allocation failed: %s\n", __func__);
780                 kmem_cache_destroy(cache);
781                 return;
782         }
783
784         kmem_cache_free(cache, p);
785         KUNIT_EXPECT_KASAN_FAIL(test, kmem_cache_free(cache, p));
786         kmem_cache_destroy(cache);
787 }
788
789 static void kmem_cache_invalid_free(struct kunit *test)
790 {
791         char *p;
792         size_t size = 200;
793         struct kmem_cache *cache;
794
795         cache = kmem_cache_create("test_cache", size, 0, SLAB_TYPESAFE_BY_RCU,
796                                   NULL);
797         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, cache);
798
799         p = kmem_cache_alloc(cache, GFP_KERNEL);
800         if (!p) {
801                 kunit_err(test, "Allocation failed: %s\n", __func__);
802                 kmem_cache_destroy(cache);
803                 return;
804         }
805
806         /* Trigger invalid free, the object doesn't get freed. */
807         KUNIT_EXPECT_KASAN_FAIL(test, kmem_cache_free(cache, p + 1));
808
809         /*
810          * Properly free the object to prevent the "Objects remaining in
811          * test_cache on __kmem_cache_shutdown" BUG failure.
812          */
813         kmem_cache_free(cache, p);
814
815         kmem_cache_destroy(cache);
816 }
817
818 static void kasan_memchr(struct kunit *test)
819 {
820         char *ptr;
821         size_t size = 24;
822
823         /*
824          * str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT.
825          * See https://bugzilla.kernel.org/show_bug.cgi?id=206337 for details.
826          */
827         KASAN_TEST_NEEDS_CONFIG_OFF(test, CONFIG_AMD_MEM_ENCRYPT);
828
829         if (OOB_TAG_OFF)
830                 size = round_up(size, OOB_TAG_OFF);
831
832         ptr = kmalloc(size, GFP_KERNEL | __GFP_ZERO);
833         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
834
835         KUNIT_EXPECT_KASAN_FAIL(test,
836                 kasan_ptr_result = memchr(ptr, '1', size + 1));
837
838         kfree(ptr);
839 }
840
841 static void kasan_memcmp(struct kunit *test)
842 {
843         char *ptr;
844         size_t size = 24;
845         int arr[9];
846
847         /*
848          * str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT.
849          * See https://bugzilla.kernel.org/show_bug.cgi?id=206337 for details.
850          */
851         KASAN_TEST_NEEDS_CONFIG_OFF(test, CONFIG_AMD_MEM_ENCRYPT);
852
853         if (OOB_TAG_OFF)
854                 size = round_up(size, OOB_TAG_OFF);
855
856         ptr = kmalloc(size, GFP_KERNEL | __GFP_ZERO);
857         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
858         memset(arr, 0, sizeof(arr));
859
860         KUNIT_EXPECT_KASAN_FAIL(test,
861                 kasan_int_result = memcmp(ptr, arr, size+1));
862         kfree(ptr);
863 }
864
865 static void kasan_strings(struct kunit *test)
866 {
867         char *ptr;
868         size_t size = 24;
869
870         /*
871          * str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT.
872          * See https://bugzilla.kernel.org/show_bug.cgi?id=206337 for details.
873          */
874         KASAN_TEST_NEEDS_CONFIG_OFF(test, CONFIG_AMD_MEM_ENCRYPT);
875
876         ptr = kmalloc(size, GFP_KERNEL | __GFP_ZERO);
877         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
878
879         kfree(ptr);
880
881         /*
882          * Try to cause only 1 invalid access (less spam in dmesg).
883          * For that we need ptr to point to zeroed byte.
884          * Skip metadata that could be stored in freed object so ptr
885          * will likely point to zeroed byte.
886          */
887         ptr += 16;
888         KUNIT_EXPECT_KASAN_FAIL(test, kasan_ptr_result = strchr(ptr, '1'));
889
890         KUNIT_EXPECT_KASAN_FAIL(test, kasan_ptr_result = strrchr(ptr, '1'));
891
892         KUNIT_EXPECT_KASAN_FAIL(test, kasan_int_result = strcmp(ptr, "2"));
893
894         KUNIT_EXPECT_KASAN_FAIL(test, kasan_int_result = strncmp(ptr, "2", 1));
895
896         KUNIT_EXPECT_KASAN_FAIL(test, kasan_int_result = strlen(ptr));
897
898         KUNIT_EXPECT_KASAN_FAIL(test, kasan_int_result = strnlen(ptr, 1));
899 }
900
901 static void kasan_bitops_modify(struct kunit *test, int nr, void *addr)
902 {
903         KUNIT_EXPECT_KASAN_FAIL(test, set_bit(nr, addr));
904         KUNIT_EXPECT_KASAN_FAIL(test, __set_bit(nr, addr));
905         KUNIT_EXPECT_KASAN_FAIL(test, clear_bit(nr, addr));
906         KUNIT_EXPECT_KASAN_FAIL(test, __clear_bit(nr, addr));
907         KUNIT_EXPECT_KASAN_FAIL(test, clear_bit_unlock(nr, addr));
908         KUNIT_EXPECT_KASAN_FAIL(test, __clear_bit_unlock(nr, addr));
909         KUNIT_EXPECT_KASAN_FAIL(test, change_bit(nr, addr));
910         KUNIT_EXPECT_KASAN_FAIL(test, __change_bit(nr, addr));
911 }
912
913 static void kasan_bitops_test_and_modify(struct kunit *test, int nr, void *addr)
914 {
915         KUNIT_EXPECT_KASAN_FAIL(test, test_and_set_bit(nr, addr));
916         KUNIT_EXPECT_KASAN_FAIL(test, __test_and_set_bit(nr, addr));
917         KUNIT_EXPECT_KASAN_FAIL(test, test_and_set_bit_lock(nr, addr));
918         KUNIT_EXPECT_KASAN_FAIL(test, test_and_clear_bit(nr, addr));
919         KUNIT_EXPECT_KASAN_FAIL(test, __test_and_clear_bit(nr, addr));
920         KUNIT_EXPECT_KASAN_FAIL(test, test_and_change_bit(nr, addr));
921         KUNIT_EXPECT_KASAN_FAIL(test, __test_and_change_bit(nr, addr));
922         KUNIT_EXPECT_KASAN_FAIL(test, kasan_int_result = test_bit(nr, addr));
923
924 #if defined(clear_bit_unlock_is_negative_byte)
925         KUNIT_EXPECT_KASAN_FAIL(test, kasan_int_result =
926                                 clear_bit_unlock_is_negative_byte(nr, addr));
927 #endif
928 }
929
930 static void kasan_bitops_generic(struct kunit *test)
931 {
932         long *bits;
933
934         /* This test is specifically crafted for the generic mode. */
935         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_GENERIC);
936
937         /*
938          * Allocate 1 more byte, which causes kzalloc to round up to 16 bytes;
939          * this way we do not actually corrupt other memory.
940          */
941         bits = kzalloc(sizeof(*bits) + 1, GFP_KERNEL);
942         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, bits);
943
944         /*
945          * Below calls try to access bit within allocated memory; however, the
946          * below accesses are still out-of-bounds, since bitops are defined to
947          * operate on the whole long the bit is in.
948          */
949         kasan_bitops_modify(test, BITS_PER_LONG, bits);
950
951         /*
952          * Below calls try to access bit beyond allocated memory.
953          */
954         kasan_bitops_test_and_modify(test, BITS_PER_LONG + BITS_PER_BYTE, bits);
955
956         kfree(bits);
957 }
958
959 static void kasan_bitops_tags(struct kunit *test)
960 {
961         long *bits;
962
963         /* This test is specifically crafted for tag-based modes. */
964         KASAN_TEST_NEEDS_CONFIG_OFF(test, CONFIG_KASAN_GENERIC);
965
966         /* kmalloc-64 cache will be used and the last 16 bytes will be the redzone. */
967         bits = kzalloc(48, GFP_KERNEL);
968         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, bits);
969
970         /* Do the accesses past the 48 allocated bytes, but within the redone. */
971         kasan_bitops_modify(test, BITS_PER_LONG, (void *)bits + 48);
972         kasan_bitops_test_and_modify(test, BITS_PER_LONG + BITS_PER_BYTE, (void *)bits + 48);
973
974         kfree(bits);
975 }
976
977 static void kmalloc_double_kzfree(struct kunit *test)
978 {
979         char *ptr;
980         size_t size = 16;
981
982         ptr = kmalloc(size, GFP_KERNEL);
983         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
984
985         kfree_sensitive(ptr);
986         KUNIT_EXPECT_KASAN_FAIL(test, kfree_sensitive(ptr));
987 }
988
989 static void vmalloc_oob(struct kunit *test)
990 {
991         void *area;
992
993         KASAN_TEST_NEEDS_CONFIG_ON(test, CONFIG_KASAN_VMALLOC);
994
995         /*
996          * We have to be careful not to hit the guard page.
997          * The MMU will catch that and crash us.
998          */
999         area = vmalloc(3000);
1000         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, area);
1001
1002         KUNIT_EXPECT_KASAN_FAIL(test, ((volatile char *)area)[3100]);
1003         vfree(area);
1004 }
1005
1006 /*
1007  * Check that the assigned pointer tag falls within the [KASAN_TAG_MIN,
1008  * KASAN_TAG_KERNEL) range (note: excluding the match-all tag) for tag-based
1009  * modes.
1010  */
1011 static void match_all_not_assigned(struct kunit *test)
1012 {
1013         char *ptr;
1014         struct page *pages;
1015         int i, size, order;
1016
1017         KASAN_TEST_NEEDS_CONFIG_OFF(test, CONFIG_KASAN_GENERIC);
1018
1019         for (i = 0; i < 256; i++) {
1020                 size = (get_random_int() % 1024) + 1;
1021                 ptr = kmalloc(size, GFP_KERNEL);
1022                 KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
1023                 KUNIT_EXPECT_GE(test, (u8)get_tag(ptr), (u8)KASAN_TAG_MIN);
1024                 KUNIT_EXPECT_LT(test, (u8)get_tag(ptr), (u8)KASAN_TAG_KERNEL);
1025                 kfree(ptr);
1026         }
1027
1028         for (i = 0; i < 256; i++) {
1029                 order = (get_random_int() % 4) + 1;
1030                 pages = alloc_pages(GFP_KERNEL, order);
1031                 ptr = page_address(pages);
1032                 KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
1033                 KUNIT_EXPECT_GE(test, (u8)get_tag(ptr), (u8)KASAN_TAG_MIN);
1034                 KUNIT_EXPECT_LT(test, (u8)get_tag(ptr), (u8)KASAN_TAG_KERNEL);
1035                 free_pages((unsigned long)ptr, order);
1036         }
1037 }
1038
1039 /* Check that 0xff works as a match-all pointer tag for tag-based modes. */
1040 static void match_all_ptr_tag(struct kunit *test)
1041 {
1042         char *ptr;
1043         u8 tag;
1044
1045         KASAN_TEST_NEEDS_CONFIG_OFF(test, CONFIG_KASAN_GENERIC);
1046
1047         ptr = kmalloc(128, GFP_KERNEL);
1048         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
1049
1050         /* Backup the assigned tag. */
1051         tag = get_tag(ptr);
1052         KUNIT_EXPECT_NE(test, tag, (u8)KASAN_TAG_KERNEL);
1053
1054         /* Reset the tag to 0xff.*/
1055         ptr = set_tag(ptr, KASAN_TAG_KERNEL);
1056
1057         /* This access shouldn't trigger a KASAN report. */
1058         *ptr = 0;
1059
1060         /* Recover the pointer tag and free. */
1061         ptr = set_tag(ptr, tag);
1062         kfree(ptr);
1063 }
1064
1065 /* Check that there are no match-all memory tags for tag-based modes. */
1066 static void match_all_mem_tag(struct kunit *test)
1067 {
1068         char *ptr;
1069         int tag;
1070
1071         KASAN_TEST_NEEDS_CONFIG_OFF(test, CONFIG_KASAN_GENERIC);
1072
1073         ptr = kmalloc(128, GFP_KERNEL);
1074         KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr);
1075         KUNIT_EXPECT_NE(test, (u8)get_tag(ptr), (u8)KASAN_TAG_KERNEL);
1076
1077         /* For each possible tag value not matching the pointer tag. */
1078         for (tag = KASAN_TAG_MIN; tag <= KASAN_TAG_KERNEL; tag++) {
1079                 if (tag == get_tag(ptr))
1080                         continue;
1081
1082                 /* Mark the first memory granule with the chosen memory tag. */
1083                 kasan_poison(ptr, KASAN_GRANULE_SIZE, (u8)tag, false);
1084
1085                 /* This access must cause a KASAN report. */
1086                 KUNIT_EXPECT_KASAN_FAIL(test, *ptr = 0);
1087         }
1088
1089         /* Recover the memory tag and free. */
1090         kasan_poison(ptr, KASAN_GRANULE_SIZE, get_tag(ptr), false);
1091         kfree(ptr);
1092 }
1093
1094 static struct kunit_case kasan_kunit_test_cases[] = {
1095         KUNIT_CASE(kmalloc_oob_right),
1096         KUNIT_CASE(kmalloc_oob_left),
1097         KUNIT_CASE(kmalloc_node_oob_right),
1098         KUNIT_CASE(kmalloc_pagealloc_oob_right),
1099         KUNIT_CASE(kmalloc_pagealloc_uaf),
1100         KUNIT_CASE(kmalloc_pagealloc_invalid_free),
1101         KUNIT_CASE(pagealloc_oob_right),
1102         KUNIT_CASE(pagealloc_uaf),
1103         KUNIT_CASE(kmalloc_large_oob_right),
1104         KUNIT_CASE(krealloc_more_oob),
1105         KUNIT_CASE(krealloc_less_oob),
1106         KUNIT_CASE(krealloc_pagealloc_more_oob),
1107         KUNIT_CASE(krealloc_pagealloc_less_oob),
1108         KUNIT_CASE(krealloc_uaf),
1109         KUNIT_CASE(kmalloc_oob_16),
1110         KUNIT_CASE(kmalloc_uaf_16),
1111         KUNIT_CASE(kmalloc_oob_in_memset),
1112         KUNIT_CASE(kmalloc_oob_memset_2),
1113         KUNIT_CASE(kmalloc_oob_memset_4),
1114         KUNIT_CASE(kmalloc_oob_memset_8),
1115         KUNIT_CASE(kmalloc_oob_memset_16),
1116         KUNIT_CASE(kmalloc_memmove_invalid_size),
1117         KUNIT_CASE(kmalloc_uaf),
1118         KUNIT_CASE(kmalloc_uaf_memset),
1119         KUNIT_CASE(kmalloc_uaf2),
1120         KUNIT_CASE(kfree_via_page),
1121         KUNIT_CASE(kfree_via_phys),
1122         KUNIT_CASE(kmem_cache_oob),
1123         KUNIT_CASE(kmem_cache_accounted),
1124         KUNIT_CASE(kmem_cache_bulk),
1125         KUNIT_CASE(kasan_global_oob),
1126         KUNIT_CASE(kasan_stack_oob),
1127         KUNIT_CASE(kasan_alloca_oob_left),
1128         KUNIT_CASE(kasan_alloca_oob_right),
1129         KUNIT_CASE(ksize_unpoisons_memory),
1130         KUNIT_CASE(ksize_uaf),
1131         KUNIT_CASE(kmem_cache_double_free),
1132         KUNIT_CASE(kmem_cache_invalid_free),
1133         KUNIT_CASE(kasan_memchr),
1134         KUNIT_CASE(kasan_memcmp),
1135         KUNIT_CASE(kasan_strings),
1136         KUNIT_CASE(kasan_bitops_generic),
1137         KUNIT_CASE(kasan_bitops_tags),
1138         KUNIT_CASE(kmalloc_double_kzfree),
1139         KUNIT_CASE(vmalloc_oob),
1140         KUNIT_CASE(match_all_not_assigned),
1141         KUNIT_CASE(match_all_ptr_tag),
1142         KUNIT_CASE(match_all_mem_tag),
1143         {}
1144 };
1145
1146 static struct kunit_suite kasan_kunit_test_suite = {
1147         .name = "kasan",
1148         .init = kasan_test_init,
1149         .test_cases = kasan_kunit_test_cases,
1150         .exit = kasan_test_exit,
1151 };
1152
1153 kunit_test_suite(kasan_kunit_test_suite);
1154
1155 MODULE_LICENSE("GPL");