From mboxrd@z Thu Jan 1 00:00:00 1970 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=-23.3 required=3.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_IN_DEF_DKIM_WL autolearn=ham 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 0DB33C433E0 for ; Wed, 13 Jan 2021 16:24:19 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 90AB923339 for ; Wed, 13 Jan 2021 16:24:18 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 90AB923339 Authentication-Results: mail.kernel.org; dmarc=fail (p=reject dis=none) header.from=google.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id B42D06B015B; Wed, 13 Jan 2021 11:24:17 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id ACA376B015C; Wed, 13 Jan 2021 11:24:17 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 96B996B015D; Wed, 13 Jan 2021 11:24:17 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0232.hostedemail.com [216.40.44.232]) by kanga.kvack.org (Postfix) with ESMTP id 7AD466B015B for ; Wed, 13 Jan 2021 11:24:17 -0500 (EST) Received: from smtpin12.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay04.hostedemail.com (Postfix) with ESMTP id 3CC2B1EE6 for ; Wed, 13 Jan 2021 16:24:17 +0000 (UTC) X-FDA: 77701274154.12.drum82_490ace32751f Received: from filter.hostedemail.com (10.5.16.251.rfc1918.com [10.5.16.251]) by smtpin12.hostedemail.com (Postfix) with ESMTP id 17A6918055A04 for ; Wed, 13 Jan 2021 16:24:17 +0000 (UTC) X-HE-Tag: drum82_490ace32751f X-Filterd-Recvd-Size: 10893 Received: from mail-oi1-f170.google.com (mail-oi1-f170.google.com [209.85.167.170]) by imf03.hostedemail.com (Postfix) with ESMTP for ; Wed, 13 Jan 2021 16:24:16 +0000 (UTC) Received: by mail-oi1-f170.google.com with SMTP id s75so2723107oih.1 for ; Wed, 13 Jan 2021 08:24:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=GyTHDPIRlWLUaLwyKAW0evEpBngzgktQyEH3p/lXCIQ=; b=tlmb7Dtm51MoH15iZg/lhbLEU6E68eF7hqHr1ps+iDOD9RNrV57MUjlTOEoiDYpx69 2YAEmHX3h7QQSxfCGnPtws3q+v+8qoDfQgCAX/6c5bnqVjNrNclTcfs88p4Ts0qyke/v ZlCAK0KNdVFHCc/68pduQuHGmlZ+rAqUP1e16Pxj2qGysyZQe1ElKbcaJYO/2BQrFCKa BwcWhOlEbJPZrmymNTXoiudyzG6dgf19wjbt8WJxM0qyLERrMKqDZgCfl8rEZlDio16m GRYglcqBDhqtJofwb28SiGQ3j6arsVBTJccjuQnqdI/ztty+oWz6GQNyTFbNlwdDE1qX 3kvg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=GyTHDPIRlWLUaLwyKAW0evEpBngzgktQyEH3p/lXCIQ=; b=WpKk7X9fgrAdnRk7zw6/LLhP5/XwuNxu20GXcw7456RaAK5v2N3ozTdjYktyiDOE/5 BRwCgPhqSphTS/zZnQrpOVHSP6xHBex6yIM9jyyOfunpew8TKLl/nbIxNGACv2PnoZpq NVHDAxDHHiI5Fm3gszf0/FKkdUgHyfqO+h3waH3prNTsgAPkW7o3j7VaMNCNTkb8VKZ7 Pu4RsRzaqO9ZY8IP7EF6An+XRD02AA6S6qjQN1zlTilKtFh5rk4HLC95maPrXVIVeBIL 8kodWDbwEwNyV/i2VgQPMpq8ARL1tSH1sjIdwyYUp+UwyFsaFTu9Vy84vm8E5rbfhFIN MddQ== X-Gm-Message-State: AOAM530434W6i8KIzGP8jyC5kFFI5tIU86/LgPtf71mLNMABRJy7TfUO /XSkKM1yUXvK9xBQjotE6DzgG/xSM/Jng2KJlwdfnQ== X-Google-Smtp-Source: ABdhPJzTX1NywOTNPaOnaT0/36HRmD8HHFaXd0vCHiUeKsmc7RWZZTe0P8Mxj/7ZesW69I5KXUm9LuyLJUSGubltUn8= X-Received: by 2002:aca:c085:: with SMTP id q127mr58645oif.70.1610555055524; Wed, 13 Jan 2021 08:24:15 -0800 (PST) MIME-Version: 1.0 References: <2b43049e25dcd04850ba6c205cd6dcc7caa4a886.1610554432.git.andreyknvl@google.com> In-Reply-To: <2b43049e25dcd04850ba6c205cd6dcc7caa4a886.1610554432.git.andreyknvl@google.com> From: Marco Elver Date: Wed, 13 Jan 2021 17:24:03 +0100 Message-ID: Subject: Re: [PATCH v2 03/14] kasan: clean up comments in tests To: Andrey Konovalov Cc: Catalin Marinas , Vincenzo Frascino , Dmitry Vyukov , Alexander Potapenko , Andrew Morton , Will Deacon , Andrey Ryabinin , Peter Collingbourne , Evgenii Stepanov , Branislav Rankov , Kevin Brodsky , kasan-dev , Linux ARM , Linux Memory Management List , LKML Content-Type: text/plain; charset="UTF-8" X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: On Wed, 13 Jan 2021 at 17:21, Andrey Konovalov wrote: > > Clarify and update comments in KASAN tests. > > Link: https://linux-review.googlesource.com/id/I6c816c51fa1e0eb7aa3dead6bda1f339d2af46c8 > Signed-off-by: Andrey Konovalov Reviewed-by: Marco Elver > --- > lib/test_kasan.c | 59 +++++++++++++++++++++++++---------------- > lib/test_kasan_module.c | 5 ++-- > 2 files changed, 39 insertions(+), 25 deletions(-) > > diff --git a/lib/test_kasan.c b/lib/test_kasan.c > index 2947274cc2d3..6f46e27c2af7 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); \ > @@ -121,7 +119,8 @@ static void kmalloc_pagealloc_oob_right(struct kunit *test) > 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); > @@ -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); > @@ -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); > } > > @@ -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,7 +589,10 @@ 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"); > @@ -610,7 +617,10 @@ 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"); > @@ -634,7 +644,10 @@ 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"); > @@ -706,7 +719,7 @@ static void kasan_bitops_generic(struct kunit *test) > } > > /* > - * 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); > 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(); > > -- > 2.30.0.284.gd98b1dd5eaa7-goog >