Write context fields into trace
[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;
c0e31d2e 108 synchronize_trace(); /* Wait for in-flight events to complete */
c099397a
MD
109 ret = _ltt_session_metadata_statedump(session);
110 if (ret) {
111 ACCESS_ONCE(session->active) = 0;
112 synchronize_trace(); /* Wait for in-flight events to complete */
113 }
c0e31d2e
MD
114end:
115 mutex_unlock(&sessions_mutex);
11b5a3c2 116 return ret;
c0e31d2e
MD
117}
118
119int ltt_session_stop(struct ltt_session *session)
120{
121 int ret = 0;
122
123 mutex_lock(&sessions_mutex);
124 if (!session->active) {
125 ret = -EBUSY;
126 goto end;
127 }
52fc2e1f 128 ACCESS_ONCE(session->active) = 0;
c0e31d2e
MD
129 synchronize_trace(); /* Wait for in-flight events to complete */
130end:
131 mutex_unlock(&sessions_mutex);
11b5a3c2 132 return ret;
c0e31d2e
MD
133}
134
c535175e 135static struct ltt_transport *ltt_transport_find(const char *name)
f3d01b96
MD
136{
137 struct ltt_transport *transport;
138
139 list_for_each_entry(transport, &ltt_transport_list, node) {
140 if (!strcmp(transport->name, name))
141 return transport;
142 }
143 return NULL;
144}
145
baf20995 146struct ltt_channel *ltt_channel_create(struct ltt_session *session,
5dbbdb43
MD
147 const char *transport_name,
148 void *buf_addr,
4e3c1b9b
MD
149 size_t subbuf_size, size_t num_subbuf,
150 unsigned int switch_timer_interval,
151 unsigned int read_timer_interval)
152{
153 struct ltt_channel *chan;
f3d01b96 154 struct ltt_transport *transport;
4e3c1b9b
MD
155
156 mutex_lock(&sessions_mutex);
f3d01b96
MD
157 if (session->active) {
158 printk(KERN_WARNING "LTTng refusing to add channel to active session\n");
e5382b6d 159 goto active; /* Refuse to add channel to active session */
c0e31d2e 160 }
f3d01b96
MD
161 transport = ltt_transport_find(transport_name);
162 if (!transport) {
163 printk(KERN_WARNING "LTTng transport %s not found\n",
164 transport_name);
c0e31d2e 165 goto notransport;
f3d01b96 166 }
f3d01b96 167 chan = kzalloc(sizeof(struct ltt_channel), GFP_KERNEL);
4e3c1b9b 168 if (!chan)
c0e31d2e 169 goto nomem;
4e3c1b9b 170 chan->session = session;
653fe716 171 init_waitqueue_head(&chan->notify_wait);
05d32c64 172 chan->id = session->free_chan_id++;
125b4df4
MD
173 /*
174 * Note: the channel creation op already writes into the packet
175 * headers. Therefore the "chan" information used as input
176 * should be already accessible.
177 */
9115fbdc 178 chan->chan = transport->ops.channel_create("[lttng]", chan, buf_addr,
11b5a3c2
MD
179 subbuf_size, num_subbuf, switch_timer_interval,
180 read_timer_interval);
f3d01b96
MD
181 if (!chan->chan)
182 goto create_error;
11b5a3c2 183 chan->ops = &transport->ops;
4e3c1b9b
MD
184 list_add(&chan->list, &session->chan);
185 mutex_unlock(&sessions_mutex);
186 return chan;
187
f3d01b96
MD
188create_error:
189 kfree(chan);
c0e31d2e
MD
190nomem:
191notransport:
e5382b6d 192active:
4e3c1b9b
MD
193 mutex_unlock(&sessions_mutex);
194 return NULL;
195}
196
197/*
198 * Only used internally at session destruction.
199 */
aa7c23a9 200static
11b5a3c2 201void _ltt_channel_destroy(struct ltt_channel *chan)
4e3c1b9b 202{
11b5a3c2 203 chan->ops->channel_destroy(chan->chan);
4e3c1b9b
MD
204 list_del(&chan->list);
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);
11b5a3c2 343 kmem_cache_free(event_cache, event);
4e3c1b9b
MD
344}
345
1ec3f75a
MD
346/*
347 * We have exclusive access to our metadata buffer (protected by the
348 * sessions_mutex), so we can do racy operations such as looking for
349 * remaining space left in packet and write, since mutual exclusion
350 * protects us from concurrent writes.
351 */
c099397a
MD
352int lttng_metadata_printf(struct ltt_session *session,
353 const char *fmt, ...)
354{
355 struct lib_ring_buffer_ctx ctx;
356 struct ltt_channel *chan = session->metadata;
357 char *str;
358 int ret = 0, waitret;
1ec3f75a 359 size_t len, reserve_len, pos;
c099397a
MD
360 va_list ap;
361
362 WARN_ON_ONCE(!ACCESS_ONCE(session->active));
363
364 va_start(ap, fmt);
365 str = kvasprintf(GFP_KERNEL, fmt, ap);
366 va_end(ap);
367 if (!str)
368 return -ENOMEM;
369
1ec3f75a
MD
370 len = strlen(str);
371 pos = 0;
372
373 for (pos = 0; pos < len; pos += reserve_len) {
374 reserve_len = min_t(size_t,
375 chan->ops->packet_avail_size(chan->chan),
376 len - pos);
377 lib_ring_buffer_ctx_init(&ctx, chan->chan, NULL, reserve_len,
378 sizeof(char), -1);
379 /*
380 * We don't care about metadata buffer's records lost
381 * count, because we always retry here. Report error if
382 * we need to bail out after timeout or being
383 * interrupted.
384 */
385 waitret = wait_event_interruptible_timeout(*chan->ops->get_reader_wait_queue(chan),
386 ({
4e1f08f4 387 ret = chan->ops->event_reserve(&ctx, 0);
1ec3f75a
MD
388 ret != -ENOBUFS || !ret;
389 }),
390 msecs_to_jiffies(LTTNG_METADATA_TIMEOUT_MSEC));
391 if (!waitret || waitret == -ERESTARTSYS || ret) {
392 printk(KERN_WARNING "LTTng: Failure to write metadata to buffers (%s)\n",
393 waitret == -ERESTARTSYS ? "interrupted" :
394 (ret == -ENOBUFS ? "timeout" : "I/O error"));
395 if (waitret == -ERESTARTSYS)
396 ret = waitret;
397 goto end;
398 }
399 chan->ops->event_write(&ctx, &str[pos], len);
400 chan->ops->event_commit(&ctx);
c099397a 401 }
c099397a
MD
402end:
403 kfree(str);
404 return ret;
405}
406
407static
408int _ltt_fields_metadata_statedump(struct ltt_session *session,
409 struct ltt_event *event)
410{
411 const struct lttng_event_desc *desc = event->desc;
412 int ret = 0;
413 int i;
414
415 for (i = 0; i < desc->nr_fields; i++) {
416 const struct lttng_event_field *field = &desc->fields[i];
417
418 switch (field->type.atype) {
419 case atype_integer:
420 ret = lttng_metadata_printf(session,
e0a7a7c4 421 " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s;\n",
c099397a
MD
422 field->type.u.basic.integer.size,
423 field->type.u.basic.integer.alignment,
424 field->type.u.basic.integer.signedness,
e0a7a7c4
MD
425 (field->type.u.basic.integer.encoding == lttng_encode_none)
426 ? "none"
427 : (field->type.u.basic.integer.encoding == lttng_encode_UTF8)
428 ? "UTF8"
429 : "ASCII",
430 field->type.u.basic.integer.base,
c099397a
MD
431#ifdef __BIG_ENDIAN
432 field->type.u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
433#else
434 field->type.u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
435#endif
436 field->name);
437 break;
438 case atype_enum:
439 ret = lttng_metadata_printf(session,
440 " %s %s;\n",
441 field->type.u.basic.enumeration.name,
442 field->name);
443 break;
444 case atype_array:
8fa75f34
MD
445 {
446 const struct lttng_basic_type *elem_type;
447
448 elem_type = &field->type.u.array.elem_type;
449 ret = lttng_metadata_printf(session,
e0a7a7c4 450 " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s[%u];\n",
8fa75f34
MD
451 elem_type->u.basic.integer.size,
452 elem_type->u.basic.integer.alignment,
453 elem_type->u.basic.integer.signedness,
e0a7a7c4
MD
454 (elem_type->u.basic.integer.encoding == lttng_encode_none)
455 ? "none"
456 : (elem_type->u.basic.integer.encoding == lttng_encode_UTF8)
457 ? "UTF8"
458 : "ASCII",
459 elem_type->u.basic.integer.base,
8fa75f34
MD
460#ifdef __BIG_ENDIAN
461 elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
462#else
463 elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
464#endif
465 field->name, field->type.u.array.length);
c099397a 466 break;
8fa75f34 467 }
c099397a 468 case atype_sequence:
8fa75f34
MD
469 {
470 const struct lttng_basic_type *elem_type;
471 const struct lttng_basic_type *length_type;
472
473 elem_type = &field->type.u.sequence.elem_type;
474 length_type = &field->type.u.sequence.length_type;
475 ret = lttng_metadata_printf(session,
e0a7a7c4
MD
476 " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n",
477 " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } %s[ __%s_length ];\n",
478 length_type->u.basic.integer.size,
479 length_type->u.basic.integer.alignment,
480 length_type->u.basic.integer.signedness,
481 (length_type->u.basic.integer.encoding == lttng_encode_none)
482 ? "none"
483 : (length_type->u.basic.integer.encoding == lttng_encode_UTF8)
484 ? "UTF8"
485 : "ASCII",
486 length_type->u.basic.integer.base,
487#ifdef __BIG_ENDIAN
488 length_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
489#else
490 length_type->u.basic.integer.reverse_byte_order
491? " byte_order = be;" : "",
492#endif
493 field->name,
8fa75f34
MD
494 elem_type->u.basic.integer.size,
495 elem_type->u.basic.integer.alignment,
496 elem_type->u.basic.integer.signedness,
e0a7a7c4
MD
497 (elem_type->u.basic.integer.encoding == lttng_encode_none)
498 ? "none"
499 : (elem_type->u.basic.integer.encoding == lttng_encode_UTF8)
500 ? "UTF8"
501 : "ASCII",
502 elem_type->u.basic.integer.base,
8fa75f34
MD
503#ifdef __BIG_ENDIAN
504 elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
505#else
506 elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
507#endif
508 field->name,
e0a7a7c4 509 field->name
8fa75f34 510 );
c099397a 511 break;
8fa75f34 512 }
c099397a
MD
513
514 case atype_string:
e0a7a7c4 515 /* Default encoding is UTF8 */
c099397a
MD
516 ret = lttng_metadata_printf(session,
517 " string%s %s;\n",
518 field->type.u.basic.string.encoding == lttng_encode_ASCII ?
519 " { encoding = ASCII; }" : "",
520 field->name);
521 break;
522 default:
523 WARN_ON_ONCE(1);
524 return -EINVAL;
525 }
526 }
527 return ret;
528}
529
530static
531int _ltt_event_metadata_statedump(struct ltt_session *session,
532 struct ltt_channel *chan,
533 struct ltt_event *event)
534{
535 int ret = 0;
536
537 if (event->metadata_dumped || !ACCESS_ONCE(session->active))
538 return 0;
539 if (chan == session->metadata)
540 return 0;
541
542 ret = lttng_metadata_printf(session,
543 "event {\n"
544 " name = %s;\n"
545 " id = %u;\n"
546 " stream_id = %u;\n"
91e0dcaa 547 " fields := struct {\n",
c099397a
MD
548 event->desc->name,
549 event->id,
550 event->chan->id);
551 if (ret)
552 goto end;
553
554 ret = _ltt_fields_metadata_statedump(session, event);
555 if (ret)
556 goto end;
557
558 /*
559 * LTTng space reservation can only reserve multiples of the
560 * byte size.
561 */
562 ret = lttng_metadata_printf(session,
9115fbdc
MD
563 " };\n"
564 "};\n\n");
c099397a
MD
565 if (ret)
566 goto end;
567
c099397a
MD
568 event->metadata_dumped = 1;
569end:
570 return ret;
571
572}
573
574static
575int _ltt_channel_metadata_statedump(struct ltt_session *session,
576 struct ltt_channel *chan)
577{
578 int ret = 0;
579
580 if (chan->metadata_dumped || !ACCESS_ONCE(session->active))
581 return 0;
582 if (chan == session->metadata)
583 return 0;
584
585 WARN_ON_ONCE(!chan->header_type);
586 ret = lttng_metadata_printf(session,
587 "stream {\n"
588 " id = %u;\n"
9115fbdc
MD
589 " event.header := %s;\n"
590 " packet.context := struct packet_context;\n"
d793d5e1 591 "};\n\n",
c099397a
MD
592 chan->id,
593 chan->header_type == 1 ? "struct event_header_compact" :
594 "struct event_header_large");
595 if (ret)
596 goto end;
597
598 chan->metadata_dumped = 1;
599end:
600 return ret;
601}
602
9115fbdc
MD
603static
604int _ltt_stream_packet_context_declare(struct ltt_session *session)
605{
606 return lttng_metadata_printf(session,
607 "struct packet_context {\n"
608 " uint64_t timestamp_begin;\n"
609 " uint64_t timestamp_end;\n"
610 " uint32_t events_discarded;\n"
611 " uint32_t content_size;\n"
612 " uint32_t packet_size;\n"
613 " uint32_t cpu_id;\n"
c6dfdf6f 614 "};\n\n"
9115fbdc
MD
615 );
616}
617
618/*
619 * Compact header:
620 * id: range: 0 - 30.
621 * id 31 is reserved to indicate an extended header.
622 *
623 * Large header:
624 * id: range: 0 - 65534.
625 * id 65535 is reserved to indicate an extended header.
626 */
627static
628int _ltt_event_header_declare(struct ltt_session *session)
629{
630 return lttng_metadata_printf(session,
631 "struct event_header_compact {\n"
632 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
633 " variant <id> {\n"
634 " struct {\n"
635 " uint27_t timestamp;\n"
636 " } compact;\n"
637 " struct {\n"
638 " uint32_t id;\n"
639 " uint64_t timestamp;\n"
640 " } extended;\n"
641 " } v;\n"
642 "} align(%u);\n"
643 "\n"
644 "struct event_header_large {\n"
645 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
646 " variant <id> {\n"
647 " struct {\n"
648 " uint32_t timestamp;\n"
649 " } compact;\n"
650 " struct {\n"
651 " uint32_t id;\n"
652 " uint64_t timestamp;\n"
653 " } extended;\n"
654 " } v;\n"
655 "} align(%u);\n\n",
656 ltt_alignof(uint32_t) * CHAR_BIT,
657 ltt_alignof(uint16_t) * CHAR_BIT
658 );
659}
660
c099397a
MD
661/*
662 * Output metadata into this session's metadata buffers.
663 */
664static
665int _ltt_session_metadata_statedump(struct ltt_session *session)
666{
30bdb6e4
MD
667 unsigned char *uuid_c = session->uuid.b;
668 unsigned char uuid_s[37];
c099397a
MD
669 struct ltt_channel *chan;
670 struct ltt_event *event;
671 int ret = 0;
672
673 if (!ACCESS_ONCE(session->active))
674 return 0;
675 if (session->metadata_dumped)
676 goto skip_session;
f40270ad 677 if (!session->metadata) {
cd4bd11f 678 printk(KERN_WARNING "LTTng: attempt to start tracing, but metadata channel is not found. Operation abort.\n");
f40270ad
MD
679 return -EPERM;
680 }
c099397a 681
d793d5e1 682 snprintf(uuid_s, sizeof(uuid_s),
30bdb6e4
MD
683 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
684 uuid_c[0], uuid_c[1], uuid_c[2], uuid_c[3],
685 uuid_c[4], uuid_c[5], uuid_c[6], uuid_c[7],
686 uuid_c[8], uuid_c[9], uuid_c[10], uuid_c[11],
687 uuid_c[12], uuid_c[13], uuid_c[14], uuid_c[15]);
d793d5e1
MD
688
689 ret = lttng_metadata_printf(session,
9115fbdc
MD
690 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
691 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
692 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
693 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
694 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
695 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
d793d5e1
MD
696 "\n"
697 "trace {\n"
698 " major = %u;\n"
699 " minor = %u;\n"
30bdb6e4 700 " uuid = \"%s\";\n"
d793d5e1
MD
701 " byte_order = %s;\n"
702 " packet.header := struct {\n"
703 " uint32_t magic;\n"
1ec3f75a 704 " uint8_t uuid[16];\n"
d793d5e1 705 " uint32_t stream_id;\n"
0eb25f58 706 " };\n"
d793d5e1
MD
707 "};\n\n",
708 ltt_alignof(uint8_t) * CHAR_BIT,
0eb25f58 709 ltt_alignof(uint16_t) * CHAR_BIT,
d793d5e1
MD
710 ltt_alignof(uint32_t) * CHAR_BIT,
711 ltt_alignof(uint64_t) * CHAR_BIT,
712 CTF_VERSION_MAJOR,
713 CTF_VERSION_MINOR,
714 uuid_s,
715#ifdef __BIG_ENDIAN
716 "be"
717#else
718 "le"
719#endif
720 );
721 if (ret)
722 goto end;
723
9115fbdc
MD
724 ret = _ltt_stream_packet_context_declare(session);
725 if (ret)
726 goto end;
727
728 ret = _ltt_event_header_declare(session);
729 if (ret)
730 goto end;
731
c099397a
MD
732skip_session:
733 list_for_each_entry(chan, &session->chan, list) {
734 ret = _ltt_channel_metadata_statedump(session, chan);
735 if (ret)
736 goto end;
737 }
738
739 list_for_each_entry(event, &session->events, list) {
91e0dcaa 740 ret = _ltt_event_metadata_statedump(session, event->chan, event);
c099397a
MD
741 if (ret)
742 goto end;
743 }
744 session->metadata_dumped = 1;
745end:
746 return ret;
747}
748
c0e31d2e
MD
749/**
750 * ltt_transport_register - LTT transport registration
751 * @transport: transport structure
752 *
753 * Registers a transport which can be used as output to extract the data out of
754 * LTTng. The module calling this registration function must ensure that no
755 * trap-inducing code will be executed by the transport functions. E.g.
756 * vmalloc_sync_all() must be called between a vmalloc and the moment the memory
757 * is made visible to the transport function. This registration acts as a
758 * vmalloc_sync_all. Therefore, only if the module allocates virtual memory
759 * after its registration must it synchronize the TLBs.
760 */
761void ltt_transport_register(struct ltt_transport *transport)
762{
763 /*
764 * Make sure no page fault can be triggered by the module about to be
765 * registered. We deal with this here so we don't have to call
766 * vmalloc_sync_all() in each module's init.
767 */
6d2a620c 768 wrapper_vmalloc_sync_all();
c0e31d2e
MD
769
770 mutex_lock(&sessions_mutex);
771 list_add_tail(&transport->node, &ltt_transport_list);
772 mutex_unlock(&sessions_mutex);
773}
774EXPORT_SYMBOL_GPL(ltt_transport_register);
775
776/**
777 * ltt_transport_unregister - LTT transport unregistration
778 * @transport: transport structure
779 */
780void ltt_transport_unregister(struct ltt_transport *transport)
781{
782 mutex_lock(&sessions_mutex);
783 list_del(&transport->node);
784 mutex_unlock(&sessions_mutex);
785}
786EXPORT_SYMBOL_GPL(ltt_transport_unregister);
787
4e3c1b9b
MD
788static int __init ltt_events_init(void)
789{
1c25284c
MD
790 int ret;
791
11b5a3c2
MD
792 event_cache = KMEM_CACHE(ltt_event, 0);
793 if (!event_cache)
4e3c1b9b 794 return -ENOMEM;
02119ee5
MD
795 ret = ltt_debugfs_abi_init();
796 if (ret)
797 goto error_abi;
4e3c1b9b 798 return 0;
02119ee5 799error_abi:
1c25284c
MD
800 kmem_cache_destroy(event_cache);
801 return ret;
4e3c1b9b
MD
802}
803
11b5a3c2
MD
804module_init(ltt_events_init);
805
4e3c1b9b
MD
806static void __exit ltt_events_exit(void)
807{
92e94819
MD
808 struct ltt_session *session, *tmpsession;
809
1c25284c 810 ltt_debugfs_abi_exit();
92e94819
MD
811 list_for_each_entry_safe(session, tmpsession, &sessions, list)
812 ltt_session_destroy(session);
11b5a3c2 813 kmem_cache_destroy(event_cache);
4e3c1b9b 814}
92e94819 815
11b5a3c2
MD
816module_exit(ltt_events_exit);
817
92e94819
MD
818MODULE_LICENSE("GPL and additional rights");
819MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
820MODULE_DESCRIPTION("LTTng Events");
This page took 0.059947 seconds and 4 git commands to generate.