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