From patchwork Fri Oct 21 07:28:54 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 618544 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4DC42C4332F for ; Fri, 21 Oct 2022 07:31:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230197AbiJUHb2 (ORCPT ); Fri, 21 Oct 2022 03:31:28 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:32976 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230222AbiJUHbU (ORCPT ); Fri, 21 Oct 2022 03:31:20 -0400 Received: from mail-yw1-x114a.google.com (mail-yw1-x114a.google.com [IPv6:2607:f8b0:4864:20::114a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E09AC2475EB for ; Fri, 21 Oct 2022 00:31:10 -0700 (PDT) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-3586920096bso20252047b3.20 for ; Fri, 21 Oct 2022 00:31:10 -0700 (PDT) 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=yYRI4YM/O3HPavk8M56cMbkj+MwZGK3MSk39K+2fBzs=; b=jbSx66ETI+A32fKzKRjx5OquaUQL8nMNegJ5xcIQN/qDilciMPGigwaH0+Zc07EiKX vSt4omPWR1sWbZsL2+Jbm91k4cOhgnEndNJ4H69cflKemIXd6lPrpY/Pjpl1Mxu4Wt3n X4PBCIK2jEgZJ1gOlO6NCeZsnY0RlvaZeykZbwYvhpJYFWPM0IhI/nWiMDD+Vl2X0cay 56gP5+65jhmTYTzgC7jF0WhkFSwDzXQQp2gPZIHL1iFYBBPGGr2yPllgTZEU63g98MIf G5fkmIXxWhW4nf+dadIq1oRCMUQKZGlFkRE6gpPhJkomEXnY+zNpM/fuof6ZeqpZj90M hj8g== 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=yYRI4YM/O3HPavk8M56cMbkj+MwZGK3MSk39K+2fBzs=; b=Zi48ekGpp7y2gG/NJ50uERvbHvsm494OCO/+G/pRvgEQfhzWFYJSvdbSbptCCxTHWw rGW4ygHKL6s+ZHZKcXdQUD5rAr/DiqJXFl9BWJ/BaKEekOvq7s5I3Qi+N3fwUQGQsdR5 z6QKAqAAn461LTZPFiEJL8nYAgc4RxFJfgkyl11vDqvfT3ltl+TDSJzsP8F1Jgfkjl3x pwMOV4Wy9a0qZRqDDuXszKPW9w64kIT3jpBJ+d0p917Pmnm9KvqKAOhBJy0E7htVg5se 9ClHr2gTFQ8HTTKpuhcH+swsK0snHR4HsOaXNr949uhnM6MvUHPlunszinBFxPxITFmX R2zA== X-Gm-Message-State: ACrzQf2WCVA8gARyA0Ndf1HuTfWQg0aUY7PPf995eKSF2I8vZIDlwF0s LVONX6v6tj5QhhQZ2RzaDClxT21JhuF5oQ== X-Google-Smtp-Source: AMsMyM76iIWNmGWl5azzgQ/kUxazHQFVQEwuFrEmhRfU3we+Qyko7o5kcAkKNyco/dfhd8d2fOk1nyM9rBERtg== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a05:6902:34b:b0:691:4b82:7624 with SMTP id e11-20020a056902034b00b006914b827624mr16182648ybs.614.1666337470120; Fri, 21 Oct 2022 00:31:10 -0700 (PDT) Date: Fri, 21 Oct 2022 15:28:54 +0800 Mime-Version: 1.0 X-Mailer: git-send-email 2.38.0.135.g90850a2211-goog Message-ID: <20221021072854.333010-1-davidgow@google.com> Subject: [PATCH 1/2] 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 Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org 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 --- 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. --- 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 b1ab6b32216d..450a778a039e 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 */ +extern struct 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 90640a43cf62..314717b63080 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. @@ -612,10 +614,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 Oct 21 07:28:55 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 617395 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CA931C433FE for ; Fri, 21 Oct 2022 07:31:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230126AbiJUHbb (ORCPT ); Fri, 21 Oct 2022 03:31:31 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60874 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230149AbiJUHbW (ORCPT ); Fri, 21 Oct 2022 03:31:22 -0400 Received: from mail-yb1-xb49.google.com (mail-yb1-xb49.google.com [IPv6:2607:f8b0:4864:20::b49]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 363612475FC for ; Fri, 21 Oct 2022 00:31:15 -0700 (PDT) Received: by mail-yb1-xb49.google.com with SMTP id t17-20020a257811000000b006c509f9a16dso2381021ybc.10 for ; Fri, 21 Oct 2022 00:31:15 -0700 (PDT) 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=4Ukwd+W4yUObSSiJHNA3xBbGR2xkY62jRsxgv2DCjeM=; b=DDR1FZmXOPfNnIahF64Yl1WnL3w1ledFOway/UOkPmf59UO0S5M9JKyLb7LqsKBBpd SwCMN0yvBUeC/7w6TJ/3PGjpiP95babhe9PQdsYTzelfzTyOU7DqeUaiETnnKY4BmoOL w1/dLB+J3w06ZKSH6j+WQOc0tqOZVs/2oOSujKZManwU/mRZV7yVmh25nMuPRpQaajRx BjhLvJcwjN0tpVo/o6/yVDkW8ra/Bh1EoJPZsLTgtXWbUVLc4RD+8HlEe4wkDhP05eST 71o0FtYoGrDlSlJYzSlgdegNH1hj2tS69LxMbieFLlSq+l2LMQe9IPxh2VkXIIxTrwv7 KrUg== 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=4Ukwd+W4yUObSSiJHNA3xBbGR2xkY62jRsxgv2DCjeM=; b=68e7HxYoQzvaXtTZ/TVGo1P9uy2Oh+qK3j8wDt0PuS1ub3/qWFPdZ3XqYgTzgUOHXq HC7PXekk6AYKNLZZqnCjxWg7nqIDcvjqhoH/610Crm7oC0KYZX0tx1/SAvFtUtoX8s8P TSVYQzQfpQZNxBX3SHDMAcZx8KXrj4Z/kJspMTCvLqNQlOO5PNfstfwm5L+v2hGNZj+C XiZ46VpFjyG+Y1zL3EdHbG2/7arCC878QdkphmZylTVm63JhE6Rj2segGhB/kXLMmsM/ WcKlpvJd3s08mMo+TDjejumFLbR0gnVYh592uhCZptFPZh0jSzVXd6oYH227OoAtblG8 YQkw== X-Gm-Message-State: ACrzQf0GTU9J/chnR2RCiHDwUqYSKM576gO1dcwjJmt77n9Pz/GkW9sZ CSb+ARqJjfdDv9OAEguwjAKHWwsEOiHawQ== X-Google-Smtp-Source: AMsMyM5R/AzkN9cwYEhav+L0OEzaKWiS2EE//NDTf7ZoZct9r8qpgWiVgwQhkG3Pyp7lj414XFyXnh8scXZ0jA== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a05:6902:1003:b0:6bf:3ae4:7d31 with SMTP id w3-20020a056902100300b006bf3ae47d31mr15179638ybt.48.1666337474473; Fri, 21 Oct 2022 00:31:14 -0700 (PDT) Date: Fri, 21 Oct 2022 15:28:55 +0800 In-Reply-To: <20221021072854.333010-1-davidgow@google.com> Mime-Version: 1.0 References: <20221021072854.333010-1-davidgow@google.com> X-Mailer: git-send-email 2.38.0.135.g90850a2211-goog Message-ID: <20221021072854.333010-2-davidgow@google.com> Subject: [PATCH 2/2] kunit: Use the static key in kunit_fail_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 Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org Speed up the case where kunit_fail_current_test() is called when no test is running. This should make it convenient for code to call this unconditionally in some error paths, without fear of causing a performance problem. If CONFIG_KUNIT=n, 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. kunit_fail_current_test() does not work if KUnit itself is built as a module, though this is a pre-existing limitation. 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. Signed-off-by: David Gow --- include/kunit/test-bug.h | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/include/kunit/test-bug.h b/include/kunit/test-bug.h index 5fc58081d511..ba9558a9f9c0 100644 --- a/include/kunit/test-bug.h +++ b/include/kunit/test-bug.h @@ -9,16 +9,29 @@ #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 */ + +/* Static key if KUnit is running any tests. */ +extern struct static_key_false kunit_running; + +#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 +/* 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, ...) {