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