Case alignment to uint for metadata print
[lttng-modules.git] / ltt-events.c
CommitLineData
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
20static LIST_HEAD(sessions);
c0e31d2e 21static LIST_HEAD(ltt_transport_list);
4e3c1b9b
MD
22static DEFINE_MUTEX(sessions_mutex);
23static struct kmem_cache *event_cache;
24
be066e6c 25static void _ltt_event_destroy(struct ltt_event *event);
aa7c23a9 26static void _ltt_channel_destroy(struct ltt_channel *chan);
be066e6c 27static int _ltt_event_unregister(struct ltt_event *event);
c099397a
MD
28static
29int _ltt_event_metadata_statedump(struct ltt_session *session,
30 struct ltt_channel *chan,
31 struct ltt_event *event);
32static
33int _ltt_session_metadata_statedump(struct ltt_session *session);
34
35
36static
37void synchronize_trace(void)
abcca994
MD
38{
39 synchronize_sched();
40#ifdef CONFIG_PREEMPT_RT
41 synchronize_rcu();
42#endif
43}
44
baf20995 45struct 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 61void 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
83int 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
115end:
116 mutex_unlock(&sessions_mutex);
11b5a3c2 117 return ret;
c0e31d2e
MD
118}
119
120int 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 */
131end:
132 mutex_unlock(&sessions_mutex);
11b5a3c2 133 return ret;
c0e31d2e
MD
134}
135
c535175e 136static struct ltt_transport *ltt_transport_find(const char *name)
f3d01b96
MD
137{
138 struct ltt_transport *transport;
139
140 list_for_each_entry(transport, &ltt_transport_list, node) {
141 if (!strcmp(transport->name, name))
142 return transport;
143 }
144 return NULL;
145}
146
baf20995 147struct 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
187create_error:
188 kfree(chan);
c0e31d2e
MD
189nomem:
190notransport:
e5382b6d 191active:
4e3c1b9b
MD
192 mutex_unlock(&sessions_mutex);
193 return NULL;
194}
195
196/*
197 * Only used internally at session destruction.
198 */
aa7c23a9 199static
11b5a3c2 200void _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 211struct 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 278statedump_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 283register_error:
11b5a3c2 284 kmem_cache_free(event_cache, event);
4e3c1b9b
MD
285cache_error:
286exist:
e5382b6d 287full:
4e3c1b9b
MD
288 mutex_unlock(&sessions_mutex);
289 return NULL;
290}
291
292/*
293 * Only used internally at session destruction.
294 */
dda6a249 295int _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 324static
dda6a249
MD
325void _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
353int 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
403end:
404 kfree(str);
405 return ret;
406}
407
408static
8070f5c0
MD
409int _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,
32257272 475 (unsigned int) length_type->u.basic.integer.alignment,
8070f5c0
MD
476 length_type->u.basic.integer.signedness,
477 (length_type->u.basic.integer.encoding == lttng_encode_none)
478 ? "none"
0635cdd4 479 : ((length_type->u.basic.integer.encoding == lttng_encode_UTF8)
8070f5c0 480 ? "UTF8"
0635cdd4 481 : "ASCII"),
8070f5c0 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
0635cdd4 486 length_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
e0a7a7c4 487#endif
8070f5c0
MD
488 field->name,
489 elem_type->u.basic.integer.size,
32257272 490 (unsigned int) elem_type->u.basic.integer.alignment,
8070f5c0
MD
491 elem_type->u.basic.integer.signedness,
492 (elem_type->u.basic.integer.encoding == lttng_encode_none)
493 ? "none"
0635cdd4 494 : ((elem_type->u.basic.integer.encoding == lttng_encode_UTF8)
8070f5c0 495 ? "UTF8"
0635cdd4 496 : "ASCII"),
8070f5c0 497 elem_type->u.basic.integer.base,
8fa75f34 498#ifdef __BIG_ENDIAN
8070f5c0 499 elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
8fa75f34 500#else
8070f5c0 501 elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
8fa75f34 502#endif
8070f5c0
MD
503 field->name,
504 field->name
505 );
506 break;
507 }
c099397a 508
8070f5c0
MD
509 case atype_string:
510 /* Default encoding is UTF8 */
511 ret = lttng_metadata_printf(session,
512 " string%s %s;\n",
513 field->type.u.basic.string.encoding == lttng_encode_ASCII ?
514 " { encoding = ASCII; }" : "",
515 field->name);
516 break;
517 default:
518 WARN_ON_ONCE(1);
519 return -EINVAL;
520 }
521 return ret;
522}
523
524static
525int _ltt_context_metadata_statedump(struct ltt_session *session,
526 struct lttng_ctx *ctx)
527{
528 int ret = 0;
529 int i;
530
531 if (!ctx)
532 return 0;
533 for (i = 0; i < ctx->nr_fields; i++) {
534 const struct lttng_ctx_field *field = &ctx->fields[i];
535
536 ret = _ltt_field_statedump(session, &field->event_field);
537 if (ret)
538 return ret;
539 }
540 return ret;
541}
542
543static
544int _ltt_fields_metadata_statedump(struct ltt_session *session,
545 struct ltt_event *event)
546{
547 const struct lttng_event_desc *desc = event->desc;
548 int ret = 0;
549 int i;
550
551 for (i = 0; i < desc->nr_fields; i++) {
552 const struct lttng_event_field *field = &desc->fields[i];
553
554 ret = _ltt_field_statedump(session, field);
555 if (ret)
556 return ret;
c099397a
MD
557 }
558 return ret;
559}
560
561static
562int _ltt_event_metadata_statedump(struct ltt_session *session,
563 struct ltt_channel *chan,
564 struct ltt_event *event)
565{
566 int ret = 0;
567
568 if (event->metadata_dumped || !ACCESS_ONCE(session->active))
569 return 0;
570 if (chan == session->metadata)
571 return 0;
572
573 ret = lttng_metadata_printf(session,
574 "event {\n"
575 " name = %s;\n"
576 " id = %u;\n"
b9074a1b 577 " stream_id = %u;\n",
c099397a
MD
578 event->desc->name,
579 event->id,
580 event->chan->id);
581 if (ret)
582 goto end;
583
b9074a1b
MD
584 if (event->ctx) {
585 ret = lttng_metadata_printf(session,
586 " context := struct {\n");
587 if (ret)
588 goto end;
589 }
8070f5c0
MD
590 ret = _ltt_context_metadata_statedump(session, event->ctx);
591 if (ret)
592 goto end;
b9074a1b
MD
593 if (event->ctx) {
594 ret = lttng_metadata_printf(session,
595 " };\n");
596 if (ret)
597 goto end;
598 }
8070f5c0
MD
599
600 ret = lttng_metadata_printf(session,
8070f5c0
MD
601 " fields := struct {\n"
602 );
603 if (ret)
604 goto end;
605
c099397a
MD
606 ret = _ltt_fields_metadata_statedump(session, event);
607 if (ret)
608 goto end;
609
610 /*
611 * LTTng space reservation can only reserve multiples of the
612 * byte size.
613 */
614 ret = lttng_metadata_printf(session,
9115fbdc
MD
615 " };\n"
616 "};\n\n");
c099397a
MD
617 if (ret)
618 goto end;
619
c099397a
MD
620 event->metadata_dumped = 1;
621end:
622 return ret;
623
624}
625
626static
627int _ltt_channel_metadata_statedump(struct ltt_session *session,
628 struct ltt_channel *chan)
629{
630 int ret = 0;
631
632 if (chan->metadata_dumped || !ACCESS_ONCE(session->active))
633 return 0;
634 if (chan == session->metadata)
635 return 0;
636
637 WARN_ON_ONCE(!chan->header_type);
638 ret = lttng_metadata_printf(session,
639 "stream {\n"
640 " id = %u;\n"
9115fbdc 641 " event.header := %s;\n"
b9074a1b 642 " packet.context := struct packet_context;\n",
c099397a
MD
643 chan->id,
644 chan->header_type == 1 ? "struct event_header_compact" :
645 "struct event_header_large");
646 if (ret)
647 goto end;
648
b9074a1b
MD
649 if (chan->ctx) {
650 ret = lttng_metadata_printf(session,
651 " event.context := struct {\n");
652 if (ret)
653 goto end;
654 }
8070f5c0
MD
655 ret = _ltt_context_metadata_statedump(session, chan->ctx);
656 if (ret)
657 goto end;
b9074a1b
MD
658 if (chan->ctx) {
659 ret = lttng_metadata_printf(session,
660 " };\n");
661 if (ret)
662 goto end;
663 }
8070f5c0
MD
664
665 ret = lttng_metadata_printf(session,
b9074a1b 666 "};\n\n");
8070f5c0 667
c099397a
MD
668 chan->metadata_dumped = 1;
669end:
670 return ret;
671}
672
9115fbdc
MD
673static
674int _ltt_stream_packet_context_declare(struct ltt_session *session)
675{
676 return lttng_metadata_printf(session,
677 "struct packet_context {\n"
678 " uint64_t timestamp_begin;\n"
679 " uint64_t timestamp_end;\n"
680 " uint32_t events_discarded;\n"
681 " uint32_t content_size;\n"
682 " uint32_t packet_size;\n"
683 " uint32_t cpu_id;\n"
c6dfdf6f 684 "};\n\n"
9115fbdc
MD
685 );
686}
687
688/*
689 * Compact header:
690 * id: range: 0 - 30.
691 * id 31 is reserved to indicate an extended header.
692 *
693 * Large header:
694 * id: range: 0 - 65534.
695 * id 65535 is reserved to indicate an extended header.
696 */
697static
698int _ltt_event_header_declare(struct ltt_session *session)
699{
700 return lttng_metadata_printf(session,
701 "struct event_header_compact {\n"
702 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
703 " variant <id> {\n"
704 " struct {\n"
705 " uint27_t timestamp;\n"
706 " } compact;\n"
707 " struct {\n"
708 " uint32_t id;\n"
709 " uint64_t timestamp;\n"
710 " } extended;\n"
711 " } v;\n"
712 "} align(%u);\n"
713 "\n"
714 "struct event_header_large {\n"
715 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
716 " variant <id> {\n"
717 " struct {\n"
718 " uint32_t timestamp;\n"
719 " } compact;\n"
720 " struct {\n"
721 " uint32_t id;\n"
722 " uint64_t timestamp;\n"
723 " } extended;\n"
724 " } v;\n"
725 "} align(%u);\n\n",
726 ltt_alignof(uint32_t) * CHAR_BIT,
727 ltt_alignof(uint16_t) * CHAR_BIT
728 );
729}
730
c099397a
MD
731/*
732 * Output metadata into this session's metadata buffers.
733 */
734static
735int _ltt_session_metadata_statedump(struct ltt_session *session)
736{
30bdb6e4
MD
737 unsigned char *uuid_c = session->uuid.b;
738 unsigned char uuid_s[37];
c099397a
MD
739 struct ltt_channel *chan;
740 struct ltt_event *event;
741 int ret = 0;
742
743 if (!ACCESS_ONCE(session->active))
744 return 0;
745 if (session->metadata_dumped)
746 goto skip_session;
f40270ad 747 if (!session->metadata) {
cd4bd11f 748 printk(KERN_WARNING "LTTng: attempt to start tracing, but metadata channel is not found. Operation abort.\n");
f40270ad
MD
749 return -EPERM;
750 }
c099397a 751
d793d5e1 752 snprintf(uuid_s, sizeof(uuid_s),
30bdb6e4
MD
753 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
754 uuid_c[0], uuid_c[1], uuid_c[2], uuid_c[3],
755 uuid_c[4], uuid_c[5], uuid_c[6], uuid_c[7],
756 uuid_c[8], uuid_c[9], uuid_c[10], uuid_c[11],
757 uuid_c[12], uuid_c[13], uuid_c[14], uuid_c[15]);
d793d5e1
MD
758
759 ret = lttng_metadata_printf(session,
9115fbdc
MD
760 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
761 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
762 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
763 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
764 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
765 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
d793d5e1
MD
766 "\n"
767 "trace {\n"
768 " major = %u;\n"
769 " minor = %u;\n"
30bdb6e4 770 " uuid = \"%s\";\n"
d793d5e1
MD
771 " byte_order = %s;\n"
772 " packet.header := struct {\n"
773 " uint32_t magic;\n"
1ec3f75a 774 " uint8_t uuid[16];\n"
d793d5e1 775 " uint32_t stream_id;\n"
0eb25f58 776 " };\n"
d793d5e1
MD
777 "};\n\n",
778 ltt_alignof(uint8_t) * CHAR_BIT,
0eb25f58 779 ltt_alignof(uint16_t) * CHAR_BIT,
d793d5e1
MD
780 ltt_alignof(uint32_t) * CHAR_BIT,
781 ltt_alignof(uint64_t) * CHAR_BIT,
782 CTF_VERSION_MAJOR,
783 CTF_VERSION_MINOR,
784 uuid_s,
785#ifdef __BIG_ENDIAN
786 "be"
787#else
788 "le"
789#endif
790 );
791 if (ret)
792 goto end;
793
9115fbdc
MD
794 ret = _ltt_stream_packet_context_declare(session);
795 if (ret)
796 goto end;
797
798 ret = _ltt_event_header_declare(session);
799 if (ret)
800 goto end;
801
c099397a
MD
802skip_session:
803 list_for_each_entry(chan, &session->chan, list) {
804 ret = _ltt_channel_metadata_statedump(session, chan);
805 if (ret)
806 goto end;
807 }
808
809 list_for_each_entry(event, &session->events, list) {
91e0dcaa 810 ret = _ltt_event_metadata_statedump(session, event->chan, event);
c099397a
MD
811 if (ret)
812 goto end;
813 }
814 session->metadata_dumped = 1;
815end:
816 return ret;
817}
818
c0e31d2e
MD
819/**
820 * ltt_transport_register - LTT transport registration
821 * @transport: transport structure
822 *
823 * Registers a transport which can be used as output to extract the data out of
824 * LTTng. The module calling this registration function must ensure that no
825 * trap-inducing code will be executed by the transport functions. E.g.
826 * vmalloc_sync_all() must be called between a vmalloc and the moment the memory
827 * is made visible to the transport function. This registration acts as a
828 * vmalloc_sync_all. Therefore, only if the module allocates virtual memory
829 * after its registration must it synchronize the TLBs.
830 */
831void ltt_transport_register(struct ltt_transport *transport)
832{
833 /*
834 * Make sure no page fault can be triggered by the module about to be
835 * registered. We deal with this here so we don't have to call
836 * vmalloc_sync_all() in each module's init.
837 */
6d2a620c 838 wrapper_vmalloc_sync_all();
c0e31d2e
MD
839
840 mutex_lock(&sessions_mutex);
841 list_add_tail(&transport->node, &ltt_transport_list);
842 mutex_unlock(&sessions_mutex);
843}
844EXPORT_SYMBOL_GPL(ltt_transport_register);
845
846/**
847 * ltt_transport_unregister - LTT transport unregistration
848 * @transport: transport structure
849 */
850void ltt_transport_unregister(struct ltt_transport *transport)
851{
852 mutex_lock(&sessions_mutex);
853 list_del(&transport->node);
854 mutex_unlock(&sessions_mutex);
855}
856EXPORT_SYMBOL_GPL(ltt_transport_unregister);
857
4e3c1b9b
MD
858static int __init ltt_events_init(void)
859{
1c25284c
MD
860 int ret;
861
11b5a3c2
MD
862 event_cache = KMEM_CACHE(ltt_event, 0);
863 if (!event_cache)
4e3c1b9b 864 return -ENOMEM;
02119ee5
MD
865 ret = ltt_debugfs_abi_init();
866 if (ret)
867 goto error_abi;
4e3c1b9b 868 return 0;
02119ee5 869error_abi:
1c25284c
MD
870 kmem_cache_destroy(event_cache);
871 return ret;
4e3c1b9b
MD
872}
873
11b5a3c2
MD
874module_init(ltt_events_init);
875
4e3c1b9b
MD
876static void __exit ltt_events_exit(void)
877{
92e94819
MD
878 struct ltt_session *session, *tmpsession;
879
1c25284c 880 ltt_debugfs_abi_exit();
92e94819
MD
881 list_for_each_entry_safe(session, tmpsession, &sessions, list)
882 ltt_session_destroy(session);
11b5a3c2 883 kmem_cache_destroy(event_cache);
4e3c1b9b 884}
92e94819 885
11b5a3c2
MD
886module_exit(ltt_events_exit);
887
92e94819
MD
888MODULE_LICENSE("GPL and additional rights");
889MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
890MODULE_DESCRIPTION("LTTng Events");
This page took 0.0651 seconds and 4 git commands to generate.