2 * Read-Copy Update tracing for classic implementation
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, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 * Copyright IBM Corporation, 2008
20 * Papers: http://www.rdrop.com/users/paulmck/RCU
22 * For detailed explanation of Read-Copy Update mechanism see -
26 #include <linux/types.h>
27 #include <linux/kernel.h>
28 #include <linux/init.h>
29 #include <linux/spinlock.h>
30 #include <linux/smp.h>
31 #include <linux/rcupdate.h>
32 #include <linux/interrupt.h>
33 #include <linux/sched.h>
34 #include <linux/atomic.h>
35 #include <linux/bitops.h>
36 #include <linux/module.h>
37 #include <linux/completion.h>
38 #include <linux/moduleparam.h>
39 #include <linux/percpu.h>
40 #include <linux/notifier.h>
41 #include <linux/cpu.h>
42 #include <linux/mutex.h>
43 #include <linux/debugfs.h>
44 #include <linux/seq_file.h>
46 #define RCU_TREE_NONCORE
49 #ifdef CONFIG_RCU_BOOST
51 static char convert_kthread_status(unsigned int kthread_status)
53 if (kthread_status > RCU_KTHREAD_MAX)
55 return "SRWOY"[kthread_status];
58 #endif /* #ifdef CONFIG_RCU_BOOST */
60 static void print_one_rcu_data(struct seq_file *m, struct rcu_data *rdp)
64 seq_printf(m, "%3d%cc=%lu g=%lu pq=%d pgp=%lu qp=%d",
66 cpu_is_offline(rdp->cpu) ? '!' : ' ',
67 rdp->completed, rdp->gpnum,
68 rdp->passed_quiesce, rdp->passed_quiesce_gpnum,
71 seq_printf(m, " dt=%d/%d/%d df=%lu",
72 atomic_read(&rdp->dynticks->dynticks),
73 rdp->dynticks->dynticks_nesting,
74 rdp->dynticks->dynticks_nmi_nesting,
76 #endif /* #ifdef CONFIG_NO_HZ */
77 seq_printf(m, " of=%lu ri=%lu", rdp->offline_fqs, rdp->resched_ipi);
78 seq_printf(m, " ql=%ld qs=%c%c%c%c",
80 ".N"[rdp->nxttail[RCU_NEXT_READY_TAIL] !=
81 rdp->nxttail[RCU_NEXT_TAIL]],
82 ".R"[rdp->nxttail[RCU_WAIT_TAIL] !=
83 rdp->nxttail[RCU_NEXT_READY_TAIL]],
84 ".W"[rdp->nxttail[RCU_DONE_TAIL] !=
85 rdp->nxttail[RCU_WAIT_TAIL]],
86 ".D"[&rdp->nxtlist != rdp->nxttail[RCU_DONE_TAIL]]);
87 #ifdef CONFIG_RCU_BOOST
88 seq_printf(m, " kt=%d/%c/%d ktl=%x",
89 per_cpu(rcu_cpu_has_work, rdp->cpu),
90 convert_kthread_status(per_cpu(rcu_cpu_kthread_status,
92 per_cpu(rcu_cpu_kthread_cpu, rdp->cpu),
93 per_cpu(rcu_cpu_kthread_loops, rdp->cpu) & 0xffff);
94 #endif /* #ifdef CONFIG_RCU_BOOST */
95 seq_printf(m, " b=%ld", rdp->blimit);
96 seq_printf(m, " ci=%lu co=%lu ca=%lu\n",
97 rdp->n_cbs_invoked, rdp->n_cbs_orphaned, rdp->n_cbs_adopted);
100 #define PRINT_RCU_DATA(name, func, m) \
104 for_each_possible_cpu(_p_r_d_i) \
105 func(m, &per_cpu(name, _p_r_d_i)); \
108 static int show_rcudata(struct seq_file *m, void *unused)
110 #ifdef CONFIG_TREE_PREEMPT_RCU
111 seq_puts(m, "rcu_preempt:\n");
112 PRINT_RCU_DATA(rcu_preempt_data, print_one_rcu_data, m);
113 #endif /* #ifdef CONFIG_TREE_PREEMPT_RCU */
114 seq_puts(m, "rcu_sched:\n");
115 PRINT_RCU_DATA(rcu_sched_data, print_one_rcu_data, m);
116 seq_puts(m, "rcu_bh:\n");
117 PRINT_RCU_DATA(rcu_bh_data, print_one_rcu_data, m);
121 static int rcudata_open(struct inode *inode, struct file *file)
123 return single_open(file, show_rcudata, NULL);
126 static const struct file_operations rcudata_fops = {
127 .owner = THIS_MODULE,
128 .open = rcudata_open,
131 .release = single_release,
134 static void print_one_rcu_data_csv(struct seq_file *m, struct rcu_data *rdp)
136 if (!rdp->beenonline)
138 seq_printf(m, "%d,%s,%lu,%lu,%d,%lu,%d",
140 cpu_is_offline(rdp->cpu) ? "\"N\"" : "\"Y\"",
141 rdp->completed, rdp->gpnum,
142 rdp->passed_quiesce, rdp->passed_quiesce_gpnum,
145 seq_printf(m, ",%d,%d,%d,%lu",
146 atomic_read(&rdp->dynticks->dynticks),
147 rdp->dynticks->dynticks_nesting,
148 rdp->dynticks->dynticks_nmi_nesting,
150 #endif /* #ifdef CONFIG_NO_HZ */
151 seq_printf(m, ",%lu,%lu", rdp->offline_fqs, rdp->resched_ipi);
152 seq_printf(m, ",%ld,\"%c%c%c%c\"", rdp->qlen,
153 ".N"[rdp->nxttail[RCU_NEXT_READY_TAIL] !=
154 rdp->nxttail[RCU_NEXT_TAIL]],
155 ".R"[rdp->nxttail[RCU_WAIT_TAIL] !=
156 rdp->nxttail[RCU_NEXT_READY_TAIL]],
157 ".W"[rdp->nxttail[RCU_DONE_TAIL] !=
158 rdp->nxttail[RCU_WAIT_TAIL]],
159 ".D"[&rdp->nxtlist != rdp->nxttail[RCU_DONE_TAIL]]);
160 #ifdef CONFIG_RCU_BOOST
161 seq_printf(m, ",%d,\"%c\"",
162 per_cpu(rcu_cpu_has_work, rdp->cpu),
163 convert_kthread_status(per_cpu(rcu_cpu_kthread_status,
165 #endif /* #ifdef CONFIG_RCU_BOOST */
166 seq_printf(m, ",%ld", rdp->blimit);
167 seq_printf(m, ",%lu,%lu,%lu\n",
168 rdp->n_cbs_invoked, rdp->n_cbs_orphaned, rdp->n_cbs_adopted);
171 static int show_rcudata_csv(struct seq_file *m, void *unused)
173 seq_puts(m, "\"CPU\",\"Online?\",\"c\",\"g\",\"pq\",\"pgp\",\"pq\",");
175 seq_puts(m, "\"dt\",\"dt nesting\",\"dt NMI nesting\",\"df\",");
176 #endif /* #ifdef CONFIG_NO_HZ */
177 seq_puts(m, "\"of\",\"ri\",\"ql\",\"qs\"");
178 #ifdef CONFIG_RCU_BOOST
179 seq_puts(m, "\"kt\",\"ktl\"");
180 #endif /* #ifdef CONFIG_RCU_BOOST */
181 seq_puts(m, ",\"b\",\"ci\",\"co\",\"ca\"\n");
182 #ifdef CONFIG_TREE_PREEMPT_RCU
183 seq_puts(m, "\"rcu_preempt:\"\n");
184 PRINT_RCU_DATA(rcu_preempt_data, print_one_rcu_data_csv, m);
185 #endif /* #ifdef CONFIG_TREE_PREEMPT_RCU */
186 seq_puts(m, "\"rcu_sched:\"\n");
187 PRINT_RCU_DATA(rcu_sched_data, print_one_rcu_data_csv, m);
188 seq_puts(m, "\"rcu_bh:\"\n");
189 PRINT_RCU_DATA(rcu_bh_data, print_one_rcu_data_csv, m);
193 static int rcudata_csv_open(struct inode *inode, struct file *file)
195 return single_open(file, show_rcudata_csv, NULL);
198 static const struct file_operations rcudata_csv_fops = {
199 .owner = THIS_MODULE,
200 .open = rcudata_csv_open,
203 .release = single_release,
206 #ifdef CONFIG_RCU_BOOST
208 static void print_one_rcu_node_boost(struct seq_file *m, struct rcu_node *rnp)
210 seq_printf(m, "%d:%d tasks=%c%c%c%c kt=%c ntb=%lu neb=%lu nnb=%lu "
212 rnp->grplo, rnp->grphi,
213 "T."[list_empty(&rnp->blkd_tasks)],
214 "N."[!rnp->gp_tasks],
215 "E."[!rnp->exp_tasks],
216 "B."[!rnp->boost_tasks],
217 convert_kthread_status(rnp->boost_kthread_status),
218 rnp->n_tasks_boosted, rnp->n_exp_boosts,
219 rnp->n_normal_boosts,
220 (int)(jiffies & 0xffff),
221 (int)(rnp->boost_time & 0xffff));
222 seq_printf(m, "%s: nt=%lu egt=%lu bt=%lu nb=%lu ny=%lu nos=%lu\n",
224 rnp->n_balk_blkd_tasks,
225 rnp->n_balk_exp_gp_tasks,
226 rnp->n_balk_boost_tasks,
227 rnp->n_balk_notblocked,
232 static int show_rcu_node_boost(struct seq_file *m, void *unused)
234 struct rcu_node *rnp;
236 rcu_for_each_leaf_node(&rcu_preempt_state, rnp)
237 print_one_rcu_node_boost(m, rnp);
241 static int rcu_node_boost_open(struct inode *inode, struct file *file)
243 return single_open(file, show_rcu_node_boost, NULL);
246 static const struct file_operations rcu_node_boost_fops = {
247 .owner = THIS_MODULE,
248 .open = rcu_node_boost_open,
251 .release = single_release,
255 * Create the rcuboost debugfs entry. Standard error return.
257 static int rcu_boost_trace_create_file(struct dentry *rcudir)
259 return !debugfs_create_file("rcuboost", 0444, rcudir, NULL,
260 &rcu_node_boost_fops);
263 #else /* #ifdef CONFIG_RCU_BOOST */
265 static int rcu_boost_trace_create_file(struct dentry *rcudir)
267 return 0; /* There cannot be an error if we didn't create it! */
270 #endif /* #else #ifdef CONFIG_RCU_BOOST */
272 static void print_one_rcu_state(struct seq_file *m, struct rcu_state *rsp)
276 struct rcu_node *rnp;
279 seq_printf(m, "c=%lu g=%lu s=%d jfq=%ld j=%x "
280 "nfqs=%lu/nfqsng=%lu(%lu) fqlh=%lu\n",
281 rsp->completed, gpnum, rsp->signaled,
282 (long)(rsp->jiffies_force_qs - jiffies),
283 (int)(jiffies & 0xffff),
284 rsp->n_force_qs, rsp->n_force_qs_ngp,
285 rsp->n_force_qs - rsp->n_force_qs_ngp,
287 for (rnp = &rsp->node[0]; rnp - &rsp->node[0] < NUM_RCU_NODES; rnp++) {
288 if (rnp->level != level) {
292 seq_printf(m, "%lx/%lx %c%c>%c %d:%d ^%d ",
293 rnp->qsmask, rnp->qsmaskinit,
294 ".G"[rnp->gp_tasks != NULL],
295 ".E"[rnp->exp_tasks != NULL],
296 ".T"[!list_empty(&rnp->blkd_tasks)],
297 rnp->grplo, rnp->grphi, rnp->grpnum);
302 static int show_rcuhier(struct seq_file *m, void *unused)
304 #ifdef CONFIG_TREE_PREEMPT_RCU
305 seq_puts(m, "rcu_preempt:\n");
306 print_one_rcu_state(m, &rcu_preempt_state);
307 #endif /* #ifdef CONFIG_TREE_PREEMPT_RCU */
308 seq_puts(m, "rcu_sched:\n");
309 print_one_rcu_state(m, &rcu_sched_state);
310 seq_puts(m, "rcu_bh:\n");
311 print_one_rcu_state(m, &rcu_bh_state);
315 static int rcuhier_open(struct inode *inode, struct file *file)
317 return single_open(file, show_rcuhier, NULL);
320 static const struct file_operations rcuhier_fops = {
321 .owner = THIS_MODULE,
322 .open = rcuhier_open,
325 .release = single_release,
328 static void show_one_rcugp(struct seq_file *m, struct rcu_state *rsp)
331 unsigned long completed;
335 struct rcu_node *rnp = &rsp->node[0];
337 raw_spin_lock_irqsave(&rnp->lock, flags);
338 completed = rsp->completed;
340 if (rsp->completed == rsp->gpnum)
343 gpage = jiffies - rsp->gp_start;
345 raw_spin_unlock_irqrestore(&rnp->lock, flags);
346 seq_printf(m, "%s: completed=%ld gpnum=%lu age=%ld max=%ld\n",
347 rsp->name, completed, gpnum, gpage, gpmax);
350 static int show_rcugp(struct seq_file *m, void *unused)
352 #ifdef CONFIG_TREE_PREEMPT_RCU
353 show_one_rcugp(m, &rcu_preempt_state);
354 #endif /* #ifdef CONFIG_TREE_PREEMPT_RCU */
355 show_one_rcugp(m, &rcu_sched_state);
356 show_one_rcugp(m, &rcu_bh_state);
360 static int rcugp_open(struct inode *inode, struct file *file)
362 return single_open(file, show_rcugp, NULL);
365 static const struct file_operations rcugp_fops = {
366 .owner = THIS_MODULE,
370 .release = single_release,
373 static void print_one_rcu_pending(struct seq_file *m, struct rcu_data *rdp)
375 seq_printf(m, "%3d%cnp=%ld "
376 "qsp=%ld rpq=%ld cbr=%ld cng=%ld "
377 "gpc=%ld gps=%ld nf=%ld nn=%ld\n",
379 cpu_is_offline(rdp->cpu) ? '!' : ' ',
381 rdp->n_rp_qs_pending,
384 rdp->n_rp_cpu_needs_gp,
385 rdp->n_rp_gp_completed,
386 rdp->n_rp_gp_started,
388 rdp->n_rp_need_nothing);
391 static void print_rcu_pendings(struct seq_file *m, struct rcu_state *rsp)
394 struct rcu_data *rdp;
396 for_each_possible_cpu(cpu) {
397 rdp = per_cpu_ptr(rsp->rda, cpu);
399 print_one_rcu_pending(m, rdp);
403 static int show_rcu_pending(struct seq_file *m, void *unused)
405 #ifdef CONFIG_TREE_PREEMPT_RCU
406 seq_puts(m, "rcu_preempt:\n");
407 print_rcu_pendings(m, &rcu_preempt_state);
408 #endif /* #ifdef CONFIG_TREE_PREEMPT_RCU */
409 seq_puts(m, "rcu_sched:\n");
410 print_rcu_pendings(m, &rcu_sched_state);
411 seq_puts(m, "rcu_bh:\n");
412 print_rcu_pendings(m, &rcu_bh_state);
416 static int rcu_pending_open(struct inode *inode, struct file *file)
418 return single_open(file, show_rcu_pending, NULL);
421 static const struct file_operations rcu_pending_fops = {
422 .owner = THIS_MODULE,
423 .open = rcu_pending_open,
426 .release = single_release,
429 static int show_rcutorture(struct seq_file *m, void *unused)
431 seq_printf(m, "rcutorture test sequence: %lu %s\n",
432 rcutorture_testseq >> 1,
433 (rcutorture_testseq & 0x1) ? "(test in progress)" : "");
434 seq_printf(m, "rcutorture update version number: %lu\n",
439 static int rcutorture_open(struct inode *inode, struct file *file)
441 return single_open(file, show_rcutorture, NULL);
444 static const struct file_operations rcutorture_fops = {
445 .owner = THIS_MODULE,
446 .open = rcutorture_open,
449 .release = single_release,
452 static struct dentry *rcudir;
454 static int __init rcutree_trace_init(void)
456 struct dentry *retval;
458 rcudir = debugfs_create_dir("rcu", NULL);
462 retval = debugfs_create_file("rcudata", 0444, rcudir,
463 NULL, &rcudata_fops);
467 retval = debugfs_create_file("rcudata.csv", 0444, rcudir,
468 NULL, &rcudata_csv_fops);
472 if (rcu_boost_trace_create_file(rcudir))
475 retval = debugfs_create_file("rcugp", 0444, rcudir, NULL, &rcugp_fops);
479 retval = debugfs_create_file("rcuhier", 0444, rcudir,
480 NULL, &rcuhier_fops);
484 retval = debugfs_create_file("rcu_pending", 0444, rcudir,
485 NULL, &rcu_pending_fops);
489 retval = debugfs_create_file("rcutorture", 0444, rcudir,
490 NULL, &rcutorture_fops);
495 debugfs_remove_recursive(rcudir);
499 static void __exit rcutree_trace_cleanup(void)
501 debugfs_remove_recursive(rcudir);
505 module_init(rcutree_trace_init);
506 module_exit(rcutree_trace_cleanup);
508 MODULE_AUTHOR("Paul E. McKenney");
509 MODULE_DESCRIPTION("Read-Copy Update tracing for hierarchical implementation");
510 MODULE_LICENSE("GPL");