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