From patchwork Fri Apr 24 06:13:39 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 208554 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.4 required=3.0 tests=DKIMWL_WL_MED, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE, SPF_PASS, USER_AGENT_GIT, USER_IN_DEF_DKIM_WL 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 C1F47C5518A for ; Fri, 24 Apr 2020 06:14:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9BC5620857 for ; Fri, 24 Apr 2020 06:14:02 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="dmjNNyI1" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726481AbgDXGN7 (ORCPT ); Fri, 24 Apr 2020 02:13:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49876 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1726457AbgDXGN6 (ORCPT ); Fri, 24 Apr 2020 02:13:58 -0400 Received: from mail-pg1-x54a.google.com (mail-pg1-x54a.google.com [IPv6:2607:f8b0:4864:20::54a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BD921C09B046 for ; Thu, 23 Apr 2020 23:13:58 -0700 (PDT) Received: by mail-pg1-x54a.google.com with SMTP id x132so3262796pgx.22 for ; Thu, 23 Apr 2020 23:13:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=HEF/DAV8bcIOedhqOgbS7UFU8rZD4FDsBF5mByxyLwc=; b=dmjNNyI1rJUF1XHCEPaHRL/W5bFWwyIOrOF8ku3pOQnTKU+73x2UN+LcuNoGNVmbU7 yL6mIlgSr+6yTnwgdiHs+BYi9mRCwtahZ2F9jKkBtTWGKl9hvJZsEEcoMHN7lZ91af0X 1jBDfl1CZTNg4Pj6i/ldDGfReE9IlwVGFzbBRHvSVs3SP4kR3eAYOyo9w7m1XYbvAYtq Wjaw5UpPUtPGsuy2tK405WaOqXn13GQgOvhvKE1j21I0l2bQLqbtQzj1rouEE51Fdz7V f01vputYSdAlvDZpGZfrlIQl7rYhMkdCVB4O4fPVLGcQGv6HeERGsYQ0GCSJeB+FhyVX BeBA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=HEF/DAV8bcIOedhqOgbS7UFU8rZD4FDsBF5mByxyLwc=; b=DAzAdLZT7EWvSTvtg9XhpWjHrpJu2xWUsTe+N+kLFfyhF6owrpmDWmD4V1uBHp9Vyx r/hS/3uvgrPhhJg5S3fHm2EqFahfQynNGYMSbYTKumHCrfNL+BrwPmAGc/nu0s0dUXZJ 4NF6qF12kTBELyZKdo5shj7/+2xm/VoprctRxcAcSLI9JzDIL3bR3mL136Cd0uzzBqf5 Atdit/ZaFmMmQ8vOBZ5JIRt8HdV7cSBprqJ9H+TVmLlkDZKxrWQkP/UwdsFZeUi/YgXo 3Q49NFYspNyDuuFXG+bijPybBE+5FHfkm3MS25UhKqzdO/h6jYVTxlNf3ndF49WMybEH 49/Q== X-Gm-Message-State: AGi0Pubbvg79aLU3PC8mylGVYcCpWpwPzmFYpghg5o035eExcoiOYer8 9g3M/C0j+XUhYk46GFoBhoG+jNxREfQhTg== X-Google-Smtp-Source: APiQypIPAM0kjRIoyj7/9sXlGjH6NcD3j+wjiRkAibksQ3LJ3FDiVQ8X4sCbIq168nHzsonT64HPNpxzW6naxA== X-Received: by 2002:a17:90a:3287:: with SMTP id l7mr4678886pjb.126.1587708838255; Thu, 23 Apr 2020 23:13:58 -0700 (PDT) Date: Thu, 23 Apr 2020 23:13:39 -0700 In-Reply-To: <20200424061342.212535-1-davidgow@google.com> Message-Id: <20200424061342.212535-3-davidgow@google.com> Mime-Version: 1.0 References: <20200424061342.212535-1-davidgow@google.com> X-Mailer: git-send-email 2.26.2.303.gf8c07b1a785-goog Subject: [PATCH v7 2/5] KUnit: KASAN Integration From: David Gow To: trishalfonso@google.com, brendanhiggins@google.com, aryabinin@virtuozzo.com, dvyukov@google.com, mingo@redhat.com, peterz@infradead.org, juri.lelli@redhat.com, vincent.guittot@linaro.org Cc: linux-kernel@vger.kernel.org, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, David Gow , Andrey Konovalov Sender: linux-kselftest-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org From: Patricia Alfonso Integrate KASAN into KUnit testing framework. - Fail tests when KASAN reports an error that is not expected - Use KUNIT_EXPECT_KASAN_FAIL to expect a KASAN error in KASAN tests - Expected KASAN reports pass tests and are still printed when run without kunit_tool (kunit_tool still bypasses the report due to the test passing) - KUnit struct in current task used to keep track of the current test from KASAN code Make use of "[PATCH v3 kunit-next 1/2] kunit: generalize kunit_resource API beyond allocated resources" and "[PATCH v3 kunit-next 2/2] kunit: add support for named resources" from Alan Maguire [1] - A named resource is added to a test when a KASAN report is expected - This resource contains a struct for kasan_data containing booleans representing if a KASAN report is expected and if a KASAN report is found [1] (https://lore.kernel.org/linux-kselftest/1583251361-12748-1-git-send-email-alan.maguire@oracle.com/T/#t) Signed-off-by: Patricia Alfonso Signed-off-by: David Gow Reviewed-by: Dmitry Vyukov Reviewed-by: Andrey Konovalov --- include/kunit/test.h | 5 +++++ include/linux/kasan.h | 6 ++++++ lib/kunit/test.c | 13 +++++++----- lib/test_kasan.c | 47 +++++++++++++++++++++++++++++++++++++++++-- mm/kasan/report.c | 32 +++++++++++++++++++++++++++++ 5 files changed, 96 insertions(+), 7 deletions(-) diff --git a/include/kunit/test.h b/include/kunit/test.h index ac59d18e6bab..1dc3d118f64b 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -225,6 +225,11 @@ struct kunit { struct list_head resources; /* Protected by lock. */ }; +static inline void kunit_set_failure(struct kunit *test) +{ + WRITE_ONCE(test->success, false); +} + void kunit_init_test(struct kunit *test, const char *name, char *log); int kunit_run_tests(struct kunit_suite *suite); diff --git a/include/linux/kasan.h b/include/linux/kasan.h index 31314ca7c635..d58db2f67f43 100644 --- a/include/linux/kasan.h +++ b/include/linux/kasan.h @@ -14,6 +14,12 @@ struct task_struct; #include #include +/* kasan_data struct is used in KUnit tests for KASAN expected failures */ +struct kunit_kasan_expectation { + bool report_expected; + bool report_found; +}; + extern unsigned char kasan_early_shadow_page[PAGE_SIZE]; extern pte_t kasan_early_shadow_pte[PTRS_PER_PTE]; extern pmd_t kasan_early_shadow_pmd[PTRS_PER_PMD]; diff --git a/lib/kunit/test.c b/lib/kunit/test.c index 2002f0cc5165..ef3bfb9fae48 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -10,16 +10,12 @@ #include #include #include +#include #include "debugfs.h" #include "string-stream.h" #include "try-catch-impl.h" -static void kunit_set_failure(struct kunit *test) -{ - WRITE_ONCE(test->success, false); -} - static void kunit_print_tap_version(void) { static bool kunit_has_printed_tap_version; @@ -288,6 +284,10 @@ static void kunit_try_run_case(void *data) struct kunit_suite *suite = ctx->suite; struct kunit_case *test_case = ctx->test_case; +#if (IS_ENABLED(CONFIG_KASAN) && IS_ENABLED(CONFIG_KUNIT)) + current->kunit_test = test; +#endif /* IS_ENABLED(CONFIG_KASAN) && IS_ENABLED(CONFIG_KUNIT) */ + /* * kunit_run_case_internal may encounter a fatal error; if it does, * abort will be called, this thread will exit, and finally the parent @@ -603,6 +603,9 @@ void kunit_cleanup(struct kunit *test) spin_unlock(&test->lock); kunit_remove_resource(test, res); } +#if (IS_ENABLED(CONFIG_KASAN) && IS_ENABLED(CONFIG_KUNIT)) + current->kunit_test = NULL; +#endif /* IS_ENABLED(CONFIG_KASAN) && IS_ENABLED(CONFIG_KUNIT)*/ } EXPORT_SYMBOL_GPL(kunit_cleanup); diff --git a/lib/test_kasan.c b/lib/test_kasan.c index 7700097842c8..c4bf58dd73cf 100644 --- a/lib/test_kasan.c +++ b/lib/test_kasan.c @@ -23,19 +23,62 @@ #include +#include + /* * We assign some test results to these globals to make sure the tests * are not eliminated as dead code. */ -int kasan_int_result; void *kasan_ptr_result; +int kasan_int_result; + +static struct kunit_resource resource; +static struct kunit_kasan_expectation fail_data; +static bool multishot; + +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; +} + +static void kasan_test_exit(struct kunit *test) +{ + kasan_restore_multi_shot(multishot); +} + +/** + * 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. + * + */ +#define KUNIT_EXPECT_KASAN_FAIL(test, condition) do { \ + fail_data.report_expected = true; \ + fail_data.report_found = false; \ + kunit_add_named_resource(test, \ + NULL, \ + NULL, \ + &resource, \ + "kasan_data", &fail_data); \ + condition; \ + KUNIT_EXPECT_EQ(test, \ + fail_data.report_expected, \ + fail_data.report_found); \ +} while (0) + + /* * Note: test functions are marked noinline so that their names appear in * reports. */ - static noinline void __init kmalloc_oob_right(void) { char *ptr; diff --git a/mm/kasan/report.c b/mm/kasan/report.c index 80f23c9da6b0..45f3c23f54cb 100644 --- a/mm/kasan/report.c +++ b/mm/kasan/report.c @@ -32,6 +32,8 @@ #include +#include + #include "kasan.h" #include "../slab.h" @@ -463,12 +465,37 @@ bool report_enabled(void) return !test_and_set_bit(KASAN_BIT_REPORTED, &kasan_flags); } +#if IS_ENABLED(CONFIG_KUNIT) +static void kasan_update_kunit_status(struct kunit *cur_test) +{ + struct kunit_resource *resource; + struct kunit_kasan_expectation *kasan_data; + + resource = kunit_find_named_resource(cur_test, "kasan_data"); + + if (!resource) { + kunit_set_failure(cur_test); + return; + } + + kasan_data = (struct kunit_kasan_expectation *)resource->data; + kasan_data->report_found = true; + kunit_put_resource(resource); +} +#endif /* IS_ENABLED(CONFIG_KUNIT) */ + void kasan_report_invalid_free(void *object, unsigned long ip) { unsigned long flags; u8 tag = get_tag(object); object = reset_tag(object); + +#if IS_ENABLED(CONFIG_KUNIT) + if (current->kunit_test) + kasan_update_kunit_status(current->kunit_test); +#endif /* IS_ENABLED(CONFIG_KUNIT) */ + start_report(&flags); pr_err("BUG: KASAN: double-free or invalid-free in %pS\n", (void *)ip); print_tags(tag, object); @@ -486,6 +513,11 @@ void __kasan_report(unsigned long addr, size_t size, bool is_write, unsigned lon void *untagged_addr; unsigned long flags; +#if IS_ENABLED(CONFIG_KUNIT) + if (current->kunit_test) + kasan_update_kunit_status(current->kunit_test); +#endif /* IS_ENABLED(CONFIG_KUNIT) */ + disable_trace_on_warning(); tagged_addr = (void *)addr; From patchwork Fri Apr 24 06:13:41 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 208553 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.4 required=3.0 tests=DKIMWL_WL_MED, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE, SPF_PASS, USER_AGENT_GIT, 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 16909C2BA1A for ; Fri, 24 Apr 2020 06:14:08 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id E955E2098B for ; Fri, 24 Apr 2020 06:14:07 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="ulwvVvdq" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726554AbgDXGOH (ORCPT ); Fri, 24 Apr 2020 02:14:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49898 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1725889AbgDXGOG (ORCPT ); Fri, 24 Apr 2020 02:14:06 -0400 Received: from mail-yb1-xb4a.google.com (mail-yb1-xb4a.google.com [IPv6:2607:f8b0:4864:20::b4a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E12BEC09B045 for ; Thu, 23 Apr 2020 23:14:05 -0700 (PDT) Received: by mail-yb1-xb4a.google.com with SMTP id m138so2435862ybf.12 for ; Thu, 23 Apr 2020 23:14:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=5epptiP6vyK9ksah1mqKRXgiRHBz5N7tvZFE7or+VcA=; b=ulwvVvdqEW+IJ4ZDJ8/ufTJ/zOyYKVP39a143BYyHnkike1p3jMupT4mYRbcDXGObR kt/ycV+2w4PE+xLdGnOd72QOFvCtb/zTp89MZBAKxwolAEK+nUufeHi1AZWm29hq6ZLE /JML3lImDzCGevk5SkhdI9IFNaCtuGfbobXCQdycrnVlghyg7LW9hskkiNHXoEiv4Q0x rmlxt8TuRi6I3Xvy2IO/59Thimn5irJyuGxgPvcAWQlnZx4fGRXe7BUbboXF7AhNN9A8 foEVvkDb5g9p+3H2LXbAwJxzam5E5LlTyqgw7/J3v5JKu+oeY0LSoSUKznBIdMx96hNW //gA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=5epptiP6vyK9ksah1mqKRXgiRHBz5N7tvZFE7or+VcA=; b=k71iB0z94S0HEUZao8iQZlql6QXe3v9Zi3JjbHb8s/whtBSRyRy2sd96D5UAp4WZLL 3mX6DNQbhlOdfohlt987Mryt/M7uByg7ABieehamk7reSB4616p6mlOIu2NOxEh5JzGh 84WR0hYHDz8o2FIFXdjjkwVQnDiEwjbnFlf/HIPGyC1c61scQb88bJZWjNK1VXIN4/TO BNTPace37MMXQP+vOW7AilnXDRHuSyLxI8PdA2pVoquVtoLzckiYJwRX+kgFQFlxU+kd JNNBSOZhKZdZ2/Reuo9C2cRIdQ7Ogc23bzuCFhmk2Gcv2F0qUDO0bpIuZg0ZNnRMsfPC a6wg== X-Gm-Message-State: AGi0PuahUEc6Zej/adv8QsQPezoJr3VBUm6XLGxusG12Kii/kMuriT1+ cwyQt/KczfqB6Yly6I0lNlfKVk/qs2eqFA== X-Google-Smtp-Source: APiQypJovP6+qI5o42bhNd8V9jsDjBcJywaFZ16qLB01QR5bZhAswW3ktdSN1KWfx+4lWLLGUYKhYpLKpM5S/w== X-Received: by 2002:a25:bd4c:: with SMTP id p12mr13287597ybm.140.1587708844982; Thu, 23 Apr 2020 23:14:04 -0700 (PDT) Date: Thu, 23 Apr 2020 23:13:41 -0700 In-Reply-To: <20200424061342.212535-1-davidgow@google.com> Message-Id: <20200424061342.212535-5-davidgow@google.com> Mime-Version: 1.0 References: <20200424061342.212535-1-davidgow@google.com> X-Mailer: git-send-email 2.26.2.303.gf8c07b1a785-goog Subject: [PATCH v7 4/5] KASAN: Testing Documentation From: David Gow To: trishalfonso@google.com, brendanhiggins@google.com, aryabinin@virtuozzo.com, dvyukov@google.com, mingo@redhat.com, peterz@infradead.org, juri.lelli@redhat.com, vincent.guittot@linaro.org Cc: linux-kernel@vger.kernel.org, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, David Gow Sender: linux-kselftest-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org From: Patricia Alfonso Include documentation on how to test KASAN using CONFIG_TEST_KASAN_KUNIT and CONFIG_TEST_KASAN_MODULE. Signed-off-by: Patricia Alfonso Reviewed-by: Dmitry Vyukov Signed-off-by: David Gow --- Documentation/dev-tools/kasan.rst | 70 +++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst index c652d740735d..b4b109d88f9e 100644 --- a/Documentation/dev-tools/kasan.rst +++ b/Documentation/dev-tools/kasan.rst @@ -281,3 +281,73 @@ unmapped. This will require changes in arch-specific code. This allows ``VMAP_STACK`` support on x86, and can simplify support of architectures that do not have a fixed module region. + +CONFIG_TEST_KASAN_KUNIT & CONFIG_TEST_KASAN_MODULE +-------------------------------------------------- + +``CONFIG_TEST_KASAN_KUNIT`` utilizes the KUnit Test Framework for testing. +This means each test focuses on a small unit of functionality and +there are a few ways these tests can be run. + +Each test will print the KASAN report if an error is detected and then +print the number of the test and the status of the test: + +pass:: + + ok 28 - kmalloc_double_kzfree +or, if kmalloc failed:: + + # kmalloc_large_oob_right: ASSERTION FAILED at lib/test_kasan.c:163 + Expected ptr is not null, but is + not ok 4 - kmalloc_large_oob_right +or, if a KASAN report was expected, but not found:: + + # kmalloc_double_kzfree: EXPECTATION FAILED at lib/test_kasan.c:629 + Expected kasan_data->report_expected == kasan_data->report_found, but + kasan_data->report_expected == 1 + kasan_data->report_found == 0 + not ok 28 - kmalloc_double_kzfree + +All test statuses are tracked as they run and an overall status will +be printed at the end:: + + ok 1 - kasan_kunit_test + +or:: + + not ok 1 - kasan_kunit_test + +(1) Loadable Module +~~~~~~~~~~~~~~~~~~~~ + +With ``CONFIG_KUNIT`` enabled, ``CONFIG_TEST_KASAN_KUNIT`` can be built as +a loadable module and run on any architecture that supports KASAN +using something like insmod or modprobe. + +(2) Built-In +~~~~~~~~~~~~~ + +With ``CONFIG_KUNIT`` built-in, ``CONFIG_TEST_KASAN_KUNIT`` can be built-in +on any architecure that supports KASAN. These and any other KUnit +tests enabled will run and print the results at boot as a late-init +call. + +(3) Using kunit_tool +~~~~~~~~~~~~~~~~~~~~~ + +With ``CONFIG_KUNIT`` and ``CONFIG_TEST_KASAN_KUNIT`` built-in, we can also +use kunit_tool to see the results of these along with other KUnit +tests in a more readable way. This will not print the KASAN reports +of tests that passed. Use `KUnit documentation `_ for more up-to-date +information on kunit_tool. + +.. _KUnit: https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html + +``CONFIG_TEST_KASAN_MODULE`` is a set of KASAN tests that could not be +converted to KUnit. These tests can be run only as a module with +``CONFIG_TEST_KASAN_MODULE`` built as a loadable module and +``CONFIG_KASAN`` built-in. The type of error expected and the +function being run is printed before the expression expected to give +an error. Then the error is printed, if found, and that test +should be interpretted to pass only if the error was the one expected +by the test.