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