lib: Add stress test for ratelimit

Add a simple stress test for lib/ratelimit.c

To run on x86:

	./tools/testing/kunit/kunit.py run --arch x86_64 --kconfig_add CONFIG_RATELIMIT_KUNIT_TEST=y --kconfig_add CONFIG_SMP=y --qemu_args "-smp 4" lib_ratelimit

On a 16-CPU system, the "4" in "-smp 4" can be varied between 1 and 8.
Larger numbers have higher probabilities of introducing delays that
break the smoke test.  In the extreme case, increasing the number to
larger than the number of CPUs in the underlying system is an excellent
way to get a test failure.

Link: https://lore.kernel.org/all/fbe93a52-365e-47fe-93a4-44a44547d601@paulmck-laptop/
Link: https://lore.kernel.org/all/20250423115409.3425-1-spasswolf@web.de/
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Cc: Petr Mladek <pmladek@suse.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Kuniyuki Iwashima <kuniyu@amazon.com>
Cc: Mateusz Guzik <mjguzik@gmail.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: John Ogness <john.ogness@linutronix.de>
Cc: Sergey Senozhatsky <senozhatsky@chromium.org>
Cc: Jon Pan-Doh <pandoh@google.com>
Cc: Bjorn Helgaas <bhelgaas@google.com>
Cc: Karolina Stolarek <karolina.stolarek@oracle.com>

diff --git a/lib/tests/test_ratelimit.c b/lib/tests/test_ratelimit.c
index 5d6ec88546005c5f8e999843c550b21054916ce8..bfaeca49304a556701f6193f193816deb24b6e27 100644 (file)
--- a/lib/tests/test_ratelimit.c
+++ b/lib/tests/test_ratelimit.c
@@ -4,6 +4,8 @@
 
 #include <linux/ratelimit.h>
 #include <linux/module.h>
+#include <linux/kthread.h>
+#include <linux/cpumask.h>
 
 /* a simple boot-time regression test */
 
@@ -63,14 +65,77 @@ static void test_ratelimit_smoke(struct kunit *test)
        test_ratelimited(test, false);
 }
 
-static struct kunit_case sort_test_cases[] = {
+static struct ratelimit_state stressrl = RATELIMIT_STATE_INIT_FLAGS("stressrl", HZ / 10, 3,
+                                                                   RATELIMIT_MSG_ON_RELEASE);
+
+static int doneflag;
+static const int stress_duration = 2 * HZ;
+
+struct stress_kthread {
+       unsigned long nattempts;
+       unsigned long nunlimited;
+       unsigned long nlimited;
+       unsigned long nmissed;
+       struct task_struct *tp;
+};
+
+static int test_ratelimit_stress_child(void *arg)
+{
+       struct stress_kthread *sktp = arg;
+
+       set_user_nice(current, MAX_NICE);
+       WARN_ON_ONCE(!sktp->tp);
+
+       while (!READ_ONCE(doneflag)) {
+               sktp->nattempts++;
+               if (___ratelimit(&stressrl, __func__))
+                       sktp->nunlimited++;
+               else
+                       sktp->nlimited++;
+               cond_resched();
+       }
+
+       sktp->nmissed = ratelimit_state_reset_miss(&stressrl);
+       return 0;
+}
+
+static void test_ratelimit_stress(struct kunit *test)
+{
+       int i;
+       const int n_stress_kthread = cpumask_weight(cpu_online_mask);
+       struct stress_kthread skt = { 0 };
+       struct stress_kthread *sktp = kcalloc(n_stress_kthread, sizeof(*sktp), GFP_KERNEL);
+
+       KUNIT_EXPECT_NOT_NULL_MSG(test, sktp, "Memory allocation failure");
+       for (i = 0; i < n_stress_kthread; i++) {
+               sktp[i].tp = kthread_run(test_ratelimit_stress_child, &sktp[i], "%s/%i",
+                                        "test_ratelimit_stress_child", i);
+               KUNIT_EXPECT_NOT_NULL_MSG(test, sktp, "kthread creation failure");
+               pr_alert("Spawned test_ratelimit_stress_child %d\n", i);
+       }
+       schedule_timeout_idle(stress_duration);
+       WRITE_ONCE(doneflag, 1);
+       for (i = 0; i < n_stress_kthread; i++) {
+               kthread_stop(sktp[i].tp);
+               skt.nattempts += sktp[i].nattempts;
+               skt.nunlimited += sktp[i].nunlimited;
+               skt.nlimited += sktp[i].nlimited;
+               skt.nmissed += sktp[i].nmissed;
+       }
+       KUNIT_ASSERT_EQ_MSG(test, skt.nunlimited + skt.nlimited, skt.nattempts,
+                           "Outcomes not equal to attempts");
+       KUNIT_ASSERT_EQ_MSG(test, skt.nlimited, skt.nmissed, "Misses not equal to limits");
+}
+
+static struct kunit_case ratelimit_test_cases[] = {
        KUNIT_CASE_SLOW(test_ratelimit_smoke),
+       KUNIT_CASE_SLOW(test_ratelimit_stress),
        {}
 };
 
 static struct kunit_suite ratelimit_test_suite = {
        .name = "lib_ratelimit",
-       .test_cases = sort_test_cases,
+       .test_cases = ratelimit_test_cases,
 };
 
 kunit_test_suites(&ratelimit_test_suite);