From patchwork Tue Oct 25 07:19: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: 10549 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp859839wru; Tue, 25 Oct 2022 00:33:35 -0700 (PDT) X-Google-Smtp-Source: AMsMyM4QR9wUaOHianpmj9LoZReB/IyJmUl4eYLQq61atJ7r9XjMlK/BG/08XNisOsGz3vlkbgOg X-Received: by 2002:a17:90b:2812:b0:20d:7a3b:df3e with SMTP id qb18-20020a17090b281200b0020d7a3bdf3emr79070550pjb.169.1666683215055; Tue, 25 Oct 2022 00:33:35 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666683215; cv=none; d=google.com; s=arc-20160816; b=Eof0qhQ1FPXmZ0I66wgoJtPggNJpx88JZT8shBPEVhtoqVRjUBkSLESOX+Ll7rPHGT TzSGZTB1ijaDSHf8Oye4DWHeOpDPIqLsWviEAJQRde1V/6ahnDCOtUx0UjwArCDhmefV 8RFjQPgIkPQWxRdgFW11MompFiRYQRuj8bo24noP2Yo0osj/ImU//jI1Qw1nRjQAr/PH sVxstTxIv7gCzWoKCHMrvPRXbeYiWbZknFc471iCCTehV86l8bdNaL3xGWZMkhNp8f5V 1x2Cg6R2/883tVz6HNAHGsvAhN5ZWrv0gWWsyb5ev1122zcYPL/B2PsDOyZoc+oOLnlJ fQbw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:message-id:mime-version:date :dkim-signature; bh=Tg+2eIYV8Ht6XVdDxVGWgiFGyJrz8FeDTVg6oxA83to=; b=apQsxrh6YoKSl3tLKkY98l0SfHzIgAhD2E30MDudIw0Zbdujava74sgv5Qd2y767/A IRplCzMdYHONRVTRwBXsSbyFEsPv27L+OZCMqKSc30X6gKnnWoqKnKQpJgpbMc6O3B2/ 7UPV2fEmxH5vRwQEPJi9FuajehFZPTHt9zMTJxWMQW8ERpAdwmXQKnv6zFpCoNGugQcM pLUPTYMxdJtE4buHrEJaDLysKQmBp3PXIs/d3gvh0BYwFPjy7cS42qq2kgIke7aP9xFN aPIxF7Bct13RrB1xnq6YjuJTq6BNqobVNae8iQzjjSMFGaIYBosgnR6HcW2l6b1ECgtN 3eKw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=N20hIBlj; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id a18-20020aa794b2000000b0056618176fd4si2285546pfl.148.2022.10.25.00.33.22; Tue, 25 Oct 2022 00:33:35 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=N20hIBlj; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231610AbiJYHTX (ORCPT + 99 others); Tue, 25 Oct 2022 03:19:23 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57158 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231611AbiJYHTV (ORCPT ); Tue, 25 Oct 2022 03:19:21 -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 C1BDD14D1F9 for ; Tue, 25 Oct 2022 00:19:20 -0700 (PDT) Received: by mail-yb1-xb4a.google.com with SMTP id h4-20020a5b02c4000000b006bc192d672bso11290205ybp.22 for ; Tue, 25 Oct 2022 00:19:20 -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=Tg+2eIYV8Ht6XVdDxVGWgiFGyJrz8FeDTVg6oxA83to=; b=N20hIBljO9B2x5fTp2LgIWIJ6EaOGsk8PztwvAmRhr/ICL8s2SDtYc8Xej+kchGmum RO8n9j1w+WKDCz7oFgqPc2IdvBYxzjByNjkm4hxwVX+FcssRWGWyfKDGaBXlpNHd/ESd w53SmUZL8Apz9MpYSTDJwmcgtyACqeyETGmVKhgDL1+oWIiKfB8MKRr+LXaBk3NwQMSq S59QO27GUgYRSNVlxuBn8eg+5y6oeZVK8xiN8MecuKy51E1BGP8PDElLUtQgOdAZ3oz6 M198xDTBoLYhZB6crv2JTgJMdFBDEkWmU+VOD3su3teMa0VAyK1zEM0iSqeyadiML47h /9QA== 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=Tg+2eIYV8Ht6XVdDxVGWgiFGyJrz8FeDTVg6oxA83to=; b=BJD+MJeqSrdS/n6szpy6gTPd5EelVAeptNCF3dYMLaztkIg0E8Z/wln2oPMdWmh3j6 n041ZJTvcxafTiPfvo4HC0U8LtPNBHJ65ra6QP6RqPjybuGBzGaPfaYXt4FlHd+vZUnP EkO+JoIza1uzituWm6EaeC1eK3Ci68Sh0wDE8uQwpuM369fjP5/sDe87iC7c5pHKFQ2l VtCQxSgxey4silwYE2RCjnKv+n+YWc0rFX4MwbuE/oBKj4XYNbjK4TZMhrNNEvq5G1PP gfzyOPZ6I8+gmsxaR9/OCLohwTE4Zqu3NH4IeF9IVeoYjQF/MPsu8J57Cl0lrD4OZj3a DCzQ== X-Gm-Message-State: ACrzQf12OFaDj3HV7IQ5ny6oFr2Cff64hh6a6YUNCGflSY0GoKEksTGh CnGjqShhOjzW/hyKXmUHqZTkygyYA93ybQ== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a25:b749:0:b0:68f:171f:96bd with SMTP id e9-20020a25b749000000b0068f171f96bdmr34115629ybm.137.1666682360070; Tue, 25 Oct 2022 00:19:20 -0700 (PDT) Date: Tue, 25 Oct 2022 15:19:05 +0800 Mime-Version: 1.0 X-Mailer: git-send-email 2.38.0.135.g90850a2211-goog Message-ID: <20221025071907.1251820-1-davidgow@google.com> Subject: [PATCH v2 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 X-Spam-Status: No, score=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1747644019217403549?= X-GMAIL-MSGID: =?utf-8?q?1747644019217403549?= 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. 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 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 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 Tue Oct 25 07:19: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: 10544 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp858530wru; Tue, 25 Oct 2022 00:29:45 -0700 (PDT) X-Google-Smtp-Source: AMsMyM7ICiA3fzEGb5+rQBoHk+l78/PkpuxLR1+sAbolca0a/ZWdI+EW3fhSpmyTD5mapyycGjpF X-Received: by 2002:a17:907:2d8a:b0:78d:4448:e96c with SMTP id gt10-20020a1709072d8a00b0078d4448e96cmr30914035ejc.199.1666682985194; Tue, 25 Oct 2022 00:29:45 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666682985; cv=none; d=google.com; s=arc-20160816; b=MVvco0UfEOHaHD23UGtDq6pXERP29PUpKvSZkvrHFDfcP9liAhMdtdQ0bAFKSpYvRe hE14GH1hInYbfp3ka/SrKj23PTJQep5R7p9oH3MCeT2aUTpsQeS5CdAG6YUmDUdrVg3L oN8FTLi0XFy9/y/qA0lOeU794bDKlHmV+x8y+QumHgMvFUkgzFRpgDNSnRilfZPglDQ/ vrEQrz16+bwbwF0QKqIu95Qt0MWW4wc9NXUrrKDpHlVnHmpdnQlG4NBy4ZOokrVHLfQj czUI7YDnS9GIJ39Pk9vaZGuC+9iUimJ3YWha3XTqGNaV5RaLb0st6klFCqFU6aZy7OLG FI8w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:dkim-signature; bh=TSSlU0WBF0cN+y9B6p4hl7aqwNlQFVfaKcc/sTiVTfk=; b=teGL0l6zIzJph8M0Iw/EesXH89c+JBSaUULM12xaCd/AG9SiA3Hv+oMynwH/Sm63y/ Szbje57KYGOnY5Pc54iXAPt7BxHGarFCUJW6rKysHsp3pnl8opGjv0fbhCV02r2Iu8Q9 PcwoVGmIZkAZRc8d6piQVgOad2uVYaoO7tjH5yRDA8yDrKupkorARbSWTj5jhKZLuPBt 6mmhBampjr5/K1zyV3Rjb+sMq4tjT+xZluzcgFWM84FF4bV75hwr5AOsCaGNVoDGFTxY 3VtHfWrNX2eUWi7IKxgMGD/tNOZOFBlXtAviG2PbaH45w1NEHDbqi/Fdl6gwA5lVPgcl zpUg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=E3PupdkS; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id y25-20020a50ce19000000b004580ae4abfcsi1676474edi.460.2022.10.25.00.29.21; Tue, 25 Oct 2022 00:29:45 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=E3PupdkS; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231650AbiJYHTd (ORCPT + 99 others); Tue, 25 Oct 2022 03:19:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57546 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231625AbiJYHT0 (ORCPT ); Tue, 25 Oct 2022 03:19:26 -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 97725A98F4 for ; Tue, 25 Oct 2022 00:19:25 -0700 (PDT) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-368e6c449f2so110415387b3.5 for ; Tue, 25 Oct 2022 00:19:25 -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=TSSlU0WBF0cN+y9B6p4hl7aqwNlQFVfaKcc/sTiVTfk=; b=E3PupdkStZtJB4puC3t+1GP+0h5T91gRco+SuJL2Nn9UlYfQn3vEADEUzpLKj99yAV wsQJJv5DrRAjuD5O6Lv3b4s7WfP2Rd6UPWgtZHWiv9LZSrLOUVrlJTvkePyLP0EUZTcp iBsyGqpKBPHFcwsj2H5GsWT0t6fZRoFC7qIBuB4nnKD+/Rj49giGUB/dcIihCs0taa14 noAYF9r2FlZEMPEiYV5oeCAI0TS9HTqz/LQBm+yvMY6QUMkJaeDr+2P/RJnGOOJlwWG5 cXHXdJIv0fwgaBR0jTEEf4PqBPouf1hGx39el2Bk9A3NyD7j+LtCP/0WF5qbst2k/jDi SVYQ== 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=TSSlU0WBF0cN+y9B6p4hl7aqwNlQFVfaKcc/sTiVTfk=; b=3POYBNZE5gmJ9Ge/Wa7TQ7XUzpShD6RXkSS1dCIeNdytIr2SS4P98MQhcfcuYdDl7U L0MsalTnm5ej6og/xVQS0kYAPN7do/H0HlmoOQOMMas1g646Idq5UsjN+zEbWuD3JxDN dyfKV4v+qNdP464uwQSezbKny69/gaG6umyp2jGZGUVpEkRa3sbVghE5DONna6wsS8b/ Q/BAqpJb39jxruMMl2WwDNd+DKYm3bM4H6z5OkE5CSd5P14ZbuxS5hlLi8ZmILI2oXA4 KTmw6QZojDzOPz4+s1sc/jfIX5E0C6zY8n+BC2Y/Kg+SYWmZZBaxQsXomUNNfCY9b8Qq wmoQ== X-Gm-Message-State: ACrzQf2jrTVTk39yQYdBsjZgoHyUD4SFfhAOyC1UqwWPKzWyG+xyXr4Q sKavvffVrQu6p7z5T15joi+IPnWogllMbA== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a25:f205:0:b0:6af:ffab:9cfd with SMTP id i5-20020a25f205000000b006afffab9cfdmr33741860ybe.256.1666682364912; Tue, 25 Oct 2022 00:19:24 -0700 (PDT) Date: Tue, 25 Oct 2022 15:19:06 +0800 In-Reply-To: <20221025071907.1251820-1-davidgow@google.com> Mime-Version: 1.0 References: <20221025071907.1251820-1-davidgow@google.com> X-Mailer: git-send-email 2.38.0.135.g90850a2211-goog Message-ID: <20221025071907.1251820-2-davidgow@google.com> Subject: [PATCH v2 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 X-Spam-Status: No, score=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1747643778040944617?= X-GMAIL-MSGID: =?utf-8?q?1747643778040944617?= 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, 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. 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 --- 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 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 | 24 +++++++---- include/kunit/test-bug.h | 56 ++++++++++++++++++++++++- 2 files changed, 69 insertions(+), 11 deletions(-) diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst index 2737863ef365..05786564b968 100644 --- a/Documentation/dev-tools/kunit/usage.rst +++ b/Documentation/dev-tools/kunit/usage.rst @@ -625,17 +625,20 @@ 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, +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 disabled, or no test is running in the current task, it will quickly return ``NULL``. + +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; @@ -644,7 +647,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); @@ -675,7 +678,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 ------------------------ @@ -703,3 +706,6 @@ structures as shown below: static void my_debug_function(void) { } #endif +Note that ``kunit_fail_current_test`` requires KUnit be built-in to the kernel, i.e. +``CONFIG_KUNIT=y``. It is safe to call even if KUnit is not enabled, is built as a module, +or no test is currently running, but will do nothing. \ No newline at end of file diff --git a/include/kunit/test-bug.h b/include/kunit/test-bug.h index 5fc58081d511..85b085030a7a 100644 --- a/include/kunit/test-bug.h +++ b/include/kunit/test-bug.h @@ -9,16 +9,68 @@ #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_ENABLED(CONFIG_KUNIT) + +#include /* For static branch */ +#include + +/* Static key if KUnit is running any tests. */ +extern struct 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, which 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: it will compile + * down to nothing if CONFIG_KUNIT is not enabled, and will be very fast if + * 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; +} + +#else + +static inline struct kunit *kunit_get_current_test(void) { return NULL; } + +#endif #if IS_BUILTIN(CONFIG_KUNIT) +/** + * 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 +/* 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 Tue Oct 25 07:19:07 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 10550 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp859912wru; Tue, 25 Oct 2022 00:33:49 -0700 (PDT) X-Google-Smtp-Source: AMsMyM66/G+/ikp+tqtJEQLz0Na5IwziiqLzW0Wos1tMx8QokvSGpPcsena0jA0kkzq6YGjdmq9d X-Received: by 2002:a17:903:40cb:b0:17f:6e08:6eac with SMTP id t11-20020a17090340cb00b0017f6e086eacmr37531102pld.80.1666683229724; Tue, 25 Oct 2022 00:33:49 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666683229; cv=none; d=google.com; s=arc-20160816; b=s2RO5Y7LYyzTIi1NotHAIb5kUNHCLs3A33aGXnz9nDt07WaO68eTtqWR6RByXtcG6N IFfDQJVMpDDnCRgpLKRvVQ3NOkb3SKaRGLV530bvKG3KrqadJrmmKoKjnmv2FseG1+UN ptPUECcctnpDqkdzTKiC9nsqksCMxvYAXb0pJgyC118TcFXGloo+PLxSUQcP2GjHz+6v 61WoAzIkRFYqg1am3L/+Qt5gBfGhMteRK9RRJY86v8Z9WiVXTZEM9F6FiudNY+1hzh2m unmAspevxVSF3Y6cSxDRH84S9HyQd79pKHc3FdF2MudHJ5qljuZ5rbOmCVt68C5mp0r6 n/sg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:dkim-signature; bh=KA5AmQjfCAbtpdHkGDjwVts9T7CuDkkry+0zPgKF0lM=; b=IgqRhHNYIdIidMr9UV//7GXlV4H8jy4vgs6lrhRybrDvvr+YARFtZjcgl32sqRvndo i9r76SaLsLI13BdOoQBcaOY7heATtby1l0th9jNJbNljqA17V6Ml26tXvfa2JPbqPNwm A333iu1vOEDlykZRYYM1dtHuOhTDjujB3TRtJ7wiHoKzkxanf+L7S6tM40hlQ6iD2C5o Yn9/MyYOZsidnkxgwiV7FdUU1E4pyEGHp9obPLfdOgeyCd4j8vI8gG+SGxiJvePbtFg2 HCONLXVKUJaZzRSTpOCSi9xLc6NaaRvnQ9fa8B2V81ucoSrrlYuNfzBuxNcimfGO7Irf vNDg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=ho9NvHEq; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id b13-20020a170902d88d00b001868ef35f09si2198858plz.258.2022.10.25.00.33.36; Tue, 25 Oct 2022 00:33:49 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=ho9NvHEq; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231486AbiJYHTs (ORCPT + 99 others); Tue, 25 Oct 2022 03:19:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57808 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231629AbiJYHTd (ORCPT ); Tue, 25 Oct 2022 03:19:33 -0400 Received: from mail-yw1-x1149.google.com (mail-yw1-x1149.google.com [IPv6:2607:f8b0:4864:20::1149]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A5C012BE09 for ; Tue, 25 Oct 2022 00:19:30 -0700 (PDT) Received: by mail-yw1-x1149.google.com with SMTP id 00721157ae682-360a7ff46c3so111050707b3.12 for ; Tue, 25 Oct 2022 00:19:30 -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=KA5AmQjfCAbtpdHkGDjwVts9T7CuDkkry+0zPgKF0lM=; b=ho9NvHEqLfDplAjRx3uXKJiU3DoSROQtKqQ8jRhFd0Ck3bp2UOpw8N9lYdxjatKuYv co/P5Nk6CLcK/+U9EK4lL66rumOXMbWTwndY1+zqeBCGNIjWtMZexvP1r8fzZLGhIbkU URsp7CuLP4czyMYdx7nshdoj5wFvyKDgBctnpRho0U/7PipKMJWU+msjlZHwvoClSw6O EvgkK+rfUfDrf/fynysJgKuFNt/SnjNJ/7x0wc8t7u3GvmcbGHIzDOGamTDQO4RMxpdU hh8nQ1fXv3LVNN0nD4AItp5Or8XNWSODER0ITRmk2Az9YLODBHDSLXNZo3mhj/LYKCQs eyxw== 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=KA5AmQjfCAbtpdHkGDjwVts9T7CuDkkry+0zPgKF0lM=; b=MvJTt1GvyBc5fnPmee/coaae5ECv1CxyLCHGaon7dYwcNa4srNE93k44RQZ+lfkGSF 1GrC7R/P0r/OZCZY4GJcA1rkmRIL6RhEACTqgjyDzcyv5jnDjsZxLHJSjoERXRQ1BMz9 5gxMgSwEjgQscOOOmaSFTCDdPC8k4pLN5rilj4d+kRAkm2fa34evef3kap+neePdy9tJ 2WbX5pUz3dHP65bjztPTV56gpSGxFyUXzMClJqr3KdBpKvlc77ZQ7GRGgxikWZz635Ei 4l9D3ABJvwSExaHiL8zfuLQ0t904LOab3DgKoDlPSD78eLHA9Su7PVZ3ZeS74sAPIRMN BN0A== X-Gm-Message-State: ACrzQf26em5UTwTXzrdPnN2rWEmcFC9BpdkZfDcc6IGIadvBV5x4VmYW 6ZUCeI2r5yF3o7sBrRL2bUEmOBvZlU2J4g== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:20a1]) (user=davidgow job=sendgmr) by 2002:a81:6907:0:b0:34a:51ce:3b38 with SMTP id e7-20020a816907000000b0034a51ce3b38mr32787158ywc.151.1666682369948; Tue, 25 Oct 2022 00:19:29 -0700 (PDT) Date: Tue, 25 Oct 2022 15:19:07 +0800 In-Reply-To: <20221025071907.1251820-1-davidgow@google.com> Mime-Version: 1.0 References: <20221025071907.1251820-1-davidgow@google.com> X-Mailer: git-send-email 2.38.0.135.g90850a2211-goog Message-ID: <20221025071907.1251820-3-davidgow@google.com> Subject: [PATCH v2 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 X-Spam-Status: No, score=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1747644034753459694?= X-GMAIL-MSGID: =?utf-8?q?1747644034753459694?= 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 --- 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. Assuming there are no objections, we'll take this whole series via the kselftest/kunit tree. 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 --- lib/slub_kunit.c | 1 + mm/slub.c | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) 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..15d10d250ef2 100644 --- a/mm/slub.c +++ b/mm/slub.c @@ -39,6 +39,7 @@ #include #include #include +#include #include #include @@ -603,10 +604,10 @@ static bool slab_add_kunit_errors(void) { struct kunit_resource *resource; - if (likely(!current->kunit_test)) + if (likely(!kunit_get_current_test())) return false; - resource = kunit_find_named_resource(current->kunit_test, "slab_errors"); + resource = kunit_find_named_resource(kunit_get_current_test(), "slab_errors"); if (!resource) return false;