Commit | Line | Data |
---|---|---|
8020ceb5 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 | * Dual LGPL v2.1/GPL v2 license. | |
9 | */ | |
10 | ||
b5234c06 MD |
11 | #define _GNU_SOURCE |
12 | #include <stdio.h> | |
8a98a75d | 13 | #include <endian.h> |
b5234c06 | 14 | #include <urcu/list.h> |
8165c8da | 15 | #include <urcu/hlist.h> |
b5234c06 MD |
16 | #include <pthread.h> |
17 | #include <urcu-bp.h> | |
18 | #include <urcu/compiler.h> | |
19 | #include <urcu/uatomic.h> | |
20 | #include <uuid/uuid.h> | |
4318ae1b | 21 | #include <lttng/tracepoint.h> |
b5234c06 | 22 | #include <errno.h> |
f4681817 MD |
23 | #include <sys/shm.h> |
24 | #include <sys/ipc.h> | |
4318ae1b MD |
25 | #include <lttng/ust-events.h> |
26 | #include <lttng/usterr-signal-safe.h> | |
27 | #include "lttng/core.h" | |
8020ceb5 | 28 | #include "ltt-tracer.h" |
8165c8da | 29 | #include "ltt-tracer-core.h" |
4318ae1b | 30 | #include "lttng/wait.h" |
8d8a24c8 | 31 | #include "../libringbuffer/shm.h" |
8020ceb5 | 32 | |
8165c8da | 33 | typedef u32 uint32_t; |
4318ae1b | 34 | #include <lttng/kcompat/jhash.h> |
8165c8da MD |
35 | |
36 | /* | |
37 | * The sessions mutex is the centralized mutex across UST tracing | |
17dfb34b MD |
38 | * control and probe registration. All operations within this file are |
39 | * called by the communication thread, under ust_lock protection. | |
8165c8da MD |
40 | */ |
41 | static DEFINE_MUTEX(sessions_mutex); | |
42 | ||
17dfb34b | 43 | void ust_lock(void) |
8165c8da MD |
44 | { |
45 | pthread_mutex_lock(&sessions_mutex); | |
46 | } | |
47 | ||
17dfb34b | 48 | void ust_unlock(void) |
8165c8da MD |
49 | { |
50 | pthread_mutex_unlock(&sessions_mutex); | |
51 | } | |
52 | ||
b5234c06 | 53 | static CDS_LIST_HEAD(sessions); |
8165c8da MD |
54 | |
55 | /* | |
56 | * Pending probes hash table, containing the registered ltt events for | |
57 | * which tracepoint probes are still missing. Protected by the sessions | |
58 | * mutex. | |
59 | */ | |
60 | #define PENDING_PROBE_HASH_BITS 6 | |
61 | #define PENDING_PROBE_HASH_SIZE (1 << PENDING_PROBE_HASH_BITS) | |
62 | static struct cds_hlist_head pending_probe_table[PENDING_PROBE_HASH_SIZE]; | |
63 | ||
64 | struct ust_pending_probe { | |
65 | struct ltt_event *event; | |
66 | struct cds_hlist_node node; | |
67 | char name[]; | |
68 | }; | |
8020ceb5 MD |
69 | |
70 | static void _ltt_event_destroy(struct ltt_event *event); | |
71 | static void _ltt_channel_destroy(struct ltt_channel *chan); | |
72 | static int _ltt_event_unregister(struct ltt_event *event); | |
73 | static | |
74 | int _ltt_event_metadata_statedump(struct ltt_session *session, | |
75 | struct ltt_channel *chan, | |
76 | struct ltt_event *event); | |
77 | static | |
78 | int _ltt_session_metadata_statedump(struct ltt_session *session); | |
79 | ||
8165c8da MD |
80 | /* |
81 | * called at event creation if probe is missing. | |
82 | * called with session mutex held. | |
83 | */ | |
84 | static | |
85 | int add_pending_probe(struct ltt_event *event, const char *name) | |
86 | { | |
87 | struct cds_hlist_head *head; | |
8165c8da MD |
88 | struct ust_pending_probe *e; |
89 | size_t name_len = strlen(name) + 1; | |
90 | u32 hash = jhash(name, name_len - 1, 0); | |
91 | ||
92 | head = &pending_probe_table[hash & (PENDING_PROBE_HASH_SIZE - 1)]; | |
93 | e = zmalloc(sizeof(struct ust_pending_probe) + name_len); | |
94 | if (!e) | |
95 | return -ENOMEM; | |
96 | memcpy(&e->name[0], name, name_len); | |
97 | cds_hlist_add_head(&e->node, head); | |
98 | e->event = event; | |
99 | event->pending_probe = e; | |
100 | return 0; | |
101 | } | |
102 | ||
103 | /* | |
104 | * remove a pending probe. called when at event teardown and when an | |
105 | * event is fixed (probe is loaded). | |
106 | * called with session mutex held. | |
107 | */ | |
108 | static | |
109 | void remove_pending_probe(struct ust_pending_probe *e) | |
110 | { | |
111 | if (!e) | |
112 | return; | |
113 | cds_hlist_del(&e->node); | |
114 | free(e); | |
115 | } | |
116 | ||
117 | /* | |
118 | * Called at library load: connect the probe on the events pending on | |
119 | * probe load. | |
120 | * called with session mutex held. | |
121 | */ | |
122 | int pending_probe_fix_events(const struct lttng_event_desc *desc) | |
123 | { | |
124 | struct cds_hlist_head *head; | |
125 | struct cds_hlist_node *node, *p; | |
126 | struct ust_pending_probe *e; | |
127 | const char *name = desc->name; | |
128 | size_t name_len = strlen(name) + 1; | |
129 | u32 hash = jhash(name, name_len - 1, 0); | |
130 | int ret = 0; | |
131 | ||
132 | head = &pending_probe_table[hash & (PENDING_PROBE_HASH_SIZE - 1)]; | |
133 | cds_hlist_for_each_entry_safe(e, node, p, head, node) { | |
134 | struct ltt_event *event; | |
135 | struct ltt_channel *chan; | |
136 | ||
137 | if (strcmp(name, e->name)) | |
138 | continue; | |
139 | event = e->event; | |
140 | chan = event->chan; | |
141 | assert(!event->desc); | |
142 | event->desc = desc; | |
143 | event->pending_probe = NULL; | |
144 | remove_pending_probe(e); | |
145 | ret |= __tracepoint_probe_register(name, | |
146 | event->desc->probe_callback, | |
147 | event); | |
636c5aa4 MD |
148 | if (ret) |
149 | continue; | |
150 | event->id = chan->free_event_id++; | |
8165c8da MD |
151 | ret |= _ltt_event_metadata_statedump(chan->session, chan, |
152 | event); | |
153 | } | |
154 | return ret; | |
155 | } | |
156 | ||
8020ceb5 MD |
157 | void synchronize_trace(void) |
158 | { | |
8020ceb5 | 159 | synchronize_rcu(); |
8020ceb5 MD |
160 | } |
161 | ||
162 | struct ltt_session *ltt_session_create(void) | |
163 | { | |
164 | struct ltt_session *session; | |
165 | ||
b5234c06 | 166 | session = zmalloc(sizeof(struct ltt_session)); |
8020ceb5 MD |
167 | if (!session) |
168 | return NULL; | |
b5234c06 MD |
169 | CDS_INIT_LIST_HEAD(&session->chan); |
170 | CDS_INIT_LIST_HEAD(&session->events); | |
171 | uuid_generate(session->uuid); | |
172 | cds_list_add(&session->list, &sessions); | |
8020ceb5 MD |
173 | return session; |
174 | } | |
175 | ||
176 | void ltt_session_destroy(struct ltt_session *session) | |
177 | { | |
178 | struct ltt_channel *chan, *tmpchan; | |
179 | struct ltt_event *event, *tmpevent; | |
180 | int ret; | |
181 | ||
b5234c06 MD |
182 | CMM_ACCESS_ONCE(session->active) = 0; |
183 | cds_list_for_each_entry(event, &session->events, list) { | |
8020ceb5 MD |
184 | ret = _ltt_event_unregister(event); |
185 | WARN_ON(ret); | |
186 | } | |
187 | synchronize_trace(); /* Wait for in-flight events to complete */ | |
b5234c06 | 188 | cds_list_for_each_entry_safe(event, tmpevent, &session->events, list) |
8020ceb5 | 189 | _ltt_event_destroy(event); |
b5234c06 | 190 | cds_list_for_each_entry_safe(chan, tmpchan, &session->chan, list) |
8020ceb5 | 191 | _ltt_channel_destroy(chan); |
b5234c06 | 192 | cds_list_del(&session->list); |
b5234c06 | 193 | free(session); |
8020ceb5 MD |
194 | } |
195 | ||
976fe9ea | 196 | int ltt_session_enable(struct ltt_session *session) |
8020ceb5 MD |
197 | { |
198 | int ret = 0; | |
199 | struct ltt_channel *chan; | |
200 | ||
8020ceb5 MD |
201 | if (session->active) { |
202 | ret = -EBUSY; | |
203 | goto end; | |
204 | } | |
205 | ||
206 | /* | |
207 | * Snapshot the number of events per channel to know the type of header | |
208 | * we need to use. | |
209 | */ | |
b5234c06 | 210 | cds_list_for_each_entry(chan, &session->chan, list) { |
8020ceb5 MD |
211 | if (chan->header_type) |
212 | continue; /* don't change it if session stop/restart */ | |
213 | if (chan->free_event_id < 31) | |
214 | chan->header_type = 1; /* compact */ | |
215 | else | |
216 | chan->header_type = 2; /* large */ | |
217 | } | |
218 | ||
b5234c06 MD |
219 | CMM_ACCESS_ONCE(session->active) = 1; |
220 | CMM_ACCESS_ONCE(session->been_active) = 1; | |
8020ceb5 | 221 | ret = _ltt_session_metadata_statedump(session); |
4b4de73e | 222 | if (ret) |
b5234c06 | 223 | CMM_ACCESS_ONCE(session->active) = 0; |
8020ceb5 | 224 | end: |
8020ceb5 MD |
225 | return ret; |
226 | } | |
227 | ||
976fe9ea | 228 | int ltt_session_disable(struct ltt_session *session) |
8020ceb5 MD |
229 | { |
230 | int ret = 0; | |
231 | ||
8020ceb5 MD |
232 | if (!session->active) { |
233 | ret = -EBUSY; | |
234 | goto end; | |
235 | } | |
b5234c06 | 236 | CMM_ACCESS_ONCE(session->active) = 0; |
8020ceb5 | 237 | end: |
8020ceb5 MD |
238 | return ret; |
239 | } | |
240 | ||
976fe9ea MD |
241 | int ltt_channel_enable(struct ltt_channel *channel) |
242 | { | |
243 | int old; | |
244 | ||
9beb36ba MD |
245 | if (channel == channel->session->metadata) |
246 | return -EPERM; | |
b5234c06 | 247 | old = uatomic_xchg(&channel->enabled, 1); |
976fe9ea MD |
248 | if (old) |
249 | return -EEXIST; | |
250 | return 0; | |
251 | } | |
252 | ||
253 | int ltt_channel_disable(struct ltt_channel *channel) | |
254 | { | |
255 | int old; | |
256 | ||
9beb36ba MD |
257 | if (channel == channel->session->metadata) |
258 | return -EPERM; | |
b5234c06 | 259 | old = uatomic_xchg(&channel->enabled, 0); |
976fe9ea MD |
260 | if (!old) |
261 | return -EEXIST; | |
262 | return 0; | |
263 | } | |
264 | ||
265 | int ltt_event_enable(struct ltt_event *event) | |
266 | { | |
267 | int old; | |
268 | ||
9beb36ba MD |
269 | if (event->chan == event->chan->session->metadata) |
270 | return -EPERM; | |
b5234c06 | 271 | old = uatomic_xchg(&event->enabled, 1); |
976fe9ea MD |
272 | if (old) |
273 | return -EEXIST; | |
274 | return 0; | |
275 | } | |
276 | ||
277 | int ltt_event_disable(struct ltt_event *event) | |
278 | { | |
279 | int old; | |
280 | ||
9beb36ba MD |
281 | if (event->chan == event->chan->session->metadata) |
282 | return -EPERM; | |
b5234c06 | 283 | old = uatomic_xchg(&event->enabled, 0); |
976fe9ea MD |
284 | if (!old) |
285 | return -EEXIST; | |
286 | return 0; | |
287 | } | |
288 | ||
8020ceb5 MD |
289 | struct ltt_channel *ltt_channel_create(struct ltt_session *session, |
290 | const char *transport_name, | |
291 | void *buf_addr, | |
292 | size_t subbuf_size, size_t num_subbuf, | |
293 | unsigned int switch_timer_interval, | |
193183fb MD |
294 | unsigned int read_timer_interval, |
295 | int *shm_fd, int *wait_fd, | |
296 | uint64_t *memory_map_size) | |
8020ceb5 MD |
297 | { |
298 | struct ltt_channel *chan; | |
299 | struct ltt_transport *transport; | |
300 | ||
8020ceb5 MD |
301 | if (session->been_active) |
302 | goto active; /* Refuse to add channel to active session */ | |
303 | transport = ltt_transport_find(transport_name); | |
304 | if (!transport) { | |
b5234c06 | 305 | DBG("LTTng transport %s not found\n", |
8020ceb5 MD |
306 | transport_name); |
307 | goto notransport; | |
308 | } | |
b5234c06 | 309 | chan = zmalloc(sizeof(struct ltt_channel)); |
8020ceb5 MD |
310 | if (!chan) |
311 | goto nomem; | |
312 | chan->session = session; | |
313 | chan->id = session->free_chan_id++; | |
314 | /* | |
315 | * Note: the channel creation op already writes into the packet | |
316 | * headers. Therefore the "chan" information used as input | |
317 | * should be already accessible. | |
318 | */ | |
1d498196 | 319 | transport->ops.channel_create("[lttng]", chan, buf_addr, |
8020ceb5 | 320 | subbuf_size, num_subbuf, switch_timer_interval, |
193183fb MD |
321 | read_timer_interval, shm_fd, wait_fd, |
322 | memory_map_size); | |
8020ceb5 MD |
323 | if (!chan->chan) |
324 | goto create_error; | |
976fe9ea | 325 | chan->enabled = 1; |
8020ceb5 | 326 | chan->ops = &transport->ops; |
b5234c06 | 327 | cds_list_add(&chan->list, &session->chan); |
8020ceb5 MD |
328 | return chan; |
329 | ||
330 | create_error: | |
b5234c06 | 331 | free(chan); |
8020ceb5 MD |
332 | nomem: |
333 | notransport: | |
334 | active: | |
8020ceb5 MD |
335 | return NULL; |
336 | } | |
337 | ||
338 | /* | |
339 | * Only used internally at session destruction. | |
340 | */ | |
341 | static | |
342 | void _ltt_channel_destroy(struct ltt_channel *chan) | |
343 | { | |
1d498196 | 344 | chan->ops->channel_destroy(chan); |
b5234c06 | 345 | cds_list_del(&chan->list); |
8020ceb5 | 346 | lttng_destroy_context(chan->ctx); |
b5234c06 | 347 | free(chan); |
8020ceb5 MD |
348 | } |
349 | ||
350 | /* | |
351 | * Supports event creation while tracing session is active. | |
352 | */ | |
353 | struct ltt_event *ltt_event_create(struct ltt_channel *chan, | |
b5234c06 | 354 | struct lttng_ust_event *event_param, |
8020ceb5 MD |
355 | void *filter) |
356 | { | |
357 | struct ltt_event *event; | |
358 | int ret; | |
359 | ||
8165c8da | 360 | if (chan->used_event_id == -1UL) |
8020ceb5 MD |
361 | goto full; |
362 | /* | |
363 | * This is O(n^2) (for each event, the loop is called at event | |
364 | * creation). Might require a hash if we have lots of events. | |
365 | */ | |
b5234c06 | 366 | cds_list_for_each_entry(event, &chan->session->events, list) |
8165c8da | 367 | if (event->desc && !strcmp(event->desc->name, event_param->name)) |
8020ceb5 | 368 | goto exist; |
b5234c06 | 369 | event = zmalloc(sizeof(struct ltt_event)); |
8020ceb5 MD |
370 | if (!event) |
371 | goto cache_error; | |
372 | event->chan = chan; | |
373 | event->filter = filter; | |
8165c8da MD |
374 | /* |
375 | * used_event_id counts the maximum number of event IDs that can | |
376 | * register if all probes register. | |
377 | */ | |
378 | chan->used_event_id++; | |
976fe9ea | 379 | event->enabled = 1; |
8020ceb5 MD |
380 | event->instrumentation = event_param->instrumentation; |
381 | /* Populate ltt_event structure before tracepoint registration. */ | |
b5234c06 | 382 | cmm_smp_wmb(); |
8020ceb5 | 383 | switch (event_param->instrumentation) { |
b5234c06 | 384 | case LTTNG_UST_TRACEPOINT: |
8020ceb5 | 385 | event->desc = ltt_event_get(event_param->name); |
8165c8da MD |
386 | if (event->desc) { |
387 | ret = __tracepoint_probe_register(event_param->name, | |
388 | event->desc->probe_callback, | |
389 | event); | |
390 | if (ret) | |
391 | goto register_error; | |
392 | event->id = chan->free_event_id++; | |
393 | } else { | |
394 | /* | |
395 | * If the probe is not present, event->desc stays NULL, | |
396 | * waiting for the probe to register, and the event->id | |
397 | * stays unallocated. | |
398 | */ | |
399 | ret = add_pending_probe(event, event_param->name); | |
400 | if (ret) | |
401 | goto add_pending_error; | |
402 | } | |
8020ceb5 | 403 | break; |
8020ceb5 MD |
404 | default: |
405 | WARN_ON_ONCE(1); | |
406 | } | |
8165c8da MD |
407 | if (event->desc) { |
408 | ret = _ltt_event_metadata_statedump(chan->session, chan, event); | |
409 | if (ret) | |
410 | goto statedump_error; | |
411 | } | |
b5234c06 | 412 | cds_list_add(&event->list, &chan->session->events); |
8020ceb5 MD |
413 | return event; |
414 | ||
415 | statedump_error: | |
8165c8da MD |
416 | if (event->desc) { |
417 | WARN_ON_ONCE(__tracepoint_probe_unregister(event_param->name, | |
418 | event->desc->probe_callback, | |
419 | event)); | |
420 | ltt_event_put(event->desc); | |
421 | } | |
422 | add_pending_error: | |
8020ceb5 | 423 | register_error: |
b5234c06 | 424 | free(event); |
8020ceb5 MD |
425 | cache_error: |
426 | exist: | |
427 | full: | |
8020ceb5 MD |
428 | return NULL; |
429 | } | |
430 | ||
431 | /* | |
432 | * Only used internally at session destruction. | |
433 | */ | |
434 | int _ltt_event_unregister(struct ltt_event *event) | |
435 | { | |
436 | int ret = -EINVAL; | |
437 | ||
438 | switch (event->instrumentation) { | |
b5234c06 | 439 | case LTTNG_UST_TRACEPOINT: |
8165c8da MD |
440 | if (event->desc) { |
441 | ret = __tracepoint_probe_unregister(event->desc->name, | |
442 | event->desc->probe_callback, | |
443 | event); | |
444 | if (ret) | |
445 | return ret; | |
446 | } else { | |
447 | remove_pending_probe(event->pending_probe); | |
448 | ret = 0; | |
449 | } | |
8020ceb5 | 450 | break; |
8020ceb5 MD |
451 | default: |
452 | WARN_ON_ONCE(1); | |
453 | } | |
454 | return ret; | |
455 | } | |
456 | ||
457 | /* | |
458 | * Only used internally at session destruction. | |
459 | */ | |
460 | static | |
461 | void _ltt_event_destroy(struct ltt_event *event) | |
462 | { | |
463 | switch (event->instrumentation) { | |
b5234c06 | 464 | case LTTNG_UST_TRACEPOINT: |
8165c8da MD |
465 | if (event->desc) { |
466 | ltt_event_put(event->desc); | |
467 | } | |
8020ceb5 | 468 | break; |
8020ceb5 MD |
469 | default: |
470 | WARN_ON_ONCE(1); | |
471 | } | |
b5234c06 | 472 | cds_list_del(&event->list); |
8020ceb5 | 473 | lttng_destroy_context(event->ctx); |
b5234c06 | 474 | free(event); |
8020ceb5 MD |
475 | } |
476 | ||
477 | /* | |
478 | * We have exclusive access to our metadata buffer (protected by the | |
17dfb34b | 479 | * ust_lock), so we can do racy operations such as looking for |
8020ceb5 MD |
480 | * remaining space left in packet and write, since mutual exclusion |
481 | * protects us from concurrent writes. | |
482 | */ | |
483 | int lttng_metadata_printf(struct ltt_session *session, | |
484 | const char *fmt, ...) | |
485 | { | |
4cfec15c | 486 | struct lttng_ust_lib_ring_buffer_ctx ctx; |
8020ceb5 | 487 | struct ltt_channel *chan = session->metadata; |
b5234c06 | 488 | char *str = NULL; |
8020ceb5 MD |
489 | int ret = 0, waitret; |
490 | size_t len, reserve_len, pos; | |
491 | va_list ap; | |
492 | ||
b5234c06 | 493 | WARN_ON_ONCE(!CMM_ACCESS_ONCE(session->active)); |
8020ceb5 MD |
494 | |
495 | va_start(ap, fmt); | |
b5234c06 | 496 | ret = vasprintf(&str, fmt, ap); |
8020ceb5 | 497 | va_end(ap); |
b5234c06 | 498 | if (ret < 0) |
8020ceb5 MD |
499 | return -ENOMEM; |
500 | ||
501 | len = strlen(str); | |
502 | pos = 0; | |
503 | ||
504 | for (pos = 0; pos < len; pos += reserve_len) { | |
505 | reserve_len = min_t(size_t, | |
1d498196 | 506 | chan->ops->packet_avail_size(chan->chan, chan->handle), |
8020ceb5 MD |
507 | len - pos); |
508 | lib_ring_buffer_ctx_init(&ctx, chan->chan, NULL, reserve_len, | |
1d498196 | 509 | sizeof(char), -1, chan->handle); |
8020ceb5 MD |
510 | /* |
511 | * We don't care about metadata buffer's records lost | |
512 | * count, because we always retry here. Report error if | |
513 | * we need to bail out after timeout or being | |
514 | * interrupted. | |
515 | */ | |
b5234c06 | 516 | waitret = wait_cond_interruptible_timeout( |
8020ceb5 MD |
517 | ({ |
518 | ret = chan->ops->event_reserve(&ctx, 0); | |
519 | ret != -ENOBUFS || !ret; | |
520 | }), | |
b5234c06 | 521 | LTTNG_METADATA_TIMEOUT_MSEC); |
b472cfc0 | 522 | if (waitret == -ETIMEDOUT || waitret == -EINTR || ret) { |
b5234c06 MD |
523 | DBG("LTTng: Failure to write metadata to buffers (%s)\n", |
524 | waitret == -EINTR ? "interrupted" : | |
8020ceb5 | 525 | (ret == -ENOBUFS ? "timeout" : "I/O error")); |
b5234c06 | 526 | if (waitret == -EINTR) |
8020ceb5 MD |
527 | ret = waitret; |
528 | goto end; | |
529 | } | |
530 | chan->ops->event_write(&ctx, &str[pos], reserve_len); | |
531 | chan->ops->event_commit(&ctx); | |
532 | } | |
533 | end: | |
b5234c06 | 534 | free(str); |
8020ceb5 MD |
535 | return ret; |
536 | } | |
537 | ||
538 | static | |
539 | int _ltt_field_statedump(struct ltt_session *session, | |
540 | const struct lttng_event_field *field) | |
541 | { | |
542 | int ret = 0; | |
543 | ||
544 | switch (field->type.atype) { | |
545 | case atype_integer: | |
546 | ret = lttng_metadata_printf(session, | |
4e2ee1f5 | 547 | " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s;\n", |
8020ceb5 MD |
548 | field->type.u.basic.integer.size, |
549 | field->type.u.basic.integer.alignment, | |
550 | field->type.u.basic.integer.signedness, | |
551 | (field->type.u.basic.integer.encoding == lttng_encode_none) | |
552 | ? "none" | |
553 | : (field->type.u.basic.integer.encoding == lttng_encode_UTF8) | |
554 | ? "UTF8" | |
555 | : "ASCII", | |
556 | field->type.u.basic.integer.base, | |
8a98a75d | 557 | #if (BYTE_ORDER == BIG_ENDIAN) |
403c40b4 MD |
558 | field->type.u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
559 | #else | |
560 | field->type.u.basic.integer.reverse_byte_order ? " byte_order = be;" : "", | |
561 | #endif | |
562 | field->name); | |
563 | break; | |
564 | case atype_float: | |
565 | ret = lttng_metadata_printf(session, | |
8a98a75d | 566 | " floating_point { exp_dig = %u; mant_dig = %u; align = %u;%s } _%s;\n", |
403c40b4 MD |
567 | field->type.u.basic._float.exp_dig, |
568 | field->type.u.basic._float.mant_dig, | |
569 | field->type.u.basic._float.alignment, | |
8a98a75d | 570 | #if (BYTE_ORDER == BIG_ENDIAN) |
8020ceb5 MD |
571 | field->type.u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
572 | #else | |
573 | field->type.u.basic.integer.reverse_byte_order ? " byte_order = be;" : "", | |
574 | #endif | |
575 | field->name); | |
576 | break; | |
577 | case atype_enum: | |
578 | ret = lttng_metadata_printf(session, | |
579 | " %s %s;\n", | |
580 | field->type.u.basic.enumeration.name, | |
581 | field->name); | |
582 | break; | |
583 | case atype_array: | |
584 | { | |
585 | const struct lttng_basic_type *elem_type; | |
586 | ||
587 | elem_type = &field->type.u.array.elem_type; | |
588 | ret = lttng_metadata_printf(session, | |
4e2ee1f5 | 589 | " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[%u];\n", |
8020ceb5 MD |
590 | elem_type->u.basic.integer.size, |
591 | elem_type->u.basic.integer.alignment, | |
592 | elem_type->u.basic.integer.signedness, | |
593 | (elem_type->u.basic.integer.encoding == lttng_encode_none) | |
594 | ? "none" | |
595 | : (elem_type->u.basic.integer.encoding == lttng_encode_UTF8) | |
596 | ? "UTF8" | |
597 | : "ASCII", | |
598 | elem_type->u.basic.integer.base, | |
8a98a75d | 599 | #if (BYTE_ORDER == BIG_ENDIAN) |
8020ceb5 MD |
600 | elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
601 | #else | |
602 | elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "", | |
603 | #endif | |
604 | field->name, field->type.u.array.length); | |
605 | break; | |
606 | } | |
607 | case atype_sequence: | |
608 | { | |
609 | const struct lttng_basic_type *elem_type; | |
610 | const struct lttng_basic_type *length_type; | |
611 | ||
612 | elem_type = &field->type.u.sequence.elem_type; | |
613 | length_type = &field->type.u.sequence.length_type; | |
614 | ret = lttng_metadata_printf(session, | |
615 | " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n", | |
616 | length_type->u.basic.integer.size, | |
617 | (unsigned int) length_type->u.basic.integer.alignment, | |
618 | length_type->u.basic.integer.signedness, | |
619 | (length_type->u.basic.integer.encoding == lttng_encode_none) | |
620 | ? "none" | |
621 | : ((length_type->u.basic.integer.encoding == lttng_encode_UTF8) | |
622 | ? "UTF8" | |
623 | : "ASCII"), | |
624 | length_type->u.basic.integer.base, | |
8a98a75d | 625 | #if (BYTE_ORDER == BIG_ENDIAN) |
8020ceb5 MD |
626 | length_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
627 | #else | |
628 | length_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "", | |
629 | #endif | |
630 | field->name); | |
631 | if (ret) | |
632 | return ret; | |
633 | ||
634 | ret = lttng_metadata_printf(session, | |
4e2ee1f5 | 635 | " integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[ __%s_length ];\n", |
8020ceb5 MD |
636 | elem_type->u.basic.integer.size, |
637 | (unsigned int) elem_type->u.basic.integer.alignment, | |
638 | elem_type->u.basic.integer.signedness, | |
639 | (elem_type->u.basic.integer.encoding == lttng_encode_none) | |
640 | ? "none" | |
641 | : ((elem_type->u.basic.integer.encoding == lttng_encode_UTF8) | |
642 | ? "UTF8" | |
643 | : "ASCII"), | |
644 | elem_type->u.basic.integer.base, | |
8a98a75d | 645 | #if (BYTE_ORDER == BIG_ENDIAN) |
8020ceb5 MD |
646 | elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "", |
647 | #else | |
648 | elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "", | |
649 | #endif | |
650 | field->name, | |
651 | field->name); | |
652 | break; | |
653 | } | |
654 | ||
655 | case atype_string: | |
656 | /* Default encoding is UTF8 */ | |
657 | ret = lttng_metadata_printf(session, | |
4e2ee1f5 | 658 | " string%s _%s;\n", |
8020ceb5 MD |
659 | field->type.u.basic.string.encoding == lttng_encode_ASCII ? |
660 | " { encoding = ASCII; }" : "", | |
661 | field->name); | |
662 | break; | |
663 | default: | |
664 | WARN_ON_ONCE(1); | |
665 | return -EINVAL; | |
666 | } | |
667 | return ret; | |
668 | } | |
669 | ||
670 | static | |
671 | int _ltt_context_metadata_statedump(struct ltt_session *session, | |
672 | struct lttng_ctx *ctx) | |
673 | { | |
674 | int ret = 0; | |
675 | int i; | |
676 | ||
677 | if (!ctx) | |
678 | return 0; | |
679 | for (i = 0; i < ctx->nr_fields; i++) { | |
680 | const struct lttng_ctx_field *field = &ctx->fields[i]; | |
681 | ||
682 | ret = _ltt_field_statedump(session, &field->event_field); | |
683 | if (ret) | |
684 | return ret; | |
685 | } | |
686 | return ret; | |
687 | } | |
688 | ||
689 | static | |
690 | int _ltt_fields_metadata_statedump(struct ltt_session *session, | |
691 | struct ltt_event *event) | |
692 | { | |
693 | const struct lttng_event_desc *desc = event->desc; | |
694 | int ret = 0; | |
695 | int i; | |
696 | ||
697 | for (i = 0; i < desc->nr_fields; i++) { | |
698 | const struct lttng_event_field *field = &desc->fields[i]; | |
699 | ||
700 | ret = _ltt_field_statedump(session, field); | |
701 | if (ret) | |
702 | return ret; | |
703 | } | |
704 | return ret; | |
705 | } | |
706 | ||
707 | static | |
708 | int _ltt_event_metadata_statedump(struct ltt_session *session, | |
709 | struct ltt_channel *chan, | |
710 | struct ltt_event *event) | |
711 | { | |
712 | int ret = 0; | |
713 | ||
b5234c06 | 714 | if (event->metadata_dumped || !CMM_ACCESS_ONCE(session->active)) |
8020ceb5 MD |
715 | return 0; |
716 | if (chan == session->metadata) | |
717 | return 0; | |
8165c8da MD |
718 | /* |
719 | * Don't print events for which probe load is pending. | |
720 | */ | |
721 | if (!event->desc) | |
722 | return 0; | |
8020ceb5 MD |
723 | |
724 | ret = lttng_metadata_printf(session, | |
725 | "event {\n" | |
726 | " name = %s;\n" | |
727 | " id = %u;\n" | |
728 | " stream_id = %u;\n", | |
729 | event->desc->name, | |
730 | event->id, | |
731 | event->chan->id); | |
732 | if (ret) | |
733 | goto end; | |
734 | ||
735 | if (event->ctx) { | |
736 | ret = lttng_metadata_printf(session, | |
737 | " context := struct {\n"); | |
738 | if (ret) | |
739 | goto end; | |
740 | } | |
741 | ret = _ltt_context_metadata_statedump(session, event->ctx); | |
742 | if (ret) | |
743 | goto end; | |
744 | if (event->ctx) { | |
745 | ret = lttng_metadata_printf(session, | |
746 | " };\n"); | |
747 | if (ret) | |
748 | goto end; | |
749 | } | |
750 | ||
751 | ret = lttng_metadata_printf(session, | |
752 | " fields := struct {\n" | |
753 | ); | |
754 | if (ret) | |
755 | goto end; | |
756 | ||
757 | ret = _ltt_fields_metadata_statedump(session, event); | |
758 | if (ret) | |
759 | goto end; | |
760 | ||
761 | /* | |
762 | * LTTng space reservation can only reserve multiples of the | |
763 | * byte size. | |
764 | */ | |
765 | ret = lttng_metadata_printf(session, | |
766 | " };\n" | |
767 | "};\n\n"); | |
768 | if (ret) | |
769 | goto end; | |
770 | ||
771 | event->metadata_dumped = 1; | |
772 | end: | |
773 | return ret; | |
774 | ||
775 | } | |
776 | ||
777 | static | |
778 | int _ltt_channel_metadata_statedump(struct ltt_session *session, | |
779 | struct ltt_channel *chan) | |
780 | { | |
781 | int ret = 0; | |
782 | ||
b5234c06 | 783 | if (chan->metadata_dumped || !CMM_ACCESS_ONCE(session->active)) |
8020ceb5 MD |
784 | return 0; |
785 | if (chan == session->metadata) | |
786 | return 0; | |
787 | ||
788 | WARN_ON_ONCE(!chan->header_type); | |
789 | ret = lttng_metadata_printf(session, | |
790 | "stream {\n" | |
791 | " id = %u;\n" | |
792 | " event.header := %s;\n" | |
793 | " packet.context := struct packet_context;\n", | |
794 | chan->id, | |
795 | chan->header_type == 1 ? "struct event_header_compact" : | |
796 | "struct event_header_large"); | |
797 | if (ret) | |
798 | goto end; | |
799 | ||
800 | if (chan->ctx) { | |
801 | ret = lttng_metadata_printf(session, | |
802 | " event.context := struct {\n"); | |
803 | if (ret) | |
804 | goto end; | |
805 | } | |
806 | ret = _ltt_context_metadata_statedump(session, chan->ctx); | |
807 | if (ret) | |
808 | goto end; | |
809 | if (chan->ctx) { | |
810 | ret = lttng_metadata_printf(session, | |
811 | " };\n"); | |
812 | if (ret) | |
813 | goto end; | |
814 | } | |
815 | ||
816 | ret = lttng_metadata_printf(session, | |
817 | "};\n\n"); | |
818 | ||
819 | chan->metadata_dumped = 1; | |
820 | end: | |
821 | return ret; | |
822 | } | |
823 | ||
824 | static | |
825 | int _ltt_stream_packet_context_declare(struct ltt_session *session) | |
826 | { | |
827 | return lttng_metadata_printf(session, | |
828 | "struct packet_context {\n" | |
829 | " uint64_t timestamp_begin;\n" | |
830 | " uint64_t timestamp_end;\n" | |
831 | " uint32_t events_discarded;\n" | |
832 | " uint32_t content_size;\n" | |
833 | " uint32_t packet_size;\n" | |
834 | " uint32_t cpu_id;\n" | |
835 | "};\n\n" | |
836 | ); | |
837 | } | |
838 | ||
839 | /* | |
840 | * Compact header: | |
841 | * id: range: 0 - 30. | |
842 | * id 31 is reserved to indicate an extended header. | |
843 | * | |
844 | * Large header: | |
845 | * id: range: 0 - 65534. | |
846 | * id 65535 is reserved to indicate an extended header. | |
847 | */ | |
848 | static | |
849 | int _ltt_event_header_declare(struct ltt_session *session) | |
850 | { | |
851 | return lttng_metadata_printf(session, | |
852 | "struct event_header_compact {\n" | |
853 | " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n" | |
854 | " variant <id> {\n" | |
855 | " struct {\n" | |
856 | " uint27_t timestamp;\n" | |
857 | " } compact;\n" | |
858 | " struct {\n" | |
859 | " uint32_t id;\n" | |
860 | " uint64_t timestamp;\n" | |
861 | " } extended;\n" | |
862 | " } v;\n" | |
863 | "} align(%u);\n" | |
864 | "\n" | |
865 | "struct event_header_large {\n" | |
866 | " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n" | |
867 | " variant <id> {\n" | |
868 | " struct {\n" | |
869 | " uint32_t timestamp;\n" | |
870 | " } compact;\n" | |
871 | " struct {\n" | |
872 | " uint32_t id;\n" | |
873 | " uint64_t timestamp;\n" | |
874 | " } extended;\n" | |
875 | " } v;\n" | |
876 | "} align(%u);\n\n", | |
1dbfff0c MD |
877 | lttng_alignof(uint32_t) * CHAR_BIT, |
878 | lttng_alignof(uint16_t) * CHAR_BIT | |
8020ceb5 MD |
879 | ); |
880 | } | |
881 | ||
882 | /* | |
883 | * Output metadata into this session's metadata buffers. | |
884 | */ | |
885 | static | |
886 | int _ltt_session_metadata_statedump(struct ltt_session *session) | |
887 | { | |
b5234c06 MD |
888 | unsigned char *uuid_c = session->uuid; |
889 | char uuid_s[37]; | |
8020ceb5 MD |
890 | struct ltt_channel *chan; |
891 | struct ltt_event *event; | |
892 | int ret = 0; | |
893 | ||
b5234c06 | 894 | if (!CMM_ACCESS_ONCE(session->active)) |
8020ceb5 MD |
895 | return 0; |
896 | if (session->metadata_dumped) | |
897 | goto skip_session; | |
898 | if (!session->metadata) { | |
b5234c06 | 899 | DBG("LTTng: attempt to start tracing, but metadata channel is not found. Operation abort.\n"); |
8020ceb5 MD |
900 | return -EPERM; |
901 | } | |
902 | ||
903 | snprintf(uuid_s, sizeof(uuid_s), | |
904 | "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x", | |
905 | uuid_c[0], uuid_c[1], uuid_c[2], uuid_c[3], | |
906 | uuid_c[4], uuid_c[5], uuid_c[6], uuid_c[7], | |
907 | uuid_c[8], uuid_c[9], uuid_c[10], uuid_c[11], | |
908 | uuid_c[12], uuid_c[13], uuid_c[14], uuid_c[15]); | |
909 | ||
910 | ret = lttng_metadata_printf(session, | |
911 | "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n" | |
912 | "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n" | |
913 | "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n" | |
914 | "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n" | |
915 | "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n" | |
916 | "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n" | |
917 | "\n" | |
918 | "trace {\n" | |
919 | " major = %u;\n" | |
920 | " minor = %u;\n" | |
921 | " uuid = \"%s\";\n" | |
922 | " byte_order = %s;\n" | |
923 | " packet.header := struct {\n" | |
924 | " uint32_t magic;\n" | |
925 | " uint8_t uuid[16];\n" | |
926 | " uint32_t stream_id;\n" | |
927 | " };\n" | |
928 | "};\n\n", | |
1dbfff0c MD |
929 | lttng_alignof(uint8_t) * CHAR_BIT, |
930 | lttng_alignof(uint16_t) * CHAR_BIT, | |
931 | lttng_alignof(uint32_t) * CHAR_BIT, | |
932 | lttng_alignof(uint64_t) * CHAR_BIT, | |
8020ceb5 MD |
933 | CTF_VERSION_MAJOR, |
934 | CTF_VERSION_MINOR, | |
935 | uuid_s, | |
8a98a75d | 936 | #if (BYTE_ORDER == BIG_ENDIAN) |
8020ceb5 MD |
937 | "be" |
938 | #else | |
939 | "le" | |
940 | #endif | |
941 | ); | |
942 | if (ret) | |
943 | goto end; | |
944 | ||
945 | ret = _ltt_stream_packet_context_declare(session); | |
946 | if (ret) | |
947 | goto end; | |
948 | ||
949 | ret = _ltt_event_header_declare(session); | |
950 | if (ret) | |
951 | goto end; | |
952 | ||
953 | skip_session: | |
b5234c06 | 954 | cds_list_for_each_entry(chan, &session->chan, list) { |
8020ceb5 MD |
955 | ret = _ltt_channel_metadata_statedump(session, chan); |
956 | if (ret) | |
957 | goto end; | |
958 | } | |
959 | ||
b5234c06 | 960 | cds_list_for_each_entry(event, &session->events, list) { |
8020ceb5 MD |
961 | ret = _ltt_event_metadata_statedump(session, event->chan, event); |
962 | if (ret) | |
963 | goto end; | |
964 | } | |
965 | session->metadata_dumped = 1; | |
966 | end: | |
967 | return ret; | |
968 | } | |
969 | ||
003fedf4 | 970 | void lttng_ust_events_exit(void) |
8020ceb5 MD |
971 | { |
972 | struct ltt_session *session, *tmpsession; | |
973 | ||
b5234c06 | 974 | cds_list_for_each_entry_safe(session, tmpsession, &sessions, list) |
8020ceb5 | 975 | ltt_session_destroy(session); |
8020ceb5 | 976 | } |