include/lttng/event.h

   1 /*
   2  * Copyright (C) 2014 - David Goulet <dgoulet@efficios.com>
   3  *
   4  * This library is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License, version 2.1 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This library is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this library; if not, write to the Free Software Foundation,
  15  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  16  */
  17
  18 #ifndef LTTNG_EVENT_H
  19 #define LTTNG_EVENT_H
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25 #include <lttng/handle.h>
  26
  27 /*
  28  * Instrumentation type of tracing event.
  29  */
  30 enum lttng_event_type {
  31         LTTNG_EVENT_ALL                       = -1,
  32         LTTNG_EVENT_TRACEPOINT                = 0,
  33         LTTNG_EVENT_PROBE                     = 1,
  34         LTTNG_EVENT_FUNCTION                  = 2,
  35         LTTNG_EVENT_FUNCTION_ENTRY            = 3,
  36         LTTNG_EVENT_NOOP                      = 4,
  37         LTTNG_EVENT_SYSCALL                   = 5,
  38 };
  39
  40 /*
  41  * Loglevel information.
  42  */
  43 enum lttng_loglevel_type {
  44         LTTNG_EVENT_LOGLEVEL_ALL              = 0,
  45         LTTNG_EVENT_LOGLEVEL_RANGE            = 1,
  46         LTTNG_EVENT_LOGLEVEL_SINGLE           = 2,
  47 };
  48
  49 /*
  50  * Available loglevels.
  51  */
  52 enum lttng_loglevel {
  53         LTTNG_LOGLEVEL_EMERG                  = 0,
  54         LTTNG_LOGLEVEL_ALERT                  = 1,
  55         LTTNG_LOGLEVEL_CRIT                   = 2,
  56         LTTNG_LOGLEVEL_ERR                    = 3,
  57         LTTNG_LOGLEVEL_WARNING                = 4,
  58         LTTNG_LOGLEVEL_NOTICE                 = 5,
  59         LTTNG_LOGLEVEL_INFO                   = 6,
  60         LTTNG_LOGLEVEL_DEBUG_SYSTEM           = 7,
  61         LTTNG_LOGLEVEL_DEBUG_PROGRAM          = 8,
  62         LTTNG_LOGLEVEL_DEBUG_PROCESS          = 9,
  63         LTTNG_LOGLEVEL_DEBUG_MODULE           = 10,
  64         LTTNG_LOGLEVEL_DEBUG_UNIT             = 11,
  65         LTTNG_LOGLEVEL_DEBUG_FUNCTION         = 12,
  66         LTTNG_LOGLEVEL_DEBUG_LINE             = 13,
  67         LTTNG_LOGLEVEL_DEBUG                  = 14,
  68 };
  69
  70 /*
  71  * Available loglevels for the JUL domain. Those are an exact map from the
  72  * class java.util.logging.Level.
  73  */
  74 enum lttng_loglevel_jul {
  75         LTTNG_LOGLEVEL_JUL_OFF                = INT32_MAX,
  76         LTTNG_LOGLEVEL_JUL_SEVERE             = 1000,
  77         LTTNG_LOGLEVEL_JUL_WARNING            = 900,
  78         LTTNG_LOGLEVEL_JUL_INFO               = 800,
  79         LTTNG_LOGLEVEL_JUL_CONFIG             = 700,
  80         LTTNG_LOGLEVEL_JUL_FINE               = 500,
  81         LTTNG_LOGLEVEL_JUL_FINER              = 400,
  82         LTTNG_LOGLEVEL_JUL_FINEST             = 300,
  83         LTTNG_LOGLEVEL_JUL_ALL                = INT32_MIN,
  84 };
  85
  86 /*
  87  * Available loglevels for the LOG4j domain. Those are an exact map from the
  88  * class org.apache.log4j.Level.
  89  */
  90 enum lttng_loglevel_log4j {
  91         LTTNG_LOGLEVEL_LOG4J_OFF              = INT32_MAX,
  92         LTTNG_LOGLEVEL_LOG4J_FATAL            = 50000,
  93         LTTNG_LOGLEVEL_LOG4J_ERROR            = 40000,
  94         LTTNG_LOGLEVEL_LOG4J_WARN             = 30000,
  95         LTTNG_LOGLEVEL_LOG4J_INFO             = 20000,
  96         LTTNG_LOGLEVEL_LOG4J_DEBUG            = 10000,
  97         LTTNG_LOGLEVEL_LOG4J_TRACE            = 5000,
  98         LTTNG_LOGLEVEL_LOG4J_ALL              = INT32_MIN,
  99 };
 100
 101 /*
 102  * LTTng consumer mode
 103  */
 104 enum lttng_event_output {
 105         LTTNG_EVENT_SPLICE                    = 0,
 106         LTTNG_EVENT_MMAP                      = 1,
 107 };
 108
 109 /* Event context possible type */
 110 enum lttng_event_context_type {
 111         LTTNG_EVENT_CONTEXT_PID               = 0,
 112         LTTNG_EVENT_CONTEXT_PERF_COUNTER      = 1,      /* Backward compat. */
 113         LTTNG_EVENT_CONTEXT_PROCNAME          = 2,
 114         LTTNG_EVENT_CONTEXT_PRIO              = 3,
 115         LTTNG_EVENT_CONTEXT_NICE              = 4,
 116         LTTNG_EVENT_CONTEXT_VPID              = 5,
 117         LTTNG_EVENT_CONTEXT_TID               = 6,
 118         LTTNG_EVENT_CONTEXT_VTID              = 7,
 119         LTTNG_EVENT_CONTEXT_PPID              = 8,
 120         LTTNG_EVENT_CONTEXT_VPPID             = 9,
 121         LTTNG_EVENT_CONTEXT_PTHREAD_ID        = 10,
 122         LTTNG_EVENT_CONTEXT_HOSTNAME          = 11,
 123         LTTNG_EVENT_CONTEXT_IP                = 12,
 124         LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER  = 13,
 125         LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER = 14,
 126 };
 127
 128 enum lttng_event_field_type {
 129         LTTNG_EVENT_FIELD_OTHER               = 0,
 130         LTTNG_EVENT_FIELD_INTEGER             = 1,
 131         LTTNG_EVENT_FIELD_ENUM                = 2,
 132         LTTNG_EVENT_FIELD_FLOAT               = 3,
 133         LTTNG_EVENT_FIELD_STRING              = 4,
 134 };
 135
 136 /*
 137  * Perf counter attributes
 138  *
 139  * The structures should be initialized to zero before use.
 140  */
 141 #define LTTNG_PERF_EVENT_PADDING1          16
 142 struct lttng_event_perf_counter_ctx {
 143         uint32_t type;
 144         uint64_t config;
 145         char name[LTTNG_SYMBOL_NAME_LEN];
 146
 147         char padding[LTTNG_PERF_EVENT_PADDING1];
 148 };
 149
 150 /*
 151  * Event/channel context
 152  *
 153  * The structures should be initialized to zero before use.
 154  */
 155 #define LTTNG_EVENT_CONTEXT_PADDING1       16
 156 #define LTTNG_EVENT_CONTEXT_PADDING2       LTTNG_SYMBOL_NAME_LEN + 32
 157 struct lttng_event_context {
 158         enum lttng_event_context_type ctx;
 159         char padding[LTTNG_EVENT_CONTEXT_PADDING1];
 160
 161         union {
 162                 struct lttng_event_perf_counter_ctx perf_counter;
 163                 char padding[LTTNG_EVENT_CONTEXT_PADDING2];
 164         } u;
 165 };
 166
 167 /*
 168  * Event probe.
 169  *
 170  * Either addr is used or symbol_name and offset.
 171  *
 172  * The structures should be initialized to zero before use.
 173  */
 174 #define LTTNG_EVENT_PROBE_PADDING1         16
 175 struct lttng_event_probe_attr {
 176         uint64_t addr;
 177
 178         uint64_t offset;
 179         char symbol_name[LTTNG_SYMBOL_NAME_LEN];
 180
 181         char padding[LTTNG_EVENT_PROBE_PADDING1];
 182 };
 183
 184 /*
 185  * Function tracer
 186  *
 187  * The structures should be initialized to zero before use.
 188  */
 189 #define LTTNG_EVENT_FUNCTION_PADDING1      16
 190 struct lttng_event_function_attr {
 191         char symbol_name[LTTNG_SYMBOL_NAME_LEN];
 192
 193         char padding[LTTNG_EVENT_FUNCTION_PADDING1];
 194 };
 195
 196 /*
 197  * Generic lttng event
 198  *
 199  * The structures should be initialized to zero before use.
 200  */
 201 #define LTTNG_EVENT_PADDING1               14
 202 #define LTTNG_EVENT_PADDING2               LTTNG_SYMBOL_NAME_LEN + 32
 203 struct lttng_event {
 204         enum lttng_event_type type;
 205         char name[LTTNG_SYMBOL_NAME_LEN];
 206
 207         enum lttng_loglevel_type loglevel_type;
 208         int loglevel;
 209
 210         int32_t enabled;        /* Does not apply: -1 */
 211         pid_t pid;
 212         unsigned char filter;   /* filter enabled ? */
 213         unsigned char exclusion; /* exclusions added ? */
 214
 215         char padding[LTTNG_EVENT_PADDING1];
 216
 217         /* Per event type configuration */
 218         union {
 219                 struct lttng_event_probe_attr probe;
 220                 struct lttng_event_function_attr ftrace;
 221
 222                 char padding[LTTNG_EVENT_PADDING2];
 223         } attr;
 224 };
 225
 226 #define LTTNG_EVENT_FIELD_PADDING       LTTNG_SYMBOL_NAME_LEN + 32
 227 struct lttng_event_field {
 228         char field_name[LTTNG_SYMBOL_NAME_LEN];
 229         enum lttng_event_field_type type;
 230         char padding[LTTNG_EVENT_FIELD_PADDING];
 231         struct lttng_event event;
 232         int nowrite;
 233 };
 234
 235 /*
 236  * List the event(s) of a session channel.
 237  *
 238  * Both handle and channel_name CAN NOT be NULL.
 239  *
 240  * Return the size (number of entries) of the "lttng_event" array. Caller must
 241  * free events. On error a negative LTTng error code is returned.
 242  */
 243 extern int lttng_list_events(struct lttng_handle *handle,
 244                 const char *channel_name, struct lttng_event **events);
 245
 246 /*
 247  * List the available tracepoints of a specific lttng domain.
 248  *
 249  * The handle CAN NOT be NULL.
 250  *
 251  * Return the size (number of entries) of the "lttng_event" array.  Caller must
 252  * free events. On error a negative LTTng error code is returned.
 253  */
 254 extern int lttng_list_tracepoints(struct lttng_handle *handle,
 255                 struct lttng_event **events);
 256
 257 /*
 258  * List the available tracepoints fields of a specific lttng domain.
 259  *
 260  * The handle CAN NOT be NULL.
 261  *
 262  * Return the size (number of entries) of the "lttng_event_field" array.
 263  * Caller must free fields. On error a negative LTTng error code is
 264  * returned.
 265  */
 266 extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
 267                 struct lttng_event_field **fields);
 268
 269 /*
 270  * Add context to event(s) for a specific channel (or for all).
 271  *
 272  * If the channel_name is NULL and they are no channel for the domain, the
 273  * default channel is created (channel0). The context is then added on ALL
 274  * channels since no name was specified.
 275  *
 276  * The event_name is ignored since adding a context to an event is not possible
 277  * for now.
 278  *
 279  * Return 0 on success else a negative LTTng error code.
 280  */
 281 extern int lttng_add_context(struct lttng_handle *handle,
 282                 struct lttng_event_context *ctx, const char *event_name,
 283                 const char *channel_name);
 284
 285 /*
 286  * Create or enable an event (or events) for a channel.
 287  *
 288  * If the event you are trying to enable does not exist, it will be created,
 289  * else it is enabled. If channel_name is NULL, the default channel is used
 290  * (channel0).
 291  *
 292  * The handle and ev params can not be NULL.
 293  *
 294  * Return 0 on success else a negative LTTng error code.
 295  */
 296 extern int lttng_enable_event(struct lttng_handle *handle,
 297                 struct lttng_event *ev, const char *channel_name);
 298
 299 /*
 300  * Create or enable an event with a specific filter.
 301  *
 302  * If the event you are trying to enable does not exist, it will be created,
 303  * else it is enabled.
 304  * If ev is NULL, all events are enabled with that filter.
 305  * If channel_name is NULL, the default channel is used (channel0) and created
 306  * if not found.
 307  * If filter_expression is NULL, an event without associated filter is
 308  * created.
 309  *
 310  * Return 0 on success else a negative LTTng error code.
 311  */
 312 extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
 313                 struct lttng_event *event, const char *channel_name,
 314                 const char *filter_expression);
 315
 316 /*
 317  * Create or enable an event with a filter and/or exclusions.
 318  *
 319  * If the event you are trying to enable does not exist, it will be created,
 320  * else it is enabled.
 321  * If ev is NULL, all events are enabled with the filter and exclusion options.
 322  * If channel_name is NULL, the default channel is used (channel0) and created
 323  * if not found.
 324  * If filter_expression is NULL, an event without associated filter is
 325  * created.
 326  * If exclusion count is zero, the event will be created without exclusions.
 327  *
 328  * Return 0 on success else a negative LTTng error code.
 329  */
 330 extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
 331                 struct lttng_event *event, const char *channel_name,
 332                 const char *filter_expression,
 333                 int exclusion_count, char **exclusion_names);
 334
 335 /*
 336  * Disable event(s) of a channel and domain.
 337  *
 338  * If name is NULL, all events are disabled.
 339  * If channel_name is NULL, the default channel is used (channel0).
 340  *
 341  * Return 0 on success else a negative LTTng error code.
 342  */
 343 extern int lttng_disable_event(struct lttng_handle *handle,
 344                 const char *name, const char *channel_name);
 345
 346 /*
 347  * Disable event(s) of a channel and domain.
 348  *
 349  * Takes a struct lttng_event as parameter.
 350  * If channel_name is NULL, the default channel is used (channel0).
 351  *
 352  * Currently, @filter_expression must be NULL. (disabling specific
 353  * filter expressions not implemented)
 354  * Currently, only LTTNG_EVENT_ALL and LTTNG_EVENT_SYSCALL event types
 355  * are implemented for field @ev.
 356  *
 357  * Return 0 on success else a negative LTTng error code.
 358  */
 359 int lttng_disable_event_ext(struct lttng_handle *handle,
 360                 struct lttng_event *ev, const char *channel_name,
 361                 const char *filter_expression);
 362
 363 #ifdef __cplusplus
 364 }
 365 #endif
 366
 367 #endif /* LTTNG_EVENT_H */