Add new kernel probes instrumentation
[lttng-modules.git] / instrumentation / events / mainline / rcu.h
1 #undef TRACE_SYSTEM
2 #define TRACE_SYSTEM rcu
3
4 #if !defined(_TRACE_RCU_H) || defined(TRACE_HEADER_MULTI_READ)
5 #define _TRACE_RCU_H
6
7 #include <linux/tracepoint.h>
8
9 /*
10 * Tracepoint for start/end markers used for utilization calculations.
11 * By convention, the string is of the following forms:
12 *
13 * "Start <activity>" -- Mark the start of the specified activity,
14 * such as "context switch". Nesting is permitted.
15 * "End <activity>" -- Mark the end of the specified activity.
16 *
17 * An "@" character within "<activity>" is a comment character: Data
18 * reduction scripts will ignore the "@" and the remainder of the line.
19 */
20 TRACE_EVENT(rcu_utilization,
21
22 TP_PROTO(char *s),
23
24 TP_ARGS(s),
25
26 TP_STRUCT__entry(
27 __field(char *, s)
28 ),
29
30 TP_fast_assign(
31 __entry->s = s;
32 ),
33
34 TP_printk("%s", __entry->s)
35 );
36
37 #ifdef CONFIG_RCU_TRACE
38
39 #if defined(CONFIG_TREE_RCU) || defined(CONFIG_TREE_PREEMPT_RCU)
40
41 /*
42 * Tracepoint for grace-period events: starting and ending a grace
43 * period ("start" and "end", respectively), a CPU noting the start
44 * of a new grace period or the end of an old grace period ("cpustart"
45 * and "cpuend", respectively), a CPU passing through a quiescent
46 * state ("cpuqs"), a CPU coming online or going offline ("cpuonl"
47 * and "cpuofl", respectively), and a CPU being kicked for being too
48 * long in dyntick-idle mode ("kick").
49 */
50 TRACE_EVENT(rcu_grace_period,
51
52 TP_PROTO(char *rcuname, unsigned long gpnum, char *gpevent),
53
54 TP_ARGS(rcuname, gpnum, gpevent),
55
56 TP_STRUCT__entry(
57 __field(char *, rcuname)
58 __field(unsigned long, gpnum)
59 __field(char *, gpevent)
60 ),
61
62 TP_fast_assign(
63 __entry->rcuname = rcuname;
64 __entry->gpnum = gpnum;
65 __entry->gpevent = gpevent;
66 ),
67
68 TP_printk("%s %lu %s",
69 __entry->rcuname, __entry->gpnum, __entry->gpevent)
70 );
71
72 /*
73 * Tracepoint for grace-period-initialization events. These are
74 * distinguished by the type of RCU, the new grace-period number, the
75 * rcu_node structure level, the starting and ending CPU covered by the
76 * rcu_node structure, and the mask of CPUs that will be waited for.
77 * All but the type of RCU are extracted from the rcu_node structure.
78 */
79 TRACE_EVENT(rcu_grace_period_init,
80
81 TP_PROTO(char *rcuname, unsigned long gpnum, u8 level,
82 int grplo, int grphi, unsigned long qsmask),
83
84 TP_ARGS(rcuname, gpnum, level, grplo, grphi, qsmask),
85
86 TP_STRUCT__entry(
87 __field(char *, rcuname)
88 __field(unsigned long, gpnum)
89 __field(u8, level)
90 __field(int, grplo)
91 __field(int, grphi)
92 __field(unsigned long, qsmask)
93 ),
94
95 TP_fast_assign(
96 __entry->rcuname = rcuname;
97 __entry->gpnum = gpnum;
98 __entry->level = level;
99 __entry->grplo = grplo;
100 __entry->grphi = grphi;
101 __entry->qsmask = qsmask;
102 ),
103
104 TP_printk("%s %lu %u %d %d %lx",
105 __entry->rcuname, __entry->gpnum, __entry->level,
106 __entry->grplo, __entry->grphi, __entry->qsmask)
107 );
108
109 /*
110 * Tracepoint for tasks blocking within preemptible-RCU read-side
111 * critical sections. Track the type of RCU (which one day might
112 * include SRCU), the grace-period number that the task is blocking
113 * (the current or the next), and the task's PID.
114 */
115 TRACE_EVENT(rcu_preempt_task,
116
117 TP_PROTO(char *rcuname, int pid, unsigned long gpnum),
118
119 TP_ARGS(rcuname, pid, gpnum),
120
121 TP_STRUCT__entry(
122 __field(char *, rcuname)
123 __field(unsigned long, gpnum)
124 __field(int, pid)
125 ),
126
127 TP_fast_assign(
128 __entry->rcuname = rcuname;
129 __entry->gpnum = gpnum;
130 __entry->pid = pid;
131 ),
132
133 TP_printk("%s %lu %d",
134 __entry->rcuname, __entry->gpnum, __entry->pid)
135 );
136
137 /*
138 * Tracepoint for tasks that blocked within a given preemptible-RCU
139 * read-side critical section exiting that critical section. Track the
140 * type of RCU (which one day might include SRCU) and the task's PID.
141 */
142 TRACE_EVENT(rcu_unlock_preempted_task,
143
144 TP_PROTO(char *rcuname, unsigned long gpnum, int pid),
145
146 TP_ARGS(rcuname, gpnum, pid),
147
148 TP_STRUCT__entry(
149 __field(char *, rcuname)
150 __field(unsigned long, gpnum)
151 __field(int, pid)
152 ),
153
154 TP_fast_assign(
155 __entry->rcuname = rcuname;
156 __entry->gpnum = gpnum;
157 __entry->pid = pid;
158 ),
159
160 TP_printk("%s %lu %d", __entry->rcuname, __entry->gpnum, __entry->pid)
161 );
162
163 /*
164 * Tracepoint for quiescent-state-reporting events. These are
165 * distinguished by the type of RCU, the grace-period number, the
166 * mask of quiescent lower-level entities, the rcu_node structure level,
167 * the starting and ending CPU covered by the rcu_node structure, and
168 * whether there are any blocked tasks blocking the current grace period.
169 * All but the type of RCU are extracted from the rcu_node structure.
170 */
171 TRACE_EVENT(rcu_quiescent_state_report,
172
173 TP_PROTO(char *rcuname, unsigned long gpnum,
174 unsigned long mask, unsigned long qsmask,
175 u8 level, int grplo, int grphi, int gp_tasks),
176
177 TP_ARGS(rcuname, gpnum, mask, qsmask, level, grplo, grphi, gp_tasks),
178
179 TP_STRUCT__entry(
180 __field(char *, rcuname)
181 __field(unsigned long, gpnum)
182 __field(unsigned long, mask)
183 __field(unsigned long, qsmask)
184 __field(u8, level)
185 __field(int, grplo)
186 __field(int, grphi)
187 __field(u8, gp_tasks)
188 ),
189
190 TP_fast_assign(
191 __entry->rcuname = rcuname;
192 __entry->gpnum = gpnum;
193 __entry->mask = mask;
194 __entry->qsmask = qsmask;
195 __entry->level = level;
196 __entry->grplo = grplo;
197 __entry->grphi = grphi;
198 __entry->gp_tasks = gp_tasks;
199 ),
200
201 TP_printk("%s %lu %lx>%lx %u %d %d %u",
202 __entry->rcuname, __entry->gpnum,
203 __entry->mask, __entry->qsmask, __entry->level,
204 __entry->grplo, __entry->grphi, __entry->gp_tasks)
205 );
206
207 /*
208 * Tracepoint for quiescent states detected by force_quiescent_state().
209 * These trace events include the type of RCU, the grace-period number
210 * that was blocked by the CPU, the CPU itself, and the type of quiescent
211 * state, which can be "dti" for dyntick-idle mode, "ofl" for CPU offline,
212 * or "kick" when kicking a CPU that has been in dyntick-idle mode for
213 * too long.
214 */
215 TRACE_EVENT(rcu_fqs,
216
217 TP_PROTO(char *rcuname, unsigned long gpnum, int cpu, char *qsevent),
218
219 TP_ARGS(rcuname, gpnum, cpu, qsevent),
220
221 TP_STRUCT__entry(
222 __field(char *, rcuname)
223 __field(unsigned long, gpnum)
224 __field(int, cpu)
225 __field(char *, qsevent)
226 ),
227
228 TP_fast_assign(
229 __entry->rcuname = rcuname;
230 __entry->gpnum = gpnum;
231 __entry->cpu = cpu;
232 __entry->qsevent = qsevent;
233 ),
234
235 TP_printk("%s %lu %d %s",
236 __entry->rcuname, __entry->gpnum,
237 __entry->cpu, __entry->qsevent)
238 );
239
240 #endif /* #if defined(CONFIG_TREE_RCU) || defined(CONFIG_TREE_PREEMPT_RCU) */
241
242 /*
243 * Tracepoint for dyntick-idle entry/exit events. These take a string
244 * as argument: "Start" for entering dyntick-idle mode, "End" for
245 * leaving it, "--=" for events moving towards idle, and "++=" for events
246 * moving away from idle. "Error on entry: not idle task" and "Error on
247 * exit: not idle task" indicate that a non-idle task is erroneously
248 * toying with the idle loop.
249 *
250 * These events also take a pair of numbers, which indicate the nesting
251 * depth before and after the event of interest. Note that task-related
252 * events use the upper bits of each number, while interrupt-related
253 * events use the lower bits.
254 */
255 TRACE_EVENT(rcu_dyntick,
256
257 TP_PROTO(char *polarity, long long oldnesting, long long newnesting),
258
259 TP_ARGS(polarity, oldnesting, newnesting),
260
261 TP_STRUCT__entry(
262 __field(char *, polarity)
263 __field(long long, oldnesting)
264 __field(long long, newnesting)
265 ),
266
267 TP_fast_assign(
268 __entry->polarity = polarity;
269 __entry->oldnesting = oldnesting;
270 __entry->newnesting = newnesting;
271 ),
272
273 TP_printk("%s %llx %llx", __entry->polarity,
274 __entry->oldnesting, __entry->newnesting)
275 );
276
277 /*
278 * Tracepoint for RCU preparation for idle, the goal being to get RCU
279 * processing done so that the current CPU can shut off its scheduling
280 * clock and enter dyntick-idle mode. One way to accomplish this is
281 * to drain all RCU callbacks from this CPU, and the other is to have
282 * done everything RCU requires for the current grace period. In this
283 * latter case, the CPU will be awakened at the end of the current grace
284 * period in order to process the remainder of its callbacks.
285 *
286 * These tracepoints take a string as argument:
287 *
288 * "No callbacks": Nothing to do, no callbacks on this CPU.
289 * "In holdoff": Nothing to do, holding off after unsuccessful attempt.
290 * "Begin holdoff": Attempt failed, don't retry until next jiffy.
291 * "Dyntick with callbacks": Entering dyntick-idle despite callbacks.
292 * "Dyntick with lazy callbacks": Entering dyntick-idle w/lazy callbacks.
293 * "More callbacks": Still more callbacks, try again to clear them out.
294 * "Callbacks drained": All callbacks processed, off to dyntick idle!
295 * "Timer": Timer fired to cause CPU to continue processing callbacks.
296 * "Demigrate": Timer fired on wrong CPU, woke up correct CPU.
297 * "Cleanup after idle": Idle exited, timer canceled.
298 */
299 TRACE_EVENT(rcu_prep_idle,
300
301 TP_PROTO(char *reason),
302
303 TP_ARGS(reason),
304
305 TP_STRUCT__entry(
306 __field(char *, reason)
307 ),
308
309 TP_fast_assign(
310 __entry->reason = reason;
311 ),
312
313 TP_printk("%s", __entry->reason)
314 );
315
316 /*
317 * Tracepoint for the registration of a single RCU callback function.
318 * The first argument is the type of RCU, the second argument is
319 * a pointer to the RCU callback itself, the third element is the
320 * number of lazy callbacks queued, and the fourth element is the
321 * total number of callbacks queued.
322 */
323 TRACE_EVENT(rcu_callback,
324
325 TP_PROTO(char *rcuname, struct rcu_head *rhp, long qlen_lazy,
326 long qlen),
327
328 TP_ARGS(rcuname, rhp, qlen_lazy, qlen),
329
330 TP_STRUCT__entry(
331 __field(char *, rcuname)
332 __field(void *, rhp)
333 __field(void *, func)
334 __field(long, qlen_lazy)
335 __field(long, qlen)
336 ),
337
338 TP_fast_assign(
339 __entry->rcuname = rcuname;
340 __entry->rhp = rhp;
341 __entry->func = rhp->func;
342 __entry->qlen_lazy = qlen_lazy;
343 __entry->qlen = qlen;
344 ),
345
346 TP_printk("%s rhp=%p func=%pf %ld/%ld",
347 __entry->rcuname, __entry->rhp, __entry->func,
348 __entry->qlen_lazy, __entry->qlen)
349 );
350
351 /*
352 * Tracepoint for the registration of a single RCU callback of the special
353 * kfree() form. The first argument is the RCU type, the second argument
354 * is a pointer to the RCU callback, the third argument is the offset
355 * of the callback within the enclosing RCU-protected data structure,
356 * the fourth argument is the number of lazy callbacks queued, and the
357 * fifth argument is the total number of callbacks queued.
358 */
359 TRACE_EVENT(rcu_kfree_callback,
360
361 TP_PROTO(char *rcuname, struct rcu_head *rhp, unsigned long offset,
362 long qlen_lazy, long qlen),
363
364 TP_ARGS(rcuname, rhp, offset, qlen_lazy, qlen),
365
366 TP_STRUCT__entry(
367 __field(char *, rcuname)
368 __field(void *, rhp)
369 __field(unsigned long, offset)
370 __field(long, qlen_lazy)
371 __field(long, qlen)
372 ),
373
374 TP_fast_assign(
375 __entry->rcuname = rcuname;
376 __entry->rhp = rhp;
377 __entry->offset = offset;
378 __entry->qlen_lazy = qlen_lazy;
379 __entry->qlen = qlen;
380 ),
381
382 TP_printk("%s rhp=%p func=%ld %ld/%ld",
383 __entry->rcuname, __entry->rhp, __entry->offset,
384 __entry->qlen_lazy, __entry->qlen)
385 );
386
387 /*
388 * Tracepoint for marking the beginning rcu_do_batch, performed to start
389 * RCU callback invocation. The first argument is the RCU flavor,
390 * the second is the number of lazy callbacks queued, the third is
391 * the total number of callbacks queued, and the fourth argument is
392 * the current RCU-callback batch limit.
393 */
394 TRACE_EVENT(rcu_batch_start,
395
396 TP_PROTO(char *rcuname, long qlen_lazy, long qlen, int blimit),
397
398 TP_ARGS(rcuname, qlen_lazy, qlen, blimit),
399
400 TP_STRUCT__entry(
401 __field(char *, rcuname)
402 __field(long, qlen_lazy)
403 __field(long, qlen)
404 __field(int, blimit)
405 ),
406
407 TP_fast_assign(
408 __entry->rcuname = rcuname;
409 __entry->qlen_lazy = qlen_lazy;
410 __entry->qlen = qlen;
411 __entry->blimit = blimit;
412 ),
413
414 TP_printk("%s CBs=%ld/%ld bl=%d",
415 __entry->rcuname, __entry->qlen_lazy, __entry->qlen,
416 __entry->blimit)
417 );
418
419 /*
420 * Tracepoint for the invocation of a single RCU callback function.
421 * The first argument is the type of RCU, and the second argument is
422 * a pointer to the RCU callback itself.
423 */
424 TRACE_EVENT(rcu_invoke_callback,
425
426 TP_PROTO(char *rcuname, struct rcu_head *rhp),
427
428 TP_ARGS(rcuname, rhp),
429
430 TP_STRUCT__entry(
431 __field(char *, rcuname)
432 __field(void *, rhp)
433 __field(void *, func)
434 ),
435
436 TP_fast_assign(
437 __entry->rcuname = rcuname;
438 __entry->rhp = rhp;
439 __entry->func = rhp->func;
440 ),
441
442 TP_printk("%s rhp=%p func=%pf",
443 __entry->rcuname, __entry->rhp, __entry->func)
444 );
445
446 /*
447 * Tracepoint for the invocation of a single RCU callback of the special
448 * kfree() form. The first argument is the RCU flavor, the second
449 * argument is a pointer to the RCU callback, and the third argument
450 * is the offset of the callback within the enclosing RCU-protected
451 * data structure.
452 */
453 TRACE_EVENT(rcu_invoke_kfree_callback,
454
455 TP_PROTO(char *rcuname, struct rcu_head *rhp, unsigned long offset),
456
457 TP_ARGS(rcuname, rhp, offset),
458
459 TP_STRUCT__entry(
460 __field(char *, rcuname)
461 __field(void *, rhp)
462 __field(unsigned long, offset)
463 ),
464
465 TP_fast_assign(
466 __entry->rcuname = rcuname;
467 __entry->rhp = rhp;
468 __entry->offset = offset;
469 ),
470
471 TP_printk("%s rhp=%p func=%ld",
472 __entry->rcuname, __entry->rhp, __entry->offset)
473 );
474
475 /*
476 * Tracepoint for exiting rcu_do_batch after RCU callbacks have been
477 * invoked. The first argument is the name of the RCU flavor,
478 * the second argument is number of callbacks actually invoked,
479 * the third argument (cb) is whether or not any of the callbacks that
480 * were ready to invoke at the beginning of this batch are still
481 * queued, the fourth argument (nr) is the return value of need_resched(),
482 * the fifth argument (iit) is 1 if the current task is the idle task,
483 * and the sixth argument (risk) is the return value from
484 * rcu_is_callbacks_kthread().
485 */
486 TRACE_EVENT(rcu_batch_end,
487
488 TP_PROTO(char *rcuname, int callbacks_invoked,
489 bool cb, bool nr, bool iit, bool risk),
490
491 TP_ARGS(rcuname, callbacks_invoked, cb, nr, iit, risk),
492
493 TP_STRUCT__entry(
494 __field(char *, rcuname)
495 __field(int, callbacks_invoked)
496 __field(bool, cb)
497 __field(bool, nr)
498 __field(bool, iit)
499 __field(bool, risk)
500 ),
501
502 TP_fast_assign(
503 __entry->rcuname = rcuname;
504 __entry->callbacks_invoked = callbacks_invoked;
505 __entry->cb = cb;
506 __entry->nr = nr;
507 __entry->iit = iit;
508 __entry->risk = risk;
509 ),
510
511 TP_printk("%s CBs-invoked=%d idle=%c%c%c%c",
512 __entry->rcuname, __entry->callbacks_invoked,
513 __entry->cb ? 'C' : '.',
514 __entry->nr ? 'S' : '.',
515 __entry->iit ? 'I' : '.',
516 __entry->risk ? 'R' : '.')
517 );
518
519 /*
520 * Tracepoint for rcutorture readers. The first argument is the name
521 * of the RCU flavor from rcutorture's viewpoint and the second argument
522 * is the callback address.
523 */
524 TRACE_EVENT(rcu_torture_read,
525
526 TP_PROTO(char *rcutorturename, struct rcu_head *rhp),
527
528 TP_ARGS(rcutorturename, rhp),
529
530 TP_STRUCT__entry(
531 __field(char *, rcutorturename)
532 __field(struct rcu_head *, rhp)
533 ),
534
535 TP_fast_assign(
536 __entry->rcutorturename = rcutorturename;
537 __entry->rhp = rhp;
538 ),
539
540 TP_printk("%s torture read %p",
541 __entry->rcutorturename, __entry->rhp)
542 );
543
544 /*
545 * Tracepoint for _rcu_barrier() execution. The string "s" describes
546 * the _rcu_barrier phase:
547 * "Begin": rcu_barrier_callback() started.
548 * "Check": rcu_barrier_callback() checking for piggybacking.
549 * "EarlyExit": rcu_barrier_callback() piggybacked, thus early exit.
550 * "Inc1": rcu_barrier_callback() piggyback check counter incremented.
551 * "Offline": rcu_barrier_callback() found offline CPU
552 * "OnlineQ": rcu_barrier_callback() found online CPU with callbacks.
553 * "OnlineNQ": rcu_barrier_callback() found online CPU, no callbacks.
554 * "IRQ": An rcu_barrier_callback() callback posted on remote CPU.
555 * "CB": An rcu_barrier_callback() invoked a callback, not the last.
556 * "LastCB": An rcu_barrier_callback() invoked the last callback.
557 * "Inc2": rcu_barrier_callback() piggyback check counter incremented.
558 * The "cpu" argument is the CPU or -1 if meaningless, the "cnt" argument
559 * is the count of remaining callbacks, and "done" is the piggybacking count.
560 */
561 TRACE_EVENT(rcu_barrier,
562
563 TP_PROTO(char *rcuname, char *s, int cpu, int cnt, unsigned long done),
564
565 TP_ARGS(rcuname, s, cpu, cnt, done),
566
567 TP_STRUCT__entry(
568 __field(char *, rcuname)
569 __field(char *, s)
570 __field(int, cpu)
571 __field(int, cnt)
572 __field(unsigned long, done)
573 ),
574
575 TP_fast_assign(
576 __entry->rcuname = rcuname;
577 __entry->s = s;
578 __entry->cpu = cpu;
579 __entry->cnt = cnt;
580 __entry->done = done;
581 ),
582
583 TP_printk("%s %s cpu %d remaining %d # %lu",
584 __entry->rcuname, __entry->s, __entry->cpu, __entry->cnt,
585 __entry->done)
586 );
587
588 #else /* #ifdef CONFIG_RCU_TRACE */
589
590 #define trace_rcu_grace_period(rcuname, gpnum, gpevent) do { } while (0)
591 #define trace_rcu_grace_period_init(rcuname, gpnum, level, grplo, grphi, \
592 qsmask) do { } while (0)
593 #define trace_rcu_preempt_task(rcuname, pid, gpnum) do { } while (0)
594 #define trace_rcu_unlock_preempted_task(rcuname, gpnum, pid) do { } while (0)
595 #define trace_rcu_quiescent_state_report(rcuname, gpnum, mask, qsmask, level, \
596 grplo, grphi, gp_tasks) do { } \
597 while (0)
598 #define trace_rcu_fqs(rcuname, gpnum, cpu, qsevent) do { } while (0)
599 #define trace_rcu_dyntick(polarity, oldnesting, newnesting) do { } while (0)
600 #define trace_rcu_prep_idle(reason) do { } while (0)
601 #define trace_rcu_callback(rcuname, rhp, qlen_lazy, qlen) do { } while (0)
602 #define trace_rcu_kfree_callback(rcuname, rhp, offset, qlen_lazy, qlen) \
603 do { } while (0)
604 #define trace_rcu_batch_start(rcuname, qlen_lazy, qlen, blimit) \
605 do { } while (0)
606 #define trace_rcu_invoke_callback(rcuname, rhp) do { } while (0)
607 #define trace_rcu_invoke_kfree_callback(rcuname, rhp, offset) do { } while (0)
608 #define trace_rcu_batch_end(rcuname, callbacks_invoked, cb, nr, iit, risk) \
609 do { } while (0)
610 #define trace_rcu_torture_read(rcutorturename, rhp) do { } while (0)
611 #define trace_rcu_barrier(name, s, cpu, cnt, done) do { } while (0)
612
613 #endif /* #else #ifdef CONFIG_RCU_TRACE */
614
615 #endif /* _TRACE_RCU_H */
616
617 /* This part must be outside protection */
618 #include <trace/define_trace.h>
This page took 0.040733 seconds and 4 git commands to generate.