Update TODO
[lttng-modules.git] / ltt-events.h
CommitLineData
11b5a3c2
MD
1#ifndef _LTT_EVENTS_H
2#define _LTT_EVENTS_H
3
4e3c1b9b
MD
4/*
5 * ltt-events.h
6 *
7 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * Holds LTTng per-session event registry.
17baffe2
MD
10 *
11 * Dual LGPL v2.1/GPL v2 license.
4e3c1b9b
MD
12 */
13
14#include <linux/list.h>
d6d808f3 15#include <linux/kprobes.h>
a864fb02 16#include "wrapper/uuid.h"
e8951e63 17#include "lttng-abi.h"
4e3c1b9b 18
9e7e4892
MD
19#undef is_signed_type
20#define is_signed_type(type) (((type)(-1)) < 0)
21
4e3c1b9b
MD
22struct ltt_channel;
23struct ltt_session;
1c25284c 24struct lib_ring_buffer_ctx;
ba1f5986 25struct perf_event;
833ad6a0 26struct perf_event_attr;
4e3c1b9b 27
c0edae1d
MD
28/* Type description */
29
30/* Update the astract_types name table in lttng-types.c along with this enum */
31enum abstract_types {
32 atype_integer,
33 atype_enum,
34 atype_array,
35 atype_sequence,
36 atype_string,
37 NR_ABSTRACT_TYPES,
38};
39
40/* Update the string_encodings name table in lttng-types.c along with this enum */
41enum lttng_string_encodings {
e0a7a7c4
MD
42 lttng_encode_none = 0,
43 lttng_encode_UTF8 = 1,
44 lttng_encode_ASCII = 2,
c0edae1d
MD
45 NR_STRING_ENCODINGS,
46};
47
48struct lttng_enum_entry {
49 unsigned long long start, end; /* start and end are inclusive */
50 const char *string;
51};
52
64c796d8 53#define __type_integer(_type, _byte_order, _base, _encoding) \
c099397a
MD
54 { \
55 .atype = atype_integer, \
56 .u.basic.integer = \
57 { \
30bdb6e4 58 .size = sizeof(_type) * CHAR_BIT, \
d793d5e1 59 .alignment = ltt_alignof(_type) * CHAR_BIT, \
c099397a
MD
60 .signedness = is_signed_type(_type), \
61 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
e0a7a7c4 62 .base = _base, \
64c796d8 63 .encoding = lttng_encode_##_encoding, \
c099397a
MD
64 }, \
65 } \
66
67struct lttng_integer_type {
68 unsigned int size; /* in bits */
69 unsigned short alignment; /* in bits */
9cccf98a
MD
70 unsigned int signedness:1,
71 reverse_byte_order:1;
e0a7a7c4
MD
72 unsigned int base; /* 2, 8, 10, 16, for pretty print */
73 enum lttng_string_encodings encoding;
c099397a
MD
74};
75
76union _lttng_basic_type {
77 struct lttng_integer_type integer;
78 struct {
79 const char *name;
80 } enumeration;
81 struct {
82 enum lttng_string_encodings encoding;
83 } string;
84};
85
86struct lttng_basic_type {
87 enum abstract_types atype;
88 union {
89 union _lttng_basic_type basic;
90 } u;
c0edae1d
MD
91};
92
93struct lttng_type {
94 enum abstract_types atype;
c0edae1d 95 union {
c099397a 96 union _lttng_basic_type basic;
c0edae1d 97 struct {
c099397a 98 struct lttng_basic_type elem_type;
c0edae1d
MD
99 unsigned int length; /* num. elems. */
100 } array;
101 struct {
c099397a
MD
102 struct lttng_basic_type length_type;
103 struct lttng_basic_type elem_type;
c0edae1d 104 } sequence;
c0edae1d 105 } u;
c099397a
MD
106};
107
108struct lttng_enum {
109 const char *name;
110 struct lttng_type container_type;
111 const struct lttng_enum_entry *entries;
112 unsigned int len;
113};
c0edae1d
MD
114
115/* Event field description */
116
117struct lttng_event_field {
118 const char *name;
f17701fb 119 struct lttng_type type;
c0edae1d
MD
120};
121
2001023e
MD
122/*
123 * We need to keep this perf counter field separately from struct
124 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
125 */
126struct lttng_perf_counter_field {
127 struct notifier_block nb;
128 int hp_enable;
129 struct perf_event_attr *attr;
130 struct perf_event **e; /* per-cpu array */
131};
132
ba1f5986 133struct lttng_ctx_field {
8070f5c0 134 struct lttng_event_field event_field;
f1676205
MD
135 size_t (*get_size)(size_t offset);
136 void (*record)(struct lttng_ctx_field *field,
137 struct lib_ring_buffer_ctx *ctx,
138 struct ltt_channel *chan);
ba1f5986 139 union {
2001023e 140 struct lttng_perf_counter_field *perf_counter;
ba1f5986 141 } u;
2dccf128 142 void (*destroy)(struct lttng_ctx_field *field);
ba1f5986
MD
143};
144
145struct lttng_ctx {
833ad6a0 146 struct lttng_ctx_field *fields;
0d1a681e 147 unsigned int nr_fields;
ba1f5986 148 unsigned int allocated_fields;
0d1a681e
MD
149};
150
151struct lttng_event_desc {
c0edae1d
MD
152 const char *name;
153 void *probe_callback;
0d1a681e
MD
154 const struct lttng_event_ctx *ctx; /* context */
155 const struct lttng_event_field *fields; /* event payload */
c0edae1d 156 unsigned int nr_fields;
dc7f600a 157 struct module *owner;
c0edae1d
MD
158};
159
85a9ca7f 160struct lttng_probe_desc {
f7bdf4db 161 const struct lttng_event_desc **event_desc;
85a9ca7f
MD
162 unsigned int nr_events;
163 struct list_head head; /* chain registered probes */
164};
165
7371f44c
MD
166struct lttng_krp; /* Kretprobe handling */
167
85a9ca7f
MD
168/*
169 * ltt_event structure is referred to by the tracing fast path. It must be
170 * kept small.
171 */
172struct ltt_event {
173 unsigned int id;
174 struct ltt_channel *chan;
e64957da 175 int enabled;
d3dbe23c 176 const struct lttng_event_desc *desc;
85a9ca7f 177 void *filter;
f1676205 178 struct lttng_ctx *ctx;
38d024ae 179 enum lttng_kernel_instrumentation instrumentation;
d6d808f3
MD
180 union {
181 struct {
182 struct kprobe kp;
183 char *symbol_name;
184 } kprobe;
7371f44c
MD
185 struct {
186 struct lttng_krp *lttng_krp;
187 char *symbol_name;
188 } kretprobe;
e0a7a7c4
MD
189 struct {
190 char *symbol_name;
191 } ftrace;
d6d808f3 192 } u;
85a9ca7f 193 struct list_head list; /* Event list */
9cccf98a 194 unsigned int metadata_dumped:1;
85a9ca7f
MD
195};
196
197struct ltt_channel_ops {
198 struct channel *(*channel_create)(const char *name,
9115fbdc 199 struct ltt_channel *ltt_chan,
85a9ca7f
MD
200 void *buf_addr,
201 size_t subbuf_size, size_t num_subbuf,
202 unsigned int switch_timer_interval,
203 unsigned int read_timer_interval);
204 void (*channel_destroy)(struct channel *chan);
205 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
f71ecafa 206 int (*buffer_has_read_closed_stream)(struct channel *chan);
85a9ca7f 207 void (*buffer_read_close)(struct lib_ring_buffer *buf);
4e1f08f4 208 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
64c796d8 209 uint32_t event_id);
85a9ca7f
MD
210 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
211 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
212 size_t len);
4ea00e4f
JD
213 void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
214 const void *src, size_t len);
58aa5d24
MD
215 void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
216 int c, size_t len);
1ec3f75a
MD
217 /*
218 * packet_avail_size returns the available size in the current
219 * packet. Note that the size returned is only a hint, since it
220 * may change due to concurrent writes.
221 */
222 size_t (*packet_avail_size)(struct channel *chan);
71c1d843 223 wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
24cedcfe
MD
224 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
225 int (*is_finalized)(struct channel *chan);
254ec7bc 226 int (*is_disabled)(struct channel *chan);
85a9ca7f
MD
227};
228
a33c9927
MD
229struct ltt_transport {
230 char *name;
231 struct module *owner;
232 struct list_head node;
233 struct ltt_channel_ops ops;
234};
235
85a9ca7f 236struct ltt_channel {
c099397a 237 unsigned int id;
85a9ca7f 238 struct channel *chan; /* Channel buffers */
e64957da 239 int enabled;
f1676205 240 struct lttng_ctx *ctx;
85a9ca7f
MD
241 /* Event ID management */
242 struct ltt_session *session;
243 struct file *file; /* File associated to channel */
244 unsigned int free_event_id; /* Next event ID to allocate */
245 struct list_head list; /* Channel list */
85a9ca7f 246 struct ltt_channel_ops *ops;
a33c9927 247 struct ltt_transport *transport;
1ec65de1 248 struct ltt_event **sc_table; /* for syscall tracing */
49c50022 249 struct ltt_event **compat_sc_table;
f405cfce 250 struct ltt_event *sc_unknown; /* for unknown syscalls */
b76dc1a0 251 struct ltt_event *sc_compat_unknown;
2f804c0a 252 struct ltt_event *sc_exit; /* for syscall exit */
9115fbdc 253 int header_type; /* 0: unset, 1: compact, 2: large */
9cccf98a 254 unsigned int metadata_dumped:1;
85a9ca7f
MD
255};
256
257struct ltt_session {
258 int active; /* Is trace session active ? */
8070f5c0 259 int been_active; /* Has trace session been active ? */
85a9ca7f 260 struct file *file; /* File associated to session */
c099397a 261 struct ltt_channel *metadata; /* Metadata channel */
85a9ca7f
MD
262 struct list_head chan; /* Channel list head */
263 struct list_head events; /* Event list head */
264 struct list_head list; /* Session list */
c099397a 265 unsigned int free_chan_id; /* Next chan ID to allocate */
d793d5e1 266 uuid_le uuid; /* Trace session unique ID */
9cccf98a 267 unsigned int metadata_dumped:1;
85a9ca7f
MD
268};
269
baf20995 270struct ltt_session *ltt_session_create(void);
e64957da
MD
271int ltt_session_enable(struct ltt_session *session);
272int ltt_session_disable(struct ltt_session *session);
11b5a3c2 273void ltt_session_destroy(struct ltt_session *session);
4e3c1b9b 274
baf20995 275struct ltt_channel *ltt_channel_create(struct ltt_session *session,
5dbbdb43
MD
276 const char *transport_name,
277 void *buf_addr,
278 size_t subbuf_size, size_t num_subbuf,
279 unsigned int switch_timer_interval,
280 unsigned int read_timer_interval);
281struct ltt_channel *ltt_global_channel_create(struct ltt_session *session,
4e3c1b9b
MD
282 int overwrite, void *buf_addr,
283 size_t subbuf_size, size_t num_subbuf,
284 unsigned int switch_timer_interval,
285 unsigned int read_timer_interval);
4e3c1b9b 286
653fe716 287struct ltt_event *ltt_event_create(struct ltt_channel *chan,
d6d808f3 288 struct lttng_kernel_event *event_param,
259b6cb3
MD
289 void *filter,
290 const struct lttng_event_desc *internal_desc);
c0e31d2e 291
e64957da
MD
292int ltt_channel_enable(struct ltt_channel *channel);
293int ltt_channel_disable(struct ltt_channel *channel);
294int ltt_event_enable(struct ltt_event *event);
295int ltt_event_disable(struct ltt_event *event);
296
c0e31d2e
MD
297void ltt_transport_register(struct ltt_transport *transport);
298void ltt_transport_unregister(struct ltt_transport *transport);
11b5a3c2 299
360f38ea 300void synchronize_trace(void);
80996790
MD
301int lttng_abi_init(void);
302void lttng_abi_exit(void);
1c25284c 303
85a9ca7f
MD
304int ltt_probe_register(struct lttng_probe_desc *desc);
305void ltt_probe_unregister(struct lttng_probe_desc *desc);
306const struct lttng_event_desc *ltt_event_get(const char *name);
307void ltt_event_put(const struct lttng_event_desc *desc);
cd4bd11f
MD
308int ltt_probes_init(void);
309void ltt_probes_exit(void);
1ec65de1 310
63728b02 311#ifdef CONFIG_HAVE_SYSCALL_TRACEPOINTS
1ec65de1
MD
312int lttng_syscalls_register(struct ltt_channel *chan, void *filter);
313int lttng_syscalls_unregister(struct ltt_channel *chan);
314#else
315static inline int lttng_syscalls_register(struct ltt_channel *chan, void *filter)
316{
317 return -ENOSYS;
318}
319
320static inline int lttng_syscalls_unregister(struct ltt_channel *chan)
321{
322 return 0;
323}
324#endif
325
2dccf128 326struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
44252f0f 327int lttng_find_context(struct lttng_ctx *ctx, const char *name);
8289661d
MD
328void lttng_remove_context_field(struct lttng_ctx **ctx,
329 struct lttng_ctx_field *field);
2dccf128 330void lttng_destroy_context(struct lttng_ctx *ctx);
8070f5c0 331int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
a2563e83 332int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
a8ad3613 333int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
53f1f0ca 334int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
b64bc438
MD
335int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
336int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
337int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
338int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
339int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
41c3c24e 340#if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
c24a0d71
MD
341int lttng_add_perf_counter_to_ctx(uint32_t type,
342 uint64_t config,
343 const char *name,
344 struct lttng_ctx **ctx);
1d443b34
MD
345#else
346static inline
347int lttng_add_perf_counter_to_ctx(uint32_t type,
348 uint64_t config,
349 const char *name,
350 struct lttng_ctx **ctx)
351{
352 return -ENOSYS;
353}
354#endif
02119ee5 355
acd614cc 356#ifdef CONFIG_KPROBES
f17701fb
MD
357int lttng_kprobes_register(const char *name,
358 const char *symbol_name,
359 uint64_t offset,
360 uint64_t addr,
361 struct ltt_event *event);
362void lttng_kprobes_unregister(struct ltt_event *event);
edeb3137 363void lttng_kprobes_destroy_private(struct ltt_event *event);
acd614cc
MD
364#else
365static inline
366int lttng_kprobes_register(const char *name,
367 const char *symbol_name,
368 uint64_t offset,
369 uint64_t addr,
370 struct ltt_event *event)
371{
372 return -ENOSYS;
373}
374
25f53c39 375static inline
acd614cc
MD
376void lttng_kprobes_unregister(struct ltt_event *event)
377{
378}
edeb3137
MD
379
380static inline
381void lttng_kprobes_destroy_private(struct ltt_event *event)
382{
383}
acd614cc 384#endif
d6d808f3 385
7371f44c
MD
386#ifdef CONFIG_KRETPROBES
387int lttng_kretprobes_register(const char *name,
388 const char *symbol_name,
389 uint64_t offset,
390 uint64_t addr,
391 struct ltt_event *event_entry,
392 struct ltt_event *event_exit);
393void lttng_kretprobes_unregister(struct ltt_event *event);
394void lttng_kretprobes_destroy_private(struct ltt_event *event);
395#else
396static inline
397int lttng_kretprobes_register(const char *name,
398 const char *symbol_name,
399 uint64_t offset,
400 uint64_t addr,
401 struct ltt_event *event_entry,
402 struct ltt_event *event_exit)
403{
404 return -ENOSYS;
405}
406
407static inline
408void lttng_kretprobes_unregister(struct ltt_event *event)
409{
410}
411
412static inline
413void lttng_kretprobes_destroy_private(struct ltt_event *event)
414{
415}
416#endif
417
e0a7a7c4
MD
418#ifdef CONFIG_DYNAMIC_FTRACE
419int lttng_ftrace_register(const char *name,
420 const char *symbol_name,
421 struct ltt_event *event);
422void lttng_ftrace_unregister(struct ltt_event *event);
edeb3137 423void lttng_ftrace_destroy_private(struct ltt_event *event);
e0a7a7c4
MD
424#else
425static inline
426int lttng_ftrace_register(const char *name,
427 const char *symbol_name,
428 struct ltt_event *event)
429{
acd614cc 430 return -ENOSYS;
e0a7a7c4
MD
431}
432
433static inline
434void lttng_ftrace_unregister(struct ltt_event *event)
435{
436}
edeb3137
MD
437
438static inline
439void lttng_ftrace_destroy_private(struct ltt_event *event)
440{
441}
e0a7a7c4 442#endif
271b6681 443
3db41b2c 444int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
57105fc2 445
271b6681
MD
446extern const struct file_operations lttng_tracepoint_list_fops;
447
ef200626
MD
448#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
449#define TRACEPOINT_HAS_DATA_ARG
450#endif
451
11b5a3c2 452#endif /* _LTT_EVENTS_H */
This page took 0.047802 seconds and 4 git commands to generate.