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>
22 #include <linux/types.h>
23 #include <linux/kernel.h>
24 #include <linux/init.h>
25 #include <linux/module.h>
26 #include <linux/kthread.h>
27 #include <linux/err.h>
28 #include <linux/spinlock.h>
29 #include <linux/smp.h>
30 #include <linux/rcupdate.h>
31 #include <linux/interrupt.h>
32 #include <linux/sched.h>
33 #include <uapi/linux/sched/types.h>
34 #include <linux/atomic.h>
35 #include <linux/bitops.h>
36 #include <linux/completion.h>
37 #include <linux/moduleparam.h>
38 #include <linux/percpu.h>
39 #include <linux/notifier.h>
40 #include <linux/reboot.h>
41 #include <linux/freezer.h>
42 #include <linux/cpu.h>
43 #include <linux/delay.h>
44 #include <linux/stat.h>
45 #include <linux/srcu.h>
46 #include <linux/slab.h>
47 #include <asm/byteorder.h>
48 #include <linux/torture.h>
49 #include <linux/vmalloc.h>
53 MODULE_LICENSE("GPL");
54 MODULE_AUTHOR("Paul E. McKenney <paulmck@linux.vnet.ibm.com>");
56 #define PERF_FLAG "-perf:"
57 #define PERFOUT_STRING(s) \
58 pr_alert("%s" PERF_FLAG " %s\n", perf_type, s)
59 #define VERBOSE_PERFOUT_STRING(s) \
60 do { if (verbose) pr_alert("%s" PERF_FLAG " %s\n", perf_type, s); } while (0)
61 #define VERBOSE_PERFOUT_ERRSTRING(s) \
62 do { if (verbose) pr_alert("%s" PERF_FLAG "!!! %s\n", perf_type, s); } while (0)
65 * The intended use cases for the nreaders and nwriters module parameters
68 * 1. Specify only the nr_cpus kernel boot parameter. This will
69 * set both nreaders and nwriters to the value specified by
70 * nr_cpus for a mixed reader/writer test.
72 * 2. Specify the nr_cpus kernel boot parameter, but set
73 * rcuperf.nreaders to zero. This will set nwriters to the
74 * value specified by nr_cpus for an update-only test.
76 * 3. Specify the nr_cpus kernel boot parameter, but set
77 * rcuperf.nwriters to zero. This will set nreaders to the
78 * value specified by nr_cpus for a read-only test.
80 * Various other use cases may of course be specified.
83 torture_param(bool, gp_async
, false, "Use asynchronous GP wait primitives");
84 torture_param(int, gp_async_max
, 1000, "Max # outstanding waits per reader");
85 torture_param(bool, gp_exp
, false, "Use expedited GP wait primitives");
86 torture_param(int, holdoff
, 10, "Holdoff time before test start (s)");
87 torture_param(int, nreaders
, -1, "Number of RCU reader threads");
88 torture_param(int, nwriters
, -1, "Number of RCU updater threads");
89 torture_param(bool, shutdown
, !IS_ENABLED(MODULE
),
90 "Shutdown at end of performance tests.");
91 torture_param(bool, verbose
, true, "Enable verbose debugging printk()s");
92 torture_param(int, writer_holdoff
, 0, "Holdoff (us) between GPs, zero to disable");
94 static char *perf_type
= "rcu";
95 module_param(perf_type
, charp
, 0444);
96 MODULE_PARM_DESC(perf_type
, "Type of RCU to performance-test (rcu, rcu_bh, ...)");
98 static int nrealreaders
;
99 static int nrealwriters
;
100 static struct task_struct
**writer_tasks
;
101 static struct task_struct
**reader_tasks
;
102 static struct task_struct
*shutdown_task
;
104 static u64
**writer_durations
;
105 static int *writer_n_durations
;
106 static atomic_t n_rcu_perf_reader_started
;
107 static atomic_t n_rcu_perf_writer_started
;
108 static atomic_t n_rcu_perf_writer_finished
;
109 static wait_queue_head_t shutdown_wq
;
110 static u64 t_rcu_perf_writer_started
;
111 static u64 t_rcu_perf_writer_finished
;
112 static unsigned long b_rcu_perf_writer_started
;
113 static unsigned long b_rcu_perf_writer_finished
;
114 static DEFINE_PER_CPU(atomic_t
, n_async_inflight
);
116 static int rcu_perf_writer_state
;
119 #define RTWS_BARRIER 2
120 #define RTWS_EXP_SYNC 3
123 #define RTWS_STOPPING 6
125 #define MAX_MEAS 10000
129 * Operations vector for selecting different types of tests.
132 struct rcu_perf_ops
{
135 void (*cleanup
)(void);
136 int (*readlock
)(void);
137 void (*readunlock
)(int idx
);
138 unsigned long (*started
)(void);
139 unsigned long (*completed
)(void);
140 unsigned long (*exp_completed
)(void);
141 void (*async
)(struct rcu_head
*head
, rcu_callback_t func
);
142 void (*gp_barrier
)(void);
144 void (*exp_sync
)(void);
148 static struct rcu_perf_ops
*cur_ops
;
151 * Definitions for rcu perf testing.
154 static int rcu_perf_read_lock(void) __acquires(RCU
)
160 static void rcu_perf_read_unlock(int idx
) __releases(RCU
)
165 static unsigned long __maybe_unused
rcu_no_completed(void)
170 static void rcu_sync_perf_init(void)
174 static struct rcu_perf_ops rcu_ops
= {
176 .init
= rcu_sync_perf_init
,
177 .readlock
= rcu_perf_read_lock
,
178 .readunlock
= rcu_perf_read_unlock
,
179 .started
= rcu_batches_started
,
180 .completed
= rcu_batches_completed
,
181 .exp_completed
= rcu_exp_batches_completed
,
183 .gp_barrier
= rcu_barrier
,
184 .sync
= synchronize_rcu
,
185 .exp_sync
= synchronize_rcu_expedited
,
190 * Definitions for rcu_bh perf testing.
193 static int rcu_bh_perf_read_lock(void) __acquires(RCU_BH
)
199 static void rcu_bh_perf_read_unlock(int idx
) __releases(RCU_BH
)
201 rcu_read_unlock_bh();
204 static struct rcu_perf_ops rcu_bh_ops
= {
205 .ptype
= RCU_BH_FLAVOR
,
206 .init
= rcu_sync_perf_init
,
207 .readlock
= rcu_bh_perf_read_lock
,
208 .readunlock
= rcu_bh_perf_read_unlock
,
209 .started
= rcu_batches_started_bh
,
210 .completed
= rcu_batches_completed_bh
,
211 .exp_completed
= rcu_exp_batches_completed_sched
,
212 .async
= call_rcu_bh
,
213 .gp_barrier
= rcu_barrier_bh
,
214 .sync
= synchronize_rcu_bh
,
215 .exp_sync
= synchronize_rcu_bh_expedited
,
220 * Definitions for srcu perf testing.
223 DEFINE_STATIC_SRCU(srcu_ctl_perf
);
224 static struct srcu_struct
*srcu_ctlp
= &srcu_ctl_perf
;
226 static int srcu_perf_read_lock(void) __acquires(srcu_ctlp
)
228 return srcu_read_lock(srcu_ctlp
);
231 static void srcu_perf_read_unlock(int idx
) __releases(srcu_ctlp
)
233 srcu_read_unlock(srcu_ctlp
, idx
);
236 static unsigned long srcu_perf_completed(void)
238 return srcu_batches_completed(srcu_ctlp
);
241 static void srcu_call_rcu(struct rcu_head
*head
, rcu_callback_t func
)
243 call_srcu(srcu_ctlp
, head
, func
);
246 static void srcu_rcu_barrier(void)
248 srcu_barrier(srcu_ctlp
);
251 static void srcu_perf_synchronize(void)
253 synchronize_srcu(srcu_ctlp
);
256 static void srcu_perf_synchronize_expedited(void)
258 synchronize_srcu_expedited(srcu_ctlp
);
261 static struct rcu_perf_ops srcu_ops
= {
262 .ptype
= SRCU_FLAVOR
,
263 .init
= rcu_sync_perf_init
,
264 .readlock
= srcu_perf_read_lock
,
265 .readunlock
= srcu_perf_read_unlock
,
267 .completed
= srcu_perf_completed
,
268 .exp_completed
= srcu_perf_completed
,
269 .async
= srcu_call_rcu
,
270 .gp_barrier
= srcu_rcu_barrier
,
271 .sync
= srcu_perf_synchronize
,
272 .exp_sync
= srcu_perf_synchronize_expedited
,
276 static struct srcu_struct srcud
;
278 static void srcu_sync_perf_init(void)
281 init_srcu_struct(srcu_ctlp
);
284 static void srcu_sync_perf_cleanup(void)
286 cleanup_srcu_struct(srcu_ctlp
);
289 static struct rcu_perf_ops srcud_ops
= {
290 .ptype
= SRCU_FLAVOR
,
291 .init
= srcu_sync_perf_init
,
292 .cleanup
= srcu_sync_perf_cleanup
,
293 .readlock
= srcu_perf_read_lock
,
294 .readunlock
= srcu_perf_read_unlock
,
296 .completed
= srcu_perf_completed
,
297 .exp_completed
= srcu_perf_completed
,
298 .async
= srcu_call_rcu
,
299 .gp_barrier
= srcu_rcu_barrier
,
300 .sync
= srcu_perf_synchronize
,
301 .exp_sync
= srcu_perf_synchronize_expedited
,
306 * Definitions for sched perf testing.
309 static int sched_perf_read_lock(void)
315 static void sched_perf_read_unlock(int idx
)
320 static struct rcu_perf_ops sched_ops
= {
321 .ptype
= RCU_SCHED_FLAVOR
,
322 .init
= rcu_sync_perf_init
,
323 .readlock
= sched_perf_read_lock
,
324 .readunlock
= sched_perf_read_unlock
,
325 .started
= rcu_batches_started_sched
,
326 .completed
= rcu_batches_completed_sched
,
327 .exp_completed
= rcu_exp_batches_completed_sched
,
328 .async
= call_rcu_sched
,
329 .gp_barrier
= rcu_barrier_sched
,
330 .sync
= synchronize_sched
,
331 .exp_sync
= synchronize_sched_expedited
,
336 * Definitions for RCU-tasks perf testing.
339 static int tasks_perf_read_lock(void)
344 static void tasks_perf_read_unlock(int idx
)
348 static struct rcu_perf_ops tasks_ops
= {
349 .ptype
= RCU_TASKS_FLAVOR
,
350 .init
= rcu_sync_perf_init
,
351 .readlock
= tasks_perf_read_lock
,
352 .readunlock
= tasks_perf_read_unlock
,
353 .started
= rcu_no_completed
,
354 .completed
= rcu_no_completed
,
355 .async
= call_rcu_tasks
,
356 .gp_barrier
= rcu_barrier_tasks
,
357 .sync
= synchronize_rcu_tasks
,
358 .exp_sync
= synchronize_rcu_tasks
,
362 static bool __maybe_unused
torturing_tasks(void)
364 return cur_ops
== &tasks_ops
;
368 * If performance tests complete, wait for shutdown to commence.
370 static void rcu_perf_wait_shutdown(void)
372 cond_resched_rcu_qs();
373 if (atomic_read(&n_rcu_perf_writer_finished
) < nrealwriters
)
375 while (!torture_must_stop())
376 schedule_timeout_uninterruptible(1);
380 * RCU perf reader kthread. Repeatedly does empty RCU read-side
381 * critical section, minimizing update-side interference.
384 rcu_perf_reader(void *arg
)
390 VERBOSE_PERFOUT_STRING("rcu_perf_reader task started");
391 set_cpus_allowed_ptr(current
, cpumask_of(me
% nr_cpu_ids
));
392 set_user_nice(current
, MAX_NICE
);
393 atomic_inc(&n_rcu_perf_reader_started
);
396 local_irq_save(flags
);
397 idx
= cur_ops
->readlock();
398 cur_ops
->readunlock(idx
);
399 local_irq_restore(flags
);
400 rcu_perf_wait_shutdown();
401 } while (!torture_must_stop());
402 torture_kthread_stopping("rcu_perf_reader");
407 * Callback function for asynchronous grace periods from rcu_perf_writer().
409 static void rcu_perf_async_cb(struct rcu_head
*rhp
)
411 atomic_dec(this_cpu_ptr(&n_async_inflight
));
416 * RCU perf writer kthread. Repeatedly does a grace period.
419 rcu_perf_writer(void *arg
)
424 struct rcu_head
*rhp
= NULL
;
425 struct sched_param sp
;
426 bool started
= false, done
= false, alldone
= false;
429 u64
*wdpp
= writer_durations
[me
];
431 VERBOSE_PERFOUT_STRING("rcu_perf_writer task started");
433 set_cpus_allowed_ptr(current
, cpumask_of(me
% nr_cpu_ids
));
434 sp
.sched_priority
= 1;
435 sched_setscheduler_nocheck(current
, SCHED_FIFO
, &sp
);
438 schedule_timeout_uninterruptible(holdoff
* HZ
);
440 t
= ktime_get_mono_fast_ns();
441 if (atomic_inc_return(&n_rcu_perf_writer_started
) >= nrealwriters
) {
442 t_rcu_perf_writer_started
= t
;
444 b_rcu_perf_writer_started
=
445 cur_ops
->exp_completed() / 2;
447 b_rcu_perf_writer_started
=
448 cur_ops
->completed();
454 udelay(writer_holdoff
);
456 *wdp
= ktime_get_mono_fast_ns();
460 rhp
= kmalloc(sizeof(*rhp
), GFP_KERNEL
);
461 if (rhp
&& atomic_read(this_cpu_ptr(&n_async_inflight
)) < gp_async_max
) {
462 rcu_perf_writer_state
= RTWS_ASYNC
;
463 atomic_inc(this_cpu_ptr(&n_async_inflight
));
464 cur_ops
->async(rhp
, rcu_perf_async_cb
);
466 } else if (!kthread_should_stop()) {
467 rcu_perf_writer_state
= RTWS_BARRIER
;
468 cur_ops
->gp_barrier();
471 kfree(rhp
); /* Because we are stopping. */
474 rcu_perf_writer_state
= RTWS_EXP_SYNC
;
477 rcu_perf_writer_state
= RTWS_SYNC
;
480 rcu_perf_writer_state
= RTWS_IDLE
;
481 t
= ktime_get_mono_fast_ns();
485 atomic_read(&n_rcu_perf_writer_started
) >= nrealwriters
)
487 if (!done
&& i
>= MIN_MEAS
) {
489 sp
.sched_priority
= 0;
490 sched_setscheduler_nocheck(current
,
492 pr_alert("%s%s rcu_perf_writer %ld has %d measurements\n",
493 perf_type
, PERF_FLAG
, me
, MIN_MEAS
);
494 if (atomic_inc_return(&n_rcu_perf_writer_finished
) >=
496 schedule_timeout_interruptible(10);
497 rcu_ftrace_dump(DUMP_ALL
);
498 PERFOUT_STRING("Test complete");
499 t_rcu_perf_writer_finished
= t
;
501 b_rcu_perf_writer_finished
=
502 cur_ops
->exp_completed() / 2;
504 b_rcu_perf_writer_finished
=
505 cur_ops
->completed();
508 smp_mb(); /* Assign before wake. */
509 wake_up(&shutdown_wq
);
513 if (done
&& !alldone
&&
514 atomic_read(&n_rcu_perf_writer_finished
) >= nrealwriters
)
516 if (started
&& !alldone
&& i
< MAX_MEAS
- 1)
518 rcu_perf_wait_shutdown();
519 } while (!torture_must_stop());
521 rcu_perf_writer_state
= RTWS_BARRIER
;
522 cur_ops
->gp_barrier();
524 rcu_perf_writer_state
= RTWS_STOPPING
;
525 writer_n_durations
[me
] = i_max
;
526 torture_kthread_stopping("rcu_perf_writer");
531 rcu_perf_print_module_parms(struct rcu_perf_ops
*cur_ops
, const char *tag
)
533 pr_alert("%s" PERF_FLAG
534 "--- %s: nreaders=%d nwriters=%d verbose=%d shutdown=%d\n",
535 perf_type
, tag
, nrealreaders
, nrealwriters
, verbose
, shutdown
);
539 rcu_perf_cleanup(void)
548 * Would like warning at start, but everything is expedited
549 * during the mid-boot phase, so have to wait till the end.
551 if (rcu_gp_is_expedited() && !rcu_gp_is_normal() && !gp_exp
)
552 VERBOSE_PERFOUT_ERRSTRING("All grace periods expedited, no normal ones to measure!");
553 if (rcu_gp_is_normal() && gp_exp
)
554 VERBOSE_PERFOUT_ERRSTRING("All grace periods normal, no expedited ones to measure!");
555 if (gp_exp
&& gp_async
)
556 VERBOSE_PERFOUT_ERRSTRING("No expedited async GPs, so went with async!");
558 if (torture_cleanup_begin())
562 for (i
= 0; i
< nrealreaders
; i
++)
563 torture_stop_kthread(rcu_perf_reader
,
569 for (i
= 0; i
< nrealwriters
; i
++) {
570 torture_stop_kthread(rcu_perf_writer
,
572 if (!writer_n_durations
)
574 j
= writer_n_durations
[i
];
575 pr_alert("%s%s writer %d gps: %d\n",
576 perf_type
, PERF_FLAG
, i
, j
);
579 pr_alert("%s%s start: %llu end: %llu duration: %llu gps: %d batches: %ld\n",
580 perf_type
, PERF_FLAG
,
581 t_rcu_perf_writer_started
, t_rcu_perf_writer_finished
,
582 t_rcu_perf_writer_finished
-
583 t_rcu_perf_writer_started
,
585 b_rcu_perf_writer_finished
-
586 b_rcu_perf_writer_started
);
587 for (i
= 0; i
< nrealwriters
; i
++) {
588 if (!writer_durations
)
590 if (!writer_n_durations
)
592 wdpp
= writer_durations
[i
];
595 for (j
= 0; j
<= writer_n_durations
[i
]; j
++) {
597 pr_alert("%s%s %4d writer-duration: %5d %llu\n",
598 perf_type
, PERF_FLAG
,
601 schedule_timeout_uninterruptible(1);
603 kfree(writer_durations
[i
]);
606 kfree(writer_durations
);
607 kfree(writer_n_durations
);
610 /* Do flavor-specific cleanup operations. */
611 if (cur_ops
->cleanup
!= NULL
)
614 torture_cleanup_end();
618 * Return the number if non-negative. If -1, the number of CPUs.
619 * If less than -1, that much less than the number of CPUs, but
622 static int compute_real(int n
)
629 nr
= num_online_cpus() + 1 + n
;
637 * RCU perf shutdown kthread. Just waits to be awakened, then shuts
641 rcu_perf_shutdown(void *arg
)
644 wait_event(shutdown_wq
,
645 atomic_read(&n_rcu_perf_writer_finished
) >=
647 } while (atomic_read(&n_rcu_perf_writer_finished
) < nrealwriters
);
648 smp_mb(); /* Wake before output. */
659 static struct rcu_perf_ops
*perf_ops
[] = {
660 &rcu_ops
, &rcu_bh_ops
, &srcu_ops
, &srcud_ops
, &sched_ops
,
664 if (!torture_init_begin(perf_type
, verbose
))
667 /* Process args and tell the world that the perf'er is on the job. */
668 for (i
= 0; i
< ARRAY_SIZE(perf_ops
); i
++) {
669 cur_ops
= perf_ops
[i
];
670 if (strcmp(perf_type
, cur_ops
->name
) == 0)
673 if (i
== ARRAY_SIZE(perf_ops
)) {
674 pr_alert("rcu-perf: invalid perf type: \"%s\"\n",
676 pr_alert("rcu-perf types:");
677 for (i
= 0; i
< ARRAY_SIZE(perf_ops
); i
++)
678 pr_alert(" %s", perf_ops
[i
]->name
);
686 nrealwriters
= compute_real(nwriters
);
687 nrealreaders
= compute_real(nreaders
);
688 atomic_set(&n_rcu_perf_reader_started
, 0);
689 atomic_set(&n_rcu_perf_writer_started
, 0);
690 atomic_set(&n_rcu_perf_writer_finished
, 0);
691 rcu_perf_print_module_parms(cur_ops
, "Start of test");
693 /* Start up the kthreads. */
696 init_waitqueue_head(&shutdown_wq
);
697 firsterr
= torture_create_kthread(rcu_perf_shutdown
, NULL
,
701 schedule_timeout_uninterruptible(1);
703 reader_tasks
= kcalloc(nrealreaders
, sizeof(reader_tasks
[0]),
705 if (reader_tasks
== NULL
) {
706 VERBOSE_PERFOUT_ERRSTRING("out of memory");
710 for (i
= 0; i
< nrealreaders
; i
++) {
711 firsterr
= torture_create_kthread(rcu_perf_reader
, (void *)i
,
716 while (atomic_read(&n_rcu_perf_reader_started
) < nrealreaders
)
717 schedule_timeout_uninterruptible(1);
718 writer_tasks
= kcalloc(nrealwriters
, sizeof(reader_tasks
[0]),
720 writer_durations
= kcalloc(nrealwriters
, sizeof(*writer_durations
),
723 kcalloc(nrealwriters
, sizeof(*writer_n_durations
),
725 if (!writer_tasks
|| !writer_durations
|| !writer_n_durations
) {
726 VERBOSE_PERFOUT_ERRSTRING("out of memory");
730 for (i
= 0; i
< nrealwriters
; i
++) {
731 writer_durations
[i
] =
732 kcalloc(MAX_MEAS
, sizeof(*writer_durations
[i
]),
734 if (!writer_durations
[i
]) {
738 firsterr
= torture_create_kthread(rcu_perf_writer
, (void *)i
,
752 module_init(rcu_perf_init
);
753 module_exit(rcu_perf_cleanup
);