2 * Read-Copy Update module-based performance-test facility
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, you can access it online at
16 * http://www.gnu.org/licenses/gpl-2.0.html.
18 * Copyright (C) IBM Corporation, 2015
20 * Authors: Paul E. McKenney <paulmck@us.ibm.com>
23 #define pr_fmt(fmt) fmt
25 #include <linux/types.h>
26 #include <linux/kernel.h>
27 #include <linux/init.h>
28 #include <linux/module.h>
29 #include <linux/kthread.h>
30 #include <linux/err.h>
31 #include <linux/spinlock.h>
32 #include <linux/smp.h>
33 #include <linux/rcupdate.h>
34 #include <linux/interrupt.h>
35 #include <linux/sched.h>
36 #include <uapi/linux/sched/types.h>
37 #include <linux/atomic.h>
38 #include <linux/bitops.h>
39 #include <linux/completion.h>
40 #include <linux/moduleparam.h>
41 #include <linux/percpu.h>
42 #include <linux/notifier.h>
43 #include <linux/reboot.h>
44 #include <linux/freezer.h>
45 #include <linux/cpu.h>
46 #include <linux/delay.h>
47 #include <linux/stat.h>
48 #include <linux/srcu.h>
49 #include <linux/slab.h>
50 #include <asm/byteorder.h>
51 #include <linux/torture.h>
52 #include <linux/vmalloc.h>
56 MODULE_LICENSE("GPL");
57 MODULE_AUTHOR("Paul E. McKenney <paulmck@linux.vnet.ibm.com>");
59 #define PERF_FLAG "-perf:"
60 #define PERFOUT_STRING(s) \
61 pr_alert("%s" PERF_FLAG " %s\n", perf_type, s)
62 #define VERBOSE_PERFOUT_STRING(s) \
63 do { if (verbose) pr_alert("%s" PERF_FLAG " %s\n", perf_type, s); } while (0)
64 #define VERBOSE_PERFOUT_ERRSTRING(s) \
65 do { if (verbose) pr_alert("%s" PERF_FLAG "!!! %s\n", perf_type, s); } while (0)
68 * The intended use cases for the nreaders and nwriters module parameters
71 * 1. Specify only the nr_cpus kernel boot parameter. This will
72 * set both nreaders and nwriters to the value specified by
73 * nr_cpus for a mixed reader/writer test.
75 * 2. Specify the nr_cpus kernel boot parameter, but set
76 * rcuperf.nreaders to zero. This will set nwriters to the
77 * value specified by nr_cpus for an update-only test.
79 * 3. Specify the nr_cpus kernel boot parameter, but set
80 * rcuperf.nwriters to zero. This will set nreaders to the
81 * value specified by nr_cpus for a read-only test.
83 * Various other use cases may of course be specified.
86 torture_param(bool, gp_async
, false, "Use asynchronous GP wait primitives");
87 torture_param(int, gp_async_max
, 1000, "Max # outstanding waits per reader");
88 torture_param(bool, gp_exp
, false, "Use expedited GP wait primitives");
89 torture_param(int, holdoff
, 10, "Holdoff time before test start (s)");
90 torture_param(int, nreaders
, -1, "Number of RCU reader threads");
91 torture_param(int, nwriters
, -1, "Number of RCU updater threads");
92 torture_param(bool, shutdown
, !IS_ENABLED(MODULE
),
93 "Shutdown at end of performance tests.");
94 torture_param(int, verbose
, 1, "Enable verbose debugging printk()s");
95 torture_param(int, writer_holdoff
, 0, "Holdoff (us) between GPs, zero to disable");
97 static char *perf_type
= "rcu";
98 module_param(perf_type
, charp
, 0444);
99 MODULE_PARM_DESC(perf_type
, "Type of RCU to performance-test (rcu, rcu_bh, ...)");
101 static int nrealreaders
;
102 static int nrealwriters
;
103 static struct task_struct
**writer_tasks
;
104 static struct task_struct
**reader_tasks
;
105 static struct task_struct
*shutdown_task
;
107 static u64
**writer_durations
;
108 static int *writer_n_durations
;
109 static atomic_t n_rcu_perf_reader_started
;
110 static atomic_t n_rcu_perf_writer_started
;
111 static atomic_t n_rcu_perf_writer_finished
;
112 static wait_queue_head_t shutdown_wq
;
113 static u64 t_rcu_perf_writer_started
;
114 static u64 t_rcu_perf_writer_finished
;
115 static unsigned long b_rcu_perf_writer_started
;
116 static unsigned long b_rcu_perf_writer_finished
;
117 static DEFINE_PER_CPU(atomic_t
, n_async_inflight
);
119 static int rcu_perf_writer_state
;
122 #define RTWS_BARRIER 2
123 #define RTWS_EXP_SYNC 3
126 #define RTWS_STOPPING 6
128 #define MAX_MEAS 10000
132 * Operations vector for selecting different types of tests.
135 struct rcu_perf_ops
{
138 void (*cleanup
)(void);
139 int (*readlock
)(void);
140 void (*readunlock
)(int idx
);
141 unsigned long (*get_gp_seq
)(void);
142 unsigned long (*gp_diff
)(unsigned long new, unsigned long old
);
143 unsigned long (*exp_completed
)(void);
144 void (*async
)(struct rcu_head
*head
, rcu_callback_t func
);
145 void (*gp_barrier
)(void);
147 void (*exp_sync
)(void);
151 static struct rcu_perf_ops
*cur_ops
;
154 * Definitions for rcu perf testing.
157 static int rcu_perf_read_lock(void) __acquires(RCU
)
163 static void rcu_perf_read_unlock(int idx
) __releases(RCU
)
168 static unsigned long __maybe_unused
rcu_no_completed(void)
173 static void rcu_sync_perf_init(void)
177 static struct rcu_perf_ops rcu_ops
= {
179 .init
= rcu_sync_perf_init
,
180 .readlock
= rcu_perf_read_lock
,
181 .readunlock
= rcu_perf_read_unlock
,
182 .get_gp_seq
= rcu_get_gp_seq
,
183 .gp_diff
= rcu_seq_diff
,
184 .exp_completed
= rcu_exp_batches_completed
,
186 .gp_barrier
= rcu_barrier
,
187 .sync
= synchronize_rcu
,
188 .exp_sync
= synchronize_rcu_expedited
,
193 * Definitions for rcu_bh perf testing.
196 static int rcu_bh_perf_read_lock(void) __acquires(RCU_BH
)
202 static void rcu_bh_perf_read_unlock(int idx
) __releases(RCU_BH
)
204 rcu_read_unlock_bh();
207 static struct rcu_perf_ops rcu_bh_ops
= {
208 .ptype
= RCU_BH_FLAVOR
,
209 .init
= rcu_sync_perf_init
,
210 .readlock
= rcu_bh_perf_read_lock
,
211 .readunlock
= rcu_bh_perf_read_unlock
,
212 .get_gp_seq
= rcu_bh_get_gp_seq
,
213 .gp_diff
= rcu_seq_diff
,
214 .exp_completed
= rcu_exp_batches_completed_sched
,
215 .async
= call_rcu_bh
,
216 .gp_barrier
= rcu_barrier_bh
,
217 .sync
= synchronize_rcu_bh
,
218 .exp_sync
= synchronize_rcu_bh_expedited
,
223 * Definitions for srcu perf testing.
226 DEFINE_STATIC_SRCU(srcu_ctl_perf
);
227 static struct srcu_struct
*srcu_ctlp
= &srcu_ctl_perf
;
229 static int srcu_perf_read_lock(void) __acquires(srcu_ctlp
)
231 return srcu_read_lock(srcu_ctlp
);
234 static void srcu_perf_read_unlock(int idx
) __releases(srcu_ctlp
)
236 srcu_read_unlock(srcu_ctlp
, idx
);
239 static unsigned long srcu_perf_completed(void)
241 return srcu_batches_completed(srcu_ctlp
);
244 static void srcu_call_rcu(struct rcu_head
*head
, rcu_callback_t func
)
246 call_srcu(srcu_ctlp
, head
, func
);
249 static void srcu_rcu_barrier(void)
251 srcu_barrier(srcu_ctlp
);
254 static void srcu_perf_synchronize(void)
256 synchronize_srcu(srcu_ctlp
);
259 static void srcu_perf_synchronize_expedited(void)
261 synchronize_srcu_expedited(srcu_ctlp
);
264 static struct rcu_perf_ops srcu_ops
= {
265 .ptype
= SRCU_FLAVOR
,
266 .init
= rcu_sync_perf_init
,
267 .readlock
= srcu_perf_read_lock
,
268 .readunlock
= srcu_perf_read_unlock
,
269 .get_gp_seq
= srcu_perf_completed
,
270 .gp_diff
= rcu_seq_diff
,
271 .exp_completed
= srcu_perf_completed
,
272 .async
= srcu_call_rcu
,
273 .gp_barrier
= srcu_rcu_barrier
,
274 .sync
= srcu_perf_synchronize
,
275 .exp_sync
= srcu_perf_synchronize_expedited
,
279 static struct srcu_struct srcud
;
281 static void srcu_sync_perf_init(void)
284 init_srcu_struct(srcu_ctlp
);
287 static void srcu_sync_perf_cleanup(void)
289 cleanup_srcu_struct(srcu_ctlp
);
292 static struct rcu_perf_ops srcud_ops
= {
293 .ptype
= SRCU_FLAVOR
,
294 .init
= srcu_sync_perf_init
,
295 .cleanup
= srcu_sync_perf_cleanup
,
296 .readlock
= srcu_perf_read_lock
,
297 .readunlock
= srcu_perf_read_unlock
,
298 .get_gp_seq
= srcu_perf_completed
,
299 .gp_diff
= rcu_seq_diff
,
300 .exp_completed
= srcu_perf_completed
,
301 .async
= srcu_call_rcu
,
302 .gp_barrier
= srcu_rcu_barrier
,
303 .sync
= srcu_perf_synchronize
,
304 .exp_sync
= srcu_perf_synchronize_expedited
,
309 * Definitions for sched perf testing.
312 static int sched_perf_read_lock(void)
318 static void sched_perf_read_unlock(int idx
)
323 static struct rcu_perf_ops sched_ops
= {
324 .ptype
= RCU_SCHED_FLAVOR
,
325 .init
= rcu_sync_perf_init
,
326 .readlock
= sched_perf_read_lock
,
327 .readunlock
= sched_perf_read_unlock
,
328 .get_gp_seq
= rcu_sched_get_gp_seq
,
329 .gp_diff
= rcu_seq_diff
,
330 .exp_completed
= rcu_exp_batches_completed_sched
,
331 .async
= call_rcu_sched
,
332 .gp_barrier
= rcu_barrier_sched
,
333 .sync
= synchronize_sched
,
334 .exp_sync
= synchronize_sched_expedited
,
339 * Definitions for RCU-tasks perf testing.
342 static int tasks_perf_read_lock(void)
347 static void tasks_perf_read_unlock(int idx
)
351 static struct rcu_perf_ops tasks_ops
= {
352 .ptype
= RCU_TASKS_FLAVOR
,
353 .init
= rcu_sync_perf_init
,
354 .readlock
= tasks_perf_read_lock
,
355 .readunlock
= tasks_perf_read_unlock
,
356 .get_gp_seq
= rcu_no_completed
,
357 .gp_diff
= rcu_seq_diff
,
358 .async
= call_rcu_tasks
,
359 .gp_barrier
= rcu_barrier_tasks
,
360 .sync
= synchronize_rcu_tasks
,
361 .exp_sync
= synchronize_rcu_tasks
,
365 static unsigned long rcuperf_seq_diff(unsigned long new, unsigned long old
)
367 if (!cur_ops
->gp_diff
)
369 return cur_ops
->gp_diff(new, old
);
373 * If performance tests complete, wait for shutdown to commence.
375 static void rcu_perf_wait_shutdown(void)
377 cond_resched_tasks_rcu_qs();
378 if (atomic_read(&n_rcu_perf_writer_finished
) < nrealwriters
)
380 while (!torture_must_stop())
381 schedule_timeout_uninterruptible(1);
385 * RCU perf reader kthread. Repeatedly does empty RCU read-side
386 * critical section, minimizing update-side interference.
389 rcu_perf_reader(void *arg
)
395 VERBOSE_PERFOUT_STRING("rcu_perf_reader task started");
396 set_cpus_allowed_ptr(current
, cpumask_of(me
% nr_cpu_ids
));
397 set_user_nice(current
, MAX_NICE
);
398 atomic_inc(&n_rcu_perf_reader_started
);
401 local_irq_save(flags
);
402 idx
= cur_ops
->readlock();
403 cur_ops
->readunlock(idx
);
404 local_irq_restore(flags
);
405 rcu_perf_wait_shutdown();
406 } while (!torture_must_stop());
407 torture_kthread_stopping("rcu_perf_reader");
412 * Callback function for asynchronous grace periods from rcu_perf_writer().
414 static void rcu_perf_async_cb(struct rcu_head
*rhp
)
416 atomic_dec(this_cpu_ptr(&n_async_inflight
));
421 * RCU perf writer kthread. Repeatedly does a grace period.
424 rcu_perf_writer(void *arg
)
429 struct rcu_head
*rhp
= NULL
;
430 struct sched_param sp
;
431 bool started
= false, done
= false, alldone
= false;
434 u64
*wdpp
= writer_durations
[me
];
436 VERBOSE_PERFOUT_STRING("rcu_perf_writer task started");
438 set_cpus_allowed_ptr(current
, cpumask_of(me
% nr_cpu_ids
));
439 sp
.sched_priority
= 1;
440 sched_setscheduler_nocheck(current
, SCHED_FIFO
, &sp
);
443 schedule_timeout_uninterruptible(holdoff
* HZ
);
445 t
= ktime_get_mono_fast_ns();
446 if (atomic_inc_return(&n_rcu_perf_writer_started
) >= nrealwriters
) {
447 t_rcu_perf_writer_started
= t
;
449 b_rcu_perf_writer_started
=
450 cur_ops
->exp_completed() / 2;
452 b_rcu_perf_writer_started
= cur_ops
->get_gp_seq();
458 udelay(writer_holdoff
);
460 *wdp
= ktime_get_mono_fast_ns();
464 rhp
= kmalloc(sizeof(*rhp
), GFP_KERNEL
);
465 if (rhp
&& atomic_read(this_cpu_ptr(&n_async_inflight
)) < gp_async_max
) {
466 rcu_perf_writer_state
= RTWS_ASYNC
;
467 atomic_inc(this_cpu_ptr(&n_async_inflight
));
468 cur_ops
->async(rhp
, rcu_perf_async_cb
);
470 } else if (!kthread_should_stop()) {
471 rcu_perf_writer_state
= RTWS_BARRIER
;
472 cur_ops
->gp_barrier();
475 kfree(rhp
); /* Because we are stopping. */
478 rcu_perf_writer_state
= RTWS_EXP_SYNC
;
481 rcu_perf_writer_state
= RTWS_SYNC
;
484 rcu_perf_writer_state
= RTWS_IDLE
;
485 t
= ktime_get_mono_fast_ns();
489 atomic_read(&n_rcu_perf_writer_started
) >= nrealwriters
)
491 if (!done
&& i
>= MIN_MEAS
) {
493 sp
.sched_priority
= 0;
494 sched_setscheduler_nocheck(current
,
496 pr_alert("%s%s rcu_perf_writer %ld has %d measurements\n",
497 perf_type
, PERF_FLAG
, me
, MIN_MEAS
);
498 if (atomic_inc_return(&n_rcu_perf_writer_finished
) >=
500 schedule_timeout_interruptible(10);
501 rcu_ftrace_dump(DUMP_ALL
);
502 PERFOUT_STRING("Test complete");
503 t_rcu_perf_writer_finished
= t
;
505 b_rcu_perf_writer_finished
=
506 cur_ops
->exp_completed() / 2;
508 b_rcu_perf_writer_finished
=
509 cur_ops
->get_gp_seq();
512 smp_mb(); /* Assign before wake. */
513 wake_up(&shutdown_wq
);
517 if (done
&& !alldone
&&
518 atomic_read(&n_rcu_perf_writer_finished
) >= nrealwriters
)
520 if (started
&& !alldone
&& i
< MAX_MEAS
- 1)
522 rcu_perf_wait_shutdown();
523 } while (!torture_must_stop());
525 rcu_perf_writer_state
= RTWS_BARRIER
;
526 cur_ops
->gp_barrier();
528 rcu_perf_writer_state
= RTWS_STOPPING
;
529 writer_n_durations
[me
] = i_max
;
530 torture_kthread_stopping("rcu_perf_writer");
535 rcu_perf_print_module_parms(struct rcu_perf_ops
*cur_ops
, const char *tag
)
537 pr_alert("%s" PERF_FLAG
538 "--- %s: nreaders=%d nwriters=%d verbose=%d shutdown=%d\n",
539 perf_type
, tag
, nrealreaders
, nrealwriters
, verbose
, shutdown
);
543 rcu_perf_cleanup(void)
552 * Would like warning at start, but everything is expedited
553 * during the mid-boot phase, so have to wait till the end.
555 if (rcu_gp_is_expedited() && !rcu_gp_is_normal() && !gp_exp
)
556 VERBOSE_PERFOUT_ERRSTRING("All grace periods expedited, no normal ones to measure!");
557 if (rcu_gp_is_normal() && gp_exp
)
558 VERBOSE_PERFOUT_ERRSTRING("All grace periods normal, no expedited ones to measure!");
559 if (gp_exp
&& gp_async
)
560 VERBOSE_PERFOUT_ERRSTRING("No expedited async GPs, so went with async!");
562 if (torture_cleanup_begin())
566 for (i
= 0; i
< nrealreaders
; i
++)
567 torture_stop_kthread(rcu_perf_reader
,
573 for (i
= 0; i
< nrealwriters
; i
++) {
574 torture_stop_kthread(rcu_perf_writer
,
576 if (!writer_n_durations
)
578 j
= writer_n_durations
[i
];
579 pr_alert("%s%s writer %d gps: %d\n",
580 perf_type
, PERF_FLAG
, i
, j
);
583 pr_alert("%s%s start: %llu end: %llu duration: %llu gps: %d batches: %ld\n",
584 perf_type
, PERF_FLAG
,
585 t_rcu_perf_writer_started
, t_rcu_perf_writer_finished
,
586 t_rcu_perf_writer_finished
-
587 t_rcu_perf_writer_started
,
589 rcuperf_seq_diff(b_rcu_perf_writer_finished
,
590 b_rcu_perf_writer_started
));
591 for (i
= 0; i
< nrealwriters
; i
++) {
592 if (!writer_durations
)
594 if (!writer_n_durations
)
596 wdpp
= writer_durations
[i
];
599 for (j
= 0; j
<= writer_n_durations
[i
]; j
++) {
601 pr_alert("%s%s %4d writer-duration: %5d %llu\n",
602 perf_type
, PERF_FLAG
,
605 schedule_timeout_uninterruptible(1);
607 kfree(writer_durations
[i
]);
610 kfree(writer_durations
);
611 kfree(writer_n_durations
);
614 /* Do flavor-specific cleanup operations. */
615 if (cur_ops
->cleanup
!= NULL
)
618 torture_cleanup_end();
622 * Return the number if non-negative. If -1, the number of CPUs.
623 * If less than -1, that much less than the number of CPUs, but
626 static int compute_real(int n
)
633 nr
= num_online_cpus() + 1 + n
;
641 * RCU perf shutdown kthread. Just waits to be awakened, then shuts
645 rcu_perf_shutdown(void *arg
)
648 wait_event(shutdown_wq
,
649 atomic_read(&n_rcu_perf_writer_finished
) >=
651 } while (atomic_read(&n_rcu_perf_writer_finished
) < nrealwriters
);
652 smp_mb(); /* Wake before output. */
663 static struct rcu_perf_ops
*perf_ops
[] = {
664 &rcu_ops
, &rcu_bh_ops
, &srcu_ops
, &srcud_ops
, &sched_ops
,
668 if (!torture_init_begin(perf_type
, verbose
))
671 /* Process args and tell the world that the perf'er is on the job. */
672 for (i
= 0; i
< ARRAY_SIZE(perf_ops
); i
++) {
673 cur_ops
= perf_ops
[i
];
674 if (strcmp(perf_type
, cur_ops
->name
) == 0)
677 if (i
== ARRAY_SIZE(perf_ops
)) {
678 pr_alert("rcu-perf: invalid perf type: \"%s\"\n", perf_type
);
679 pr_alert("rcu-perf types:");
680 for (i
= 0; i
< ARRAY_SIZE(perf_ops
); i
++)
681 pr_cont(" %s", perf_ops
[i
]->name
);
689 nrealwriters
= compute_real(nwriters
);
690 nrealreaders
= compute_real(nreaders
);
691 atomic_set(&n_rcu_perf_reader_started
, 0);
692 atomic_set(&n_rcu_perf_writer_started
, 0);
693 atomic_set(&n_rcu_perf_writer_finished
, 0);
694 rcu_perf_print_module_parms(cur_ops
, "Start of test");
696 /* Start up the kthreads. */
699 init_waitqueue_head(&shutdown_wq
);
700 firsterr
= torture_create_kthread(rcu_perf_shutdown
, NULL
,
704 schedule_timeout_uninterruptible(1);
706 reader_tasks
= kcalloc(nrealreaders
, sizeof(reader_tasks
[0]),
708 if (reader_tasks
== NULL
) {
709 VERBOSE_PERFOUT_ERRSTRING("out of memory");
713 for (i
= 0; i
< nrealreaders
; i
++) {
714 firsterr
= torture_create_kthread(rcu_perf_reader
, (void *)i
,
719 while (atomic_read(&n_rcu_perf_reader_started
) < nrealreaders
)
720 schedule_timeout_uninterruptible(1);
721 writer_tasks
= kcalloc(nrealwriters
, sizeof(reader_tasks
[0]),
723 writer_durations
= kcalloc(nrealwriters
, sizeof(*writer_durations
),
726 kcalloc(nrealwriters
, sizeof(*writer_n_durations
),
728 if (!writer_tasks
|| !writer_durations
|| !writer_n_durations
) {
729 VERBOSE_PERFOUT_ERRSTRING("out of memory");
733 for (i
= 0; i
< nrealwriters
; i
++) {
734 writer_durations
[i
] =
735 kcalloc(MAX_MEAS
, sizeof(*writer_durations
[i
]),
737 if (!writer_durations
[i
]) {
741 firsterr
= torture_create_kthread(rcu_perf_writer
, (void *)i
,
755 module_init(rcu_perf_init
);
756 module_exit(rcu_perf_cleanup
);