LCOV - code coverage report
Current view: top level - include/linux - trace_events.h (source / functions) Hit Total Coverage
Test: combined.info Lines: 6 23 26.1 %
Date: 2022-04-01 13:59:58 Functions: 0 1 0.0 %
Branches: 11 338 3.3 %

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

Generated by: LCOV version 1.14