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