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