From patchwork Thu Sep 9 17:10:51 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Latypov X-Patchwork-Id: 12483571 X-Patchwork-Delegate: brendanhiggins@google.com 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 80244C433EF for ; Thu, 9 Sep 2021 17:11:04 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6A8BE61100 for ; Thu, 9 Sep 2021 17:11:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240077AbhIIRMM (ORCPT ); Thu, 9 Sep 2021 13:12:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53814 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239891AbhIIRMM (ORCPT ); Thu, 9 Sep 2021 13:12:12 -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 AC5A2C061575 for ; Thu, 9 Sep 2021 10:11:02 -0700 (PDT) Received: by mail-yb1-xb4a.google.com with SMTP id z6-20020a257e06000000b0059bad6decfbso3171739ybc.16 for ; Thu, 09 Sep 2021 10:11:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=date:message-id:mime-version:subject:from:to:cc; bh=uy74vWb7x9CjpeXzDF9JGC37Nd1wyF55MqZMbJTR5Wo=; b=KMiCfwB1nufAZzfwSVnXzPS82JzQ6fOxWEC4q/O5nQ7bU6Bx5w+WlxaqAclivgSus5 9fRTE67ONAz6q79HJt9krqocKryGTA6icq1fxyfeQCbEl7MMlLb9/VsxTDw2VZCgjXVy bjWt9v0DF2GNZ3V/oH3W8RuMffP0BPf83mgRMhsogXJ9gy3tXO6C0WEOLgTTylju8Vrq 5UNjDpNIKB77J1x6g/QtmtmozEth0VUpiHQScDl/dJZEKyEuVjMHPLKeedSmLiWSen1A sNL2h6S3wzPy7PbxAPU8oSSzRu+GLN4VSFfGM5+Y+xE2g1utwBqIyxBZWl5zuOUViXnK w1Cg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:message-id:mime-version:subject:from:to:cc; bh=uy74vWb7x9CjpeXzDF9JGC37Nd1wyF55MqZMbJTR5Wo=; b=j4FDjm05dKLcN46lusz6BuCuP/IZ58pedFd0eRulaG5BvzM/79Zfm/5cqio3g8Z3vE JnZq/OId3fb/zQCVPhEa+78eSMI1XnBIHodEoVyHzy0i8G1Px00Wyharhzkl1A/vQWUl zM9OCF9QpJu+9jP8uCTy3OngmEfLfTTgt5+MiAOMd0VvtZtRYS9gmt1JRg2iO5flh/ut Opar/Dluic455bg0qHJ0Lm9WvABFAaGKb6hHy9zKPBGqczCY32vYbjGxl79b+7yjO7TO A7SS00lQjg/Ph/kdbpEkIJPStnlKOTs5RuUiRtEJb8vzfme4N7D+1Pic+getpV9V5zeY bKrA== X-Gm-Message-State: AOAM533+E4jimkuQ8MOsCfWVsP6amF7U/3NAPboPsGl/tF/8Cb70HZ14 B0snHW177ApDGZGHSWiz2NkKPQHgtfNveA== X-Google-Smtp-Source: ABdhPJz/Qr4KbA9nPcYmGjr5qftwLt6v207+aRKN2ehtwNbyTWlnEO1sGHvMKOcEmYvY61jzJb5z16dBLCm17g== X-Received: from dlatypov.svl.corp.google.com ([2620:15c:2cd:202:d3ed:35f2:f475:fbc1]) (user=dlatypov job=sendgmr) by 2002:a25:d68e:: with SMTP id n136mr5409238ybg.271.1631207461822; Thu, 09 Sep 2021 10:11:01 -0700 (PDT) Date: Thu, 9 Sep 2021 10:10:51 -0700 Message-Id: <20210909171052.3192326-1-dlatypov@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.33.0.309.g3052b89438-goog Subject: [PATCH v4 1/2] kunit: drop assumption in kunit-log-test about current suite From: Daniel Latypov To: brendanhiggins@google.com, davidgow@google.com Cc: linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, skhan@linuxfoundation.org, Daniel Latypov Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org This test assumes that the declared kunit_suite object is the exact one which is being executed, which KUnit will not guarantee [1]. Specifically, `suite->log` is not initialized until a suite object is executed. So if KUnit makes a copy of the suite and runs that instead, this test dereferences an invalid pointer and (hopefully) segfaults. N.B. since we no longer assume this, we can no longer verify that `suite->log` is *not* allocated during normal execution. An alternative to this patch that would allow us to test that would require exposing an API for the current test to get its current suite. Exposing that for one internal kunit test seems like overkill, and grants users more footguns (e.g. reusing a test case in multiple suites and changing behavior based on the suite name, dynamically modifying the setup/cleanup funcs, storing/reading stuff out of the suite->log, etc.). [1] In a subsequent patch, KUnit will allow running subsets of test cases within a suite by making a copy of the suite w/ the filtered test list. But there are other reasons KUnit might execute a copy, e.g. if it ever wants to support parallel execution of different suites, recovering from errors and restarting suites Signed-off-by: Daniel Latypov Reviewed-by: Brendan Higgins --- lib/kunit/kunit-test.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) base-commit: a3fa7a101dcff93791d1b1bdb3affcad1410c8c1 diff --git a/lib/kunit/kunit-test.c b/lib/kunit/kunit-test.c index d69efcbed624..555601d17f79 100644 --- a/lib/kunit/kunit-test.c +++ b/lib/kunit/kunit-test.c @@ -415,12 +415,15 @@ static struct kunit_suite kunit_log_test_suite = { static void kunit_log_test(struct kunit *test) { - struct kunit_suite *suite = &kunit_log_test_suite; + struct kunit_suite suite; + + suite.log = kunit_kzalloc(test, KUNIT_LOG_SIZE, GFP_KERNEL); + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, suite.log); kunit_log(KERN_INFO, test, "put this in log."); kunit_log(KERN_INFO, test, "this too."); - kunit_log(KERN_INFO, suite, "add to suite log."); - kunit_log(KERN_INFO, suite, "along with this."); + kunit_log(KERN_INFO, &suite, "add to suite log."); + kunit_log(KERN_INFO, &suite, "along with this."); #ifdef CONFIG_KUNIT_DEBUGFS KUNIT_EXPECT_NOT_ERR_OR_NULL(test, @@ -428,12 +431,11 @@ static void kunit_log_test(struct kunit *test) KUNIT_EXPECT_NOT_ERR_OR_NULL(test, strstr(test->log, "this too.")); KUNIT_EXPECT_NOT_ERR_OR_NULL(test, - strstr(suite->log, "add to suite log.")); + strstr(suite.log, "add to suite log.")); KUNIT_EXPECT_NOT_ERR_OR_NULL(test, - strstr(suite->log, "along with this.")); + strstr(suite.log, "along with this.")); #else KUNIT_EXPECT_PTR_EQ(test, test->log, (char *)NULL); - KUNIT_EXPECT_PTR_EQ(test, suite->log, (char *)NULL); #endif }