From patchwork Sat Feb 8 22:52:30 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tamir Duberstein X-Patchwork-Id: 863491 Received: from mail-qt1-f180.google.com (mail-qt1-f180.google.com [209.85.160.180]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4ADF7244195; Sat, 8 Feb 2025 22:52:47 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.160.180 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739055169; cv=none; b=cmCVvkPOF3pqnl1qFI3xmxz0yExL5FJUho33es9pwqSE3I8PDoMIktpTLxVGrcAxA3vcwWQTKa6Fuiv9R5RtKOmjP9KuwgLGiAg/2XS0AVXH3I1RCvxlDoPeAZrq/ciTvY2VtmE8h0OmEMXmRaSr/LoTvW8JL2hq9UMdUm8KNm4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739055169; c=relaxed/simple; bh=8MNDiNpDPWBdjrpw3CF1vf3bp/M/sxQFM3PmtkUFb/I=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=iXrdxNSIat9TxLO+cHVjvrz3rRjnRgINstxBZgT9ktpFCU7HtMI3aStGu12jt7uX3dudqsAFwBSKSp1osY0/QQqYhEFSQFQFsBEBvdn5LteSiAp3jGrIMXfSOhxG2a5Ax71RkQVsfjAyaSGUinCJnZa8epWXPhBgnsqCVO5hKLU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=TF4DBw27; arc=none smtp.client-ip=209.85.160.180 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="TF4DBw27" Received: by mail-qt1-f180.google.com with SMTP id d75a77b69052e-467a3f1e667so20212181cf.0; Sat, 08 Feb 2025 14:52:46 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1739055166; x=1739659966; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=5HY8IF8KhtroO/ZndjY8ubdvu13F9tIx02mF455vd9M=; b=TF4DBw27KR0sW0SIQm+ZitgGI4+GiyC70dXgBU+6TX9sJT9FJwP/eQm5QpdwpA4S/v zkumZq3WFRnJRRdEJftvAiATcxSefD6KoSXqkPYk4agp/jBAyt+7XuRBvEY0QGrcodlm Ge3q0SV/qEYfckJV29nJ1oT+5GTm46ijKmExVjF7Gvj9b9wvYEek3z0Fp5BWpIG9XMAe VNYR69VKx/X0syWnEqGkZP+pGcFbQUv8yyhHnKm+P5dM6csaDL9NY3oTMu7xGLOWqy7P A+gKMgKOeO2GCI2AmtfuJZP/itPfOdui85h97/GnyecJYRv26UxL3M/Fo/sTXgKJHP2/ lVTg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1739055166; x=1739659966; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=5HY8IF8KhtroO/ZndjY8ubdvu13F9tIx02mF455vd9M=; b=GzrX0MF+aN4bcDxZhkyujFJrSdpkifxerSM6ZGbraaXBoje1aWj6wjBx/b+3TeC5zc qdET/IKSgCj9IPZxoNe9gvWArzJ3n5yK48KA92f1Z8whpE1HO/jgjuuzs01yoF+LQhc5 2+091Ik4qV8iMFpKl8msKejGtyHS+xcseSs3aOxWWcgaPUZhfn5vwX52fk0mJVgjm2/+ 0Vt7139hP9cV5KUcV8eEvKlvbUFmKMoTZxWH+nkTJbQOIsF0to4r9hWhChnfb4VYR3RN ftyUVEFCNHC52NGTG4qg3b95nZ5jF+mJ1QWAK3hZFOYPPoONRIqBTDpt2mgiaMVhiMI2 B1gw== X-Forwarded-Encrypted: i=1; AJvYcCXKpc+6SpAJ5bYVwPkyZ1FoySKVwK9NMOTXwRfgYqszcNDt1aqNhesAw/udElucaER1MCuJurVkU2/ySXWlQ0w=@vger.kernel.org X-Gm-Message-State: AOJu0Yx5zbuKTkBKnhg2xuiV3sNffr1Lg/V9Yb5wOie89VGTkUYHwDyd D7ZnS8jEj0hwTDB9RpwNnRq2l+FKhkHNLbEhrTWnU7WaGkCfXu/e X-Gm-Gg: ASbGncunYTTeSsxgW4wcsSYFe4lYnRlvQtU38aycT0zTiW3bB08oaUr9oV2sA0o7Xd5 YCEtT1CjhvqUiYlsz0jWn8rbW9j+V5GoZOHHdYJ/pZb62p+IbFuVWPwpXPGWYU/bnySQWqfM0cK jv90zkw4PSTQ7SOmh8FTTqPCPBOFnAL+IIIfAbVEHNLTBVkf/zM8voDnHTxK7ncrtionKUK4otS 3ahgBswLZU9Pam1ZeUaWWU/IR0SMYvflP3w6gsCWGTjAMfJkoUEhZzzRT+EYyjTi2FcMx8x7qi/ ImvD1sYeWT5yMpmcuV+mQS2UmRRkEuiHiZzWfcFU/BQ= X-Google-Smtp-Source: AGHT+IHYV0ZvU5f0UvqI7ZfVe0cZSWwepVqczbX2EyQOWkTBM4QVCwtj7ldJsxOmdhV8nFAhb2bRYQ== X-Received: by 2002:a05:622a:4296:b0:46c:9f53:4a45 with SMTP id d75a77b69052e-47167b7854cmr127683411cf.43.1739055165941; Sat, 08 Feb 2025 14:52:45 -0800 (PST) Received: from [192.168.1.159] ([2600:4041:5be7:7c00:15f6:96e9:3308:934a]) by smtp.gmail.com with ESMTPSA id d75a77b69052e-4718c20a23esm310731cf.4.2025.02.08.14.52.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 08 Feb 2025 14:52:44 -0800 (PST) From: Tamir Duberstein Date: Sat, 08 Feb 2025 17:52:30 -0500 Subject: [PATCH v3 2/2] lib/prime_numbers: convert self-test to KUnit Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-Id: <20250208-prime_numbers-kunit-convert-v3-2-8ffd5816d8dc@gmail.com> References: <20250208-prime_numbers-kunit-convert-v3-0-8ffd5816d8dc@gmail.com> In-Reply-To: <20250208-prime_numbers-kunit-convert-v3-0-8ffd5816d8dc@gmail.com> To: David Gow , Shuah Khan , Luis Felipe Hernandez , Andrew Morton , Shuah Khan Cc: linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, Tamir Duberstein X-Mailer: b4 0.15-dev Extract a private header and convert the prime_numbers self-test to a KUnit test. I considered parameterizing the test using `KUNIT_CASE_PARAM` but didn't see how it was possible since the test logic is entangled with the test parameter generation logic. Signed-off-by: Tamir Duberstein --- lib/Kconfig.debug | 14 +++++ lib/math/prime_numbers.c | 76 ++++------------------------ lib/math/prime_numbers_private.h | 17 +++++++ lib/math/tests/Makefile | 1 + lib/math/tests/prime_numbers_kunit.c | 59 +++++++++++++++++++++ tools/testing/selftests/lib/config | 1 - tools/testing/selftests/lib/prime_numbers.sh | 4 -- 7 files changed, 100 insertions(+), 72 deletions(-) diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index 1af972a92d06..616beaca4a2b 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -3197,6 +3197,20 @@ config INT_SQRT_KUNIT_TEST If unsure, say N +config PRIME_NUMBERS_KUNIT_TEST + tristate "Prime number generator test" if !KUNIT_ALL_TESTS + depends on KUNIT + select PRIME_NUMBERS + default KUNIT_ALL_TESTS + help + This option enables the KUnit test suite for the {is,next}_prime_number + functions. + + Enabling this option will include tests that compare the prime number + generator functions against a brute force implementation. + + If unsure, say N + endif # RUNTIME_TESTING_MENU config ARCH_USE_MEMTEST diff --git a/lib/math/prime_numbers.c b/lib/math/prime_numbers.c index 9a17ee9af93a..bb3d66f91364 100644 --- a/lib/math/prime_numbers.c +++ b/lib/math/prime_numbers.c @@ -1,16 +1,11 @@ // SPDX-License-Identifier: GPL-2.0-only -#define pr_fmt(fmt) "prime numbers: " fmt #include #include #include #include -struct primes { - struct rcu_head rcu; - unsigned long last, sz; - unsigned long primes[]; -}; +#include "prime_numbers_private.h" #if BITS_PER_LONG == 64 static const struct primes small_primes = { @@ -62,9 +57,13 @@ static const struct primes small_primes = { static DEFINE_MUTEX(lock); static const struct primes __rcu *primes = RCU_INITIALIZER(&small_primes); -static unsigned long selftest_max; +#ifdef CONFIG_PRIME_NUMBERS_KUNIT_TEST +EXPORT_SYMBOL(slow_is_prime_number); -static bool slow_is_prime_number(unsigned long x) +#else +static +#endif +bool slow_is_prime_number(unsigned long x) { unsigned long y = int_sqrt(x); @@ -239,65 +238,11 @@ bool is_prime_number(unsigned long x) } EXPORT_SYMBOL(is_prime_number); -static void dump_primes(void) +void with_primes(void *ctx, primes_fn fn) { - const struct primes *p; - char *buf; - - buf = kmalloc(PAGE_SIZE, GFP_KERNEL); - rcu_read_lock(); - p = rcu_dereference(primes); - - if (buf) - bitmap_print_to_pagebuf(true, buf, p->primes, p->sz); - pr_info("primes.{last=%lu, .sz=%lu, .primes[]=...x%lx} = %s\n", - p->last, p->sz, p->primes[BITS_TO_LONGS(p->sz) - 1], buf); - + fn(ctx, rcu_dereference(primes)); rcu_read_unlock(); - - kfree(buf); -} - -static int selftest(unsigned long max) -{ - unsigned long x, last; - - if (!max) - return 0; - - for (last = 0, x = 2; x < max; x++) { - bool slow = slow_is_prime_number(x); - bool fast = is_prime_number(x); - - if (slow != fast) { - pr_err("inconsistent result for is-prime(%lu): slow=%s, fast=%s!\n", - x, slow ? "yes" : "no", fast ? "yes" : "no"); - goto err; - } - - if (!slow) - continue; - - if (next_prime_number(last) != x) { - pr_err("incorrect result for next-prime(%lu): expected %lu, got %lu\n", - last, x, next_prime_number(last)); - goto err; - } - last = x; - } - - pr_info("%s(%lu) passed, last prime was %lu\n", __func__, x, last); - return 0; - -err: - dump_primes(); - return -EINVAL; -} - -static int __init primes_init(void) -{ - return selftest(selftest_max); } static void __exit primes_exit(void) @@ -305,11 +250,8 @@ static void __exit primes_exit(void) free_primes(); } -module_init(primes_init); module_exit(primes_exit); -module_param_named(selftest, selftest_max, ulong, 0400); - MODULE_AUTHOR("Intel Corporation"); MODULE_DESCRIPTION("Prime number library"); MODULE_LICENSE("GPL"); diff --git a/lib/math/prime_numbers_private.h b/lib/math/prime_numbers_private.h new file mode 100644 index 000000000000..9e1d440c5398 --- /dev/null +++ b/lib/math/prime_numbers_private.h @@ -0,0 +1,17 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +#include + +struct primes { + struct rcu_head rcu; + unsigned long last, sz; + unsigned long primes[]; +}; + +#ifdef CONFIG_PRIME_NUMBERS_KUNIT_TEST +bool slow_is_prime_number(unsigned long x); +#endif +typedef void (*primes_fn)(void *, const struct primes *); + +// Calls the callback under RCU lock. The callback must not retain the primes pointer. +void with_primes(void *ctx, primes_fn fn); diff --git a/lib/math/tests/Makefile b/lib/math/tests/Makefile index e1a79f093b2d..da21a592c75a 100644 --- a/lib/math/tests/Makefile +++ b/lib/math/tests/Makefile @@ -2,3 +2,4 @@ obj-$(CONFIG_INT_POW_TEST) += int_pow_kunit.o obj-$(CONFIG_INT_SQRT_KUNIT_TEST) += int_sqrt_kunit.o +obj-$(CONFIG_PRIME_NUMBERS_KUNIT_TEST) += prime_numbers_kunit.o diff --git a/lib/math/tests/prime_numbers_kunit.c b/lib/math/tests/prime_numbers_kunit.c new file mode 100644 index 000000000000..2f1643208c66 --- /dev/null +++ b/lib/math/tests/prime_numbers_kunit.c @@ -0,0 +1,59 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include +#include +#include + +#include "../prime_numbers_private.h" + +static void dump_primes(void *ctx, const struct primes *p) +{ + static char buf[PAGE_SIZE]; + struct kunit_suite *suite = ctx; + + bitmap_print_to_pagebuf(true, buf, p->primes, p->sz); + kunit_info(suite, "primes.{last=%lu, .sz=%lu, .primes[]=...x%lx} = %s", + p->last, p->sz, p->primes[BITS_TO_LONGS(p->sz) - 1], buf); +} + +static void prime_numbers_test(struct kunit *test) +{ + const unsigned long max = 65536; + unsigned long x, last, next; + + for (last = 0, x = 2; x < max; x++) { + const bool slow = slow_is_prime_number(x); + const bool fast = is_prime_number(x); + + KUNIT_ASSERT_EQ_MSG(test, slow, fast, "is-prime(%lu)", x); + + if (!slow) + continue; + + next = next_prime_number(last); + KUNIT_ASSERT_EQ_MSG(test, next, x, "next-prime(%lu)", last); + last = next; + } +} + +static void kunit_suite_exit(struct kunit_suite *suite) +{ + with_primes(suite, dump_primes); +} + +static struct kunit_case prime_numbers_cases[] = { + KUNIT_CASE(prime_numbers_test), + {}, +}; + +static struct kunit_suite prime_numbers_suite = { + .name = "math-prime_numbers", + .suite_exit = kunit_suite_exit, + .test_cases = prime_numbers_cases, +}; + +kunit_test_suite(prime_numbers_suite); + +MODULE_AUTHOR("Intel Corporation"); +MODULE_DESCRIPTION("Prime number library"); +MODULE_LICENSE("GPL"); diff --git a/tools/testing/selftests/lib/config b/tools/testing/selftests/lib/config index dc15aba8d0a3..306a3d4dca98 100644 --- a/tools/testing/selftests/lib/config +++ b/tools/testing/selftests/lib/config @@ -1,5 +1,4 @@ CONFIG_TEST_PRINTF=m CONFIG_TEST_SCANF=m CONFIG_TEST_BITMAP=m -CONFIG_PRIME_NUMBERS=m CONFIG_TEST_BITOPS=m diff --git a/tools/testing/selftests/lib/prime_numbers.sh b/tools/testing/selftests/lib/prime_numbers.sh deleted file mode 100755 index 370b79a9cb2e..000000000000 --- a/tools/testing/selftests/lib/prime_numbers.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh -# SPDX-License-Identifier: GPL-2.0 -# Checks fast/slow prime_number generation for inconsistencies -$(dirname $0)/../kselftest/module.sh "prime numbers" prime_numbers selftest=65536