include/instrumentation/events/timer.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 #undef TRACE_SYSTEM
   3 #define TRACE_SYSTEM timer
   4
   5 #if !defined(LTTNG_TRACE_TIMER_H) || defined(TRACE_HEADER_MULTI_READ)
   6 #define LTTNG_TRACE_TIMER_H
   7
   8 #include <lttng/tracepoint-event.h>
   9
  10 #ifndef _TRACE_TIMER_DEF_
  11 #define _TRACE_TIMER_DEF_
  12 #include <linux/hrtimer.h>
  13 #include <linux/timer.h>
  14 #include <lttng/kernel-version.h>
  15
  16 struct timer_list;
  17
  18 #endif /* _TRACE_TIMER_DEF_ */
  19
  20 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
  21 #define lttng_ktime_get_tv64(kt)        (kt)
  22 #else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
  23 #define lttng_ktime_get_tv64(kt)        ((kt).tv64)
  24 #endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
  25
  26 LTTNG_TRACEPOINT_EVENT_CLASS(timer_class,
  27
  28         TP_PROTO(struct timer_list *timer),
  29
  30         TP_ARGS(timer),
  31
  32         TP_FIELDS(
  33                 ctf_integer_hex(void *, timer, timer)
  34         )
  35 )
  36
  37 /**
  38  * timer_init - called when the timer is initialized
  39  * @timer:      pointer to struct timer_list
  40  */
  41 LTTNG_TRACEPOINT_EVENT_INSTANCE(timer_class, timer_init,
  42
  43         TP_PROTO(struct timer_list *timer),
  44
  45         TP_ARGS(timer)
  46 )
  47
  48 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,2,0) || \
  49         LTTNG_RHEL_KERNEL_RANGE(3,10,0,957,0,0, 3,11,0,0,0,0))
  50 /**
  51  * timer_start - called when the timer is started
  52  * @timer:      pointer to struct timer_list
  53  * @expires:    the timers expiry time
  54  * @flags:      the timers expiry time
  55  */
  56 LTTNG_TRACEPOINT_EVENT(timer_start,
  57
  58         TP_PROTO(struct timer_list *timer, unsigned long expires,
  59                 unsigned int flags),
  60
  61         TP_ARGS(timer, expires, flags),
  62
  63         TP_FIELDS(
  64                 ctf_integer_hex(void *, timer, timer)
  65                 ctf_integer_hex(void *, function, timer->function)
  66                 ctf_integer(unsigned long, expires, expires)
  67                 ctf_integer(unsigned long, now, jiffies)
  68                 ctf_integer(unsigned int, flags, flags)
  69         )
  70 )
  71 #else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,2,0)) */
  72 /**
  73  * timer_start - called when the timer is started
  74  * @timer:      pointer to struct timer_list
  75  * @expires:    the timers expiry time
  76  */
  77 LTTNG_TRACEPOINT_EVENT(timer_start,
  78
  79         TP_PROTO(struct timer_list *timer, unsigned long expires),
  80
  81         TP_ARGS(timer, expires),
  82
  83         TP_FIELDS(
  84                 ctf_integer_hex(void *, timer, timer)
  85                 ctf_integer_hex(void *, function, timer->function)
  86                 ctf_integer(unsigned long, expires, expires)
  87                 ctf_integer(unsigned long, now, jiffies)
  88         )
  89 )
  90 #endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,2,0)) */
  91
  92 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,2,0) || \
  93         LTTNG_RHEL_KERNEL_RANGE(4,18,0,193,0,0, 4,19,0,0,0,0))
  94 /**
  95  * timer_expire_entry - called immediately before the timer callback
  96  * @timer:      pointer to struct timer_list
  97  *
  98  * Allows to determine the timer latency.
  99  */
 100 LTTNG_TRACEPOINT_EVENT(timer_expire_entry,
 101
 102         TP_PROTO(struct timer_list *timer, unsigned long baseclk),
 103
 104         TP_ARGS(timer, baseclk),
 105
 106         TP_FIELDS(
 107                 ctf_integer_hex(void *, timer, timer)
 108                 ctf_integer(unsigned long, now, jiffies)
 109                 ctf_integer_hex(void *, function, timer->function)
 110                 ctf_integer(unsigned long, baseclk, baseclk)
 111         )
 112 )
 113 #else
 114 /**
 115  * timer_expire_entry - called immediately before the timer callback
 116  * @timer:      pointer to struct timer_list
 117  *
 118  * Allows to determine the timer latency.
 119  */
 120 LTTNG_TRACEPOINT_EVENT(timer_expire_entry,
 121
 122         TP_PROTO(struct timer_list *timer),
 123
 124         TP_ARGS(timer),
 125
 126         TP_FIELDS(
 127                 ctf_integer_hex(void *, timer, timer)
 128                 ctf_integer(unsigned long, now, jiffies)
 129                 ctf_integer_hex(void *, function, timer->function)
 130         )
 131 )
 132 #endif
 133
 134 /**
 135  * timer_expire_exit - called immediately after the timer callback returns
 136  * @timer:      pointer to struct timer_list
 137  *
 138  * When used in combination with the timer_expire_entry tracepoint we can
 139  * determine the runtime of the timer callback function.
 140  *
 141  * NOTE: Do NOT derefernce timer in TP_fast_assign. The pointer might
 142  * be invalid. We solely track the pointer.
 143  */
 144 LTTNG_TRACEPOINT_EVENT_INSTANCE(timer_class, timer_expire_exit,
 145
 146         TP_PROTO(struct timer_list *timer),
 147
 148         TP_ARGS(timer)
 149 )
 150
 151 /**
 152  * timer_cancel - called when the timer is canceled
 153  * @timer:      pointer to struct timer_list
 154  */
 155 LTTNG_TRACEPOINT_EVENT_INSTANCE(timer_class, timer_cancel,
 156
 157         TP_PROTO(struct timer_list *timer),
 158
 159         TP_ARGS(timer)
 160 )
 161
 162 /**
 163  * hrtimer_init - called when the hrtimer is initialized
 164  * @timer:      pointer to struct hrtimer
 165  * @clockid:    the hrtimers clock
 166  * @mode:       the hrtimers mode
 167  */
 168 LTTNG_TRACEPOINT_EVENT_MAP(hrtimer_init,
 169
 170         timer_hrtimer_init,
 171
 172         TP_PROTO(struct hrtimer *hrtimer, clockid_t clockid,
 173                  enum hrtimer_mode mode),
 174
 175         TP_ARGS(hrtimer, clockid, mode),
 176
 177         TP_FIELDS(
 178                 ctf_integer_hex(void *, hrtimer, hrtimer)
 179                 ctf_integer(clockid_t, clockid, clockid)
 180                 ctf_integer(enum hrtimer_mode, mode, mode)
 181         )
 182 )
 183
 184 /**
 185  * hrtimer_start - called when the hrtimer is started
 186  * @timer: pointer to struct hrtimer
 187  */
 188 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,16,0) || \
 189         LTTNG_RT_KERNEL_RANGE(4,14,0,0, 4,15,0,0))
 190 LTTNG_TRACEPOINT_EVENT_MAP(hrtimer_start,
 191
 192         timer_hrtimer_start,
 193
 194         TP_PROTO(struct hrtimer *hrtimer, enum hrtimer_mode mode),
 195
 196         TP_ARGS(hrtimer, mode),
 197
 198         TP_FIELDS(
 199                 ctf_integer_hex(void *, hrtimer, hrtimer)
 200                 ctf_integer_hex(void *, function, hrtimer->function)
 201                 ctf_integer(s64, expires,
 202                         lttng_ktime_get_tv64(hrtimer_get_expires(hrtimer)))
 203                 ctf_integer(s64, softexpires,
 204                         lttng_ktime_get_tv64(hrtimer_get_softexpires(hrtimer)))
 205                 ctf_integer(enum hrtimer_mode, mode, mode)
 206         )
 207 )
 208 #else
 209 LTTNG_TRACEPOINT_EVENT_MAP(hrtimer_start,
 210
 211         timer_hrtimer_start,
 212
 213         TP_PROTO(struct hrtimer *hrtimer),
 214
 215         TP_ARGS(hrtimer),
 216
 217         TP_FIELDS(
 218                 ctf_integer_hex(void *, hrtimer, hrtimer)
 219                 ctf_integer_hex(void *, function, hrtimer->function)
 220                 ctf_integer(s64, expires,
 221                         lttng_ktime_get_tv64(hrtimer_get_expires(hrtimer)))
 222                 ctf_integer(s64, softexpires,
 223                         lttng_ktime_get_tv64(hrtimer_get_softexpires(hrtimer)))
 224         )
 225 )
 226 #endif
 227
 228 /**
 229  * htimmer_expire_entry - called immediately before the hrtimer callback
 230  * @timer:      pointer to struct hrtimer
 231  * @now:        pointer to variable which contains current time of the
 232  *              timers base.
 233  *
 234  * Allows to determine the timer latency.
 235  */
 236 LTTNG_TRACEPOINT_EVENT_MAP(hrtimer_expire_entry,
 237
 238         timer_hrtimer_expire_entry,
 239
 240         TP_PROTO(struct hrtimer *hrtimer, ktime_t *now),
 241
 242         TP_ARGS(hrtimer, now),
 243
 244         TP_FIELDS(
 245                 ctf_integer_hex(void *, hrtimer, hrtimer)
 246                 ctf_integer(s64, now, lttng_ktime_get_tv64(*now))
 247                 ctf_integer_hex(void *, function, hrtimer->function)
 248         )
 249 )
 250
 251 LTTNG_TRACEPOINT_EVENT_CLASS(timer_hrtimer_class,
 252
 253         TP_PROTO(struct hrtimer *hrtimer),
 254
 255         TP_ARGS(hrtimer),
 256
 257         TP_FIELDS(
 258                 ctf_integer_hex(void *, hrtimer, hrtimer)
 259         )
 260 )
 261
 262 /**
 263  * hrtimer_expire_exit - called immediately after the hrtimer callback returns
 264  * @timer:      pointer to struct hrtimer
 265  *
 266  * When used in combination with the hrtimer_expire_entry tracepoint we can
 267  * determine the runtime of the callback function.
 268  */
 269 LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP(timer_hrtimer_class, hrtimer_expire_exit,
 270
 271         timer_hrtimer_expire_exit,
 272
 273         TP_PROTO(struct hrtimer *hrtimer),
 274
 275         TP_ARGS(hrtimer)
 276 )
 277
 278 /**
 279  * hrtimer_cancel - called when the hrtimer is canceled
 280  * @hrtimer:    pointer to struct hrtimer
 281  */
 282 LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP(timer_hrtimer_class, hrtimer_cancel,
 283
 284         timer_hrtimer_cancel,
 285
 286         TP_PROTO(struct hrtimer *hrtimer),
 287
 288         TP_ARGS(hrtimer)
 289 )
 290
 291 /**
 292  * itimer_state - called when itimer is started or canceled
 293  * @which:      name of the interval timer
 294  * @value:      the itimers value, itimer is canceled if value->it_value is
 295  *              zero, otherwise it is started
 296  * @expires:    the itimers expiry time
 297  */
 298 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,5,0))
 299 LTTNG_TRACEPOINT_EVENT_MAP(itimer_state,
 300
 301         timer_itimer_state,
 302
 303         TP_PROTO(int which, const struct itimerspec64 *const value,
 304                  unsigned long long expires),
 305
 306         TP_ARGS(which, value, expires),
 307
 308         TP_FIELDS(
 309                 ctf_integer(int, which, which)
 310                 ctf_integer(unsigned long long, expires, expires)
 311                 ctf_integer(long, value_sec, value->it_value.tv_sec)
 312                 ctf_integer(long, value_nsec, value->it_value.tv_nsec)
 313                 ctf_integer(long, interval_sec, value->it_interval.tv_sec)
 314                 ctf_integer(long, interval_nsec, value->it_interval.tv_nsec)
 315         )
 316 )
 317 #elif (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,11,0))
 318 LTTNG_TRACEPOINT_EVENT_MAP(itimer_state,
 319
 320         timer_itimer_state,
 321
 322         TP_PROTO(int which, const struct itimerval *const value,
 323                  unsigned long long expires),
 324
 325         TP_ARGS(which, value, expires),
 326
 327         TP_FIELDS(
 328                 ctf_integer(int, which, which)
 329                 ctf_integer(unsigned long long, expires, expires)
 330                 ctf_integer(long, value_sec, value->it_value.tv_sec)
 331                 ctf_integer(long, value_usec, value->it_value.tv_usec)
 332                 ctf_integer(long, interval_sec, value->it_interval.tv_sec)
 333                 ctf_integer(long, interval_usec, value->it_interval.tv_usec)
 334         )
 335 )
 336 #else /* if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,11,0)) */
 337 LTTNG_TRACEPOINT_EVENT_MAP(itimer_state,
 338
 339         timer_itimer_state,
 340
 341         TP_PROTO(int which, const struct itimerval *const value,
 342                  cputime_t expires),
 343
 344         TP_ARGS(which, value, expires),
 345
 346         TP_FIELDS(
 347                 ctf_integer(int, which, which)
 348                 ctf_integer(cputime_t, expires, expires)
 349                 ctf_integer(long, value_sec, value->it_value.tv_sec)
 350                 ctf_integer(long, value_usec, value->it_value.tv_usec)
 351                 ctf_integer(long, interval_sec, value->it_interval.tv_sec)
 352                 ctf_integer(long, interval_usec, value->it_interval.tv_usec)
 353         )
 354 )
 355 #endif /* #else (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,11,0)) */
 356
 357 /**
 358  * itimer_expire - called when itimer expires
 359  * @which:      type of the interval timer
 360  * @pid:        pid of the process which owns the timer
 361  * @now:        current time, used to calculate the latency of itimer
 362  */
 363 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,11,0))
 364 LTTNG_TRACEPOINT_EVENT_MAP(itimer_expire,
 365
 366         timer_itimer_expire,
 367
 368         TP_PROTO(int which, struct pid *pid, unsigned long long now),
 369
 370         TP_ARGS(which, pid, now),
 371
 372         TP_FIELDS(
 373                 ctf_integer(int , which, which)
 374                 ctf_integer(pid_t, pid, pid_nr(pid))
 375                 ctf_integer(unsigned long long, now, now)
 376         )
 377 )
 378 #else /* if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,11,0)) */
 379 LTTNG_TRACEPOINT_EVENT_MAP(itimer_expire,
 380
 381         timer_itimer_expire,
 382
 383         TP_PROTO(int which, struct pid *pid, cputime_t now),
 384
 385         TP_ARGS(which, pid, now),
 386
 387         TP_FIELDS(
 388                 ctf_integer(int , which, which)
 389                 ctf_integer(pid_t, pid, pid_nr(pid))
 390                 ctf_integer(cputime_t, now, now)
 391         )
 392 )
 393 #endif /* #else (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,11,0)) */
 394
 395 #endif /*  LTTNG_TRACE_TIMER_H */
 396
 397 /* This part must be outside protection */
 398 #include <lttng/define_trace.h>