From patchwork Thu Mar 11 15:23:13 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Latypov X-Patchwork-Id: 397922 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=-26.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, 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 CFCD8C433E0 for ; Thu, 11 Mar 2021 15:24:20 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8EA7C64FEC for ; Thu, 11 Mar 2021 15:24:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234101AbhCKPXq (ORCPT ); Thu, 11 Mar 2021 10:23:46 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42802 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234218AbhCKPXX (ORCPT ); Thu, 11 Mar 2021 10:23:23 -0500 Received: from mail-qv1-xf4a.google.com (mail-qv1-xf4a.google.com [IPv6:2607:f8b0:4864:20::f4a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 763FBC061574 for ; Thu, 11 Mar 2021 07:23:23 -0800 (PST) Received: by mail-qv1-xf4a.google.com with SMTP id d15so15332042qvn.16 for ; Thu, 11 Mar 2021 07:23:23 -0800 (PST) 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=Uo+jdzDkstwte4rd5KP1ZCWjSQcfZaf7ZJhZWXy2RKs=; b=oU2FmmZy1hcNiNWsHS5LxlTOzAWKO8wzT9oIwklSSFU8vic4F9LLZemwiu5iaPJ7kb 0r5jphxrIlJMeTC9Q4pBCp0fvcx87DYKidbdpH/6FWR7AjA4wefUB7SG5d+iWlyj8KqP vxD2QcLXsAjKKQy7xzfraTFyWvRpk5FfsdJnWZEaXqATSC9zORoiaJM6aRlr4jUqFPng ziaGRRqHDdgUSCfoQVaL1guOfsuy0CpchIqafwrjcXghFqfTWMaOzLo0CXWAc6pIMLKo dtG9x5xh86R0tUGmwFhGedtf/RUzFWLAe3jXDiF/rMBAYgzKZJAdTNRPbfd8IeeLQRrT Jjyg== 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=Uo+jdzDkstwte4rd5KP1ZCWjSQcfZaf7ZJhZWXy2RKs=; b=pnm1mjwQsW2rt+mCbHXi/TSohjFwqeTo5SibHeMZ3UgCRjf0IRjgI85t4zHkL6lY/0 enYHk8X46K+0u8yd3/+2CIcfXVYOsg1ZG3f3ThsBy+myjI5nTwix3vp0rlZuQnhI1vs/ 5KXIvkybCibqy9Thu3nTHZlZEiFdbKlQpBgiMhz9y3QFL3d0BJBc8rIKKPzfJfr9I6ED 6oYiclLDItgXTv4HcqMAQDdILIgTATcmmcxHjJ8XEF7HEHuJHFBNTY3mWwelmsVrs14A Be97YxkrFOMyYZNhYYhozKF/suqin69F+3fQpcnLVFWTEdSWFQdTl0GpSseDKem3KhmW KLkQ== X-Gm-Message-State: AOAM533lZkHNG6Fl9m2jIIkWG7EQYp/mka3HPrs6k2Y59qjxPivkP+pd LTJI9WJqZTg8LJpUz+K9zV2tqSJpyyeKzA== X-Google-Smtp-Source: ABdhPJy1zi+D10F+EaOLwJkcGaJWbsWc2A4cgtaoxCxs+Xt42a/9UWmbeAIBXnObyqjj6bb+TiMDj9xPxP6ZNQ== X-Received: from dlatypov.svl.corp.google.com ([2620:15c:2cd:202:d84c:1a92:8f6c:2d41]) (user=dlatypov job=sendgmr) by 2002:a05:6214:242f:: with SMTP id gy15mr8169011qvb.17.1615476202686; Thu, 11 Mar 2021 07:23:22 -0800 (PST) Date: Thu, 11 Mar 2021 07:23:13 -0800 In-Reply-To: <20210311152314.3814916-1-dlatypov@google.com> Message-Id: <20210311152314.3814916-2-dlatypov@google.com> Mime-Version: 1.0 References: <20210311152314.3814916-1-dlatypov@google.com> X-Mailer: git-send-email 2.31.0.rc2.261.g7f71774620-goog Subject: [PATCH v4 1/2] kunit: support failure from dynamic analysis tools From: Daniel Latypov To: brendanhiggins@google.com Cc: davidgow@google.com, alan.maguire@oracle.com, linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, skhan@linuxfoundation.org, Uriel Guajardo , Daniel Latypov Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org From: Uriel Guajardo Add a kunit_fail_current_test() function to fail the currently running test, if any, with an error message. This is largely intended for dynamic analysis tools like UBSAN and for fakes. E.g. say I had a fake ops struct for testing and I wanted my `free` function to complain if it was called with an invalid argument, or caught a double-free. Most return void and have no normal means of signalling failure (e.g. super_operations, iommu_ops, etc.). Key points: * Always update current->kunit_test so anyone can use it. * commit 83c4e7a0363b ("KUnit: KASAN Integration") only updated it for CONFIG_KASAN=y * Create a new header so non-test code doesn't have to include all of (e.g. lib/ubsan.c) * Forward the file and line number to make it easier to track down failures * Declare the helper function for nice __printf() warnings about mismatched format strings even when KUnit is not enabled. Example output from kunit_fail_current_test("message"): [15:19:34] [FAILED] example_simple_test [15:19:34] # example_simple_test: initializing [15:19:34] # example_simple_test: lib/kunit/kunit-example-test.c:24: message [15:19:34] not ok 1 - example_simple_test Co-developed-by: Daniel Latypov Signed-off-by: Daniel Latypov Signed-off-by: Uriel Guajardo Reviewed-by: Alan Maguire Reviewed-by: Brendan Higgins --- include/kunit/test-bug.h | 30 ++++++++++++++++++++++++++++++ lib/kunit/test.c | 39 +++++++++++++++++++++++++++++++++++---- 2 files changed, 65 insertions(+), 4 deletions(-) create mode 100644 include/kunit/test-bug.h diff --git a/include/kunit/test-bug.h b/include/kunit/test-bug.h new file mode 100644 index 000000000000..e88b74a4fd85 --- /dev/null +++ b/include/kunit/test-bug.h @@ -0,0 +1,30 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * KUnit API allowing dynamic analysis tools to interact with KUnit tests + * + * Copyright (C) 2020, Google LLC. + * Author: Uriel Guajardo + */ + +#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) + +extern __printf(3, 4) void __kunit_fail_current_test(const char *file, int line, + const char *fmt, ...); + +#else + +static __printf(3, 4) void __kunit_fail_current_test(const char *file, int line, + const char *fmt, ...) +{ +} + +#endif + + +#endif /* _KUNIT_TEST_BUG_H */ diff --git a/lib/kunit/test.c b/lib/kunit/test.c index ec9494e914ef..2f6cc0123232 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -7,6 +7,7 @@ */ #include +#include #include #include #include @@ -16,6 +17,40 @@ #include "string-stream.h" #include "try-catch-impl.h" +#if IS_BUILTIN(CONFIG_KUNIT) +/* + * Fail the current test and print an error message to the log. + */ +void __kunit_fail_current_test(const char *file, int line, const char *fmt, ...) +{ + va_list args; + int len; + char *buffer; + + if (!current->kunit_test) + return; + + kunit_set_failure(current->kunit_test); + + /* kunit_err() only accepts literals, so evaluate the args first. */ + va_start(args, fmt); + len = vsnprintf(NULL, 0, fmt, args) + 1; + va_end(args); + + buffer = kunit_kmalloc(current->kunit_test, len, GFP_KERNEL); + if (!buffer) + return; + + va_start(args, fmt); + vsnprintf(buffer, len, fmt, args); + va_end(args); + + kunit_err(current->kunit_test, "%s:%d: %s", file, line, buffer); + kunit_kfree(current->kunit_test, buffer); +} +EXPORT_SYMBOL_GPL(__kunit_fail_current_test); +#endif + /* * Append formatted message to log, size of which is limited to * KUNIT_LOG_SIZE bytes (including null terminating byte). @@ -273,9 +308,7 @@ 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, @@ -624,9 +657,7 @@ 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);