From patchwork Fri Nov 25 08:43:04 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13055606 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 40F8AC4332F for ; Fri, 25 Nov 2022 08:43:16 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id A22C56B0073; Fri, 25 Nov 2022 03:43:15 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 9D2896B0074; Fri, 25 Nov 2022 03:43:15 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 8C2756B0075; Fri, 25 Nov 2022 03:43:15 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id 7D6A06B0073 for ; Fri, 25 Nov 2022 03:43:15 -0500 (EST) Received: from smtpin18.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id 48CBE809B0 for ; Fri, 25 Nov 2022 08:43:15 +0000 (UTC) X-FDA: 80171325150.18.0A31DB4 Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) by imf17.hostedemail.com (Postfix) with ESMTP id CC9EA40013 for ; Fri, 25 Nov 2022 08:43:14 +0000 (UTC) Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-398d108a04cso33392417b3.16 for ; Fri, 25 Nov 2022 00:43:14 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=dehjIhc0oB2x/7qa8tpHLfPv+8ip2PCtDc/VgLdDFS0=; b=U3tR0OVoZ0hHgA1k6gQVY26XcT3oNgQIup/uX30yKzUfLfrSKpvRJsmcSBuhiAXpTS rTzQMGzMJNRsRtthJ4BxyoK+TidlhhFCJmjhxBf/o1FEDj74nyLKCXv3UoCsEVkyMOeU 364amPEiG2TPV7cF3TGX+tLLAPX4almhYT7NCNw9CXxbjzI0V/mb8zoOMitrJVRJA7dj so3SRxWDXfqlFI3Uw6FkxsZS8mgE7neClxz6IKN1K/gUkQhbn5yotHy8A0DKQmNZGmod UisNijbujJ0UGmHkgWBKaLdxRuxz2CsxSAWjZikzhuh6GNn9njbaHLDcXdeN0Mt/hTxE 23bg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=dehjIhc0oB2x/7qa8tpHLfPv+8ip2PCtDc/VgLdDFS0=; b=w/1PuXuSARwflnrY6dF6iGfBdOoMHQiq4nVJ/yzJteVwSyg/wp1SE5NMJRLngwplZ6 Tk0OjMTSvkXTJwNBYc8rlAGdiW5rwRWI6+jyZzM7Ox3/SfsAZnBdIst4rgp53DInnnQ5 lOaXxUGCrNa+xirv4H8YgrK+gPPmSdcxuqj6OAAZ0qXY//Fqr+Sl5cwlggM64ChMzBgT 9ar4zHr395dBCn4bEhlYvsa0w3MFT5Zmrb6EEWQKygRoGXRBIVf2LNzJYJASSZ6Vz3MI lvYcYBt918NfE64E1DK4+THuM92fjEbfDbSh8iQ5sWyk6WT+AZ3JQO85rWLGj+ADq8kz GXcg== X-Gm-Message-State: ANoB5plYezxwZEIt8tWPKVVdjA7YvjwsHmUwPnqkMsWK2q65jIXCceo4 Vlmkx1h7xB4dSEmtXm+moEZa1chdz0fpSg== X-Google-Smtp-Source: AA0mqf6SIG2nM06vCqr04rh+5zvembhI1If1NZodMNsjqU25om3zZ8oQIazCspuzdvbnHIuLg9UcLSc+CucUsg== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a05:6902:114b:b0:6e1:ce17:6c40 with SMTP id p11-20020a056902114b00b006e1ce176c40mr9ybu.5.1669365793417; Fri, 25 Nov 2022 00:43:13 -0800 (PST) Date: Fri, 25 Nov 2022 16:43:04 +0800 Mime-Version: 1.0 X-Mailer: git-send-email 2.38.1.584.g0f3c55d4c2-goog Message-ID: <20221125084306.1063074-1-davidgow@google.com> Subject: [PATCH v4 1/3] kunit: Provide a static key to check if KUnit is actively running tests From: David Gow To: Brendan Higgins , Daniel Latypov , Shuah Khan Cc: David Gow , kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org, Kees Cook , linux-doc@vger.kernel.org, linux-mm@kvack.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1669365794; a=rsa-sha256; cv=none; b=yNO6zK8HPRd/m+xvsQ6wrlvWaPH2soz2s1GmLPyItNKQVyitVJyRkuB6EW3s6qtmpqOnUM q1w4LHqBJjprf67IVTvabs364dSgDU2C7rzJeoJeIwwQdHwoqpYQOtRV+I0d910RgBpKT1 qlKv6sfAKo4cgrKzTmTtSivgRm2CO0A= ARC-Authentication-Results: i=1; imf17.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=U3tR0OVo; spf=pass (imf17.hostedemail.com: domain of 3IYCAYwgKCEYli3qlow4owwotm.kwutqv25-uus3iks.wzo@flex--davidgow.bounces.google.com designates 209.85.128.202 as permitted sender) smtp.mailfrom=3IYCAYwgKCEYli3qlow4owwotm.kwutqv25-uus3iks.wzo@flex--davidgow.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1669365794; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding:in-reply-to: references:dkim-signature; bh=dehjIhc0oB2x/7qa8tpHLfPv+8ip2PCtDc/VgLdDFS0=; b=G8pP08Yw5KlCtkX7o/9okoKTKVLzpIJIa4km2CycKhqPqO0QOHutBZZJpzl7sWgcrWQZEo FMB83EOCTZPXse+a3A3TRQyuXf0gzHei3vp2yREKtnRgRMj+gHoQ91hfBfnQDKf0ofeZMN htXPnzHk7wpy061fc9MPLAlNH46OnRc= X-Rspam-User: Authentication-Results: imf17.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=U3tR0OVo; spf=pass (imf17.hostedemail.com: domain of 3IYCAYwgKCEYli3qlow4owwotm.kwutqv25-uus3iks.wzo@flex--davidgow.bounces.google.com designates 209.85.128.202 as permitted sender) smtp.mailfrom=3IYCAYwgKCEYli3qlow4owwotm.kwutqv25-uus3iks.wzo@flex--davidgow.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com X-Stat-Signature: pdpewizrg4ddcfifx6s9xhbym8988wt5 X-Rspamd-Queue-Id: CC9EA40013 X-Rspamd-Server: rspam12 X-HE-Tag: 1669365794-220028 X-Bogosity: Ham, tests=bogofilter, spamicity=0.025890, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: KUnit does a few expensive things when enabled. This hasn't been a problem because KUnit was only enabled on test kernels, but with a few people enabling (but not _using_) KUnit on production systems, we need a runtime way of handling this. Provide a 'kunit_running' static key (defaulting to false), which allows us to hide any KUnit code behind a static branch. This should reduce the performance impact (on other code) of having KUnit enabled to a single NOP when no tests are running. Note that, while it looks unintuitive, tests always run entirely within __kunit_test_suites_init(), so it's safe to decrement the static key at the end of this function, rather than in __kunit_test_suites_exit(), which is only there to clean up results in debugfs. Signed-off-by: David Gow Reviewed-by: Daniel Latypov Reviewed-by: Kees Cook --- This should be a no-op (other than a possible performance improvement) functionality-wise, and lays the groundwork for a more optimised static stub implementation. The remaining patches in the series add a kunit_get_current_test() function which is a more friendly and performant wrapper around current->kunit_test, and use this in the slub test. They also improve the documentation a bit. If there are no objections, we'll take the whole series via the KUnit tree. Changes since v3: https://lore.kernel.org/linux-kselftest/20221119081252.3864249-1-davidgow@google.com/ - Use DECLARE_STATIC_KEY_FALSE() -- thanks Daniel! No changes since v2: https://lore.kernel.org/all/20221025071907.1251820-1-davidgow@google.com/ Changes since v1: https://lore.kernel.org/linux-kselftest/20221021072854.333010-1-davidgow@google.com/ - No changes in this patch. - Patch 2/3 is reworked, patch 3/3 is new. --- include/kunit/test.h | 4 ++++ lib/kunit/test.c | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/include/kunit/test.h b/include/kunit/test.h index 4666a4d199ea..87ea90576b50 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -16,6 +16,7 @@ #include #include #include +#include #include #include #include @@ -27,6 +28,9 @@ #include +/* Static key: true if any KUnit tests are currently running */ +DECLARE_STATIC_KEY_FALSE(kunit_running); + struct kunit; /* Size of log associated with test. */ diff --git a/lib/kunit/test.c b/lib/kunit/test.c index 1c9d8d962d67..87a5d795843b 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -20,6 +20,8 @@ #include "string-stream.h" #include "try-catch-impl.h" +DEFINE_STATIC_KEY_FALSE(kunit_running); + #if IS_BUILTIN(CONFIG_KUNIT) /* * Fail the current test and print an error message to the log. @@ -615,10 +617,14 @@ int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_ return 0; } + static_branch_inc(&kunit_running); + for (i = 0; i < num_suites; i++) { kunit_init_suite(suites[i]); kunit_run_tests(suites[i]); } + + static_branch_dec(&kunit_running); return 0; } EXPORT_SYMBOL_GPL(__kunit_test_suites_init); From patchwork Fri Nov 25 08:43:05 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13055607 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id B1522C4321E for ; Fri, 25 Nov 2022 08:43:22 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 199006B0074; Fri, 25 Nov 2022 03:43:22 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 16FE06B0075; Fri, 25 Nov 2022 03:43:22 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 00F806B007B; Fri, 25 Nov 2022 03:43:21 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id E80336B0074 for ; Fri, 25 Nov 2022 03:43:21 -0500 (EST) Received: from smtpin18.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id B29F040AF5 for ; Fri, 25 Nov 2022 08:43:21 +0000 (UTC) X-FDA: 80171325402.18.AFD972B Received: from mail-pf1-f201.google.com (mail-pf1-f201.google.com [209.85.210.201]) by imf23.hostedemail.com (Postfix) with ESMTP id 5DDFE14000E for ; Fri, 25 Nov 2022 08:43:20 +0000 (UTC) Received: by mail-pf1-f201.google.com with SMTP id bq9-20020a056a000e0900b00571802a2eaaso2697888pfb.22 for ; Fri, 25 Nov 2022 00:43:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=XZjU2MsmtOWFt45ca4T4N4qO/2tLBYtkgkbkS/1130g=; b=Jz9X3GqyXfdaQFPAvZus+JfiaUfvrK+PTWtIQ46DEZwX2V1lpUaaEg1rwdRudkxdm/ 2C8Iv/8oOAZdgWfc2j/LWvrirBFeaJ3gusFKX9mamV9+JD+P3jQesXSiTn9AET4ROn+T kRojtpdpAp4L9DjnrtlUeiHFjlGiboo33uvFvuSFEe8Kbf0LhOi/JhBMR303thfHs8Vj S1nwCJ/j0ItiVr6A1msR9FtXwxUiKSxARW16/qW0bSuJc0CtBCV0U+/BkAieYhNxv2vk 7qgcvCrZyWjMwRH806FaXWsKERJ63Fv568yLGX/QFo+6Qir5KUmUtX148QYXEtqJ3ELE jnfA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=XZjU2MsmtOWFt45ca4T4N4qO/2tLBYtkgkbkS/1130g=; b=0VCf0cGlOxKj1bSIgBy3+BnUw1y7RoAIRPyLlC+/cDXOHJlwFMZbUT9YsQFXbVI/tg wsB0+zqdSES2rVdoQvksVuvL/mvLIIE6N3SGgWiifmIRRK9U64Tjn3oFAFMrzEAZxYjl 8dmPGAYNf/HBkz5nvZK1Pg/EdJBowJpovKTJeQYeX/l9/CdIgXOD6eWWuuuyNyS2IfS7 5PF8VmscG0XRGvpksRd5Q2y6XjPM49xgZecB5v7gRzlJf6oKj3RDHjzrXuKUg6eJfhI/ Oam256NHvOYkguITlJcOjzWtr4jr1ArVVNU4od6lHIsVY6pZYP7aIt4g+l3auheU4jb2 60Rg== X-Gm-Message-State: ANoB5pkR6JJTKrni71HNpRb6WkmWHcArvWqRUGMCBEY/rf8VNrC6NNlq YmY8fgympTVrIdLi+jBs86ryuBx4pLu19g== X-Google-Smtp-Source: AA0mqf7wRWDnLzQSS9X/1Ba7Fg7tMnyndVIQZax6r3POD5ez32auMFaLwX+ysZj2EIcjtsaKqOGqh+Jxl611og== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a62:1582:0:b0:563:f32:2c9d with SMTP id 124-20020a621582000000b005630f322c9dmr17174320pfv.32.1669365799235; Fri, 25 Nov 2022 00:43:19 -0800 (PST) Date: Fri, 25 Nov 2022 16:43:05 +0800 In-Reply-To: <20221125084306.1063074-1-davidgow@google.com> Mime-Version: 1.0 References: <20221125084306.1063074-1-davidgow@google.com> X-Mailer: git-send-email 2.38.1.584.g0f3c55d4c2-goog Message-ID: <20221125084306.1063074-2-davidgow@google.com> Subject: [PATCH v4 2/3] kunit: Use the static key when retrieving the current test From: David Gow To: Brendan Higgins , Daniel Latypov , Shuah Khan Cc: David Gow , kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org, Kees Cook , linux-doc@vger.kernel.org, linux-mm@kvack.org, Jonathan Corbet , Sadiya Kazi ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1669365800; a=rsa-sha256; cv=none; b=o1QdM+drk3chE2KAZ9roNTXrqpW8XNwQyrLcD93QWBdmz72fk/E1tUSTHq4lkWEPQz0uth 2b06MV7KRZgodke85sdIRpC94BzPduAs1F+dr3neTNHrK3+Ik7tOCL1S6gFMhR5ubkiH+y N2H42DxHGEBfHDBJzVykaYbBGENEDpQ= ARC-Authentication-Results: i=1; imf23.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=Jz9X3Gqy; spf=pass (imf23.hostedemail.com: domain of 3J4CAYwgKCEwro9wru2Au22uzs.q20zw18B-00y9oqy.25u@flex--davidgow.bounces.google.com designates 209.85.210.201 as permitted sender) smtp.mailfrom=3J4CAYwgKCEwro9wru2Au22uzs.q20zw18B-00y9oqy.25u@flex--davidgow.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1669365800; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=XZjU2MsmtOWFt45ca4T4N4qO/2tLBYtkgkbkS/1130g=; b=HxfeHijR9taK63QoltM6uMjVWQeHbI9EqMP71rIm0i0xrqKctuaTb51CRm8ptSX5JHMH7g m5AjGOgVbQM0hdOJHfQnoTtI05noE62pgc0M/Ht31BhnZXXaXvNVu0SANYRVDJQ5TEr87b 8Es9V08OPu4Z3hsXgK5eFWhy6GV/9eA= X-Stat-Signature: khhojeytfg4y7giktoengap5qhsroqqx X-Rspamd-Queue-Id: 5DDFE14000E X-Rspam-User: Authentication-Results: imf23.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=Jz9X3Gqy; spf=pass (imf23.hostedemail.com: domain of 3J4CAYwgKCEwro9wru2Au22uzs.q20zw18B-00y9oqy.25u@flex--davidgow.bounces.google.com designates 209.85.210.201 as permitted sender) smtp.mailfrom=3J4CAYwgKCEwro9wru2Au22uzs.q20zw18B-00y9oqy.25u@flex--davidgow.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com X-Rspamd-Server: rspam10 X-HE-Tag: 1669365800-295443 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: In order to detect if a KUnit test is running, and to access its context, the 'kunit_test' member of the current task_struct is used. Usually, this is accessed directly or via the kunit_fail_current_task() function. In order to speed up the case where no test is running, add a wrapper, kunit_get_current_test(), which uses the static key to fail early. Equally, Speed up kunit_fail_current_test() by using the static key. This should make it convenient for code to call this unconditionally in fakes or error paths, without worrying that this will slow the code down significantly. If CONFIG_KUNIT=n (or m), this compiles away to nothing. If CONFIG_KUNIT=y, it will compile down to a NOP (on most architectures) if no KUnit test is currently running. Note that kunit_get_current_test() does not work if KUnit is built as a module. This mirrors the existing restriction on kunit_fail_current_test(). Note that the definition of kunit_fail_current_test() still wraps an empty, inline function if KUnit is not built-in. This is to ensure that the printf format string __attribute__ will still work. Also update the documentation to suggest users use the new kunit_get_current_test() function, update the example, and to describe the behaviour when KUnit is disabled better. Cc: Jonathan Corbet Cc: Sadiya Kazi Signed-off-by: David Gow Reviewed-by: Daniel Latypov Reviewed-by: Kees Cook Reviewed-by: Sadiya Kazi --- As-is, the only code which will be directly affected by this (via the kunit_fail_current_test() change) will be UBSAN's KUnit integration. Patches to port other tests to use kunit_get_current_test() will be sent separately (other than the SLUB one in patch 3/3). KASAN in particular are reworking their KUnit tests and integration, so we'll use this in a follow up to avoid introducing a conflict. Changes since v3: https://lore.kernel.org/linux-kselftest/20221119081252.3864249-2-davidgow@google.com/ - Use DECLARE_STATIC_KEY_FALSE() -- Thanks Daniel. - Some documentation rewording to make the behaviour a bit clearer. - Thanks Daniel and Sadiya Changes since v2: https://lore.kernel.org/all/20221025071907.1251820-2-davidgow@google.com/ - Only add kunit_get_current_test() when KUnit is built-in, as the static key isn't available otherwise. - I'm going to try to put together some patches to make things like this available when CONFIG_KUNIT=m in the future. - Also update the documentation to note this. Changes since v1: https://lore.kernel.org/linux-kselftest/20221021072854.333010-2-davidgow@google.com/ - Fix a missing '}' which broke everything. Thanks Kees, kernel test robot. - Add the new kunit_get_current_test() function, as most of the cases where we retrieve the current test (even to fail it) were accessing current->kunit_test directly, not using kunit_fail_current_test(). - Add some documentation comments. - Update the documentation in usage.rst. - The version in tips.rst was not updated, and will be removed: https://lore.kernel.org/linux-kselftest/20221025055844.1231592-1-davidgow@google.com/ --- Documentation/dev-tools/kunit/usage.rst | 30 +++++++++----- include/kunit/test-bug.h | 53 +++++++++++++++++++++++-- 2 files changed, 71 insertions(+), 12 deletions(-) diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst index 22416ebb94ab..48f8196d5aad 100644 --- a/Documentation/dev-tools/kunit/usage.rst +++ b/Documentation/dev-tools/kunit/usage.rst @@ -641,17 +641,23 @@ as shown in next section: *Accessing The Current Test*. Accessing The Current Test -------------------------- -In some cases, we need to call test-only code from outside the test file. -For example, see example in section *Injecting Test-Only Code* or if -we are providing a fake implementation of an ops struct. Using -``kunit_test`` field in ``task_struct``, we can access it via -``current->kunit_test``. +In some cases, we need to call test-only code from outside the test file. This +is helpful, for example, when providing a fake implementation of a function, or +to fail any current test from within an error handler. +We can do this via the ``kunit_test`` field in ``task_struct``, which we can +access using the ``kunit_get_current_test()`` function in ``kunit/test-bug.h``. -The example below includes how to implement "mocking": +``kunit_get_current_test()`` is safe to call even if KUnit is not enabled. If +KUnit is not enabled, was built as a module (``CONFIG_KUNIT=m``), or no test is +running in the current task, it will return ``NULL``. This compiles down to +either a no-op or a static key check, so will have a negligible performance +impact when no test is running. + +The example below uses this to implement a "mock" implementation of a function, ``foo``: .. code-block:: c - #include /* for current */ + #include /* for kunit_get_current_test */ struct test_data { int foo_result; @@ -660,7 +666,7 @@ The example below includes how to implement "mocking": static int fake_foo(int arg) { - struct kunit *test = current->kunit_test; + struct kunit *test = kunit_get_current_test(); struct test_data *test_data = test->priv; KUNIT_EXPECT_EQ(test, test_data->want_foo_called_with, arg); @@ -691,7 +697,7 @@ Each test can have multiple resources which have string names providing the same flexibility as a ``priv`` member, but also, for example, allowing helper functions to create resources without conflicting with each other. It is also possible to define a clean up function for each resource, making it easy to -avoid resource leaks. For more information, see Documentation/dev-tools/kunit/api/test.rst. +avoid resource leaks. For more information, see Documentation/dev-tools/kunit/api/resource.rst. Failing The Current Test ------------------------ @@ -719,3 +725,9 @@ structures as shown below: static void my_debug_function(void) { } #endif +``kunit_fail_current_test()`` is safe to call even if KUnit is not enabled. If +KUnit is not enabled, was built as a module (``CONFIG_KUNIT=m``), or no test is +running in the current task, it will do nothing. This compiles down to either a +no-op or a static key check, so will have a negligible performance impact when +no test is running. + diff --git a/include/kunit/test-bug.h b/include/kunit/test-bug.h index 5fc58081d511..c1b2e14eab64 100644 --- a/include/kunit/test-bug.h +++ b/include/kunit/test-bug.h @@ -9,16 +9,63 @@ #ifndef _KUNIT_TEST_BUG_H #define _KUNIT_TEST_BUG_H -#define kunit_fail_current_test(fmt, ...) \ - __kunit_fail_current_test(__FILE__, __LINE__, fmt, ##__VA_ARGS__) - #if IS_BUILTIN(CONFIG_KUNIT) +#include /* For static branch */ +#include + +/* Static key if KUnit is running any tests. */ +DECLARE_STATIC_KEY_FALSE(kunit_running); + +/** + * kunit_get_current_test() - Return a pointer to the currently running + * KUnit test. + * + * If a KUnit test is running in the current task, returns a pointer to its + * associated struct kunit. This pointer can then be passed to any KUnit + * function or assertion. If no test is running (or a test is running in a + * different task), returns NULL. + * + * This function is safe to call even when KUnit is disabled. If CONFIG_KUNIT + * is not enabled, it will compile down to nothing and will return quickly no + * test is running. + */ +static inline struct kunit *kunit_get_current_test(void) +{ + if (!static_branch_unlikely(&kunit_running)) + return NULL; + + return current->kunit_test; +} + + +/** + * kunit_fail_current_test() - If a KUnit test is running, fail it. + * + * If a KUnit test is running in the current task, mark that test as failed. + * + * This macro will only work if KUnit is built-in (though the tests + * themselves can be modules). Otherwise, it compiles down to nothing. + */ +#define kunit_fail_current_test(fmt, ...) do { \ + if (static_branch_unlikely(&kunit_running)) { \ + __kunit_fail_current_test(__FILE__, __LINE__, \ + fmt, ##__VA_ARGS__); \ + } \ + } while (0) + + extern __printf(3, 4) void __kunit_fail_current_test(const char *file, int line, const char *fmt, ...); #else +static inline struct kunit *kunit_get_current_test(void) { return NULL; } + +/* We define this with an empty helper function so format string warnings work */ +#define kunit_fail_current_test(fmt, ...) \ + __kunit_fail_current_test(__FILE__, __LINE__, fmt, ##__VA_ARGS__) + static inline __printf(3, 4) void __kunit_fail_current_test(const char *file, int line, const char *fmt, ...) { From patchwork Fri Nov 25 08:43:06 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13055608 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 21628C4332F for ; Fri, 25 Nov 2022 08:43:27 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id B0D026B0075; Fri, 25 Nov 2022 03:43:26 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id ABDD66B007B; Fri, 25 Nov 2022 03:43:26 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 9AC366B007D; Fri, 25 Nov 2022 03:43:26 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 8D5A16B0075 for ; Fri, 25 Nov 2022 03:43:26 -0500 (EST) Received: from smtpin01.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id 59BB640294 for ; Fri, 25 Nov 2022 08:43:26 +0000 (UTC) X-FDA: 80171325612.01.CC9DDE4 Received: from mail-pl1-f201.google.com (mail-pl1-f201.google.com [209.85.214.201]) by imf08.hostedemail.com (Postfix) with ESMTP id E9EEA16000F for ; Fri, 25 Nov 2022 08:43:24 +0000 (UTC) Received: by mail-pl1-f201.google.com with SMTP id c1-20020a170902d48100b0018723580343so3136782plg.15 for ; Fri, 25 Nov 2022 00:43:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=dkxFkrOpjQGLbrLmIP0+FclGqPGzevJvZOLievBv8dk=; b=kqgbzNKEz/EBdl30RURuDttaaXxDeC30LnNegyGkFZc9kDj5JRKrZbbcEP9pwVxxZN G9XRyB4jJukMFOoeTGeBeQ3CnM0EbzUy0iVy1MuX2Azm+2w3BQ9adRyL9kvkdnoRUBgI X6bKvh5wnfqjPenjD+9aZ4sKilQcc3HfOGFYHURPQ69pGtxzEdI0XKeB9kAYdbFzp7Bg iV3xmvTGIdnYEq9akRm0/9IGUCEtjMcs+FCtU+t6i2Mn7bMXvKRnkKAJSxnin4lI09Y7 1pZbQEDt8j+6a4aF/rIVEb1uQE3DhbYONBvJrOsxEcU1VcYGwGBsoyKH/GlpFeZvG8ID eajQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=dkxFkrOpjQGLbrLmIP0+FclGqPGzevJvZOLievBv8dk=; b=q5MAol79F/UXemCHwOIxQQWBJA5+rfH2S+lEVA59J8acqKreAWTKgX3tlP+2kUxXKB qSTKslkZaXpYFqlfcfrmiCOHgu/8SMzxgbuTUEbPHA8ogI/ltk2dlEYlSiv2r3bWcgqq t/3+DDvp727t+0frbDoIEm2fH3zT5aNm1rsQsLJStzPp7kjAUEKpAR8Ns2P/ZgkoWBdx XGj5YjenDjMq8WL7rjda0xp51JItxJ8VZKZeM3cXHcCsznRmk9Lt9yKbCXgjRGgqh3nM Sie2QFu2b4+FrCJ5cpKGIsH6IIRTticrDbk3O/qVh8xMDmXqM3lu/gDpJm7IEzqjSPfW TVHg== X-Gm-Message-State: ANoB5pk+4xL+OtzP7RaXHPvWsDbJ1ZOcD2ZzHJrTEU8xryDS5xPxV5Yf PlqlcWqRrNLS1quiVZZqg/yrfwhsZmNWXg== X-Google-Smtp-Source: AA0mqf7RiYkevlcRuG6Fr8tnCwq1XAC9tTw8xXaio9yL/yIb9hcwf34Ri5nG0oPQNQBwzo8q3vRzqDIvG97ZmA== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a17:90b:3809:b0:20a:c64c:ae80 with SMTP id mq9-20020a17090b380900b0020ac64cae80mr28596107pjb.12.1669365803760; Fri, 25 Nov 2022 00:43:23 -0800 (PST) Date: Fri, 25 Nov 2022 16:43:06 +0800 In-Reply-To: <20221125084306.1063074-1-davidgow@google.com> Mime-Version: 1.0 References: <20221125084306.1063074-1-davidgow@google.com> X-Mailer: git-send-email 2.38.1.584.g0f3c55d4c2-goog Message-ID: <20221125084306.1063074-3-davidgow@google.com> Subject: [PATCH v4 3/3] mm: slub: test: Use the kunit_get_current_test() function From: David Gow To: Brendan Higgins , Daniel Latypov , Shuah Khan Cc: David Gow , kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org, Kees Cook , linux-doc@vger.kernel.org, linux-mm@kvack.org, Oliver Glitta , Hyeonggon Yoo <42.hyeyoo@gmail.com>, Christoph Lameter , Vlastimil Babka , David Rientjes , Andrew Morton ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1669365805; a=rsa-sha256; cv=none; b=0vIMh02rfY/gY97Ns+9uLTzaFSK+Z0otIewavWlp9lYoGq+sxQvwfEJDYTYwkGD7qzrWkv jb/YfUSTR6HF0wBRwDdhGy36rTU7PiSr0aISCy19NPH9ZSzLW6hWw6dhUncrGWpajgNgM3 DJPCJl4ZT7ygfNBqXXZmaGDT2J+0eVM= ARC-Authentication-Results: i=1; imf08.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=kqgbzNKE; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf08.hostedemail.com: domain of 3K4CAYwgKCFAvsD0vy6Ey66y3w.u64305CF-442Dsu2.69y@flex--davidgow.bounces.google.com designates 209.85.214.201 as permitted sender) smtp.mailfrom=3K4CAYwgKCFAvsD0vy6Ey66y3w.u64305CF-442Dsu2.69y@flex--davidgow.bounces.google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1669365805; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=dkxFkrOpjQGLbrLmIP0+FclGqPGzevJvZOLievBv8dk=; b=Ma7SNTID4HC5udffLghRQSe5iI6880MQSJVBEDgshonUeJ9hMF4IKZex0al3/+lDSOvUui nCU/+0I/gdaSpXRf/RfTacoz6FWs1NRforrf28G6HasCmLfyIU1tmJfnI8KZBztyFTqEjP Xprsm7zmGkaj0SpI07ep60/NU6l5aF0= X-Rspamd-Queue-Id: E9EEA16000F X-Stat-Signature: ugpaufy1peedmqj4p7s5io1ouk8ij6jn X-Rspam-User: Authentication-Results: imf08.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=kqgbzNKE; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf08.hostedemail.com: domain of 3K4CAYwgKCFAvsD0vy6Ey66y3w.u64305CF-442Dsu2.69y@flex--davidgow.bounces.google.com designates 209.85.214.201 as permitted sender) smtp.mailfrom=3K4CAYwgKCFAvsD0vy6Ey66y3w.u64305CF-442Dsu2.69y@flex--davidgow.bounces.google.com X-Rspamd-Server: rspam09 X-HE-Tag: 1669365804-540034 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: Use the newly-added function kunit_get_current_test() instead of accessing current->kunit_test directly. This function uses a static key to return more quickly when KUnit is enabled, but no tests are actively running. There should therefore be a negligible performance impact to enabling the slub KUnit tests. Other than the performance improvement, this should be a no-op. Cc: Oliver Glitta Cc: Hyeonggon Yoo <42.hyeyoo@gmail.com> Cc: Christoph Lameter Cc: Vlastimil Babka Cc: David Rientjes Cc: Andrew Morton Signed-off-by: David Gow Acked-by: Vlastimil Babka Acked-by: Hyeonggon Yoo <42.hyeyoo@gmail.com> Reviewed-by: Kees Cook --- This is intended as an example use of the new function. Other users (such as KASAN) will be updated separately, as there would otherwise be conflicts. We'll take this whole series via the kselftest/kunit tree. Changes since v3: https://lore.kernel.org/linux-kselftest/20221119081252.3864249-3-davidgow@google.com/ - Add Hyeonggon's Acked-by. Changes since v2: https://lore.kernel.org/all/20221025071907.1251820-3-davidgow@google.com/ - Get rid of a redundant 'likely' (Thanks Vlastimil Babka) - Use current->kunit_test directly when we already know a test is running. (Thanks Vlastimil Babka) - Add Vlastimil's Acked-by. There was no v1 of this patch. v1 of the series can be found here: https://lore.kernel.org/linux-kselftest/20221021072854.333010-1-davidgow@google.com/T/#u Cheers, -- David --- lib/slub_kunit.c | 1 + mm/slub.c | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/slub_kunit.c b/lib/slub_kunit.c index 7a0564d7cb7a..8fd19c8301ad 100644 --- a/lib/slub_kunit.c +++ b/lib/slub_kunit.c @@ -1,5 +1,6 @@ // SPDX-License-Identifier: GPL-2.0 #include +#include #include #include #include diff --git a/mm/slub.c b/mm/slub.c index 157527d7101b..1887996cb703 100644 --- a/mm/slub.c +++ b/mm/slub.c @@ -39,6 +39,7 @@ #include #include #include +#include #include #include @@ -603,7 +604,7 @@ static bool slab_add_kunit_errors(void) { struct kunit_resource *resource; - if (likely(!current->kunit_test)) + if (!kunit_get_current_test()) return false; resource = kunit_find_named_resource(current->kunit_test, "slab_errors");