Commit | Line | Data |
---|---|---|
4e3c1b9b MD |
1 | /* |
2 | * ltt-events.c | |
3 | * | |
4 | * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
5 | * | |
6 | * Holds LTTng per-session event registry. | |
7 | */ | |
8 | ||
9 | #include <linux/module.h> | |
c0e31d2e MD |
10 | #include <linux/list.h> |
11 | #include <linux/mutex.h> | |
12 | #include <linux/sched.h> | |
11b5a3c2 | 13 | #include <linux/slab.h> |
c099397a | 14 | #include <linux/jiffies.h> |
d793d5e1 | 15 | #include <linux/uuid.h> |
b13f3ebe | 16 | #include "wrapper/vmalloc.h" /* for wrapper_vmalloc_sync_all() */ |
4e3c1b9b | 17 | #include "ltt-events.h" |
c099397a | 18 | #include "ltt-tracer.h" |
4e3c1b9b MD |
19 | |
20 | static LIST_HEAD(sessions); | |
c0e31d2e | 21 | static LIST_HEAD(ltt_transport_list); |
4e3c1b9b MD |
22 | static DEFINE_MUTEX(sessions_mutex); |
23 | static struct kmem_cache *event_cache; | |
24 | ||
be066e6c | 25 | static void _ltt_event_destroy(struct ltt_event *event); |
aa7c23a9 | 26 | static void _ltt_channel_destroy(struct ltt_channel *chan); |
be066e6c | 27 | static int _ltt_event_unregister(struct ltt_event *event); |
c099397a MD |
28 | static |
29 | int _ltt_event_metadata_statedump(struct ltt_session *session, | |
30 | struct ltt_channel *chan, | |
31 | struct ltt_event *event); | |
32 | static | |
33 | int _ltt_session_metadata_statedump(struct ltt_session *session); | |
34 | ||
35 | ||
36 | static | |
37 | void synchronize_trace(void) | |
abcca994 MD |
38 | { |
39 | synchronize_sched(); | |
40 | #ifdef CONFIG_PREEMPT_RT | |
41 | synchronize_rcu(); | |
42 | #endif | |
43 | } | |
44 | ||
baf20995 | 45 | struct ltt_session *ltt_session_create(void) |
4e3c1b9b MD |
46 | { |
47 | struct ltt_session *session; | |
48 | ||
49 | mutex_lock(&sessions_mutex); | |
f3d01b96 | 50 | session = kzalloc(sizeof(struct ltt_session), GFP_KERNEL); |
4e3c1b9b MD |
51 | if (!session) |
52 | return NULL; | |
4e3c1b9b | 53 | INIT_LIST_HEAD(&session->chan); |
f3d01b96 | 54 | INIT_LIST_HEAD(&session->events); |
d793d5e1 | 55 | uuid_le_gen(&session->uuid); |
4e3c1b9b MD |
56 | list_add(&session->list, &sessions); |
57 | mutex_unlock(&sessions_mutex); | |
58 | return session; | |
4e3c1b9b MD |
59 | } |
60 | ||
11b5a3c2 | 61 | void ltt_session_destroy(struct ltt_session *session) |
4e3c1b9b MD |
62 | { |
63 | struct ltt_channel *chan, *tmpchan; | |
64 | struct ltt_event *event, *tmpevent; | |
dda6a249 | 65 | int ret; |
4e3c1b9b MD |
66 | |
67 | mutex_lock(&sessions_mutex); | |
52fc2e1f | 68 | ACCESS_ONCE(session->active) = 0; |
dda6a249 MD |
69 | list_for_each_entry(event, &session->events, list) { |
70 | ret = _ltt_event_unregister(event); | |
71 | WARN_ON(ret); | |
72 | } | |
abcca994 | 73 | synchronize_trace(); /* Wait for in-flight events to complete */ |
4e3c1b9b MD |
74 | list_for_each_entry_safe(event, tmpevent, &session->events, list) |
75 | _ltt_event_destroy(event); | |
76 | list_for_each_entry_safe(chan, tmpchan, &session->chan, list) | |
77 | _ltt_channel_destroy(chan); | |
78 | list_del(&session->list); | |
79 | mutex_unlock(&sessions_mutex); | |
80 | kfree(session); | |
81 | } | |
82 | ||
c0e31d2e MD |
83 | int ltt_session_start(struct ltt_session *session) |
84 | { | |
85 | int ret = 0; | |
c099397a | 86 | struct ltt_channel *chan; |
c0e31d2e MD |
87 | |
88 | mutex_lock(&sessions_mutex); | |
89 | if (session->active) { | |
90 | ret = -EBUSY; | |
91 | goto end; | |
92 | } | |
c099397a MD |
93 | |
94 | /* | |
95 | * Snapshot the number of events per channel to know the type of header | |
96 | * we need to use. | |
97 | */ | |
98 | list_for_each_entry(chan, &session->chan, list) { | |
99 | if (chan->header_type) | |
100 | continue; /* don't change it if session stop/restart */ | |
101 | if (chan->free_event_id < 31) | |
102 | chan->header_type = 1; /* compact */ | |
103 | else | |
104 | chan->header_type = 2; /* large */ | |
105 | } | |
106 | ||
52fc2e1f | 107 | ACCESS_ONCE(session->active) = 1; |
8070f5c0 | 108 | ACCESS_ONCE(session->been_active) = 1; |
c0e31d2e | 109 | synchronize_trace(); /* Wait for in-flight events to complete */ |
c099397a MD |
110 | ret = _ltt_session_metadata_statedump(session); |
111 | if (ret) { | |
112 | ACCESS_ONCE(session->active) = 0; | |
113 | synchronize_trace(); /* Wait for in-flight events to complete */ | |
114 | } | |
c0e31d2e MD |
115 | end: |
116 | mutex_unlock(&sessions_mutex); | |
11b5a3c2 | 117 | return ret; |
c0e31d2e MD |
118 | } |
119 | ||
120 | int ltt_session_stop(struct ltt_session *session) | |
121 | { | |
122 | int ret = 0; | |
123 | ||
124 | mutex_lock(&sessions_mutex); | |
125 | if (!session->active) { | |
126 | ret = -EBUSY; | |
127 | goto end; | |
128 | } | |
52fc2e1f | 129 | ACCESS_ONCE(session->active) = 0; |
c0e31d2e MD |
130 | synchronize_trace(); /* Wait for in-flight events to complete */ |
131 | end: | |
132 | mutex_unlock(&sessions_mutex); | |
11b5a3c2 | 133 | return ret; |
c0e31d2e MD |
134 | } |
135 | ||
c535175e | 136 | static struct ltt_transport *ltt_transport_find(const char *name) |
f3d01b96 MD |
137 | { |
138 | struct ltt_transport *transport; | |
139 | ||
140 | list_for_each_entry(transport, <t_transport_list, node) { | |
141 | if (!strcmp(transport->name, name)) | |
142 | return transport; | |
143 | } | |
144 | return NULL; | |
145 | } | |
146 | ||
baf20995 | 147 | struct ltt_channel *ltt_channel_create(struct ltt_session *session, |
5dbbdb43 MD |
148 | const char *transport_name, |
149 | void *buf_addr, | |
4e3c1b9b MD |
150 | size_t subbuf_size, size_t num_subbuf, |
151 | unsigned int switch_timer_interval, | |
152 | unsigned int read_timer_interval) | |
153 | { | |
154 | struct ltt_channel *chan; | |
f3d01b96 | 155 | struct ltt_transport *transport; |
4e3c1b9b MD |
156 | |
157 | mutex_lock(&sessions_mutex); | |
8070f5c0 | 158 | if (session->been_active) |
e5382b6d | 159 | goto active; /* Refuse to add channel to active session */ |
f3d01b96 MD |
160 | transport = ltt_transport_find(transport_name); |
161 | if (!transport) { | |
162 | printk(KERN_WARNING "LTTng transport %s not found\n", | |
163 | transport_name); | |
c0e31d2e | 164 | goto notransport; |
f3d01b96 | 165 | } |
f3d01b96 | 166 | chan = kzalloc(sizeof(struct ltt_channel), GFP_KERNEL); |
4e3c1b9b | 167 | if (!chan) |
c0e31d2e | 168 | goto nomem; |
4e3c1b9b | 169 | chan->session = session; |
653fe716 | 170 | init_waitqueue_head(&chan->notify_wait); |
05d32c64 | 171 | chan->id = session->free_chan_id++; |
125b4df4 MD |
172 | /* |
173 | * Note: the channel creation op already writes into the packet | |
174 | * headers. Therefore the "chan" information used as input | |
175 | * should be already accessible. | |
176 | */ | |
9115fbdc | 177 | chan->chan = transport->ops.channel_create("[lttng]", chan, buf_addr, |
11b5a3c2 MD |
178 | subbuf_size, num_subbuf, switch_timer_interval, |
179 | read_timer_interval); | |
f3d01b96 MD |
180 | if (!chan->chan) |
181 | goto create_error; | |
11b5a3c2 | 182 | chan->ops = &transport->ops; |
4e3c1b9b MD |
183 | list_add(&chan->list, &session->chan); |
184 | mutex_unlock(&sessions_mutex); | |
185 | return chan; | |
186 | ||
f3d01b96 MD |
187 | create_error: |
188 | kfree(chan); | |
c0e31d2e MD |
189 | nomem: |
190 | notransport: | |
e5382b6d | 191 | active: |
4e3c1b9b MD |
192 | mutex_unlock(&sessions_mutex); |
193 | return NULL; | |
194 | } | |
195 | ||
196 | /* | |
197 | * Only used internally at session destruction. | |
198 | */ | |
aa7c23a9 | 199 | static |
11b5a3c2 | 200 | void _ltt_channel_destroy(struct ltt_channel *chan) |
4e3c1b9b | 201 | { |
11b5a3c2 | 202 | chan->ops->channel_destroy(chan->chan); |
4e3c1b9b | 203 | list_del(&chan->list); |
8070f5c0 | 204 | lttng_destroy_context(chan->ctx); |
4e3c1b9b MD |
205 | kfree(chan); |
206 | } | |
207 | ||
e5382b6d MD |
208 | /* |
209 | * Supports event creation while tracing session is active. | |
210 | */ | |
30bdb6e4 | 211 | struct ltt_event *ltt_event_create(struct ltt_channel *chan, |
d6d808f3 | 212 | struct lttng_kernel_event *event_param, |
85a9ca7f | 213 | void *filter) |
4e3c1b9b MD |
214 | { |
215 | struct ltt_event *event; | |
3d084699 | 216 | int ret; |
4e3c1b9b MD |
217 | |
218 | mutex_lock(&sessions_mutex); | |
e5382b6d MD |
219 | if (chan->free_event_id == -1UL) |
220 | goto full; | |
4e3c1b9b | 221 | /* |
dda6a249 MD |
222 | * This is O(n^2) (for each event, the loop is called at event |
223 | * creation). Might require a hash if we have lots of events. | |
4e3c1b9b MD |
224 | */ |
225 | list_for_each_entry(event, &chan->session->events, list) | |
30bdb6e4 | 226 | if (!strcmp(event->desc->name, event_param->name)) |
4e3c1b9b | 227 | goto exist; |
11b5a3c2 | 228 | event = kmem_cache_zalloc(event_cache, GFP_KERNEL); |
4e3c1b9b MD |
229 | if (!event) |
230 | goto cache_error; | |
4e3c1b9b MD |
231 | event->chan = chan; |
232 | event->filter = filter; | |
e5382b6d | 233 | event->id = chan->free_event_id++; |
d6d808f3 | 234 | event->instrumentation = event_param->instrumentation; |
e5382b6d MD |
235 | /* Populate ltt_event structure before tracepoint registration. */ |
236 | smp_wmb(); | |
d6d808f3 | 237 | switch (event_param->instrumentation) { |
ab2277d6 | 238 | case LTTNG_KERNEL_TRACEPOINT: |
30bdb6e4 | 239 | event->desc = ltt_event_get(event_param->name); |
d3dbe23c MD |
240 | if (!event->desc) |
241 | goto register_error; | |
30bdb6e4 | 242 | ret = tracepoint_probe_register(event_param->name, |
d3dbe23c MD |
243 | event->desc->probe_callback, |
244 | event); | |
11b5a3c2 MD |
245 | if (ret) |
246 | goto register_error; | |
baf20995 | 247 | break; |
ab2277d6 | 248 | case LTTNG_KERNEL_KPROBE: |
30bdb6e4 | 249 | ret = lttng_kprobes_register(event_param->name, |
f17701fb MD |
250 | event_param->u.kprobe.symbol_name, |
251 | event_param->u.kprobe.offset, | |
252 | event_param->u.kprobe.addr, | |
253 | event); | |
254 | if (ret) | |
d6d808f3 | 255 | goto register_error; |
edeb3137 MD |
256 | ret = try_module_get(event->desc->owner); |
257 | WARN_ON_ONCE(!ret); | |
d6d808f3 | 258 | break; |
ab2277d6 | 259 | case LTTNG_KERNEL_FUNCTION: |
30bdb6e4 | 260 | ret = lttng_ftrace_register(event_param->name, |
e0a7a7c4 MD |
261 | event_param->u.ftrace.symbol_name, |
262 | event); | |
263 | if (ret) | |
264 | goto register_error; | |
edeb3137 MD |
265 | ret = try_module_get(event->desc->owner); |
266 | WARN_ON_ONCE(!ret); | |
e0a7a7c4 | 267 | break; |
baf20995 MD |
268 | default: |
269 | WARN_ON_ONCE(1); | |
270 | } | |
c099397a MD |
271 | ret = _ltt_event_metadata_statedump(chan->session, chan, event); |
272 | if (ret) | |
273 | goto statedump_error; | |
dda6a249 | 274 | list_add(&event->list, &chan->session->events); |
11b5a3c2 | 275 | mutex_unlock(&sessions_mutex); |
4e3c1b9b MD |
276 | return event; |
277 | ||
c099397a | 278 | statedump_error: |
30bdb6e4 | 279 | WARN_ON_ONCE(tracepoint_probe_unregister(event_param->name, |
d3dbe23c MD |
280 | event->desc->probe_callback, |
281 | event)); | |
282 | ltt_event_put(event->desc); | |
11b5a3c2 | 283 | register_error: |
11b5a3c2 | 284 | kmem_cache_free(event_cache, event); |
4e3c1b9b MD |
285 | cache_error: |
286 | exist: | |
e5382b6d | 287 | full: |
4e3c1b9b MD |
288 | mutex_unlock(&sessions_mutex); |
289 | return NULL; | |
290 | } | |
291 | ||
292 | /* | |
293 | * Only used internally at session destruction. | |
294 | */ | |
dda6a249 | 295 | int _ltt_event_unregister(struct ltt_event *event) |
4e3c1b9b | 296 | { |
11b5a3c2 MD |
297 | int ret = -EINVAL; |
298 | ||
38d024ae | 299 | switch (event->instrumentation) { |
ab2277d6 | 300 | case LTTNG_KERNEL_TRACEPOINT: |
85a9ca7f MD |
301 | ret = tracepoint_probe_unregister(event->desc->name, |
302 | event->desc->probe_callback, | |
11b5a3c2 MD |
303 | event); |
304 | if (ret) | |
305 | return ret; | |
baf20995 | 306 | break; |
ab2277d6 | 307 | case LTTNG_KERNEL_KPROBE: |
f17701fb | 308 | lttng_kprobes_unregister(event); |
d6d808f3 MD |
309 | ret = 0; |
310 | break; | |
ab2277d6 | 311 | case LTTNG_KERNEL_FUNCTION: |
e0a7a7c4 MD |
312 | lttng_ftrace_unregister(event); |
313 | ret = 0; | |
314 | break; | |
baf20995 MD |
315 | default: |
316 | WARN_ON_ONCE(1); | |
317 | } | |
dda6a249 MD |
318 | return ret; |
319 | } | |
320 | ||
321 | /* | |
322 | * Only used internally at session destruction. | |
323 | */ | |
be066e6c | 324 | static |
dda6a249 MD |
325 | void _ltt_event_destroy(struct ltt_event *event) |
326 | { | |
edeb3137 MD |
327 | switch (event->instrumentation) { |
328 | case LTTNG_KERNEL_TRACEPOINT: | |
329 | ltt_event_put(event->desc); | |
330 | break; | |
331 | case LTTNG_KERNEL_KPROBE: | |
332 | module_put(event->desc->owner); | |
333 | lttng_kprobes_destroy_private(event); | |
334 | break; | |
335 | case LTTNG_KERNEL_FUNCTION: | |
336 | module_put(event->desc->owner); | |
337 | lttng_ftrace_destroy_private(event); | |
338 | break; | |
339 | default: | |
340 | WARN_ON_ONCE(1); | |
341 | } | |
dda6a249 | 342 | list_del(&event->list); |
8070f5c0 | 343 | lttng_destroy_context(event->ctx); |
11b5a3c2 | 344 | kmem_cache_free(event_cache, event); |
4e3c1b9b MD |
345 | } |
346 | ||
1ec3f75a MD |
347 | /* |
348 | * We have exclusive access to our metadata buffer (protected by the | |
349 | * sessions_mutex), so we can do racy operations such as looking for | |
350 | * remaining space left in packet and write, since mutual exclusion | |
351 | * protects us from concurrent writes. | |
352 | */ | |
c099397a MD |
353 | int lttng_metadata_printf(struct ltt_session *session, |
354 | const char *fmt, ...) | |
355 | { | |
356 | struct lib_ring_buffer_ctx ctx; | |
357 | struct ltt_channel *chan = session->metadata; | |
358 | char *str; | |
359 | int ret = 0, waitret; | |
1ec3f75a | 360 | size_t len, reserve_len, pos; |
c099397a MD |
361 | va_list ap; |
362 | ||
363 | WARN_ON_ONCE(!ACCESS_ONCE(session->active)); | |
364 | ||
365 | va_start(ap, fmt); | |
366 | str = kvasprintf(GFP_KERNEL, fmt, ap); | |
367 | va_end(ap); | |
368 | if (!str) | |
369 | return -ENOMEM; | |
370 | ||
1ec3f75a MD |
371 | len = strlen(str); |
372 | pos = 0; | |
373 | ||
374 | for (pos = 0; pos < len; pos += reserve_len) { | |
375 | reserve_len = min_t(size_t, | |
376 | chan->ops->packet_avail_size(chan->chan), | |
377 | len - pos); | |
378 | lib_ring_buffer_ctx_init(&ctx, chan->chan, NULL, reserve_len, | |
379 | sizeof(char), -1); | |
380 | /* | |
381 | * We don't care about metadata buffer's records lost | |
382 | * count, because we always retry here. Report error if | |
383 | * we need to bail out after timeout or being | |
384 | * interrupted. | |
385 | */ | |
386 | waitret = wait_event_interruptible_timeout(*chan->ops->get_reader_wait_queue(chan), | |
387 | ({ | |
4e1f08f4 | 388 | ret = chan->ops->event_reserve(&ctx, 0); |
1ec3f75a MD |
389 | ret != -ENOBUFS || !ret; |
390 | }), | |
391 | msecs_to_jiffies(LTTNG_METADATA_TIMEOUT_MSEC)); | |
392 | if (!waitret || waitret == -ERESTARTSYS || ret) { | |
393 | printk(KERN_WARNING "LTTng: Failure to write metadata to buffers (%s)\n", | |
394 | waitret == -ERESTARTSYS ? "interrupted" : | |
395 | (ret == -ENOBUFS ? "timeout" : "I/O error")); | |
396 | if (waitret == -ERESTARTSYS) | |
397 | ret = waitret; | |
398 | goto end; | |
399 | } | |
400 | chan->ops->event_write(&ctx, &str[pos], len); | |
401 | chan->ops->event_commit(&ctx); | |
c099397a | 402 | } |
c099397a MD |
403 | end: |
404 | kfree(str); | |
405 | return ret; | |
406 | } | |
407 | ||
408 | static | |
8070f5c0 MD |
409 | int _ltt_field_statedump(struct ltt_session *session, |
410 | const struct lttng_event_field *field) | |
c099397a | 411 | { |
c099397a | 412 | int ret = 0; |
c099397a | 413 | |
8070f5c0 MD |
414 | switch (field->type.atype) { |
415 | case atype_integer: | |
416 | ret = lttng_metadata_printf(session, | |
417 | " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s;\n", | |
418 | field->type.u.basic.integer.size, | |
419 | field->type.u.basic.integer.alignment, | |
420 | field->type.u.basic.integer.signedness, | |
421 | (field->type.u.basic.integer.encoding == lttng_encode_none) | |
422 | ? "none" | |
423 | : (field->type.u.basic.integer.encoding == lttng_encode_UTF8) | |
424 | ? "UTF8" | |
425 | : "ASCII", | |
426 | field->type.u.basic.integer.base, | |
c099397a | 427 | #ifdef __BIG_ENDIAN |
8070f5c0 | 428 | field->type.u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
c099397a | 429 | #else |
8070f5c0 | 430 | field->type.u.basic.integer.reverse_byte_order ? " byte_order = be;" : "", |
c099397a | 431 | #endif |
8070f5c0 MD |
432 | field->name); |
433 | break; | |
434 | case atype_enum: | |
435 | ret = lttng_metadata_printf(session, | |
436 | " %s %s;\n", | |
437 | field->type.u.basic.enumeration.name, | |
438 | field->name); | |
439 | break; | |
440 | case atype_array: | |
441 | { | |
442 | const struct lttng_basic_type *elem_type; | |
443 | ||
444 | elem_type = &field->type.u.array.elem_type; | |
445 | ret = lttng_metadata_printf(session, | |
446 | " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s[%u];\n", | |
447 | elem_type->u.basic.integer.size, | |
448 | elem_type->u.basic.integer.alignment, | |
449 | elem_type->u.basic.integer.signedness, | |
450 | (elem_type->u.basic.integer.encoding == lttng_encode_none) | |
451 | ? "none" | |
452 | : (elem_type->u.basic.integer.encoding == lttng_encode_UTF8) | |
453 | ? "UTF8" | |
454 | : "ASCII", | |
455 | elem_type->u.basic.integer.base, | |
8fa75f34 | 456 | #ifdef __BIG_ENDIAN |
8070f5c0 | 457 | elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
8fa75f34 | 458 | #else |
8070f5c0 | 459 | elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "", |
8fa75f34 | 460 | #endif |
8070f5c0 MD |
461 | field->name, field->type.u.array.length); |
462 | break; | |
463 | } | |
464 | case atype_sequence: | |
465 | { | |
466 | const struct lttng_basic_type *elem_type; | |
467 | const struct lttng_basic_type *length_type; | |
468 | ||
469 | elem_type = &field->type.u.sequence.elem_type; | |
470 | length_type = &field->type.u.sequence.length_type; | |
471 | ret = lttng_metadata_printf(session, | |
472 | " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n", | |
473 | " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s[ __%s_length ];\n", | |
474 | length_type->u.basic.integer.size, | |
475 | length_type->u.basic.integer.alignment, | |
476 | length_type->u.basic.integer.signedness, | |
477 | (length_type->u.basic.integer.encoding == lttng_encode_none) | |
478 | ? "none" | |
479 | : (length_type->u.basic.integer.encoding == lttng_encode_UTF8) | |
480 | ? "UTF8" | |
481 | : "ASCII", | |
482 | length_type->u.basic.integer.base, | |
e0a7a7c4 | 483 | #ifdef __BIG_ENDIAN |
8070f5c0 | 484 | length_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
e0a7a7c4 | 485 | #else |
8070f5c0 | 486 | length_type->u.basic.integer.reverse_byte_order |
e0a7a7c4 MD |
487 | ? " byte_order = be;" : "", |
488 | #endif | |
8070f5c0 MD |
489 | field->name, |
490 | elem_type->u.basic.integer.size, | |
491 | elem_type->u.basic.integer.alignment, | |
492 | elem_type->u.basic.integer.signedness, | |
493 | (elem_type->u.basic.integer.encoding == lttng_encode_none) | |
494 | ? "none" | |
495 | : (elem_type->u.basic.integer.encoding == lttng_encode_UTF8) | |
496 | ? "UTF8" | |
497 | : "ASCII", | |
498 | elem_type->u.basic.integer.base, | |
8fa75f34 | 499 | #ifdef __BIG_ENDIAN |
8070f5c0 | 500 | elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
8fa75f34 | 501 | #else |
8070f5c0 | 502 | elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "", |
8fa75f34 | 503 | #endif |
8070f5c0 MD |
504 | field->name, |
505 | field->name | |
506 | ); | |
507 | break; | |
508 | } | |
c099397a | 509 | |
8070f5c0 MD |
510 | case atype_string: |
511 | /* Default encoding is UTF8 */ | |
512 | ret = lttng_metadata_printf(session, | |
513 | " string%s %s;\n", | |
514 | field->type.u.basic.string.encoding == lttng_encode_ASCII ? | |
515 | " { encoding = ASCII; }" : "", | |
516 | field->name); | |
517 | break; | |
518 | default: | |
519 | WARN_ON_ONCE(1); | |
520 | return -EINVAL; | |
521 | } | |
522 | return ret; | |
523 | } | |
524 | ||
525 | static | |
526 | int _ltt_context_metadata_statedump(struct ltt_session *session, | |
527 | struct lttng_ctx *ctx) | |
528 | { | |
529 | int ret = 0; | |
530 | int i; | |
531 | ||
532 | if (!ctx) | |
533 | return 0; | |
534 | for (i = 0; i < ctx->nr_fields; i++) { | |
535 | const struct lttng_ctx_field *field = &ctx->fields[i]; | |
536 | ||
537 | ret = _ltt_field_statedump(session, &field->event_field); | |
538 | if (ret) | |
539 | return ret; | |
540 | } | |
541 | return ret; | |
542 | } | |
543 | ||
544 | static | |
545 | int _ltt_fields_metadata_statedump(struct ltt_session *session, | |
546 | struct ltt_event *event) | |
547 | { | |
548 | const struct lttng_event_desc *desc = event->desc; | |
549 | int ret = 0; | |
550 | int i; | |
551 | ||
552 | for (i = 0; i < desc->nr_fields; i++) { | |
553 | const struct lttng_event_field *field = &desc->fields[i]; | |
554 | ||
555 | ret = _ltt_field_statedump(session, field); | |
556 | if (ret) | |
557 | return ret; | |
c099397a MD |
558 | } |
559 | return ret; | |
560 | } | |
561 | ||
562 | static | |
563 | int _ltt_event_metadata_statedump(struct ltt_session *session, | |
564 | struct ltt_channel *chan, | |
565 | struct ltt_event *event) | |
566 | { | |
567 | int ret = 0; | |
568 | ||
569 | if (event->metadata_dumped || !ACCESS_ONCE(session->active)) | |
570 | return 0; | |
571 | if (chan == session->metadata) | |
572 | return 0; | |
573 | ||
574 | ret = lttng_metadata_printf(session, | |
575 | "event {\n" | |
576 | " name = %s;\n" | |
577 | " id = %u;\n" | |
578 | " stream_id = %u;\n" | |
8070f5c0 | 579 | " context := struct {\n", |
c099397a MD |
580 | event->desc->name, |
581 | event->id, | |
582 | event->chan->id); | |
583 | if (ret) | |
584 | goto end; | |
585 | ||
8070f5c0 MD |
586 | ret = _ltt_context_metadata_statedump(session, event->ctx); |
587 | if (ret) | |
588 | goto end; | |
589 | ||
590 | ret = lttng_metadata_printf(session, | |
591 | " };\n" | |
592 | " fields := struct {\n" | |
593 | ); | |
594 | if (ret) | |
595 | goto end; | |
596 | ||
c099397a MD |
597 | ret = _ltt_fields_metadata_statedump(session, event); |
598 | if (ret) | |
599 | goto end; | |
600 | ||
601 | /* | |
602 | * LTTng space reservation can only reserve multiples of the | |
603 | * byte size. | |
604 | */ | |
605 | ret = lttng_metadata_printf(session, | |
9115fbdc MD |
606 | " };\n" |
607 | "};\n\n"); | |
c099397a MD |
608 | if (ret) |
609 | goto end; | |
610 | ||
c099397a MD |
611 | event->metadata_dumped = 1; |
612 | end: | |
613 | return ret; | |
614 | ||
615 | } | |
616 | ||
617 | static | |
618 | int _ltt_channel_metadata_statedump(struct ltt_session *session, | |
619 | struct ltt_channel *chan) | |
620 | { | |
621 | int ret = 0; | |
622 | ||
623 | if (chan->metadata_dumped || !ACCESS_ONCE(session->active)) | |
624 | return 0; | |
625 | if (chan == session->metadata) | |
626 | return 0; | |
627 | ||
628 | WARN_ON_ONCE(!chan->header_type); | |
629 | ret = lttng_metadata_printf(session, | |
630 | "stream {\n" | |
631 | " id = %u;\n" | |
9115fbdc MD |
632 | " event.header := %s;\n" |
633 | " packet.context := struct packet_context;\n" | |
8070f5c0 | 634 | " event.context := {\n", |
c099397a MD |
635 | chan->id, |
636 | chan->header_type == 1 ? "struct event_header_compact" : | |
637 | "struct event_header_large"); | |
638 | if (ret) | |
639 | goto end; | |
640 | ||
8070f5c0 MD |
641 | ret = _ltt_context_metadata_statedump(session, chan->ctx); |
642 | if (ret) | |
643 | goto end; | |
644 | ||
645 | ret = lttng_metadata_printf(session, | |
646 | " };\n" | |
647 | "};\n\n" | |
648 | ); | |
649 | ||
c099397a MD |
650 | chan->metadata_dumped = 1; |
651 | end: | |
652 | return ret; | |
653 | } | |
654 | ||
9115fbdc MD |
655 | static |
656 | int _ltt_stream_packet_context_declare(struct ltt_session *session) | |
657 | { | |
658 | return lttng_metadata_printf(session, | |
659 | "struct packet_context {\n" | |
660 | " uint64_t timestamp_begin;\n" | |
661 | " uint64_t timestamp_end;\n" | |
662 | " uint32_t events_discarded;\n" | |
663 | " uint32_t content_size;\n" | |
664 | " uint32_t packet_size;\n" | |
665 | " uint32_t cpu_id;\n" | |
c6dfdf6f | 666 | "};\n\n" |
9115fbdc MD |
667 | ); |
668 | } | |
669 | ||
670 | /* | |
671 | * Compact header: | |
672 | * id: range: 0 - 30. | |
673 | * id 31 is reserved to indicate an extended header. | |
674 | * | |
675 | * Large header: | |
676 | * id: range: 0 - 65534. | |
677 | * id 65535 is reserved to indicate an extended header. | |
678 | */ | |
679 | static | |
680 | int _ltt_event_header_declare(struct ltt_session *session) | |
681 | { | |
682 | return lttng_metadata_printf(session, | |
683 | "struct event_header_compact {\n" | |
684 | " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n" | |
685 | " variant <id> {\n" | |
686 | " struct {\n" | |
687 | " uint27_t timestamp;\n" | |
688 | " } compact;\n" | |
689 | " struct {\n" | |
690 | " uint32_t id;\n" | |
691 | " uint64_t timestamp;\n" | |
692 | " } extended;\n" | |
693 | " } v;\n" | |
694 | "} align(%u);\n" | |
695 | "\n" | |
696 | "struct event_header_large {\n" | |
697 | " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n" | |
698 | " variant <id> {\n" | |
699 | " struct {\n" | |
700 | " uint32_t timestamp;\n" | |
701 | " } compact;\n" | |
702 | " struct {\n" | |
703 | " uint32_t id;\n" | |
704 | " uint64_t timestamp;\n" | |
705 | " } extended;\n" | |
706 | " } v;\n" | |
707 | "} align(%u);\n\n", | |
708 | ltt_alignof(uint32_t) * CHAR_BIT, | |
709 | ltt_alignof(uint16_t) * CHAR_BIT | |
710 | ); | |
711 | } | |
712 | ||
c099397a MD |
713 | /* |
714 | * Output metadata into this session's metadata buffers. | |
715 | */ | |
716 | static | |
717 | int _ltt_session_metadata_statedump(struct ltt_session *session) | |
718 | { | |
30bdb6e4 MD |
719 | unsigned char *uuid_c = session->uuid.b; |
720 | unsigned char uuid_s[37]; | |
c099397a MD |
721 | struct ltt_channel *chan; |
722 | struct ltt_event *event; | |
723 | int ret = 0; | |
724 | ||
725 | if (!ACCESS_ONCE(session->active)) | |
726 | return 0; | |
727 | if (session->metadata_dumped) | |
728 | goto skip_session; | |
f40270ad | 729 | if (!session->metadata) { |
cd4bd11f | 730 | printk(KERN_WARNING "LTTng: attempt to start tracing, but metadata channel is not found. Operation abort.\n"); |
f40270ad MD |
731 | return -EPERM; |
732 | } | |
c099397a | 733 | |
d793d5e1 | 734 | snprintf(uuid_s, sizeof(uuid_s), |
30bdb6e4 MD |
735 | "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x", |
736 | uuid_c[0], uuid_c[1], uuid_c[2], uuid_c[3], | |
737 | uuid_c[4], uuid_c[5], uuid_c[6], uuid_c[7], | |
738 | uuid_c[8], uuid_c[9], uuid_c[10], uuid_c[11], | |
739 | uuid_c[12], uuid_c[13], uuid_c[14], uuid_c[15]); | |
d793d5e1 MD |
740 | |
741 | ret = lttng_metadata_printf(session, | |
9115fbdc MD |
742 | "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n" |
743 | "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n" | |
744 | "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n" | |
745 | "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n" | |
746 | "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n" | |
747 | "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n" | |
d793d5e1 MD |
748 | "\n" |
749 | "trace {\n" | |
750 | " major = %u;\n" | |
751 | " minor = %u;\n" | |
30bdb6e4 | 752 | " uuid = \"%s\";\n" |
d793d5e1 MD |
753 | " byte_order = %s;\n" |
754 | " packet.header := struct {\n" | |
755 | " uint32_t magic;\n" | |
1ec3f75a | 756 | " uint8_t uuid[16];\n" |
d793d5e1 | 757 | " uint32_t stream_id;\n" |
0eb25f58 | 758 | " };\n" |
d793d5e1 MD |
759 | "};\n\n", |
760 | ltt_alignof(uint8_t) * CHAR_BIT, | |
0eb25f58 | 761 | ltt_alignof(uint16_t) * CHAR_BIT, |
d793d5e1 MD |
762 | ltt_alignof(uint32_t) * CHAR_BIT, |
763 | ltt_alignof(uint64_t) * CHAR_BIT, | |
764 | CTF_VERSION_MAJOR, | |
765 | CTF_VERSION_MINOR, | |
766 | uuid_s, | |
767 | #ifdef __BIG_ENDIAN | |
768 | "be" | |
769 | #else | |
770 | "le" | |
771 | #endif | |
772 | ); | |
773 | if (ret) | |
774 | goto end; | |
775 | ||
9115fbdc MD |
776 | ret = _ltt_stream_packet_context_declare(session); |
777 | if (ret) | |
778 | goto end; | |
779 | ||
780 | ret = _ltt_event_header_declare(session); | |
781 | if (ret) | |
782 | goto end; | |
783 | ||
c099397a MD |
784 | skip_session: |
785 | list_for_each_entry(chan, &session->chan, list) { | |
786 | ret = _ltt_channel_metadata_statedump(session, chan); | |
787 | if (ret) | |
788 | goto end; | |
789 | } | |
790 | ||
791 | list_for_each_entry(event, &session->events, list) { | |
91e0dcaa | 792 | ret = _ltt_event_metadata_statedump(session, event->chan, event); |
c099397a MD |
793 | if (ret) |
794 | goto end; | |
795 | } | |
796 | session->metadata_dumped = 1; | |
797 | end: | |
798 | return ret; | |
799 | } | |
800 | ||
c0e31d2e MD |
801 | /** |
802 | * ltt_transport_register - LTT transport registration | |
803 | * @transport: transport structure | |
804 | * | |
805 | * Registers a transport which can be used as output to extract the data out of | |
806 | * LTTng. The module calling this registration function must ensure that no | |
807 | * trap-inducing code will be executed by the transport functions. E.g. | |
808 | * vmalloc_sync_all() must be called between a vmalloc and the moment the memory | |
809 | * is made visible to the transport function. This registration acts as a | |
810 | * vmalloc_sync_all. Therefore, only if the module allocates virtual memory | |
811 | * after its registration must it synchronize the TLBs. | |
812 | */ | |
813 | void ltt_transport_register(struct ltt_transport *transport) | |
814 | { | |
815 | /* | |
816 | * Make sure no page fault can be triggered by the module about to be | |
817 | * registered. We deal with this here so we don't have to call | |
818 | * vmalloc_sync_all() in each module's init. | |
819 | */ | |
6d2a620c | 820 | wrapper_vmalloc_sync_all(); |
c0e31d2e MD |
821 | |
822 | mutex_lock(&sessions_mutex); | |
823 | list_add_tail(&transport->node, <t_transport_list); | |
824 | mutex_unlock(&sessions_mutex); | |
825 | } | |
826 | EXPORT_SYMBOL_GPL(ltt_transport_register); | |
827 | ||
828 | /** | |
829 | * ltt_transport_unregister - LTT transport unregistration | |
830 | * @transport: transport structure | |
831 | */ | |
832 | void ltt_transport_unregister(struct ltt_transport *transport) | |
833 | { | |
834 | mutex_lock(&sessions_mutex); | |
835 | list_del(&transport->node); | |
836 | mutex_unlock(&sessions_mutex); | |
837 | } | |
838 | EXPORT_SYMBOL_GPL(ltt_transport_unregister); | |
839 | ||
4e3c1b9b MD |
840 | static int __init ltt_events_init(void) |
841 | { | |
1c25284c MD |
842 | int ret; |
843 | ||
11b5a3c2 MD |
844 | event_cache = KMEM_CACHE(ltt_event, 0); |
845 | if (!event_cache) | |
4e3c1b9b | 846 | return -ENOMEM; |
02119ee5 MD |
847 | ret = ltt_debugfs_abi_init(); |
848 | if (ret) | |
849 | goto error_abi; | |
4e3c1b9b | 850 | return 0; |
02119ee5 | 851 | error_abi: |
1c25284c MD |
852 | kmem_cache_destroy(event_cache); |
853 | return ret; | |
4e3c1b9b MD |
854 | } |
855 | ||
11b5a3c2 MD |
856 | module_init(ltt_events_init); |
857 | ||
4e3c1b9b MD |
858 | static void __exit ltt_events_exit(void) |
859 | { | |
92e94819 MD |
860 | struct ltt_session *session, *tmpsession; |
861 | ||
1c25284c | 862 | ltt_debugfs_abi_exit(); |
92e94819 MD |
863 | list_for_each_entry_safe(session, tmpsession, &sessions, list) |
864 | ltt_session_destroy(session); | |
11b5a3c2 | 865 | kmem_cache_destroy(event_cache); |
4e3c1b9b | 866 | } |
92e94819 | 867 | |
11b5a3c2 MD |
868 | module_exit(ltt_events_exit); |
869 | ||
92e94819 MD |
870 | MODULE_LICENSE("GPL and additional rights"); |
871 | MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>"); | |
872 | MODULE_DESCRIPTION("LTTng Events"); |