include/linux/trace_events.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2
   3 #ifndef _LINUX_TRACE_EVENT_H
   4 #define _LINUX_TRACE_EVENT_H
   5
   6 #include <linux/ring_buffer.h>
   7 #include <linux/trace_seq.h>
   8 #include <linux/percpu.h>
   9 #include <linux/hardirq.h>
  10 #include <linux/perf_event.h>
  11 #include <linux/tracepoint.h>
  12
  13 struct trace_array;
  14 struct array_buffer;
  15 struct tracer;
  16 struct dentry;
  17 struct bpf_prog;
  18
  19 const char *trace_print_flags_seq(struct trace_seq *p, const char *delim,
  20                                   unsigned long flags,
  21                                   const struct trace_print_flags *flag_array);
  22
  23 const char *trace_print_symbols_seq(struct trace_seq *p, unsigned long val,
  24                                     const struct trace_print_flags *symbol_array);
  25
  26 #if BITS_PER_LONG == 32
  27 const char *trace_print_flags_seq_u64(struct trace_seq *p, const char *delim,
  28                       unsigned long long flags,
  29                       const struct trace_print_flags_u64 *flag_array);
  30
  31 const char *trace_print_symbols_seq_u64(struct trace_seq *p,
  32                                         unsigned long long val,
  33                                         const struct trace_print_flags_u64
  34                                                                  *symbol_array);
  35 #endif
  36
  37 const char *trace_print_bitmask_seq(struct trace_seq *p, void *bitmask_ptr,
  38                                     unsigned int bitmask_size);
  39
  40 const char *trace_print_hex_seq(struct trace_seq *p,
  41                                 const unsigned char *buf, int len,
  42                                 bool concatenate);
  43
  44 const char *trace_print_array_seq(struct trace_seq *p,
  45                                    const void *buf, int count,
  46                                    size_t el_size);
  47
  48 const char *
  49 trace_print_hex_dump_seq(struct trace_seq *p, const char *prefix_str,
  50                          int prefix_type, int rowsize, int groupsize,
  51                          const void *buf, size_t len, bool ascii);
  52
  53 struct trace_iterator;
  54 struct trace_event;
  55
  56 int trace_raw_output_prep(struct trace_iterator *iter,
  57                           struct trace_event *event);
  58 extern __printf(2, 3)
  59 void trace_event_printf(struct trace_iterator *iter, const char *fmt, ...);
  60
  61 /*
  62  * The trace entry - the most basic unit of tracing. This is what
  63  * is printed in the end as a single line in the trace output, such as:
  64  *
  65  *     bash-15816 [01]   235.197585: idle_cpu <- irq_enter
  66  */
  67 struct trace_entry {
  68         unsigned short          type;
  69         unsigned char           flags;
  70         unsigned char           preempt_count;
  71         int                     pid;
  72 };
  73
  74 #define TRACE_EVENT_TYPE_MAX                                            \
  75         ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
  76
  77 /*
  78  * Trace iterator - used by printout routines who present trace
  79  * results to users and which routines might sleep, etc:
  80  */
  81 struct trace_iterator {
  82         struct trace_array      *tr;
  83         struct tracer           *trace;
  84         struct array_buffer     *array_buffer;
  85         void                    *private;
  86         int                     cpu_file;
  87         struct mutex            mutex;
  88         struct ring_buffer_iter **buffer_iter;
  89         unsigned long           iter_flags;
  90         void                    *temp;  /* temp holder */
  91         unsigned int            temp_size;
  92         char                    *fmt;   /* modified format holder */
  93         unsigned int            fmt_size;
  94
  95         /* trace_seq for __print_flags() and __print_symbolic() etc. */
  96         struct trace_seq        tmp_seq;
  97
  98         cpumask_var_t           started;
  99
 100         /* it's true when current open file is snapshot */
 101         bool                    snapshot;
 102
 103         /* The below is zeroed out in pipe_read */
 104         struct trace_seq        seq;
 105         struct trace_entry      *ent;
 106         unsigned long           lost_events;
 107         int                     leftover;
 108         int                     ent_size;
 109         int                     cpu;
 110         u64                     ts;
 111
 112         loff_t                  pos;
 113         long                    idx;
 114
 115         /* All new field here will be zeroed out in pipe_read */
 116 };
 117
 118 enum trace_iter_flags {
 119         TRACE_FILE_LAT_FMT      = 1,
 120         TRACE_FILE_ANNOTATE     = 2,
 121         TRACE_FILE_TIME_IN_NS   = 4,
 122 };
 123
 124
 125 typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
 126                                       int flags, struct trace_event *event);
 127
 128 struct trace_event_functions {
 129         trace_print_func        trace;
 130         trace_print_func        raw;
 131         trace_print_func        hex;
 132         trace_print_func        binary;
 133 };
 134
 135 struct trace_event {
 136         struct hlist_node               node;
 137         struct list_head                list;
 138         int                             type;
 139         struct trace_event_functions    *funcs;
 140 };
 141
 142 extern int register_trace_event(struct trace_event *event);
 143 extern int unregister_trace_event(struct trace_event *event);
 144
 145 /* Return values for print_line callback */
 146 enum print_line_t {
 147         TRACE_TYPE_PARTIAL_LINE = 0,    /* Retry after flushing the seq */
 148         TRACE_TYPE_HANDLED      = 1,
 149         TRACE_TYPE_UNHANDLED    = 2,    /* Relay to other output functions */
 150         TRACE_TYPE_NO_CONSUME   = 3     /* Handled but ask to not consume */
 151 };
 152
 153 enum print_line_t trace_handle_return(struct trace_seq *s);
 154
 155 static inline void tracing_generic_entry_update(struct trace_entry *entry,
 156                                                 unsigned short type,
 157                                                 unsigned int trace_ctx)
 158 {
 159         entry->preempt_count            = trace_ctx & 0xff;
 160         entry->pid                      = current->pid;
 161         entry->type                     = type;
 162         entry->flags =                  trace_ctx >> 16;
 163 }
 164
 165 unsigned int tracing_gen_ctx_irq_test(unsigned int irqs_status);
 166
 167 enum trace_flag_type {
 168         TRACE_FLAG_IRQS_OFF             = 0x01,
 169         TRACE_FLAG_IRQS_NOSUPPORT       = 0x02,
 170         TRACE_FLAG_NEED_RESCHED         = 0x04,
 171         TRACE_FLAG_HARDIRQ              = 0x08,
 172         TRACE_FLAG_SOFTIRQ              = 0x10,
 173         TRACE_FLAG_PREEMPT_RESCHED      = 0x20,
 174         TRACE_FLAG_NMI                  = 0x40,
 175         TRACE_FLAG_BH_OFF               = 0x80,
 176 };
 177
 178 #ifdef CONFIG_TRACE_IRQFLAGS_SUPPORT
 179 static inline unsigned int tracing_gen_ctx_flags(unsigned long irqflags)
 180 {
 181         unsigned int irq_status = irqs_disabled_flags(irqflags) ?
 182                 TRACE_FLAG_IRQS_OFF : 0;
 183         return tracing_gen_ctx_irq_test(irq_status);
 184 }
 185 static inline unsigned int tracing_gen_ctx(void)
 186 {
 187         unsigned long irqflags;
 188
 189         local_save_flags(irqflags);
 190         return tracing_gen_ctx_flags(irqflags);
 191 }
 192 #else
 193
 194 static inline unsigned int tracing_gen_ctx_flags(unsigned long irqflags)
 195 {
 196         return tracing_gen_ctx_irq_test(TRACE_FLAG_IRQS_NOSUPPORT);
 197 }
 198 static inline unsigned int tracing_gen_ctx(void)
 199 {
 200         return tracing_gen_ctx_irq_test(TRACE_FLAG_IRQS_NOSUPPORT);
 201 }
 202 #endif
 203
 204 static inline unsigned int tracing_gen_ctx_dec(void)
 205 {
 206         unsigned int trace_ctx;
 207
 208         trace_ctx = tracing_gen_ctx();
 209         /*
 210          * Subtract one from the preemption counter if preemption is enabled,
 211          * see trace_event_buffer_reserve()for details.
 212          */
 213         if (IS_ENABLED(CONFIG_PREEMPTION))
 214                 trace_ctx--;
 215         return trace_ctx;
 216 }
 217
 218 struct trace_event_file;
 219
 220 struct ring_buffer_event *
 221 trace_event_buffer_lock_reserve(struct trace_buffer **current_buffer,
 222                                 struct trace_event_file *trace_file,
 223                                 int type, unsigned long len,
 224                                 unsigned int trace_ctx);
 225
 226 #define TRACE_RECORD_CMDLINE    BIT(0)
 227 #define TRACE_RECORD_TGID       BIT(1)
 228
 229 void tracing_record_taskinfo(struct task_struct *task, int flags);
 230 void tracing_record_taskinfo_sched_switch(struct task_struct *prev,
 231                                           struct task_struct *next, int flags);
 232
 233 void tracing_record_cmdline(struct task_struct *task);
 234 void tracing_record_tgid(struct task_struct *task);
 235
 236 int trace_output_call(struct trace_iterator *iter, char *name, char *fmt, ...);
 237
 238 struct event_filter;
 239
 240 enum trace_reg {
 241         TRACE_REG_REGISTER,
 242         TRACE_REG_UNREGISTER,
 243 #ifdef CONFIG_PERF_EVENTS
 244         TRACE_REG_PERF_REGISTER,
 245         TRACE_REG_PERF_UNREGISTER,
 246         TRACE_REG_PERF_OPEN,
 247         TRACE_REG_PERF_CLOSE,
 248         /*
 249          * These (ADD/DEL) use a 'boolean' return value, where 1 (true) means a
 250          * custom action was taken and the default action is not to be
 251          * performed.
 252          */
 253         TRACE_REG_PERF_ADD,
 254         TRACE_REG_PERF_DEL,
 255 #endif
 256 };
 257
 258 struct trace_event_call;
 259
 260 #define TRACE_FUNCTION_TYPE ((const char *)~0UL)
 261
 262 struct trace_event_fields {
 263         const char *type;
 264         union {
 265                 struct {
 266                         const char *name;
 267                         const int  size;
 268                         const int  align;
 269                         const int  is_signed;
 270                         const int  filter_type;
 271                 };
 272                 int (*define_fields)(struct trace_event_call *);
 273         };
 274 };
 275
 276 struct trace_event_class {
 277         const char              *system;
 278         void                    *probe;
 279 #ifdef CONFIG_PERF_EVENTS
 280         void                    *perf_probe;
 281 #endif
 282         int                     (*reg)(struct trace_event_call *event,
 283                                        enum trace_reg type, void *data);
 284         struct trace_event_fields *fields_array;
 285         struct list_head        *(*get_fields)(struct trace_event_call *);
 286         struct list_head        fields;
 287         int                     (*raw_init)(struct trace_event_call *);
 288 };
 289
 290 extern int trace_event_reg(struct trace_event_call *event,
 291                             enum trace_reg type, void *data);
 292
 293 struct trace_event_buffer {
 294         struct trace_buffer             *buffer;
 295         struct ring_buffer_event        *event;
 296         struct trace_event_file         *trace_file;
 297         void                            *entry;
 298         unsigned int                    trace_ctx;
 299         struct pt_regs                  *regs;
 300 };
 301
 302 void *trace_event_buffer_reserve(struct trace_event_buffer *fbuffer,
 303                                   struct trace_event_file *trace_file,
 304                                   unsigned long len);
 305
 306 void trace_event_buffer_commit(struct trace_event_buffer *fbuffer);
 307
 308 enum {
 309         TRACE_EVENT_FL_FILTERED_BIT,
 310         TRACE_EVENT_FL_CAP_ANY_BIT,
 311         TRACE_EVENT_FL_NO_SET_FILTER_BIT,
 312         TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
 313         TRACE_EVENT_FL_TRACEPOINT_BIT,
 314         TRACE_EVENT_FL_DYNAMIC_BIT,
 315         TRACE_EVENT_FL_KPROBE_BIT,
 316         TRACE_EVENT_FL_UPROBE_BIT,
 317         TRACE_EVENT_FL_EPROBE_BIT,
 318         TRACE_EVENT_FL_CUSTOM_BIT,
 319 };
 320
 321 /*
 322  * Event flags:
 323  *  FILTERED      - The event has a filter attached
 324  *  CAP_ANY       - Any user can enable for perf
 325  *  NO_SET_FILTER - Set when filter has error and is to be ignored
 326  *  IGNORE_ENABLE - For trace internal events, do not enable with debugfs file
 327  *  TRACEPOINT    - Event is a tracepoint
 328  *  DYNAMIC       - Event is a dynamic event (created at run time)
 329  *  KPROBE        - Event is a kprobe
 330  *  UPROBE        - Event is a uprobe
 331  *  EPROBE        - Event is an event probe
 332  *  CUSTOM        - Event is a custom event (to be attached to an exsiting tracepoint)
 333  *                   This is set when the custom event has not been attached
 334  *                   to a tracepoint yet, then it is cleared when it is.
 335  */
 336 enum {
 337         TRACE_EVENT_FL_FILTERED         = (1 << TRACE_EVENT_FL_FILTERED_BIT),
 338         TRACE_EVENT_FL_CAP_ANY          = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
 339         TRACE_EVENT_FL_NO_SET_FILTER    = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
 340         TRACE_EVENT_FL_IGNORE_ENABLE    = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
 341         TRACE_EVENT_FL_TRACEPOINT       = (1 << TRACE_EVENT_FL_TRACEPOINT_BIT),
 342         TRACE_EVENT_FL_DYNAMIC          = (1 << TRACE_EVENT_FL_DYNAMIC_BIT),
 343         TRACE_EVENT_FL_KPROBE           = (1 << TRACE_EVENT_FL_KPROBE_BIT),
 344         TRACE_EVENT_FL_UPROBE           = (1 << TRACE_EVENT_FL_UPROBE_BIT),
 345         TRACE_EVENT_FL_EPROBE           = (1 << TRACE_EVENT_FL_EPROBE_BIT),
 346         TRACE_EVENT_FL_CUSTOM           = (1 << TRACE_EVENT_FL_CUSTOM_BIT),
 347 };
 348
 349 #define TRACE_EVENT_FL_UKPROBE (TRACE_EVENT_FL_KPROBE | TRACE_EVENT_FL_UPROBE)
 350
 351 struct trace_event_call {
 352         struct list_head        list;
 353         struct trace_event_class *class;
 354         union {
 355                 char                    *name;
 356                 /* Set TRACE_EVENT_FL_TRACEPOINT flag when using "tp" */
 357                 struct tracepoint       *tp;
 358         };
 359         struct trace_event      event;
 360         char                    *print_fmt;
 361         struct event_filter     *filter;
 362         /*
 363          * Static events can disappear with modules,
 364          * where as dynamic ones need their own ref count.
 365          */
 366         union {
 367                 void                            *module;
 368                 atomic_t                        refcnt;
 369         };
 370         void                    *data;
 371
 372         /* See the TRACE_EVENT_FL_* flags above */
 373         int                     flags; /* static flags of different events */
 374
 375 #ifdef CONFIG_PERF_EVENTS
 376         int                             perf_refcount;
 377         struct hlist_head __percpu      *perf_events;
 378         struct bpf_prog_array __rcu     *prog_array;
 379
 380         int     (*perf_perm)(struct trace_event_call *,
 381                              struct perf_event *);
 382 #endif
 383 };
 384
 385 #ifdef CONFIG_DYNAMIC_EVENTS
 386 bool trace_event_dyn_try_get_ref(struct trace_event_call *call);
 387 void trace_event_dyn_put_ref(struct trace_event_call *call);
 388 bool trace_event_dyn_busy(struct trace_event_call *call);
 389 #else
 390 static inline bool trace_event_dyn_try_get_ref(struct trace_event_call *call)
 391 {
 392         /* Without DYNAMIC_EVENTS configured, nothing should be calling this */
 393         return false;
 394 }
 395 static inline void trace_event_dyn_put_ref(struct trace_event_call *call)
 396 {
 397 }
 398 static inline bool trace_event_dyn_busy(struct trace_event_call *call)
 399 {
 400         /* Nothing should call this without DYNAIMIC_EVENTS configured. */
 401         return true;
 402 }
 403 #endif
 404
 405 static inline bool trace_event_try_get_ref(struct trace_event_call *call)
 406 {
 407         if (call->flags & TRACE_EVENT_FL_DYNAMIC)
 408                 return trace_event_dyn_try_get_ref(call);
 409         else
 410                 return try_module_get(call->module);
 411 }
 412
 413 static inline void trace_event_put_ref(struct trace_event_call *call)
 414 {
 415         if (call->flags & TRACE_EVENT_FL_DYNAMIC)
 416                 trace_event_dyn_put_ref(call);
 417         else
 418                 module_put(call->module);
 419 }
 420
 421 #ifdef CONFIG_PERF_EVENTS
 422 static inline bool bpf_prog_array_valid(struct trace_event_call *call)
 423 {
 424         /*
 425          * This inline function checks whether call->prog_array
 426          * is valid or not. The function is called in various places,
 427          * outside rcu_read_lock/unlock, as a heuristic to speed up execution.
 428          *
 429          * If this function returns true, and later call->prog_array
 430          * becomes false inside rcu_read_lock/unlock region,
 431          * we bail out then. If this function return false,
 432          * there is a risk that we might miss a few events if the checking
 433          * were delayed until inside rcu_read_lock/unlock region and
 434          * call->prog_array happened to become non-NULL then.
 435          *
 436          * Here, READ_ONCE() is used instead of rcu_access_pointer().
 437          * rcu_access_pointer() requires the actual definition of
 438          * "struct bpf_prog_array" while READ_ONCE() only needs
 439          * a declaration of the same type.
 440          */
 441         return !!READ_ONCE(call->prog_array);
 442 }
 443 #endif
 444
 445 static inline const char *
 446 trace_event_name(struct trace_event_call *call)
 447 {
 448         if (call->flags & TRACE_EVENT_FL_CUSTOM)
 449                 return call->name;
 450         else if (call->flags & TRACE_EVENT_FL_TRACEPOINT)
 451                 return call->tp ? call->tp->name : NULL;
 452         else
 453                 return call->name;
 454 }
 455
 456 static inline struct list_head *
 457 trace_get_fields(struct trace_event_call *event_call)
 458 {
 459         if (!event_call->class->get_fields)
 460                 return &event_call->class->fields;
 461         return event_call->class->get_fields(event_call);
 462 }
 463
 464 struct trace_subsystem_dir;
 465
 466 enum {
 467         EVENT_FILE_FL_ENABLED_BIT,
 468         EVENT_FILE_FL_RECORDED_CMD_BIT,
 469         EVENT_FILE_FL_RECORDED_TGID_BIT,
 470         EVENT_FILE_FL_FILTERED_BIT,
 471         EVENT_FILE_FL_NO_SET_FILTER_BIT,
 472         EVENT_FILE_FL_SOFT_MODE_BIT,
 473         EVENT_FILE_FL_SOFT_DISABLED_BIT,
 474         EVENT_FILE_FL_TRIGGER_MODE_BIT,
 475         EVENT_FILE_FL_TRIGGER_COND_BIT,
 476         EVENT_FILE_FL_PID_FILTER_BIT,
 477         EVENT_FILE_FL_WAS_ENABLED_BIT,
 478 };
 479
 480 extern struct trace_event_file *trace_get_event_file(const char *instance,
 481                                                      const char *system,
 482                                                      const char *event);
 483 extern void trace_put_event_file(struct trace_event_file *file);
 484
 485 #define MAX_DYNEVENT_CMD_LEN    (2048)
 486
 487 enum dynevent_type {
 488         DYNEVENT_TYPE_SYNTH = 1,
 489         DYNEVENT_TYPE_KPROBE,
 490         DYNEVENT_TYPE_NONE,
 491 };
 492
 493 struct dynevent_cmd;
 494
 495 typedef int (*dynevent_create_fn_t)(struct dynevent_cmd *cmd);
 496
 497 struct dynevent_cmd {
 498         struct seq_buf          seq;
 499         const char              *event_name;
 500         unsigned int            n_fields;
 501         enum dynevent_type      type;
 502         dynevent_create_fn_t    run_command;
 503         void                    *private_data;
 504 };
 505
 506 extern int dynevent_create(struct dynevent_cmd *cmd);
 507
 508 extern int synth_event_delete(const char *name);
 509
 510 extern void synth_event_cmd_init(struct dynevent_cmd *cmd,
 511                                  char *buf, int maxlen);
 512
 513 extern int __synth_event_gen_cmd_start(struct dynevent_cmd *cmd,
 514                                        const char *name,
 515                                        struct module *mod, ...);
 516
 517 #define synth_event_gen_cmd_start(cmd, name, mod, ...)  \
 518         __synth_event_gen_cmd_start(cmd, name, mod, ## __VA_ARGS__, NULL)
 519
 520 struct synth_field_desc {
 521         const char *type;
 522         const char *name;
 523 };
 524
 525 extern int synth_event_gen_cmd_array_start(struct dynevent_cmd *cmd,
 526                                            const char *name,
 527                                            struct module *mod,
 528                                            struct synth_field_desc *fields,
 529                                            unsigned int n_fields);
 530 extern int synth_event_create(const char *name,
 531                               struct synth_field_desc *fields,
 532                               unsigned int n_fields, struct module *mod);
 533
 534 extern int synth_event_add_field(struct dynevent_cmd *cmd,
 535                                  const char *type,
 536                                  const char *name);
 537 extern int synth_event_add_field_str(struct dynevent_cmd *cmd,
 538                                      const char *type_name);
 539 extern int synth_event_add_fields(struct dynevent_cmd *cmd,
 540                                   struct synth_field_desc *fields,
 541                                   unsigned int n_fields);
 542
 543 #define synth_event_gen_cmd_end(cmd)    \
 544         dynevent_create(cmd)
 545
 546 struct synth_event;
 547
 548 struct synth_event_trace_state {
 549         struct trace_event_buffer fbuffer;
 550         struct synth_trace_event *entry;
 551         struct trace_buffer *buffer;
 552         struct synth_event *event;
 553         unsigned int cur_field;
 554         unsigned int n_u64;
 555         bool disabled;
 556         bool add_next;
 557         bool add_name;
 558 };
 559
 560 extern int synth_event_trace(struct trace_event_file *file,
 561                              unsigned int n_vals, ...);
 562 extern int synth_event_trace_array(struct trace_event_file *file, u64 *vals,
 563                                    unsigned int n_vals);
 564 extern int synth_event_trace_start(struct trace_event_file *file,
 565                                    struct synth_event_trace_state *trace_state);
 566 extern int synth_event_add_next_val(u64 val,
 567                                     struct synth_event_trace_state *trace_state);
 568 extern int synth_event_add_val(const char *field_name, u64 val,
 569                                struct synth_event_trace_state *trace_state);
 570 extern int synth_event_trace_end(struct synth_event_trace_state *trace_state);
 571
 572 extern int kprobe_event_delete(const char *name);
 573
 574 extern void kprobe_event_cmd_init(struct dynevent_cmd *cmd,
 575                                   char *buf, int maxlen);
 576
 577 #define kprobe_event_gen_cmd_start(cmd, name, loc, ...)                 \
 578         __kprobe_event_gen_cmd_start(cmd, false, name, loc, ## __VA_ARGS__, NULL)
 579
 580 #define kretprobe_event_gen_cmd_start(cmd, name, loc, ...)              \
 581         __kprobe_event_gen_cmd_start(cmd, true, name, loc, ## __VA_ARGS__, NULL)
 582
 583 extern int __kprobe_event_gen_cmd_start(struct dynevent_cmd *cmd,
 584                                         bool kretprobe,
 585                                         const char *name,
 586                                         const char *loc, ...);
 587
 588 #define kprobe_event_add_fields(cmd, ...)       \
 589         __kprobe_event_add_fields(cmd, ## __VA_ARGS__, NULL)
 590
 591 #define kprobe_event_add_field(cmd, field)      \
 592         __kprobe_event_add_fields(cmd, field, NULL)
 593
 594 extern int __kprobe_event_add_fields(struct dynevent_cmd *cmd, ...);
 595
 596 #define kprobe_event_gen_cmd_end(cmd)           \
 597         dynevent_create(cmd)
 598
 599 #define kretprobe_event_gen_cmd_end(cmd)        \
 600         dynevent_create(cmd)
 601
 602 /*
 603  * Event file flags:
 604  *  ENABLED       - The event is enabled
 605  *  RECORDED_CMD  - The comms should be recorded at sched_switch
 606  *  RECORDED_TGID - The tgids should be recorded at sched_switch
 607  *  FILTERED      - The event has a filter attached
 608  *  NO_SET_FILTER - Set when filter has error and is to be ignored
 609  *  SOFT_MODE     - The event is enabled/disabled by SOFT_DISABLED
 610  *  SOFT_DISABLED - When set, do not trace the event (even though its
 611  *                   tracepoint may be enabled)
 612  *  TRIGGER_MODE  - When set, invoke the triggers associated with the event
 613  *  TRIGGER_COND  - When set, one or more triggers has an associated filter
 614  *  PID_FILTER    - When set, the event is filtered based on pid
 615  *  WAS_ENABLED   - Set when enabled to know to clear trace on module removal
 616  */
 617 enum {
 618         EVENT_FILE_FL_ENABLED           = (1 << EVENT_FILE_FL_ENABLED_BIT),
 619         EVENT_FILE_FL_RECORDED_CMD      = (1 << EVENT_FILE_FL_RECORDED_CMD_BIT),
 620         EVENT_FILE_FL_RECORDED_TGID     = (1 << EVENT_FILE_FL_RECORDED_TGID_BIT),
 621         EVENT_FILE_FL_FILTERED          = (1 << EVENT_FILE_FL_FILTERED_BIT),
 622         EVENT_FILE_FL_NO_SET_FILTER     = (1 << EVENT_FILE_FL_NO_SET_FILTER_BIT),
 623         EVENT_FILE_FL_SOFT_MODE         = (1 << EVENT_FILE_FL_SOFT_MODE_BIT),
 624         EVENT_FILE_FL_SOFT_DISABLED     = (1 << EVENT_FILE_FL_SOFT_DISABLED_BIT),
 625         EVENT_FILE_FL_TRIGGER_MODE      = (1 << EVENT_FILE_FL_TRIGGER_MODE_BIT),
 626         EVENT_FILE_FL_TRIGGER_COND      = (1 << EVENT_FILE_FL_TRIGGER_COND_BIT),
 627         EVENT_FILE_FL_PID_FILTER        = (1 << EVENT_FILE_FL_PID_FILTER_BIT),
 628         EVENT_FILE_FL_WAS_ENABLED       = (1 << EVENT_FILE_FL_WAS_ENABLED_BIT),
 629 };
 630
 631 struct trace_event_file {
 632         struct list_head                list;
 633         struct trace_event_call         *event_call;
 634         struct event_filter __rcu       *filter;
 635         struct dentry                   *dir;
 636         struct trace_array              *tr;
 637         struct trace_subsystem_dir      *system;
 638         struct list_head                triggers;
 639
 640         /*
 641          * 32 bit flags:
 642          *   bit 0:             enabled
 643          *   bit 1:             enabled cmd record
 644          *   bit 2:             enable/disable with the soft disable bit
 645          *   bit 3:             soft disabled
 646          *   bit 4:             trigger enabled
 647          *
 648          * Note: The bits must be set atomically to prevent races
 649          * from other writers. Reads of flags do not need to be in
 650          * sync as they occur in critical sections. But the way flags
 651          * is currently used, these changes do not affect the code
 652          * except that when a change is made, it may have a slight
 653          * delay in propagating the changes to other CPUs due to
 654          * caching and such. Which is mostly OK ;-)
 655          */
 656         unsigned long           flags;
 657         atomic_t                sm_ref; /* soft-mode reference counter */
 658         atomic_t                tm_ref; /* trigger-mode reference counter */
 659 };
 660
 661 #define __TRACE_EVENT_FLAGS(name, value)                                \
 662         static int __init trace_init_flags_##name(void)                 \
 663         {                                                               \
 664                 event_##name.flags |= value;                            \
 665                 return 0;                                               \
 666         }                                                               \
 667         early_initcall(trace_init_flags_##name);
 668
 669 #define __TRACE_EVENT_PERF_PERM(name, expr...)                          \
 670         static int perf_perm_##name(struct trace_event_call *tp_event, \
 671                                     struct perf_event *p_event)         \
 672         {                                                               \
 673                 return ({ expr; });                                     \
 674         }                                                               \
 675         static int __init trace_init_perf_perm_##name(void)             \
 676         {                                                               \
 677                 event_##name.perf_perm = &perf_perm_##name;             \
 678                 return 0;                                               \
 679         }                                                               \
 680         early_initcall(trace_init_perf_perm_##name);
 681
 682 #define PERF_MAX_TRACE_SIZE     8192
 683
 684 #define MAX_FILTER_STR_VAL      256U    /* Should handle KSYM_SYMBOL_LEN */
 685
 686 enum event_trigger_type {
 687         ETT_NONE                = (0),
 688         ETT_TRACE_ONOFF         = (1 << 0),
 689         ETT_SNAPSHOT            = (1 << 1),
 690         ETT_STACKTRACE          = (1 << 2),
 691         ETT_EVENT_ENABLE        = (1 << 3),
 692         ETT_EVENT_HIST          = (1 << 4),
 693         ETT_HIST_ENABLE         = (1 << 5),
 694         ETT_EVENT_EPROBE        = (1 << 6),
 695 };
 696
 697 extern int filter_match_preds(struct event_filter *filter, void *rec);
 698
 699 extern enum event_trigger_type
 700 event_triggers_call(struct trace_event_file *file,
 701                     struct trace_buffer *buffer, void *rec,
 702                     struct ring_buffer_event *event);
 703 extern void
 704 event_triggers_post_call(struct trace_event_file *file,
 705                          enum event_trigger_type tt);
 706
 707 bool trace_event_ignore_this_pid(struct trace_event_file *trace_file);
 708
 709 bool __trace_trigger_soft_disabled(struct trace_event_file *file);
 710
 711 /**
 712  * trace_trigger_soft_disabled - do triggers and test if soft disabled
 713  * @file: The file pointer of the event to test
 714  *
 715  * If any triggers without filters are attached to this event, they
 716  * will be called here. If the event is soft disabled and has no
 717  * triggers that require testing the fields, it will return true,
 718  * otherwise false.
 719  */
 720 static __always_inline bool
 721 trace_trigger_soft_disabled(struct trace_event_file *file)
 722 {
 723         unsigned long eflags = file->flags;
 724
 725         if (likely(!(eflags & (EVENT_FILE_FL_TRIGGER_MODE |
 726                                EVENT_FILE_FL_SOFT_DISABLED |
 727                                EVENT_FILE_FL_PID_FILTER))))
 728                 return false;
 729
 730         if (likely(eflags & EVENT_FILE_FL_TRIGGER_COND))
 731                 return false;
 732
 733         return __trace_trigger_soft_disabled(file);
 734 }
 735
 736 #ifdef CONFIG_BPF_EVENTS
 737 unsigned int trace_call_bpf(struct trace_event_call *call, void *ctx);
 738 int perf_event_attach_bpf_prog(struct perf_event *event, struct bpf_prog *prog, u64 bpf_cookie);
 739 void perf_event_detach_bpf_prog(struct perf_event *event);
 740 int perf_event_query_prog_array(struct perf_event *event, void __user *info);
 741 int bpf_probe_register(struct bpf_raw_event_map *btp, struct bpf_prog *prog);
 742 int bpf_probe_unregister(struct bpf_raw_event_map *btp, struct bpf_prog *prog);
 743 struct bpf_raw_event_map *bpf_get_raw_tracepoint(const char *name);
 744 void bpf_put_raw_tracepoint(struct bpf_raw_event_map *btp);
 745 int bpf_get_perf_event_info(const struct perf_event *event, u32 *prog_id,
 746                             u32 *fd_type, const char **buf,
 747                             u64 *probe_offset, u64 *probe_addr);
 748 #else
 749 static inline unsigned int trace_call_bpf(struct trace_event_call *call, void *ctx)
 750 {
 751         return 1;
 752 }
 753
 754 static inline int
 755 perf_event_attach_bpf_prog(struct perf_event *event, struct bpf_prog *prog, u64 bpf_cookie)
 756 {
 757         return -EOPNOTSUPP;
 758 }
 759
 760 static inline void perf_event_detach_bpf_prog(struct perf_event *event) { }
 761
 762 static inline int
 763 perf_event_query_prog_array(struct perf_event *event, void __user *info)
 764 {
 765         return -EOPNOTSUPP;
 766 }
 767 static inline int bpf_probe_register(struct bpf_raw_event_map *btp, struct bpf_prog *p)
 768 {
 769         return -EOPNOTSUPP;
 770 }
 771 static inline int bpf_probe_unregister(struct bpf_raw_event_map *btp, struct bpf_prog *p)
 772 {
 773         return -EOPNOTSUPP;
 774 }
 775 static inline struct bpf_raw_event_map *bpf_get_raw_tracepoint(const char *name)
 776 {
 777         return NULL;
 778 }
 779 static inline void bpf_put_raw_tracepoint(struct bpf_raw_event_map *btp)
 780 {
 781 }
 782 static inline int bpf_get_perf_event_info(const struct perf_event *event,
 783                                           u32 *prog_id, u32 *fd_type,
 784                                           const char **buf, u64 *probe_offset,
 785                                           u64 *probe_addr)
 786 {
 787         return -EOPNOTSUPP;
 788 }
 789 #endif
 790
 791 enum {
 792         FILTER_OTHER = 0,
 793         FILTER_STATIC_STRING,
 794         FILTER_DYN_STRING,
 795         FILTER_RDYN_STRING,
 796         FILTER_PTR_STRING,
 797         FILTER_TRACE_FN,
 798         FILTER_COMM,
 799         FILTER_CPU,
 800 };
 801
 802 extern int trace_event_raw_init(struct trace_event_call *call);
 803 extern int trace_define_field(struct trace_event_call *call, const char *type,
 804                               const char *name, int offset, int size,
 805                               int is_signed, int filter_type);
 806 extern int trace_add_event_call(struct trace_event_call *call);
 807 extern int trace_remove_event_call(struct trace_event_call *call);
 808 extern int trace_event_get_offsets(struct trace_event_call *call);
 809
 810 #define is_signed_type(type)    (((type)(-1)) < (type)1)
 811
 812 int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
 813 int trace_set_clr_event(const char *system, const char *event, int set);
 814 int trace_array_set_clr_event(struct trace_array *tr, const char *system,
 815                 const char *event, bool enable);
 816 /*
 817  * The double __builtin_constant_p is because gcc will give us an error
 818  * if we try to allocate the static variable to fmt if it is not a
 819  * constant. Even with the outer if statement optimizing out.
 820  */
 821 #define event_trace_printk(ip, fmt, args...)                            \
 822 do {                                                                    \
 823         __trace_printk_check_format(fmt, ##args);                       \
 824         tracing_record_cmdline(current);                                \
 825         if (__builtin_constant_p(fmt)) {                                \
 826                 static const char *trace_printk_fmt                     \
 827                   __section("__trace_printk_fmt") =                     \
 828                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 829                                                                         \
 830                 __trace_bprintk(ip, trace_printk_fmt, ##args);          \
 831         } else                                                          \
 832                 __trace_printk(ip, fmt, ##args);                        \
 833 } while (0)
 834
 835 #ifdef CONFIG_PERF_EVENTS
 836 struct perf_event;
 837
 838 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
 839 DECLARE_PER_CPU(int, bpf_kprobe_override);
 840
 841 extern int  perf_trace_init(struct perf_event *event);
 842 extern void perf_trace_destroy(struct perf_event *event);
 843 extern int  perf_trace_add(struct perf_event *event, int flags);
 844 extern void perf_trace_del(struct perf_event *event, int flags);
 845 #ifdef CONFIG_KPROBE_EVENTS
 846 extern int  perf_kprobe_init(struct perf_event *event, bool is_retprobe);
 847 extern void perf_kprobe_destroy(struct perf_event *event);
 848 extern int bpf_get_kprobe_info(const struct perf_event *event,
 849                                u32 *fd_type, const char **symbol,
 850                                u64 *probe_offset, u64 *probe_addr,
 851                                bool perf_type_tracepoint);
 852 #endif
 853 #ifdef CONFIG_UPROBE_EVENTS
 854 extern int  perf_uprobe_init(struct perf_event *event,
 855                              unsigned long ref_ctr_offset, bool is_retprobe);
 856 extern void perf_uprobe_destroy(struct perf_event *event);
 857 extern int bpf_get_uprobe_info(const struct perf_event *event,
 858                                u32 *fd_type, const char **filename,
 859                                u64 *probe_offset, bool perf_type_tracepoint);
 860 #endif
 861 extern int  ftrace_profile_set_filter(struct perf_event *event, int event_id,
 862                                      char *filter_str);
 863 extern void ftrace_profile_free_filter(struct perf_event *event);
 864 void perf_trace_buf_update(void *record, u16 type);
 865 void *perf_trace_buf_alloc(int size, struct pt_regs **regs, int *rctxp);
 866
 867 int perf_event_set_bpf_prog(struct perf_event *event, struct bpf_prog *prog, u64 bpf_cookie);
 868 void perf_event_free_bpf_prog(struct perf_event *event);
 869
 870 void bpf_trace_run1(struct bpf_prog *prog, u64 arg1);
 871 void bpf_trace_run2(struct bpf_prog *prog, u64 arg1, u64 arg2);
 872 void bpf_trace_run3(struct bpf_prog *prog, u64 arg1, u64 arg2,
 873                     u64 arg3);
 874 void bpf_trace_run4(struct bpf_prog *prog, u64 arg1, u64 arg2,
 875                     u64 arg3, u64 arg4);
 876 void bpf_trace_run5(struct bpf_prog *prog, u64 arg1, u64 arg2,
 877                     u64 arg3, u64 arg4, u64 arg5);
 878 void bpf_trace_run6(struct bpf_prog *prog, u64 arg1, u64 arg2,
 879                     u64 arg3, u64 arg4, u64 arg5, u64 arg6);
 880 void bpf_trace_run7(struct bpf_prog *prog, u64 arg1, u64 arg2,
 881                     u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7);
 882 void bpf_trace_run8(struct bpf_prog *prog, u64 arg1, u64 arg2,
 883                     u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 884                     u64 arg8);
 885 void bpf_trace_run9(struct bpf_prog *prog, u64 arg1, u64 arg2,
 886                     u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 887                     u64 arg8, u64 arg9);
 888 void bpf_trace_run10(struct bpf_prog *prog, u64 arg1, u64 arg2,
 889                      u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 890                      u64 arg8, u64 arg9, u64 arg10);
 891 void bpf_trace_run11(struct bpf_prog *prog, u64 arg1, u64 arg2,
 892                      u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 893                      u64 arg8, u64 arg9, u64 arg10, u64 arg11);
 894 void bpf_trace_run12(struct bpf_prog *prog, u64 arg1, u64 arg2,
 895                      u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 896                      u64 arg8, u64 arg9, u64 arg10, u64 arg11, u64 arg12);
 897 void perf_trace_run_bpf_submit(void *raw_data, int size, int rctx,
 898                                struct trace_event_call *call, u64 count,
 899                                struct pt_regs *regs, struct hlist_head *head,
 900                                struct task_struct *task);
 901
 902 static inline void
 903 perf_trace_buf_submit(void *raw_data, int size, int rctx, u16 type,
 904                        u64 count, struct pt_regs *regs, void *head,
 905                        struct task_struct *task)
 906 {
 907         perf_tp_event(type, count, raw_data, size, regs, head, rctx, task);
 908 }
 909
 910 #endif
 911
 912 #endif /* _LINUX_TRACE_EVENT_H */
 913
 914 /*
 915  * Note: we keep the TRACE_CUSTOM_EVENT outside the include file ifdef protection.
 916  *  This is due to the way trace custom events work. If a file includes two
 917  *  trace event headers under one "CREATE_CUSTOM_TRACE_EVENTS" the first include
 918  *  will override the TRACE_CUSTOM_EVENT and break the second include.
 919  */
 920
 921 #ifndef TRACE_CUSTOM_EVENT
 922
 923 #define DECLARE_CUSTOM_EVENT_CLASS(name, proto, args, tstruct, assign, print)
 924 #define DEFINE_CUSTOM_EVENT(template, name, proto, args)
 925 #define TRACE_CUSTOM_EVENT(name, proto, args, struct, assign, print)
 926
 927 #endif /* ifdef TRACE_CUSTOM_EVENT (see note above) */