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