From patchwork Tue Jan 5 18:27:47 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrey Konovalov X-Patchwork-Id: 12000071 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-17.0 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_ADSP_CUSTOM_MED,DKIM_SIGNED,DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4AA73C433DB for ; Tue, 5 Jan 2021 18:31:01 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id B93B522D57 for ; Tue, 5 Jan 2021 18:31:00 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org B93B522D57 Authentication-Results: mail.kernel.org; dmarc=fail (p=reject dis=none) header.from=google.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:To:From:Subject:References:Mime-Version:Message-Id: In-Reply-To:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=b/qk7xR4BPQwMZepDHOvTdlya+/1s8hOqHeXF1Q7bMQ=; b=G6jVh4YRgXdPLQb9o9HWUTh0v Tdfn6nrqDC7FGyxG2DvrogcALX9vTPJ6gZrUFhqxvI99pHU0gxwEwbvo4i6XOMwIDJXUhCaKImNcy tEVwDL5tbFM4X3upVdR563aPcmCmeyCEi+VNSWewTcONK788TLgvYkRPO3yPzSGvF3qA/Moc+IVSS QuH6FIdgDU4t2lKxqpU8yKjHh5TjvOOVTmA20dLXkvIRrIAdGxpRBUbmuajqFx7i08cBz0mFeHF/k wXk13Pw+HUqkx8JbGhnuWHZsmaaMTjRESbufpdmjRTb/tuTI+HxJwZAmBsywg7eI996sA7flXnmHB 9UFtZc/xQ==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1kwr4S-00079K-8B; Tue, 05 Jan 2021 18:28:40 +0000 Received: from mail-wr1-x449.google.com ([2a00:1450:4864:20::449]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1kwr41-0006xz-9g for linux-arm-kernel@lists.infradead.org; Tue, 05 Jan 2021 18:28:19 +0000 Received: by mail-wr1-x449.google.com with SMTP id i4so173102wrm.21 for ; Tue, 05 Jan 2021 10:28:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=sender:date:in-reply-to:message-id:mime-version:references:subject :from:to:cc; bh=kMqOwAycKrvTptizhNYAx5EVpfOHvBX1uRwiTYE70ik=; b=fj8BsYWgCboP+uVLBfvlbK31OG0ZtFjZt8zg55BXEKKy2v1MXA0eTVf7WHerJZ4xSW iuoWFs/AUeCZUFjT3q9Dil3OXp3+2WbO24Oy7cWUfSsHXUGhaULNe+jCfB5LXEZJqKxi XPtkWWmW6g3x8diCRQo75saoWYguzu2Y6r6vFhILoB3ct/OxXXZRLvmtH76jLWiejlKf ElfPX2qRlQVV8/Cm0kwX1BYlCrfYUSBSa9PzFRXDiaE0fSDv1gT3quf6anlqHKJe9dtM V/PrBwCcgDCk2ia/2fUZY7MB29NUlm39xinhRinn/MrO2Xv46hHXChBBVjzO7nhXHIAQ kmEA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=kMqOwAycKrvTptizhNYAx5EVpfOHvBX1uRwiTYE70ik=; b=Ty6rDLKHksthMmLtFFqNHgcSC33XDRgbPGfz7UIJ3SXa3BtKiAUIQ6vTsHO9Bk4EqQ tDbS3nd5f4hfC8SacqOyny6RrQUuzVQaYCI/DsAYcE/9YoGFPQwC7mExOfu7iI+v/MYm 38QY5llsZhBZSrwpJwQ5PjgxWgt4N9OV3/MSQZoBITpySLNr5SAoFaSnQi8DqORonWOG OoSKaeUTR0Po0b9lqt2ssKQc8nKTo/u6x5OsbdUmVK4ql3plGpy8WXw3srUD3PcCtMKb YfxaV/mKWRjGh91FUBPgNcL+B9h2EzlGf409wHAkA2OHoD/smsHpfhu3ZsyDQysci857 cXBw== X-Gm-Message-State: AOAM532U3YcV8aHHHEfW73JU74WsnqW3gwMH56xhEQvUUKqVDN4tXLbT bUmlGc6r83ReCHlehgUCaGsxO9FKfkJSfP38 X-Google-Smtp-Source: ABdhPJwGB1XJ2ejrBSrZLIAkQ/xHnnVSqucNQ8BcjHRY5B2Gd7j+EsVmJ2AdOBTl42/sHCQeRO/tPW5KILA8tRZU X-Received: from andreyknvl3.muc.corp.google.com ([2a00:79e0:15:13:7220:84ff:fe09:7e9d]) (user=andreyknvl job=sendgmr) by 2002:a5d:4307:: with SMTP id h7mr795184wrq.353.1609871289844; Tue, 05 Jan 2021 10:28:09 -0800 (PST) Date: Tue, 5 Jan 2021 19:27:47 +0100 In-Reply-To: Message-Id: Mime-Version: 1.0 References: X-Mailer: git-send-email 2.29.2.729.g45daf8777d-goog Subject: [PATCH 03/11] kasan: clean up comments in tests From: Andrey Konovalov To: Catalin Marinas , Vincenzo Frascino , Dmitry Vyukov , Alexander Potapenko , Marco Elver X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210105_132813_383280_EDDE1955 X-CRM114-Status: GOOD ( 21.23 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Branislav Rankov , Andrey Konovalov , Kevin Brodsky , Will Deacon , linux-kernel@vger.kernel.org, kasan-dev@googlegroups.com, linux-mm@kvack.org, linux-arm-kernel@lists.infradead.org, Andrey Ryabinin , Andrew Morton , Evgenii Stepanov Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Clarify and update comments and info messages in KASAN tests. Signed-off-by: Andrey Konovalov Link: https://linux-review.googlesource.com/id/I6c816c51fa1e0eb7aa3dead6bda1f339d2af46c8 Reviewed-by: Marco Elver --- lib/test_kasan.c | 94 +++++++++++++++++++++++------------------ lib/test_kasan_module.c | 5 ++- 2 files changed, 55 insertions(+), 44 deletions(-) diff --git a/lib/test_kasan.c b/lib/test_kasan.c index 2947274cc2d3..46e578c8e842 100644 --- a/lib/test_kasan.c +++ b/lib/test_kasan.c @@ -28,10 +28,9 @@ #define OOB_TAG_OFF (IS_ENABLED(CONFIG_KASAN_GENERIC) ? 0 : KASAN_GRANULE_SIZE) /* - * We assign some test results to these globals to make sure the tests - * are not eliminated as dead code. + * Some tests use these global variables to store return values from function + * calls that could otherwise be eliminated by the compiler as dead code. */ - void *kasan_ptr_result; int kasan_int_result; @@ -39,14 +38,13 @@ static struct kunit_resource resource; static struct kunit_kasan_expectation fail_data; static bool multishot; +/* + * Temporarily enable multi-shot mode. Otherwise, KASAN would only report the + * first detected bug and panic the kernel if panic_on_warn is enabled. + */ static int kasan_test_init(struct kunit *test) { - /* - * Temporarily enable multi-shot mode and set panic_on_warn=0. - * Otherwise, we'd only get a report for the first case. - */ multishot = kasan_save_enable_multi_shot(); - return 0; } @@ -56,12 +54,12 @@ static void kasan_test_exit(struct kunit *test) } /** - * KUNIT_EXPECT_KASAN_FAIL() - Causes a test failure when the expression does - * not cause a KASAN error. This uses a KUnit resource named "kasan_data." Do - * Do not use this name for a KUnit resource outside here. - * + * KUNIT_EXPECT_KASAN_FAIL() - check that the executed expression produces a + * KASAN report; causes a test failure otherwise. This relies on a KUnit + * resource named "kasan_data". Do not use this name for KUnit resources + * outside of KASAN tests. */ -#define KUNIT_EXPECT_KASAN_FAIL(test, condition) do { \ +#define KUNIT_EXPECT_KASAN_FAIL(test, expression) do { \ fail_data.report_expected = true; \ fail_data.report_found = false; \ kunit_add_named_resource(test, \ @@ -69,7 +67,7 @@ static void kasan_test_exit(struct kunit *test) NULL, \ &resource, \ "kasan_data", &fail_data); \ - condition; \ + expression; \ KUNIT_EXPECT_EQ(test, \ fail_data.report_expected, \ fail_data.report_found); \ @@ -117,11 +115,12 @@ static void kmalloc_pagealloc_oob_right(struct kunit *test) size_t size = KMALLOC_MAX_CACHE_SIZE + 10; if (!IS_ENABLED(CONFIG_SLUB)) { - kunit_info(test, "CONFIG_SLUB is not enabled."); + kunit_info(test, "skipping, CONFIG_SLUB required"); return; } - /* Allocate a chunk that does not fit into a SLUB cache to trigger + /* + * Allocate a chunk that does not fit into a SLUB cache to trigger * the page allocator fallback. */ ptr = kmalloc(size, GFP_KERNEL); @@ -137,7 +136,7 @@ static void kmalloc_pagealloc_uaf(struct kunit *test) size_t size = KMALLOC_MAX_CACHE_SIZE + 10; if (!IS_ENABLED(CONFIG_SLUB)) { - kunit_info(test, "CONFIG_SLUB is not enabled."); + kunit_info(test, "skipping, CONFIG_SLUB required"); return; } @@ -154,7 +153,7 @@ static void kmalloc_pagealloc_invalid_free(struct kunit *test) size_t size = KMALLOC_MAX_CACHE_SIZE + 10; if (!IS_ENABLED(CONFIG_SLUB)) { - kunit_info(test, "CONFIG_SLUB is not enabled."); + kunit_info(test, "skipping, CONFIG_SLUB required"); return; } @@ -168,7 +167,9 @@ static void kmalloc_large_oob_right(struct kunit *test) { char *ptr; size_t size = KMALLOC_MAX_CACHE_SIZE - 256; - /* Allocate a chunk that is large enough, but still fits into a slab + + /* + * Allocate a chunk that is large enough, but still fits into a slab * and does not trigger the page allocator fallback in SLUB. */ ptr = kmalloc(size, GFP_KERNEL); @@ -218,7 +219,7 @@ static void kmalloc_oob_16(struct kunit *test) /* This test is specifically crafted for the generic mode. */ if (!IS_ENABLED(CONFIG_KASAN_GENERIC)) { - kunit_info(test, "CONFIG_KASAN_GENERIC required\n"); + kunit_info(test, "skipping, CONFIG_KASAN_GENERIC required"); return; } @@ -454,7 +455,7 @@ static void kasan_global_oob(struct kunit *test) /* Only generic mode instruments globals. */ if (!IS_ENABLED(CONFIG_KASAN_GENERIC)) { - kunit_info(test, "CONFIG_KASAN_GENERIC required"); + kunit_info(test, "skipping, CONFIG_KASAN_GENERIC required"); return; } @@ -469,10 +470,13 @@ static void ksize_unpoisons_memory(struct kunit *test) ptr = kmalloc(size, GFP_KERNEL); KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr); real_size = ksize(ptr); - /* This access doesn't trigger an error. */ + + /* This access shouldn't trigger a KASAN report. */ ptr[size] = 'x'; - /* This one does. */ + + /* This one must. */ KUNIT_EXPECT_KASAN_FAIL(test, ptr[real_size] = 'y'); + kfree(ptr); } @@ -483,7 +487,7 @@ static void kasan_stack_oob(struct kunit *test) char *p = &stack_array[ARRAY_SIZE(stack_array) + i]; if (!IS_ENABLED(CONFIG_KASAN_STACK)) { - kunit_info(test, "CONFIG_KASAN_STACK is not enabled"); + kunit_info(test, "skipping, CONFIG_KASAN_STACK required"); return; } @@ -498,12 +502,12 @@ static void kasan_alloca_oob_left(struct kunit *test) /* Only generic mode instruments dynamic allocas. */ if (!IS_ENABLED(CONFIG_KASAN_GENERIC)) { - kunit_info(test, "CONFIG_KASAN_GENERIC required"); + kunit_info(test, "skipping, CONFIG_KASAN_GENERIC required"); return; } if (!IS_ENABLED(CONFIG_KASAN_STACK)) { - kunit_info(test, "CONFIG_KASAN_STACK is not enabled"); + kunit_info(test, "skipping, CONFIG_KASAN_STACK required"); return; } @@ -518,12 +522,12 @@ static void kasan_alloca_oob_right(struct kunit *test) /* Only generic mode instruments dynamic allocas. */ if (!IS_ENABLED(CONFIG_KASAN_GENERIC)) { - kunit_info(test, "CONFIG_KASAN_GENERIC required"); + kunit_info(test, "skipping, CONFIG_KASAN_GENERIC required"); return; } if (!IS_ENABLED(CONFIG_KASAN_STACK)) { - kunit_info(test, "CONFIG_KASAN_STACK is not enabled"); + kunit_info(test, "skipping, CONFIG_KASAN_STACK required"); return; } @@ -568,7 +572,7 @@ static void kmem_cache_invalid_free(struct kunit *test) return; } - /* Trigger invalid free, the object doesn't get freed */ + /* Trigger invalid free, the object doesn't get freed. */ KUNIT_EXPECT_KASAN_FAIL(test, kmem_cache_free(cache, p + 1)); /* @@ -585,10 +589,12 @@ static void kasan_memchr(struct kunit *test) char *ptr; size_t size = 24; - /* See https://bugzilla.kernel.org/show_bug.cgi?id=206337 */ + /* + * str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT. + * See https://bugzilla.kernel.org/show_bug.cgi?id=206337 for details. + */ if (IS_ENABLED(CONFIG_AMD_MEM_ENCRYPT)) { - kunit_info(test, - "str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT"); + kunit_info(test, "skipping, CONFIG_AMD_MEM_ENCRYPT enabled"); return; } @@ -610,10 +616,12 @@ static void kasan_memcmp(struct kunit *test) size_t size = 24; int arr[9]; - /* See https://bugzilla.kernel.org/show_bug.cgi?id=206337 */ + /* + * str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT. + * See https://bugzilla.kernel.org/show_bug.cgi?id=206337 for details. + */ if (IS_ENABLED(CONFIG_AMD_MEM_ENCRYPT)) { - kunit_info(test, - "str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT"); + kunit_info(test, "skipping, CONFIG_AMD_MEM_ENCRYPT enabled"); return; } @@ -634,10 +642,12 @@ static void kasan_strings(struct kunit *test) char *ptr; size_t size = 24; - /* See https://bugzilla.kernel.org/show_bug.cgi?id=206337 */ + /* + * str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT. + * See https://bugzilla.kernel.org/show_bug.cgi?id=206337 for details. + */ if (IS_ENABLED(CONFIG_AMD_MEM_ENCRYPT)) { - kunit_info(test, - "str* functions are not instrumented with CONFIG_AMD_MEM_ENCRYPT"); + kunit_info(test, "skipping, CONFIG_AMD_MEM_ENCRYPT enabled"); return; } @@ -701,12 +711,12 @@ static void kasan_bitops_generic(struct kunit *test) /* This test is specifically crafted for the generic mode. */ if (!IS_ENABLED(CONFIG_KASAN_GENERIC)) { - kunit_info(test, "CONFIG_KASAN_GENERIC required\n"); + kunit_info(test, "skipping, CONFIG_KASAN_GENERIC required"); return; } /* - * Allocate 1 more byte, which causes kzalloc to round up to 16-bytes; + * Allocate 1 more byte, which causes kzalloc to round up to 16 bytes; * this way we do not actually corrupt other memory. */ bits = kzalloc(sizeof(*bits) + 1, GFP_KERNEL); @@ -733,7 +743,7 @@ static void kasan_bitops_tags(struct kunit *test) /* This test is specifically crafted for the tag-based mode. */ if (IS_ENABLED(CONFIG_KASAN_GENERIC)) { - kunit_info(test, "CONFIG_KASAN_SW_TAGS required\n"); + kunit_info(test, "skipping, CONFIG_KASAN_SW_TAGS required"); return; } @@ -765,7 +775,7 @@ static void vmalloc_oob(struct kunit *test) void *area; if (!IS_ENABLED(CONFIG_KASAN_VMALLOC)) { - kunit_info(test, "CONFIG_KASAN_VMALLOC is not enabled."); + kunit_info(test, "skipping, CONFIG_KASAN_VMALLOC required"); return; } diff --git a/lib/test_kasan_module.c b/lib/test_kasan_module.c index 3b4cc77992d2..eee017ff8980 100644 --- a/lib/test_kasan_module.c +++ b/lib/test_kasan_module.c @@ -123,8 +123,9 @@ static noinline void __init kasan_workqueue_uaf(void) static int __init test_kasan_module_init(void) { /* - * Temporarily enable multi-shot mode. Otherwise, we'd only get a - * report for the first case. + * Temporarily enable multi-shot mode. Otherwise, KASAN would only + * report the first detected bug and panic the kernel if panic_on_warn + * is enabled. */ bool multishot = kasan_save_enable_multi_shot();