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         struct seq_buf          seq;
 371         const char              *event_name;
 372         unsigned int            n_fields;
 373         enum dynevent_type      type;
 374         dynevent_create_fn_t    run_command;
 375         void                    *private_data;
 376 };
 377
 378 extern int dynevent_create(struct dynevent_cmd *cmd);
 379
 380 extern int synth_event_delete(const char *name);
 381
 382 extern void synth_event_cmd_init(struct dynevent_cmd *cmd,
 383                                  char *buf, int maxlen);
 384
 385 extern int __synth_event_gen_cmd_start(struct dynevent_cmd *cmd,
 386                                        const char *name,
 387                                        struct module *mod, ...);
 388
 389 #define synth_event_gen_cmd_start(cmd, name, mod, ...)  \
 390         __synth_event_gen_cmd_start(cmd, name, mod, ## __VA_ARGS__, NULL)
 391
 392 struct synth_field_desc {
 393         const char *type;
 394         const char *name;
 395 };
 396
 397 extern int synth_event_gen_cmd_array_start(struct dynevent_cmd *cmd,
 398                                            const char *name,
 399                                            struct module *mod,
 400                                            struct synth_field_desc *fields,
 401                                            unsigned int n_fields);
 402 extern int synth_event_create(const char *name,
 403                               struct synth_field_desc *fields,
 404                               unsigned int n_fields, struct module *mod);
 405
 406 extern int synth_event_add_field(struct dynevent_cmd *cmd,
 407                                  const char *type,
 408                                  const char *name);
 409 extern int synth_event_add_field_str(struct dynevent_cmd *cmd,
 410                                      const char *type_name);
 411 extern int synth_event_add_fields(struct dynevent_cmd *cmd,
 412                                   struct synth_field_desc *fields,
 413                                   unsigned int n_fields);
 414
 415 #define synth_event_gen_cmd_end(cmd)    \
 416         dynevent_create(cmd)
 417
 418 struct synth_event;
 419
 420 struct synth_event_trace_state {
 421         struct trace_event_buffer fbuffer;
 422         struct synth_trace_event *entry;
 423         struct trace_buffer *buffer;
 424         struct synth_event *event;
 425         unsigned int cur_field;
 426         unsigned int n_u64;
 427         bool enabled;
 428         bool add_next;
 429         bool add_name;
 430 };
 431
 432 extern int synth_event_trace(struct trace_event_file *file,
 433                              unsigned int n_vals, ...);
 434 extern int synth_event_trace_array(struct trace_event_file *file, u64 *vals,
 435                                    unsigned int n_vals);
 436 extern int synth_event_trace_start(struct trace_event_file *file,
 437                                    struct synth_event_trace_state *trace_state);
 438 extern int synth_event_add_next_val(u64 val,
 439                                     struct synth_event_trace_state *trace_state);
 440 extern int synth_event_add_val(const char *field_name, u64 val,
 441                                struct synth_event_trace_state *trace_state);
 442 extern int synth_event_trace_end(struct synth_event_trace_state *trace_state);
 443
 444 extern int kprobe_event_delete(const char *name);
 445
 446 extern void kprobe_event_cmd_init(struct dynevent_cmd *cmd,
 447                                   char *buf, int maxlen);
 448
 449 #define kprobe_event_gen_cmd_start(cmd, name, loc, ...)                 \
 450         __kprobe_event_gen_cmd_start(cmd, false, name, loc, ## __VA_ARGS__, NULL)
 451
 452 #define kretprobe_event_gen_cmd_start(cmd, name, loc, ...)              \
 453         __kprobe_event_gen_cmd_start(cmd, true, name, loc, ## __VA_ARGS__, NULL)
 454
 455 extern int __kprobe_event_gen_cmd_start(struct dynevent_cmd *cmd,
 456                                         bool kretprobe,
 457                                         const char *name,
 458                                         const char *loc, ...);
 459
 460 #define kprobe_event_add_fields(cmd, ...)       \
 461         __kprobe_event_add_fields(cmd, ## __VA_ARGS__, NULL)
 462
 463 #define kprobe_event_add_field(cmd, field)      \
 464         __kprobe_event_add_fields(cmd, field, NULL)
 465
 466 extern int __kprobe_event_add_fields(struct dynevent_cmd *cmd, ...);
 467
 468 #define kprobe_event_gen_cmd_end(cmd)           \
 469         dynevent_create(cmd)
 470
 471 #define kretprobe_event_gen_cmd_end(cmd)        \
 472         dynevent_create(cmd)
 473
 474 /*
 475  * Event file flags:
 476  *  ENABLED       - The event is enabled
 477  *  RECORDED_CMD  - The comms should be recorded at sched_switch
 478  *  RECORDED_TGID - The tgids should be recorded at sched_switch
 479  *  FILTERED      - The event has a filter attached
 480  *  NO_SET_FILTER - Set when filter has error and is to be ignored
 481  *  SOFT_MODE     - The event is enabled/disabled by SOFT_DISABLED
 482  *  SOFT_DISABLED - When set, do not trace the event (even though its
 483  *                   tracepoint may be enabled)
 484  *  TRIGGER_MODE  - When set, invoke the triggers associated with the event
 485  *  TRIGGER_COND  - When set, one or more triggers has an associated filter
 486  *  PID_FILTER    - When set, the event is filtered based on pid
 487  *  WAS_ENABLED   - Set when enabled to know to clear trace on module removal
 488  */
 489 enum {
 490         EVENT_FILE_FL_ENABLED           = (1 << EVENT_FILE_FL_ENABLED_BIT),
 491         EVENT_FILE_FL_RECORDED_CMD      = (1 << EVENT_FILE_FL_RECORDED_CMD_BIT),
 492         EVENT_FILE_FL_RECORDED_TGID     = (1 << EVENT_FILE_FL_RECORDED_TGID_BIT),
 493         EVENT_FILE_FL_FILTERED          = (1 << EVENT_FILE_FL_FILTERED_BIT),
 494         EVENT_FILE_FL_NO_SET_FILTER     = (1 << EVENT_FILE_FL_NO_SET_FILTER_BIT),
 495         EVENT_FILE_FL_SOFT_MODE         = (1 << EVENT_FILE_FL_SOFT_MODE_BIT),
 496         EVENT_FILE_FL_SOFT_DISABLED     = (1 << EVENT_FILE_FL_SOFT_DISABLED_BIT),
 497         EVENT_FILE_FL_TRIGGER_MODE      = (1 << EVENT_FILE_FL_TRIGGER_MODE_BIT),
 498         EVENT_FILE_FL_TRIGGER_COND      = (1 << EVENT_FILE_FL_TRIGGER_COND_BIT),
 499         EVENT_FILE_FL_PID_FILTER        = (1 << EVENT_FILE_FL_PID_FILTER_BIT),
 500         EVENT_FILE_FL_WAS_ENABLED       = (1 << EVENT_FILE_FL_WAS_ENABLED_BIT),
 501 };
 502
 503 struct trace_event_file {
 504         struct list_head                list;
 505         struct trace_event_call         *event_call;
 506         struct event_filter __rcu       *filter;
 507         struct dentry                   *dir;
 508         struct trace_array              *tr;
 509         struct trace_subsystem_dir      *system;
 510         struct list_head                triggers;
 511
 512         /*
 513          * 32 bit flags:
 514          *   bit 0:             enabled
 515          *   bit 1:             enabled cmd record
 516          *   bit 2:             enable/disable with the soft disable bit
 517          *   bit 3:             soft disabled
 518          *   bit 4:             trigger enabled
 519          *
 520          * Note: The bits must be set atomically to prevent races
 521          * from other writers. Reads of flags do not need to be in
 522          * sync as they occur in critical sections. But the way flags
 523          * is currently used, these changes do not affect the code
 524          * except that when a change is made, it may have a slight
 525          * delay in propagating the changes to other CPUs due to
 526          * caching and such. Which is mostly OK ;-)
 527          */
 528         unsigned long           flags;
 529         atomic_t                sm_ref; /* soft-mode reference counter */
 530         atomic_t                tm_ref; /* trigger-mode reference counter */
 531 };
 532
 533 #define __TRACE_EVENT_FLAGS(name, value)                                \
 534         static int __init trace_init_flags_##name(void)                 \
 535         {                                                               \
 536                 event_##name.flags |= value;                            \
 537                 return 0;                                               \
 538         }                                                               \
 539         early_initcall(trace_init_flags_##name);
 540
 541 #define __TRACE_EVENT_PERF_PERM(name, expr...)                          \
 542         static int perf_perm_##name(struct trace_event_call *tp_event, \
 543                                     struct perf_event *p_event)         \
 544         {                                                               \
 545                 return ({ expr; });                                     \
 546         }                                                               \
 547         static int __init trace_init_perf_perm_##name(void)             \
 548         {                                                               \
 549                 event_##name.perf_perm = &perf_perm_##name;             \
 550                 return 0;                                               \
 551         }                                                               \
 552         early_initcall(trace_init_perf_perm_##name);
 553
 554 #define PERF_MAX_TRACE_SIZE     2048
 555
 556 #define MAX_FILTER_STR_VAL      256     /* Should handle KSYM_SYMBOL_LEN */
 557
 558 enum event_trigger_type {
 559         ETT_NONE                = (0),
 560         ETT_TRACE_ONOFF         = (1 << 0),
 561         ETT_SNAPSHOT            = (1 << 1),
 562         ETT_STACKTRACE          = (1 << 2),
 563         ETT_EVENT_ENABLE        = (1 << 3),
 564         ETT_EVENT_HIST          = (1 << 4),
 565         ETT_HIST_ENABLE         = (1 << 5),
 566 };
 567
 568 extern int filter_match_preds(struct event_filter *filter, void *rec);
 569
 570 extern enum event_trigger_type
 571 event_triggers_call(struct trace_event_file *file, void *rec,
 572                     struct ring_buffer_event *event);
 573 extern void
 574 event_triggers_post_call(struct trace_event_file *file,
 575                          enum event_trigger_type tt);
 576
 577 bool trace_event_ignore_this_pid(struct trace_event_file *trace_file);
 578
 579 /**
 580  * trace_trigger_soft_disabled - do triggers and test if soft disabled
 581  * @file: The file pointer of the event to test
 582  *
 583  * If any triggers without filters are attached to this event, they
 584  * will be called here. If the event is soft disabled and has no
 585  * triggers that require testing the fields, it will return true,
 586  * otherwise false.
 587  */
 588 static inline bool
 589 trace_trigger_soft_disabled(struct trace_event_file *file)
 590 {
 591         unsigned long eflags = file->flags;
 592
 593         if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
 594                 if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
 595                         event_triggers_call(file, NULL, NULL);
 596                 if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
 597                         return true;
 598                 if (eflags & EVENT_FILE_FL_PID_FILTER)
 599                         return trace_event_ignore_this_pid(file);
 600         }
 601         return false;
 602 }
 603
 604 #ifdef CONFIG_BPF_EVENTS
 605 unsigned int trace_call_bpf(struct trace_event_call *call, void *ctx);
 606 int perf_event_attach_bpf_prog(struct perf_event *event, struct bpf_prog *prog);
 607 void perf_event_detach_bpf_prog(struct perf_event *event);
 608 int perf_event_query_prog_array(struct perf_event *event, void __user *info);
 609 int bpf_probe_register(struct bpf_raw_event_map *btp, struct bpf_prog *prog);
 610 int bpf_probe_unregister(struct bpf_raw_event_map *btp, struct bpf_prog *prog);
 611 struct bpf_raw_event_map *bpf_get_raw_tracepoint(const char *name);
 612 void bpf_put_raw_tracepoint(struct bpf_raw_event_map *btp);
 613 int bpf_get_perf_event_info(const struct perf_event *event, u32 *prog_id,
 614                             u32 *fd_type, const char **buf,
 615                             u64 *probe_offset, u64 *probe_addr);
 616 #else
 617 static inline unsigned int trace_call_bpf(struct trace_event_call *call, void *ctx)
 618 {
 619         return 1;
 620 }
 621
 622 static inline int
 623 perf_event_attach_bpf_prog(struct perf_event *event, struct bpf_prog *prog)
 624 {
 625         return -EOPNOTSUPP;
 626 }
 627
 628 static inline void perf_event_detach_bpf_prog(struct perf_event *event) { }
 629
 630 static inline int
 631 perf_event_query_prog_array(struct perf_event *event, void __user *info)
 632 {
 633         return -EOPNOTSUPP;
 634 }
 635 static inline int bpf_probe_register(struct bpf_raw_event_map *btp, struct bpf_prog *p)
 636 {
 637         return -EOPNOTSUPP;
 638 }
 639 static inline int bpf_probe_unregister(struct bpf_raw_event_map *btp, struct bpf_prog *p)
 640 {
 641         return -EOPNOTSUPP;
 642 }
 643 static inline struct bpf_raw_event_map *bpf_get_raw_tracepoint(const char *name)
 644 {
 645         return NULL;
 646 }
 647 static inline void bpf_put_raw_tracepoint(struct bpf_raw_event_map *btp)
 648 {
 649 }
 650 static inline int bpf_get_perf_event_info(const struct perf_event *event,
 651                                           u32 *prog_id, u32 *fd_type,
 652                                           const char **buf, u64 *probe_offset,
 653                                           u64 *probe_addr)
 654 {
 655         return -EOPNOTSUPP;
 656 }
 657 #endif
 658
 659 enum {
 660         FILTER_OTHER = 0,
 661         FILTER_STATIC_STRING,
 662         FILTER_DYN_STRING,
 663         FILTER_PTR_STRING,
 664         FILTER_TRACE_FN,
 665         FILTER_COMM,
 666         FILTER_CPU,
 667 };
 668
 669 extern int trace_event_raw_init(struct trace_event_call *call);
 670 extern int trace_define_field(struct trace_event_call *call, const char *type,
 671                               const char *name, int offset, int size,
 672                               int is_signed, int filter_type);
 673 extern int trace_add_event_call(struct trace_event_call *call);
 674 extern int trace_remove_event_call(struct trace_event_call *call);
 675 extern int trace_event_get_offsets(struct trace_event_call *call);
 676
 677 #define is_signed_type(type)    (((type)(-1)) < (type)1)
 678
 679 int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
 680 int trace_set_clr_event(const char *system, const char *event, int set);
 681 int trace_array_set_clr_event(struct trace_array *tr, const char *system,
 682                 const char *event, bool enable);
 683 /*
 684  * The double __builtin_constant_p is because gcc will give us an error
 685  * if we try to allocate the static variable to fmt if it is not a
 686  * constant. Even with the outer if statement optimizing out.
 687  */
 688 #define event_trace_printk(ip, fmt, args...)                            \
 689 do {                                                                    \
 690         __trace_printk_check_format(fmt, ##args);                       \
 691         tracing_record_cmdline(current);                                \
 692         if (__builtin_constant_p(fmt)) {                                \
 693                 static const char *trace_printk_fmt                     \
 694                   __attribute__((section("__trace_printk_fmt"))) =      \
 695                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 696                                                                         \
 697                 __trace_bprintk(ip, trace_printk_fmt, ##args);          \
 698         } else                                                          \
 699                 __trace_printk(ip, fmt, ##args);                        \
 700 } while (0)
 701
 702 #ifdef CONFIG_PERF_EVENTS
 703 struct perf_event;
 704
 705 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
 706 DECLARE_PER_CPU(int, bpf_kprobe_override);
 707
 708 extern int  perf_trace_init(struct perf_event *event);
 709 extern void perf_trace_destroy(struct perf_event *event);
 710 extern int  perf_trace_add(struct perf_event *event, int flags);
 711 extern void perf_trace_del(struct perf_event *event, int flags);
 712 #ifdef CONFIG_KPROBE_EVENTS
 713 extern int  perf_kprobe_init(struct perf_event *event, bool is_retprobe);
 714 extern void perf_kprobe_destroy(struct perf_event *event);
 715 extern int bpf_get_kprobe_info(const struct perf_event *event,
 716                                u32 *fd_type, const char **symbol,
 717                                u64 *probe_offset, u64 *probe_addr,
 718                                bool perf_type_tracepoint);
 719 #endif
 720 #ifdef CONFIG_UPROBE_EVENTS
 721 extern int  perf_uprobe_init(struct perf_event *event,
 722                              unsigned long ref_ctr_offset, bool is_retprobe);
 723 extern void perf_uprobe_destroy(struct perf_event *event);
 724 extern int bpf_get_uprobe_info(const struct perf_event *event,
 725                                u32 *fd_type, const char **filename,
 726                                u64 *probe_offset, bool perf_type_tracepoint);
 727 #endif
 728 extern int  ftrace_profile_set_filter(struct perf_event *event, int event_id,
 729                                      char *filter_str);
 730 extern void ftrace_profile_free_filter(struct perf_event *event);
 731 void perf_trace_buf_update(void *record, u16 type);
 732 void *perf_trace_buf_alloc(int size, struct pt_regs **regs, int *rctxp);
 733
 734 void bpf_trace_run1(struct bpf_prog *prog, u64 arg1);
 735 void bpf_trace_run2(struct bpf_prog *prog, u64 arg1, u64 arg2);
 736 void bpf_trace_run3(struct bpf_prog *prog, u64 arg1, u64 arg2,
 737                     u64 arg3);
 738 void bpf_trace_run4(struct bpf_prog *prog, u64 arg1, u64 arg2,
 739                     u64 arg3, u64 arg4);
 740 void bpf_trace_run5(struct bpf_prog *prog, u64 arg1, u64 arg2,
 741                     u64 arg3, u64 arg4, u64 arg5);
 742 void bpf_trace_run6(struct bpf_prog *prog, u64 arg1, u64 arg2,
 743                     u64 arg3, u64 arg4, u64 arg5, u64 arg6);
 744 void bpf_trace_run7(struct bpf_prog *prog, u64 arg1, u64 arg2,
 745                     u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7);
 746 void bpf_trace_run8(struct bpf_prog *prog, u64 arg1, u64 arg2,
 747                     u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 748                     u64 arg8);
 749 void bpf_trace_run9(struct bpf_prog *prog, u64 arg1, u64 arg2,
 750                     u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 751                     u64 arg8, u64 arg9);
 752 void bpf_trace_run10(struct bpf_prog *prog, u64 arg1, u64 arg2,
 753                      u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 754                      u64 arg8, u64 arg9, u64 arg10);
 755 void bpf_trace_run11(struct bpf_prog *prog, u64 arg1, u64 arg2,
 756                      u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 757                      u64 arg8, u64 arg9, u64 arg10, u64 arg11);
 758 void bpf_trace_run12(struct bpf_prog *prog, u64 arg1, u64 arg2,
 759                      u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
 760                      u64 arg8, u64 arg9, u64 arg10, u64 arg11, u64 arg12);
 761 void perf_trace_run_bpf_submit(void *raw_data, int size, int rctx,
 762                                struct trace_event_call *call, u64 count,
 763                                struct pt_regs *regs, struct hlist_head *head,
 764                                struct task_struct *task);
 765
 766 static inline void
 767 perf_trace_buf_submit(void *raw_data, int size, int rctx, u16 type,
 768                        u64 count, struct pt_regs *regs, void *head,
 769                        struct task_struct *task)
 770 {
 771         perf_tp_event(type, count, raw_data, size, regs, head, rctx, task);
 772 }
 773
 774 #endif
 775
 776 #endif /* _LINUX_TRACE_EVENT_H */