Revert poll exclusive
[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>
d793d5e1 15#include <linux/uuid.h>
d6d808f3 16#include <linux/kprobes.h>
11b5a3c2 17#include "ltt-debugfs-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 */
70 unsigned int signedness:1;
71 unsigned int 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
ba1f5986 122struct lttng_ctx_field {
8070f5c0 123 struct lttng_event_field event_field;
f1676205
MD
124 size_t (*get_size)(size_t offset);
125 void (*record)(struct lttng_ctx_field *field,
126 struct lib_ring_buffer_ctx *ctx,
127 struct ltt_channel *chan);
ba1f5986
MD
128 union {
129 struct {
130 struct perf_event **e; /* per-cpu array */
8289661d
MD
131 struct notifier_block nb;
132 int hp_enable;
833ad6a0 133 struct perf_event_attr *attr;
ba1f5986
MD
134 } perf_counter;
135 } u;
2dccf128 136 void (*destroy)(struct lttng_ctx_field *field);
ba1f5986
MD
137};
138
139struct lttng_ctx {
833ad6a0 140 struct lttng_ctx_field *fields;
0d1a681e 141 unsigned int nr_fields;
ba1f5986 142 unsigned int allocated_fields;
0d1a681e
MD
143};
144
145struct lttng_event_desc {
c0edae1d
MD
146 const char *name;
147 void *probe_callback;
0d1a681e
MD
148 const struct lttng_event_ctx *ctx; /* context */
149 const struct lttng_event_field *fields; /* event payload */
c0edae1d 150 unsigned int nr_fields;
dc7f600a 151 struct module *owner;
c0edae1d
MD
152};
153
85a9ca7f
MD
154struct lttng_probe_desc {
155 const struct lttng_event_desc *event_desc;
156 unsigned int nr_events;
157 struct list_head head; /* chain registered probes */
158};
159
160/*
161 * ltt_event structure is referred to by the tracing fast path. It must be
162 * kept small.
163 */
164struct ltt_event {
165 unsigned int id;
166 struct ltt_channel *chan;
d3dbe23c 167 const struct lttng_event_desc *desc;
85a9ca7f 168 void *filter;
f1676205 169 struct lttng_ctx *ctx;
38d024ae 170 enum lttng_kernel_instrumentation instrumentation;
d6d808f3
MD
171 union {
172 struct {
173 struct kprobe kp;
174 char *symbol_name;
175 } kprobe;
e0a7a7c4
MD
176 struct {
177 char *symbol_name;
178 } ftrace;
d6d808f3 179 } u;
85a9ca7f 180 struct list_head list; /* Event list */
c099397a 181 int metadata_dumped:1;
85a9ca7f
MD
182};
183
184struct ltt_channel_ops {
185 struct channel *(*channel_create)(const char *name,
9115fbdc 186 struct ltt_channel *ltt_chan,
85a9ca7f
MD
187 void *buf_addr,
188 size_t subbuf_size, size_t num_subbuf,
189 unsigned int switch_timer_interval,
190 unsigned int read_timer_interval);
191 void (*channel_destroy)(struct channel *chan);
192 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
193 void (*buffer_read_close)(struct lib_ring_buffer *buf);
4e1f08f4 194 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
64c796d8 195 uint32_t event_id);
85a9ca7f
MD
196 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
197 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
198 size_t len);
1ec3f75a
MD
199 /*
200 * packet_avail_size returns the available size in the current
201 * packet. Note that the size returned is only a hint, since it
202 * may change due to concurrent writes.
203 */
204 size_t (*packet_avail_size)(struct channel *chan);
24cedcfe
MD
205 wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
206 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
207 int (*is_finalized)(struct channel *chan);
254ec7bc 208 int (*is_disabled)(struct channel *chan);
85a9ca7f
MD
209};
210
211struct ltt_channel {
c099397a 212 unsigned int id;
85a9ca7f 213 struct channel *chan; /* Channel buffers */
f1676205 214 struct lttng_ctx *ctx;
85a9ca7f
MD
215 /* Event ID management */
216 struct ltt_session *session;
217 struct file *file; /* File associated to channel */
218 unsigned int free_event_id; /* Next event ID to allocate */
219 struct list_head list; /* Channel list */
85a9ca7f 220 struct ltt_channel_ops *ops;
9115fbdc 221 int header_type; /* 0: unset, 1: compact, 2: large */
c099397a 222 int metadata_dumped:1;
85a9ca7f
MD
223};
224
225struct ltt_session {
226 int active; /* Is trace session active ? */
8070f5c0 227 int been_active; /* Has trace session been active ? */
85a9ca7f 228 struct file *file; /* File associated to session */
c099397a 229 struct ltt_channel *metadata; /* Metadata channel */
85a9ca7f
MD
230 struct list_head chan; /* Channel list head */
231 struct list_head events; /* Event list head */
232 struct list_head list; /* Session list */
c099397a 233 unsigned int free_chan_id; /* Next chan ID to allocate */
d793d5e1 234 uuid_le uuid; /* Trace session unique ID */
c099397a 235 int metadata_dumped:1;
85a9ca7f
MD
236};
237
238struct ltt_transport {
239 char *name;
240 struct module *owner;
241 struct list_head node;
242 struct ltt_channel_ops ops;
243};
244
baf20995 245struct ltt_session *ltt_session_create(void);
c0e31d2e
MD
246int ltt_session_start(struct ltt_session *session);
247int ltt_session_stop(struct ltt_session *session);
11b5a3c2 248void ltt_session_destroy(struct ltt_session *session);
4e3c1b9b 249
baf20995 250struct ltt_channel *ltt_channel_create(struct ltt_session *session,
5dbbdb43
MD
251 const char *transport_name,
252 void *buf_addr,
253 size_t subbuf_size, size_t num_subbuf,
254 unsigned int switch_timer_interval,
255 unsigned int read_timer_interval);
256struct ltt_channel *ltt_global_channel_create(struct ltt_session *session,
4e3c1b9b
MD
257 int overwrite, void *buf_addr,
258 size_t subbuf_size, size_t num_subbuf,
259 unsigned int switch_timer_interval,
260 unsigned int read_timer_interval);
4e3c1b9b 261
653fe716 262struct ltt_event *ltt_event_create(struct ltt_channel *chan,
d6d808f3 263 struct lttng_kernel_event *event_param,
85a9ca7f 264 void *filter);
c0e31d2e
MD
265
266void ltt_transport_register(struct ltt_transport *transport);
267void ltt_transport_unregister(struct ltt_transport *transport);
11b5a3c2 268
1c25284c
MD
269int ltt_debugfs_abi_init(void);
270void ltt_debugfs_abi_exit(void);
271
85a9ca7f
MD
272int ltt_probe_register(struct lttng_probe_desc *desc);
273void ltt_probe_unregister(struct lttng_probe_desc *desc);
274const struct lttng_event_desc *ltt_event_get(const char *name);
275void ltt_event_put(const struct lttng_event_desc *desc);
cd4bd11f
MD
276int ltt_probes_init(void);
277void ltt_probes_exit(void);
2dccf128 278struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
8289661d
MD
279void lttng_remove_context_field(struct lttng_ctx **ctx,
280 struct lttng_ctx_field *field);
2dccf128 281void lttng_destroy_context(struct lttng_ctx *ctx);
8070f5c0 282int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
25b2f99a 283int lttng_add_comm_to_ctx(struct lttng_ctx **ctx);
a8ad3613 284int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
53f1f0ca 285int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
c24a0d71
MD
286int lttng_add_perf_counter_to_ctx(uint32_t type,
287 uint64_t config,
288 const char *name,
289 struct lttng_ctx **ctx);
02119ee5 290
acd614cc 291#ifdef CONFIG_KPROBES
f17701fb
MD
292int lttng_kprobes_register(const char *name,
293 const char *symbol_name,
294 uint64_t offset,
295 uint64_t addr,
296 struct ltt_event *event);
297void lttng_kprobes_unregister(struct ltt_event *event);
edeb3137 298void lttng_kprobes_destroy_private(struct ltt_event *event);
acd614cc
MD
299#else
300static inline
301int lttng_kprobes_register(const char *name,
302 const char *symbol_name,
303 uint64_t offset,
304 uint64_t addr,
305 struct ltt_event *event)
306{
307 return -ENOSYS;
308}
309
25f53c39 310static inline
acd614cc
MD
311void lttng_kprobes_unregister(struct ltt_event *event)
312{
313}
edeb3137
MD
314
315static inline
316void lttng_kprobes_destroy_private(struct ltt_event *event)
317{
318}
acd614cc 319#endif
d6d808f3 320
e0a7a7c4
MD
321#ifdef CONFIG_DYNAMIC_FTRACE
322int lttng_ftrace_register(const char *name,
323 const char *symbol_name,
324 struct ltt_event *event);
325void lttng_ftrace_unregister(struct ltt_event *event);
edeb3137 326void lttng_ftrace_destroy_private(struct ltt_event *event);
e0a7a7c4
MD
327#else
328static inline
329int lttng_ftrace_register(const char *name,
330 const char *symbol_name,
331 struct ltt_event *event)
332{
acd614cc 333 return -ENOSYS;
e0a7a7c4
MD
334}
335
336static inline
337void lttng_ftrace_unregister(struct ltt_event *event)
338{
339}
edeb3137
MD
340
341static inline
342void lttng_ftrace_destroy_private(struct ltt_event *event)
343{
344}
e0a7a7c4 345#endif
271b6681
MD
346
347extern const struct file_operations lttng_tracepoint_list_fops;
348
11b5a3c2 349#endif /* _LTT_EVENTS_H */
This page took 0.039857 seconds and 4 git commands to generate.