Documentation/trace/user_events.rst

   1 =========================================
   2 user_events: User-based Event Tracing
   3 =========================================
   4
   5 :Author: Beau Belgrave
   6
   7 Overview
   8 --------
   9 User based trace events allow user processes to create events and trace data
  10 that can be viewed via existing tools, such as ftrace and perf.
  11 To enable this feature, build your kernel with CONFIG_USER_EVENTS=y.
  12
  13 Programs can view status of the events via
  14 /sys/kernel/debug/tracing/user_events_status and can both register and write
  15 data out via /sys/kernel/debug/tracing/user_events_data.
  16
  17 Programs can also use /sys/kernel/debug/tracing/dynamic_events to register and
  18 delete user based events via the u: prefix. The format of the command to
  19 dynamic_events is the same as the ioctl with the u: prefix applied.
  20
  21 Typically programs will register a set of events that they wish to expose to
  22 tools that can read trace_events (such as ftrace and perf). The registration
  23 process gives back two ints to the program for each event. The first int is the
  24 status index. This index describes which byte in the
  25 /sys/kernel/debug/tracing/user_events_status file represents this event. The
  26 second int is the write index. This index describes the data when a write() or
  27 writev() is called on the /sys/kernel/debug/tracing/user_events_data file.
  28
  29 The structures referenced in this document are contained with the
  30 /include/uap/linux/user_events.h file in the source tree.
  31
  32 **NOTE:** *Both user_events_status and user_events_data are under the tracefs
  33 filesystem and may be mounted at different paths than above.*
  34
  35 Registering
  36 -----------
  37 Registering within a user process is done via ioctl() out to the
  38 /sys/kernel/debug/tracing/user_events_data file. The command to issue is
  39 DIAG_IOCSREG.
  40
  41 This command takes a struct user_reg as an argument::
  42
  43   struct user_reg {
  44         u32 size;
  45         u64 name_args;
  46         u32 status_index;
  47         u32 write_index;
  48   };
  49
  50 The struct user_reg requires two inputs, the first is the size of the structure
  51 to ensure forward and backward compatibility. The second is the command string
  52 to issue for registering. Upon success two outputs are set, the status index
  53 and the write index.
  54
  55 User based events show up under tracefs like any other event under the
  56 subsystem named "user_events". This means tools that wish to attach to the
  57 events need to use /sys/kernel/debug/tracing/events/user_events/[name]/enable
  58 or perf record -e user_events:[name] when attaching/recording.
  59
  60 **NOTE:** *The write_index returned is only valid for the FD that was used*
  61
  62 Command Format
  63 ^^^^^^^^^^^^^^
  64 The command string format is as follows::
  65
  66   name[:FLAG1[,FLAG2...]] [Field1[;Field2...]]
  67
  68 Supported Flags
  69 ^^^^^^^^^^^^^^^
  70 None yet
  71
  72 Field Format
  73 ^^^^^^^^^^^^
  74 ::
  75
  76   type name [size]
  77
  78 Basic types are supported (__data_loc, u32, u64, int, char, char[20], etc).
  79 User programs are encouraged to use clearly sized types like u32.
  80
  81 **NOTE:** *Long is not supported since size can vary between user and kernel.*
  82
  83 The size is only valid for types that start with a struct prefix.
  84 This allows user programs to describe custom structs out to tools, if required.
  85
  86 For example, a struct in C that looks like this::
  87
  88   struct mytype {
  89     char data[20];
  90   };
  91
  92 Would be represented by the following field::
  93
  94   struct mytype myname 20
  95
  96 Deleting
  97 -----------
  98 Deleting an event from within a user process is done via ioctl() out to the
  99 /sys/kernel/debug/tracing/user_events_data file. The command to issue is
 100 DIAG_IOCSDEL.
 101
 102 This command only requires a single string specifying the event to delete by
 103 its name. Delete will only succeed if there are no references left to the
 104 event (in both user and kernel space). User programs should use a separate file
 105 to request deletes than the one used for registration due to this.
 106
 107 Status
 108 ------
 109 When tools attach/record user based events the status of the event is updated
 110 in realtime. This allows user programs to only incur the cost of the write() or
 111 writev() calls when something is actively attached to the event.
 112
 113 User programs call mmap() on /sys/kernel/debug/tracing/user_events_status to
 114 check the status for each event that is registered. The byte to check in the
 115 file is given back after the register ioctl() via user_reg.status_index.
 116 Currently the size of user_events_status is a single page, however, custom
 117 kernel configurations can change this size to allow more user based events. In
 118 all cases the size of the file is a multiple of a page size.
 119
 120 For example, if the register ioctl() gives back a status_index of 3 you would
 121 check byte 3 of the returned mmap data to see if anything is attached to that
 122 event.
 123
 124 Administrators can easily check the status of all registered events by reading
 125 the user_events_status file directly via a terminal. The output is as follows::
 126
 127   Byte:Name [# Comments]
 128   ...
 129
 130   Active: ActiveCount
 131   Busy: BusyCount
 132   Max: MaxCount
 133
 134 For example, on a system that has a single event the output looks like this::
 135
 136   1:test
 137
 138   Active: 1
 139   Busy: 0
 140   Max: 4096
 141
 142 If a user enables the user event via ftrace, the output would change to this::
 143
 144   1:test # Used by ftrace
 145
 146   Active: 1
 147   Busy: 1
 148   Max: 4096
 149
 150 **NOTE:** *A status index of 0 will never be returned. This allows user
 151 programs to have an index that can be used on error cases.*
 152
 153 Status Bits
 154 ^^^^^^^^^^^
 155 The byte being checked will be non-zero if anything is attached. Programs can
 156 check specific bits in the byte to see what mechanism has been attached.
 157
 158 The following values are defined to aid in checking what has been attached:
 159
 160 **EVENT_STATUS_FTRACE** - Bit set if ftrace has been attached (Bit 0).
 161
 162 **EVENT_STATUS_PERF** - Bit set if perf has been attached (Bit 1).
 163
 164 Writing Data
 165 ------------
 166 After registering an event the same fd that was used to register can be used
 167 to write an entry for that event. The write_index returned must be at the start
 168 of the data, then the remaining data is treated as the payload of the event.
 169
 170 For example, if write_index returned was 1 and I wanted to write out an int
 171 payload of the event. Then the data would have to be 8 bytes (2 ints) in size,
 172 with the first 4 bytes being equal to 1 and the last 4 bytes being equal to the
 173 value I want as the payload.
 174
 175 In memory this would look like this::
 176
 177   int index;
 178   int payload;
 179
 180 User programs might have well known structs that they wish to use to emit out
 181 as payloads. In those cases writev() can be used, with the first vector being
 182 the index and the following vector(s) being the actual event payload.
 183
 184 For example, if I have a struct like this::
 185
 186   struct payload {
 187         int src;
 188         int dst;
 189         int flags;
 190   };
 191
 192 It's advised for user programs to do the following::
 193
 194   struct iovec io[2];
 195   struct payload e;
 196
 197   io[0].iov_base = &write_index;
 198   io[0].iov_len = sizeof(write_index);
 199   io[1].iov_base = &e;
 200   io[1].iov_len = sizeof(e);
 201
 202   writev(fd, (const struct iovec*)io, 2);
 203
 204 **NOTE:** *The write_index is not emitted out into the trace being recorded.*
 205
 206 Example Code
 207 ------------
 208 See sample code in samples/user_events.