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