1 // SPDX-License-Identifier: GPL-2.0+
3 // Scalability test comparing RCU vs other mechanisms
4 // for acquiring references on objects.
6 // Copyright (C) Google, 2020.
8 // Author: Joel Fernandes <joel@joelfernandes.org>
10 #define pr_fmt(fmt) fmt
12 #include <linux/atomic.h>
13 #include <linux/bitops.h>
14 #include <linux/completion.h>
15 #include <linux/cpu.h>
16 #include <linux/delay.h>
17 #include <linux/err.h>
18 #include <linux/init.h>
19 #include <linux/interrupt.h>
20 #include <linux/kthread.h>
21 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/moduleparam.h>
25 #include <linux/notifier.h>
26 #include <linux/percpu.h>
27 #include <linux/rcupdate.h>
28 #include <linux/rcupdate_trace.h>
29 #include <linux/reboot.h>
30 #include <linux/sched.h>
31 #include <linux/spinlock.h>
32 #include <linux/smp.h>
33 #include <linux/stat.h>
34 #include <linux/srcu.h>
35 #include <linux/slab.h>
36 #include <linux/torture.h>
37 #include <linux/types.h>
41 #define SCALE_FLAG "-ref-scale: "
43 #define SCALEOUT(s, x...) \
44 pr_alert("%s" SCALE_FLAG s, scale_type, ## x)
46 #define VERBOSE_SCALEOUT(s, x...) \
47 do { if (verbose) pr_alert("%s" SCALE_FLAG s, scale_type, ## x); } while (0)
49 static atomic_t verbose_batch_ctr;
51 #define VERBOSE_SCALEOUT_BATCH(s, x...) \
54 (verbose_batched <= 0 || \
55 !(atomic_inc_return(&verbose_batch_ctr) % verbose_batched))) { \
56 schedule_timeout_uninterruptible(1); \
57 pr_alert("%s" SCALE_FLAG s, scale_type, ## x); \
61 #define VERBOSE_SCALEOUT_ERRSTRING(s, x...) \
62 do { if (verbose) pr_alert("%s" SCALE_FLAG "!!! " s, scale_type, ## x); } while (0)
64 MODULE_LICENSE("GPL");
65 MODULE_AUTHOR("Joel Fernandes (Google) <joel@joelfernandes.org>");
67 static char *scale_type = "rcu";
68 module_param(scale_type, charp, 0444);
69 MODULE_PARM_DESC(scale_type, "Type of test (rcu, srcu, refcnt, rwsem, rwlock.");
71 torture_param(int, verbose, 0, "Enable verbose debugging printk()s");
72 torture_param(int, verbose_batched, 0, "Batch verbose debugging printk()s");
74 // Wait until there are multiple CPUs before starting test.
75 torture_param(int, holdoff, IS_BUILTIN(CONFIG_RCU_REF_SCALE_TEST) ? 10 : 0,
76 "Holdoff time before test start (s)");
77 // Number of loops per experiment, all readers execute operations concurrently.
78 torture_param(long, loops, 10000, "Number of loops per experiment.");
79 // Number of readers, with -1 defaulting to about 75% of the CPUs.
80 torture_param(int, nreaders, -1, "Number of readers, -1 for 75% of CPUs.");
82 torture_param(int, nruns, 30, "Number of experiments to run.");
83 // Reader delay in nanoseconds, 0 for no delay.
84 torture_param(int, readdelay, 0, "Read-side delay in nanoseconds.");
87 # define REFSCALE_SHUTDOWN 0
89 # define REFSCALE_SHUTDOWN 1
92 torture_param(bool, shutdown, REFSCALE_SHUTDOWN,
93 "Shutdown at end of scalability tests.");
96 struct task_struct *task;
102 static struct task_struct *shutdown_task;
103 static wait_queue_head_t shutdown_wq;
105 static struct task_struct *main_task;
106 static wait_queue_head_t main_wq;
107 static int shutdown_start;
109 static struct reader_task *reader_tasks;
111 // Number of readers that are part of the current experiment.
112 static atomic_t nreaders_exp;
114 // Use to wait for all threads to start.
115 static atomic_t n_init;
116 static atomic_t n_started;
117 static atomic_t n_warmedup;
118 static atomic_t n_cooleddown;
120 // Track which experiment is currently running.
123 // Operations vector for selecting different types of tests.
124 struct ref_scale_ops {
126 void (*cleanup)(void);
127 void (*readsection)(const int nloops);
128 void (*delaysection)(const int nloops, const int udl, const int ndl);
132 static struct ref_scale_ops *cur_ops;
134 static void un_delay(const int udl, const int ndl)
142 static void ref_rcu_read_section(const int nloops)
146 for (i = nloops; i >= 0; i--) {
152 static void ref_rcu_delay_section(const int nloops, const int udl, const int ndl)
156 for (i = nloops; i >= 0; i--) {
163 static void rcu_sync_scale_init(void)
167 static struct ref_scale_ops rcu_ops = {
168 .init = rcu_sync_scale_init,
169 .readsection = ref_rcu_read_section,
170 .delaysection = ref_rcu_delay_section,
174 // Definitions for SRCU ref scale testing.
175 DEFINE_STATIC_SRCU(srcu_refctl_scale);
176 static struct srcu_struct *srcu_ctlp = &srcu_refctl_scale;
178 static void srcu_ref_scale_read_section(const int nloops)
183 for (i = nloops; i >= 0; i--) {
184 idx = srcu_read_lock(srcu_ctlp);
185 srcu_read_unlock(srcu_ctlp, idx);
189 static void srcu_ref_scale_delay_section(const int nloops, const int udl, const int ndl)
194 for (i = nloops; i >= 0; i--) {
195 idx = srcu_read_lock(srcu_ctlp);
197 srcu_read_unlock(srcu_ctlp, idx);
201 static struct ref_scale_ops srcu_ops = {
202 .init = rcu_sync_scale_init,
203 .readsection = srcu_ref_scale_read_section,
204 .delaysection = srcu_ref_scale_delay_section,
208 // Definitions for RCU Tasks ref scale testing: Empty read markers.
209 // These definitions also work for RCU Rude readers.
210 static void rcu_tasks_ref_scale_read_section(const int nloops)
214 for (i = nloops; i >= 0; i--)
218 static void rcu_tasks_ref_scale_delay_section(const int nloops, const int udl, const int ndl)
222 for (i = nloops; i >= 0; i--)
226 static struct ref_scale_ops rcu_tasks_ops = {
227 .init = rcu_sync_scale_init,
228 .readsection = rcu_tasks_ref_scale_read_section,
229 .delaysection = rcu_tasks_ref_scale_delay_section,
233 // Definitions for RCU Tasks Trace ref scale testing.
234 static void rcu_trace_ref_scale_read_section(const int nloops)
238 for (i = nloops; i >= 0; i--) {
239 rcu_read_lock_trace();
240 rcu_read_unlock_trace();
244 static void rcu_trace_ref_scale_delay_section(const int nloops, const int udl, const int ndl)
248 for (i = nloops; i >= 0; i--) {
249 rcu_read_lock_trace();
251 rcu_read_unlock_trace();
255 static struct ref_scale_ops rcu_trace_ops = {
256 .init = rcu_sync_scale_init,
257 .readsection = rcu_trace_ref_scale_read_section,
258 .delaysection = rcu_trace_ref_scale_delay_section,
262 // Definitions for reference count
263 static atomic_t refcnt;
265 static void ref_refcnt_section(const int nloops)
269 for (i = nloops; i >= 0; i--) {
275 static void ref_refcnt_delay_section(const int nloops, const int udl, const int ndl)
279 for (i = nloops; i >= 0; i--) {
286 static struct ref_scale_ops refcnt_ops = {
287 .init = rcu_sync_scale_init,
288 .readsection = ref_refcnt_section,
289 .delaysection = ref_refcnt_delay_section,
293 // Definitions for rwlock
294 static rwlock_t test_rwlock;
296 static void ref_rwlock_init(void)
298 rwlock_init(&test_rwlock);
301 static void ref_rwlock_section(const int nloops)
305 for (i = nloops; i >= 0; i--) {
306 read_lock(&test_rwlock);
307 read_unlock(&test_rwlock);
311 static void ref_rwlock_delay_section(const int nloops, const int udl, const int ndl)
315 for (i = nloops; i >= 0; i--) {
316 read_lock(&test_rwlock);
318 read_unlock(&test_rwlock);
322 static struct ref_scale_ops rwlock_ops = {
323 .init = ref_rwlock_init,
324 .readsection = ref_rwlock_section,
325 .delaysection = ref_rwlock_delay_section,
329 // Definitions for rwsem
330 static struct rw_semaphore test_rwsem;
332 static void ref_rwsem_init(void)
334 init_rwsem(&test_rwsem);
337 static void ref_rwsem_section(const int nloops)
341 for (i = nloops; i >= 0; i--) {
342 down_read(&test_rwsem);
343 up_read(&test_rwsem);
347 static void ref_rwsem_delay_section(const int nloops, const int udl, const int ndl)
351 for (i = nloops; i >= 0; i--) {
352 down_read(&test_rwsem);
354 up_read(&test_rwsem);
358 static struct ref_scale_ops rwsem_ops = {
359 .init = ref_rwsem_init,
360 .readsection = ref_rwsem_section,
361 .delaysection = ref_rwsem_delay_section,
365 static void rcu_scale_one_reader(void)
368 cur_ops->readsection(loops);
370 cur_ops->delaysection(loops, readdelay / 1000, readdelay % 1000);
373 // Reader kthread. Repeatedly does empty RCU read-side
374 // critical section, minimizing update-side interference.
376 ref_scale_reader(void *arg)
380 struct reader_task *rt = &(reader_tasks[me]);
384 VERBOSE_SCALEOUT_BATCH("ref_scale_reader %ld: task started", me);
385 set_cpus_allowed_ptr(current, cpumask_of(me % nr_cpu_ids));
386 set_user_nice(current, MAX_NICE);
389 schedule_timeout_interruptible(holdoff * HZ);
391 VERBOSE_SCALEOUT_BATCH("ref_scale_reader %ld: waiting to start next experiment on cpu %d", me, smp_processor_id());
393 // Wait for signal that this reader can start.
394 wait_event(rt->wq, (atomic_read(&nreaders_exp) && smp_load_acquire(&rt->start_reader)) ||
395 torture_must_stop());
397 if (torture_must_stop())
400 // Make sure that the CPU is affinitized appropriately during testing.
401 WARN_ON_ONCE(smp_processor_id() != me);
403 WRITE_ONCE(rt->start_reader, 0);
404 if (!atomic_dec_return(&n_started))
405 while (atomic_read_acquire(&n_started))
408 VERBOSE_SCALEOUT_BATCH("ref_scale_reader %ld: experiment %d started", me, exp_idx);
411 // To reduce noise, do an initial cache-warming invocation, check
412 // in, and then keep warming until everyone has checked in.
413 rcu_scale_one_reader();
414 if (!atomic_dec_return(&n_warmedup))
415 while (atomic_read_acquire(&n_warmedup))
416 rcu_scale_one_reader();
417 // Also keep interrupts disabled. This also has the effect
418 // of preventing entries into slow path for rcu_read_unlock().
419 local_irq_save(flags);
420 start = ktime_get_mono_fast_ns();
422 rcu_scale_one_reader();
424 duration = ktime_get_mono_fast_ns() - start;
425 local_irq_restore(flags);
427 rt->last_duration_ns = WARN_ON_ONCE(duration < 0) ? 0 : duration;
428 // To reduce runtime-skew noise, do maintain-load invocations until
430 if (!atomic_dec_return(&n_cooleddown))
431 while (atomic_read_acquire(&n_cooleddown))
432 rcu_scale_one_reader();
434 if (atomic_dec_and_test(&nreaders_exp))
437 VERBOSE_SCALEOUT_BATCH("ref_scale_reader %ld: experiment %d ended, (readers remaining=%d)",
438 me, exp_idx, atomic_read(&nreaders_exp));
440 if (!torture_must_stop())
443 torture_kthread_stopping("ref_scale_reader");
447 static void reset_readers(void)
450 struct reader_task *rt;
452 for (i = 0; i < nreaders; i++) {
453 rt = &(reader_tasks[i]);
455 rt->last_duration_ns = 0;
459 // Print the results of each reader and return the sum of all their durations.
460 static u64 process_durations(int n)
463 struct reader_task *rt;
468 buf = kmalloc(128 + nreaders * 32, GFP_KERNEL);
472 sprintf(buf, "Experiment #%d (Format: <THREAD-NUM>:<Total loop time in ns>)",
475 for (i = 0; i < n && !torture_must_stop(); i++) {
476 rt = &(reader_tasks[i]);
477 sprintf(buf1, "%d: %llu\t", i, rt->last_duration_ns);
483 sum += rt->last_duration_ns;
487 SCALEOUT("%s\n", buf);
493 // The main_func is the main orchestrator, it performs a bunch of
494 // experiments. For every experiment, it orders all the readers
495 // involved to start and waits for them to finish the experiment. It
496 // then reads their timestamps and starts the next experiment. Each
497 // experiment progresses from 1 concurrent reader to N of them at which
498 // point all the timestamps are printed.
499 static int main_func(void *arg)
501 bool errexit = false;
507 set_cpus_allowed_ptr(current, cpumask_of(nreaders % nr_cpu_ids));
508 set_user_nice(current, MAX_NICE);
510 VERBOSE_SCALEOUT("main_func task started");
511 result_avg = kzalloc(nruns * sizeof(*result_avg), GFP_KERNEL);
512 buf = kzalloc(64 + nruns * 32, GFP_KERNEL);
513 if (!result_avg || !buf) {
514 VERBOSE_SCALEOUT_ERRSTRING("out of memory");
518 schedule_timeout_interruptible(holdoff * HZ);
520 // Wait for all threads to start.
522 while (atomic_read(&n_init) < nreaders + 1)
523 schedule_timeout_uninterruptible(1);
525 // Start exp readers up per experiment
526 for (exp = 0; exp < nruns && !torture_must_stop(); exp++) {
529 if (torture_must_stop())
533 atomic_set(&nreaders_exp, nreaders);
534 atomic_set(&n_started, nreaders);
535 atomic_set(&n_warmedup, nreaders);
536 atomic_set(&n_cooleddown, nreaders);
540 for (r = 0; r < nreaders; r++) {
541 smp_store_release(&reader_tasks[r].start_reader, 1);
542 wake_up(&reader_tasks[r].wq);
545 VERBOSE_SCALEOUT("main_func: experiment started, waiting for %d readers",
549 !atomic_read(&nreaders_exp) || torture_must_stop());
551 VERBOSE_SCALEOUT("main_func: experiment ended");
553 if (torture_must_stop())
556 result_avg[exp] = div_u64(1000 * process_durations(nreaders), nreaders * loops);
559 // Print the average of all experiments
560 SCALEOUT("END OF TEST. Calculating average duration per loop (nanoseconds)...\n");
565 strcat(buf, "Runs\tTime(ns)\n");
568 for (exp = 0; exp < nruns; exp++) {
574 avg = div_u64_rem(result_avg[exp], 1000, &rem);
575 sprintf(buf1, "%d\t%llu.%03u\n", exp + 1, avg, rem);
582 // This will shutdown everything including us.
585 wake_up(&shutdown_wq);
588 // Wait for torture to stop us
589 while (!torture_must_stop())
590 schedule_timeout_uninterruptible(1);
593 torture_kthread_stopping("main_func");
600 ref_scale_print_module_parms(struct ref_scale_ops *cur_ops, const char *tag)
602 pr_alert("%s" SCALE_FLAG
603 "--- %s: verbose=%d shutdown=%d holdoff=%d loops=%ld nreaders=%d nruns=%d readdelay=%d\n", scale_type, tag,
604 verbose, shutdown, holdoff, loops, nreaders, nruns, readdelay);
608 ref_scale_cleanup(void)
612 if (torture_cleanup_begin())
616 torture_cleanup_end();
621 for (i = 0; i < nreaders; i++)
622 torture_stop_kthread("ref_scale_reader",
623 reader_tasks[i].task);
627 torture_stop_kthread("main_task", main_task);
630 // Do scale-type-specific cleanup operations.
631 if (cur_ops->cleanup != NULL)
634 torture_cleanup_end();
637 // Shutdown kthread. Just waits to be awakened, then shuts down system.
639 ref_scale_shutdown(void *arg)
641 wait_event(shutdown_wq, shutdown_start);
643 smp_mb(); // Wake before output.
655 static struct ref_scale_ops *scale_ops[] = {
656 &rcu_ops, &srcu_ops, &rcu_trace_ops, &rcu_tasks_ops,
657 &refcnt_ops, &rwlock_ops, &rwsem_ops,
660 if (!torture_init_begin(scale_type, verbose))
663 for (i = 0; i < ARRAY_SIZE(scale_ops); i++) {
664 cur_ops = scale_ops[i];
665 if (strcmp(scale_type, cur_ops->name) == 0)
668 if (i == ARRAY_SIZE(scale_ops)) {
669 pr_alert("rcu-scale: invalid scale type: \"%s\"\n", scale_type);
670 pr_alert("rcu-scale types:");
671 for (i = 0; i < ARRAY_SIZE(scale_ops); i++)
672 pr_cont(" %s", scale_ops[i]->name);
681 ref_scale_print_module_parms(cur_ops, "Start of test");
685 init_waitqueue_head(&shutdown_wq);
686 firsterr = torture_create_kthread(ref_scale_shutdown, NULL,
690 schedule_timeout_uninterruptible(1);
693 // Reader tasks (default to ~75% of online CPUs).
695 nreaders = (num_online_cpus() >> 1) + (num_online_cpus() >> 2);
696 if (WARN_ONCE(loops <= 0, "%s: loops = %ld, adjusted to 1\n", __func__, loops))
698 if (WARN_ONCE(nreaders <= 0, "%s: nreaders = %d, adjusted to 1\n", __func__, nreaders))
700 if (WARN_ONCE(nruns <= 0, "%s: nruns = %d, adjusted to 1\n", __func__, nruns))
702 reader_tasks = kcalloc(nreaders, sizeof(reader_tasks[0]),
705 VERBOSE_SCALEOUT_ERRSTRING("out of memory");
710 VERBOSE_SCALEOUT("Starting %d reader threads\n", nreaders);
712 for (i = 0; i < nreaders; i++) {
713 firsterr = torture_create_kthread(ref_scale_reader, (void *)i,
714 reader_tasks[i].task);
718 init_waitqueue_head(&(reader_tasks[i].wq));
722 init_waitqueue_head(&main_wq);
723 firsterr = torture_create_kthread(main_func, NULL, main_task);
734 WARN_ON(!IS_MODULE(CONFIG_RCU_REF_SCALE_TEST));
740 module_init(ref_scale_init);
741 module_exit(ref_scale_cleanup);