Commit | Line | Data |
---|---|---|
d0b96690 | 1 | /* |
d0b96690 DG |
2 | * Copyright (C) 2010-2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
3 | * | |
ab5be9fa | 4 | * SPDX-License-Identifier: GPL-2.0-only |
d0b96690 | 5 | * |
d0b96690 DG |
6 | */ |
7 | ||
6c1c0768 | 8 | #define _LGPL_SOURCE |
d0b96690 DG |
9 | #include <stdint.h> |
10 | #include <string.h> | |
11 | #include <stdarg.h> | |
12 | #include <stdio.h> | |
13 | #include <limits.h> | |
14 | #include <unistd.h> | |
15 | #include <inttypes.h> | |
c9e313bc SM |
16 | #include <common/common.hpp> |
17 | #include <common/time.hpp> | |
bacc39bb | 18 | #include <vector> |
d0b96690 | 19 | |
c9e313bc SM |
20 | #include "ust-registry.hpp" |
21 | #include "ust-clock.hpp" | |
22 | #include "ust-app.hpp" | |
d0b96690 | 23 | |
8c645bb0 MD |
24 | #define NR_CLOCK_OFFSET_SAMPLES 10 |
25 | ||
26 | struct offset_sample { | |
c2636b57 | 27 | int64_t offset; /* correlation offset */ |
8c645bb0 MD |
28 | uint64_t measure_delta; /* lower is better */ |
29 | }; | |
30 | ||
da860cab MD |
31 | static |
32 | int _lttng_field_statedump(struct ust_registry_session *session, | |
b623cb6a | 33 | const struct lttng_ust_ctl_field *fields, size_t nr_fields, |
da860cab MD |
34 | size_t *iter_field, size_t nesting); |
35 | ||
d0b96690 DG |
36 | static inline |
37 | int get_count_order(unsigned int count) | |
38 | { | |
39 | int order; | |
40 | ||
78ddfe55 | 41 | order = lttng_fls(count) - 1; |
46b4dda6 | 42 | if (count & (count - 1)) { |
d0b96690 | 43 | order++; |
46b4dda6 | 44 | } |
a0377dfe | 45 | LTTNG_ASSERT(order >= 0); |
d0b96690 DG |
46 | return order; |
47 | } | |
48 | ||
49 | /* | |
50 | * Returns offset where to write in metadata array, or negative error value on error. | |
51 | */ | |
52 | static | |
53 | ssize_t metadata_reserve(struct ust_registry_session *session, size_t len) | |
54 | { | |
55 | size_t new_len = session->metadata_len + len; | |
56 | size_t new_alloc_len = new_len; | |
57 | size_t old_alloc_len = session->metadata_alloc_len; | |
58 | ssize_t ret; | |
59 | ||
60 | if (new_alloc_len > (UINT32_MAX >> 1)) | |
61 | return -EINVAL; | |
62 | if ((old_alloc_len << 1) > (UINT32_MAX >> 1)) | |
63 | return -EINVAL; | |
64 | ||
65 | if (new_alloc_len > old_alloc_len) { | |
66 | char *newptr; | |
67 | ||
68 | new_alloc_len = | |
8957eb48 | 69 | std::max<size_t>(1U << get_count_order(new_alloc_len), old_alloc_len << 1); |
7966af57 | 70 | newptr = (char *) realloc(session->metadata, new_alloc_len); |
d0b96690 DG |
71 | if (!newptr) |
72 | return -ENOMEM; | |
73 | session->metadata = newptr; | |
74 | /* We zero directly the memory from start of allocation. */ | |
75 | memset(&session->metadata[old_alloc_len], 0, new_alloc_len - old_alloc_len); | |
76 | session->metadata_alloc_len = new_alloc_len; | |
77 | } | |
78 | ret = session->metadata_len; | |
79 | session->metadata_len += len; | |
80 | return ret; | |
81 | } | |
82 | ||
d7ba1388 MD |
83 | static |
84 | int metadata_file_append(struct ust_registry_session *session, | |
85 | const char *str, size_t len) | |
86 | { | |
87 | ssize_t written; | |
88 | ||
89 | if (session->metadata_fd < 0) { | |
90 | return 0; | |
91 | } | |
92 | /* Write to metadata file */ | |
93 | written = lttng_write(session->metadata_fd, str, len); | |
94 | if (written != len) { | |
95 | return -1; | |
96 | } | |
97 | return 0; | |
98 | } | |
99 | ||
d0b96690 DG |
100 | /* |
101 | * We have exclusive access to our metadata buffer (protected by the | |
102 | * ust_lock), so we can do racy operations such as looking for | |
103 | * remaining space left in packet and write, since mutual exclusion | |
104 | * protects us from concurrent writes. | |
105 | */ | |
d22ad5f8 | 106 | static ATTR_FORMAT_PRINTF(2, 3) |
d0b96690 DG |
107 | int lttng_metadata_printf(struct ust_registry_session *session, |
108 | const char *fmt, ...) | |
109 | { | |
110 | char *str = NULL; | |
111 | size_t len; | |
112 | va_list ap; | |
113 | ssize_t offset; | |
114 | int ret; | |
115 | ||
116 | va_start(ap, fmt); | |
117 | ret = vasprintf(&str, fmt, ap); | |
118 | va_end(ap); | |
119 | if (ret < 0) | |
120 | return -ENOMEM; | |
121 | ||
122 | len = strlen(str); | |
123 | offset = metadata_reserve(session, len); | |
124 | if (offset < 0) { | |
125 | ret = offset; | |
126 | goto end; | |
127 | } | |
128 | memcpy(&session->metadata[offset], str, len); | |
d7ba1388 MD |
129 | ret = metadata_file_append(session, str, len); |
130 | if (ret) { | |
131 | PERROR("Error appending to metadata file"); | |
132 | goto end; | |
133 | } | |
d0b96690 DG |
134 | DBG3("Append to metadata: \"%s\"", str); |
135 | ret = 0; | |
136 | ||
137 | end: | |
138 | free(str); | |
139 | return ret; | |
140 | } | |
141 | ||
da860cab MD |
142 | static |
143 | int print_tabs(struct ust_registry_session *session, size_t nesting) | |
144 | { | |
145 | size_t i; | |
146 | ||
147 | for (i = 0; i < nesting; i++) { | |
148 | int ret; | |
149 | ||
150 | ret = lttng_metadata_printf(session, " "); | |
151 | if (ret) { | |
152 | return ret; | |
153 | } | |
154 | } | |
155 | return 0; | |
156 | } | |
157 | ||
a1f68b22 MD |
158 | static |
159 | void sanitize_ctf_identifier(char *out, const char *in) | |
160 | { | |
161 | size_t i; | |
162 | ||
fc4b93fa | 163 | for (i = 0; i < LTTNG_UST_ABI_SYM_NAME_LEN; i++) { |
a1f68b22 MD |
164 | switch (in[i]) { |
165 | case '.': | |
166 | case '$': | |
167 | case ':': | |
168 | out[i] = '_'; | |
169 | break; | |
170 | default: | |
171 | out[i] = in[i]; | |
172 | } | |
173 | } | |
174 | } | |
175 | ||
8de88061 JR |
176 | static |
177 | int print_escaped_ctf_string(struct ust_registry_session *session, const char *string) | |
178 | { | |
35c829f8 | 179 | int ret = 0; |
8de88061 JR |
180 | size_t i; |
181 | char cur; | |
182 | ||
183 | i = 0; | |
184 | cur = string[i]; | |
185 | while (cur != '\0') { | |
186 | switch (cur) { | |
187 | case '\n': | |
188 | ret = lttng_metadata_printf(session, "%s", "\\n"); | |
189 | break; | |
190 | case '\\': | |
191 | case '"': | |
192 | ret = lttng_metadata_printf(session, "%c", '\\'); | |
193 | if (ret) { | |
194 | goto error; | |
195 | } | |
196 | /* We still print the current char */ | |
197 | /* Fallthrough */ | |
198 | default: | |
199 | ret = lttng_metadata_printf(session, "%c", cur); | |
200 | break; | |
201 | } | |
202 | ||
203 | if (ret) { | |
204 | goto error; | |
205 | } | |
206 | ||
207 | cur = string[++i]; | |
208 | } | |
209 | error: | |
210 | return ret; | |
211 | } | |
212 | ||
10b56aef MD |
213 | /* Called with session registry mutex held. */ |
214 | static | |
215 | int ust_metadata_enum_statedump(struct ust_registry_session *session, | |
216 | const char *enum_name, | |
217 | uint64_t enum_id, | |
b623cb6a | 218 | const struct lttng_ust_ctl_integer_type *container_type, |
da860cab | 219 | const char *field_name, size_t *iter_field, size_t nesting) |
10b56aef MD |
220 | { |
221 | struct ust_registry_enum *reg_enum; | |
b623cb6a | 222 | const struct lttng_ust_ctl_enum_entry *entries; |
10b56aef MD |
223 | size_t nr_entries; |
224 | int ret = 0; | |
225 | size_t i; | |
fc4b93fa | 226 | char identifier[LTTNG_UST_ABI_SYM_NAME_LEN]; |
10b56aef MD |
227 | |
228 | rcu_read_lock(); | |
229 | reg_enum = ust_registry_lookup_enum_by_id(session, enum_name, enum_id); | |
230 | rcu_read_unlock(); | |
231 | /* reg_enum can still be used because session registry mutex is held. */ | |
232 | if (!reg_enum) { | |
233 | ret = -ENOENT; | |
234 | goto end; | |
235 | } | |
236 | entries = reg_enum->entries; | |
237 | nr_entries = reg_enum->nr_entries; | |
238 | ||
da860cab MD |
239 | ret = print_tabs(session, nesting); |
240 | if (ret) { | |
241 | goto end; | |
242 | } | |
10b56aef | 243 | ret = lttng_metadata_printf(session, |
da860cab | 244 | "enum : integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u; } {\n", |
10b56aef MD |
245 | container_type->size, |
246 | container_type->alignment, | |
247 | container_type->signedness, | |
b623cb6a | 248 | (container_type->encoding == lttng_ust_ctl_encode_none) |
10b56aef | 249 | ? "none" |
b623cb6a | 250 | : (container_type->encoding == lttng_ust_ctl_encode_UTF8) |
10b56aef MD |
251 | ? "UTF8" |
252 | : "ASCII", | |
253 | container_type->base); | |
254 | if (ret) { | |
255 | goto end; | |
256 | } | |
1ddb0e8a | 257 | nesting++; |
10b56aef MD |
258 | /* Dump all entries */ |
259 | for (i = 0; i < nr_entries; i++) { | |
b623cb6a | 260 | const struct lttng_ust_ctl_enum_entry *entry = &entries[i]; |
10b56aef MD |
261 | int j, len; |
262 | ||
a1f68b22 MD |
263 | ret = print_tabs(session, nesting); |
264 | if (ret) { | |
265 | goto end; | |
266 | } | |
10b56aef | 267 | ret = lttng_metadata_printf(session, |
a1f68b22 | 268 | "\""); |
10b56aef MD |
269 | if (ret) { |
270 | goto end; | |
271 | } | |
272 | len = strlen(entry->string); | |
273 | /* Escape the character '"' */ | |
274 | for (j = 0; j < len; j++) { | |
275 | char c = entry->string[j]; | |
276 | ||
277 | switch (c) { | |
278 | case '"': | |
279 | ret = lttng_metadata_printf(session, | |
280 | "\\\""); | |
281 | break; | |
282 | case '\\': | |
283 | ret = lttng_metadata_printf(session, | |
284 | "\\\\"); | |
285 | break; | |
286 | default: | |
287 | ret = lttng_metadata_printf(session, | |
288 | "%c", c); | |
289 | break; | |
290 | } | |
291 | if (ret) { | |
292 | goto end; | |
293 | } | |
294 | } | |
e85e3723 | 295 | ret = lttng_metadata_printf(session, "\""); |
10b56aef MD |
296 | if (ret) { |
297 | goto end; | |
298 | } | |
3b016e58 | 299 | |
9d27cec7 | 300 | if (entry->u.extra.options & |
b623cb6a | 301 | LTTNG_UST_CTL_UST_ENUM_ENTRY_OPTION_IS_AUTO) { |
e85e3723 PP |
302 | ret = lttng_metadata_printf(session, ",\n"); |
303 | if (ret) { | |
304 | goto end; | |
305 | } | |
10b56aef MD |
306 | } else { |
307 | ret = lttng_metadata_printf(session, | |
e85e3723 PP |
308 | " = "); |
309 | if (ret) { | |
310 | goto end; | |
311 | } | |
3b016e58 | 312 | |
e85e3723 | 313 | if (entry->start.signedness) { |
3b016e58 | 314 | ret = lttng_metadata_printf(session, |
d22ad5f8 | 315 | "%" PRId64, entry->start.value); |
3b016e58 MD |
316 | } else { |
317 | ret = lttng_metadata_printf(session, | |
d22ad5f8 | 318 | "%" PRIu64, entry->start.value); |
e85e3723 PP |
319 | } |
320 | if (ret) { | |
321 | goto end; | |
322 | } | |
323 | ||
324 | if (entry->start.signedness == entry->end.signedness && | |
325 | entry->start.value == | |
326 | entry->end.value) { | |
327 | ret = lttng_metadata_printf(session, ",\n"); | |
328 | } else { | |
329 | if (entry->end.signedness) { | |
330 | ret = lttng_metadata_printf(session, | |
d22ad5f8 SM |
331 | " ... %" PRId64 ",\n", |
332 | entry->end.value); | |
e85e3723 PP |
333 | } else { |
334 | ret = lttng_metadata_printf(session, | |
d22ad5f8 | 335 | " ... %" PRIu64 ",\n", |
e85e3723 PP |
336 | entry->end.value); |
337 | } | |
338 | } | |
339 | if (ret) { | |
340 | goto end; | |
3b016e58 | 341 | } |
10b56aef MD |
342 | } |
343 | } | |
1ddb0e8a | 344 | nesting--; |
a1f68b22 MD |
345 | sanitize_ctf_identifier(identifier, field_name); |
346 | ret = print_tabs(session, nesting); | |
347 | if (ret) { | |
348 | goto end; | |
349 | } | |
350 | ret = lttng_metadata_printf(session, "} _%s;\n", | |
351 | identifier); | |
da860cab MD |
352 | end: |
353 | (*iter_field)++; | |
354 | return ret; | |
355 | } | |
356 | ||
da860cab MD |
357 | static |
358 | int _lttng_variant_statedump(struct ust_registry_session *session, | |
0d32d1a9 MD |
359 | uint32_t nr_choices, const char *tag_name, |
360 | uint32_t alignment, | |
b623cb6a | 361 | const struct lttng_ust_ctl_field *fields, size_t nr_fields, |
da860cab MD |
362 | size_t *iter_field, size_t nesting) |
363 | { | |
b623cb6a | 364 | const struct lttng_ust_ctl_field *variant = &fields[*iter_field]; |
0d32d1a9 | 365 | uint32_t i; |
da860cab | 366 | int ret; |
fc4b93fa | 367 | char identifier[LTTNG_UST_ABI_SYM_NAME_LEN]; |
da860cab | 368 | |
da860cab | 369 | (*iter_field)++; |
0d32d1a9 MD |
370 | sanitize_ctf_identifier(identifier, tag_name); |
371 | if (alignment) { | |
372 | ret = print_tabs(session, nesting); | |
373 | if (ret) { | |
374 | goto end; | |
375 | } | |
376 | ret = lttng_metadata_printf(session, | |
377 | "struct { } align(%u) _%s_padding;\n", | |
378 | alignment * CHAR_BIT, | |
379 | variant->name); | |
380 | if (ret) { | |
381 | goto end; | |
382 | } | |
383 | } | |
a1f68b22 MD |
384 | ret = print_tabs(session, nesting); |
385 | if (ret) { | |
386 | goto end; | |
387 | } | |
da860cab | 388 | ret = lttng_metadata_printf(session, |
a1f68b22 MD |
389 | "variant <_%s> {\n", |
390 | identifier); | |
da860cab MD |
391 | if (ret) { |
392 | goto end; | |
393 | } | |
394 | ||
395 | for (i = 0; i < nr_choices; i++) { | |
396 | if (*iter_field >= nr_fields) { | |
397 | ret = -EOVERFLOW; | |
398 | goto end; | |
399 | } | |
400 | ret = _lttng_field_statedump(session, | |
401 | fields, nr_fields, | |
402 | iter_field, nesting + 1); | |
dc6403f3 JG |
403 | if (ret) { |
404 | goto end; | |
405 | } | |
da860cab | 406 | } |
a1f68b22 MD |
407 | sanitize_ctf_identifier(identifier, variant->name); |
408 | ret = print_tabs(session, nesting); | |
850c5d4a JR |
409 | if (ret) { |
410 | goto end; | |
411 | } | |
da860cab | 412 | ret = lttng_metadata_printf(session, |
a1f68b22 MD |
413 | "} _%s;\n", |
414 | identifier); | |
da860cab MD |
415 | if (ret) { |
416 | goto end; | |
417 | } | |
10b56aef MD |
418 | end: |
419 | return ret; | |
420 | } | |
421 | ||
d0b96690 DG |
422 | static |
423 | int _lttng_field_statedump(struct ust_registry_session *session, | |
b623cb6a | 424 | const struct lttng_ust_ctl_field *fields, size_t nr_fields, |
da860cab | 425 | size_t *iter_field, size_t nesting) |
d0b96690 DG |
426 | { |
427 | int ret = 0; | |
428 | const char *bo_be = " byte_order = be;"; | |
429 | const char *bo_le = " byte_order = le;"; | |
430 | const char *bo_native = ""; | |
431 | const char *bo_reverse; | |
b623cb6a | 432 | const struct lttng_ust_ctl_field *field; |
d0b96690 | 433 | |
da860cab MD |
434 | if (*iter_field >= nr_fields) { |
435 | ret = -EOVERFLOW; | |
436 | goto end; | |
437 | } | |
438 | field = &fields[*iter_field]; | |
439 | ||
440 | if (session->byte_order == BIG_ENDIAN) { | |
d0b96690 | 441 | bo_reverse = bo_le; |
da860cab | 442 | } else { |
d0b96690 | 443 | bo_reverse = bo_be; |
da860cab | 444 | } |
d0b96690 DG |
445 | |
446 | switch (field->type.atype) { | |
b623cb6a | 447 | case lttng_ust_ctl_atype_integer: |
da860cab MD |
448 | ret = print_tabs(session, nesting); |
449 | if (ret) { | |
450 | goto end; | |
451 | } | |
d0b96690 | 452 | ret = lttng_metadata_printf(session, |
da860cab | 453 | "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s;\n", |
0d32d1a9 MD |
454 | field->type.u.integer.size, |
455 | field->type.u.integer.alignment, | |
456 | field->type.u.integer.signedness, | |
b623cb6a | 457 | (field->type.u.integer.encoding == lttng_ust_ctl_encode_none) |
d0b96690 | 458 | ? "none" |
b623cb6a | 459 | : (field->type.u.integer.encoding == lttng_ust_ctl_encode_UTF8) |
d0b96690 DG |
460 | ? "UTF8" |
461 | : "ASCII", | |
0d32d1a9 MD |
462 | field->type.u.integer.base, |
463 | field->type.u.integer.reverse_byte_order ? bo_reverse : bo_native, | |
d0b96690 | 464 | field->name); |
da860cab | 465 | (*iter_field)++; |
d0b96690 | 466 | break; |
b623cb6a | 467 | case lttng_ust_ctl_atype_enum: |
10b56aef | 468 | ret = ust_metadata_enum_statedump(session, |
0d32d1a9 MD |
469 | field->type.u.legacy.basic.enumeration.name, |
470 | field->type.u.legacy.basic.enumeration.id, | |
471 | &field->type.u.legacy.basic.enumeration.container_type, | |
da860cab | 472 | field->name, iter_field, nesting); |
10b56aef | 473 | break; |
b623cb6a | 474 | case lttng_ust_ctl_atype_float: |
da860cab MD |
475 | ret = print_tabs(session, nesting); |
476 | if (ret) { | |
477 | goto end; | |
478 | } | |
d0b96690 | 479 | ret = lttng_metadata_printf(session, |
da860cab | 480 | "floating_point { exp_dig = %u; mant_dig = %u; align = %u;%s } _%s;\n", |
0d32d1a9 MD |
481 | field->type.u._float.exp_dig, |
482 | field->type.u._float.mant_dig, | |
483 | field->type.u._float.alignment, | |
484 | field->type.u._float.reverse_byte_order ? bo_reverse : bo_native, | |
d0b96690 | 485 | field->name); |
da860cab | 486 | (*iter_field)++; |
d0b96690 | 487 | break; |
b623cb6a | 488 | case lttng_ust_ctl_atype_array: |
d0b96690 | 489 | { |
b623cb6a | 490 | const struct lttng_ust_ctl_basic_type *elem_type; |
d0b96690 | 491 | |
da860cab MD |
492 | ret = print_tabs(session, nesting); |
493 | if (ret) { | |
494 | goto end; | |
495 | } | |
0d32d1a9 MD |
496 | elem_type = &field->type.u.legacy.array.elem_type; |
497 | /* Only integers are currently supported in arrays. */ | |
b623cb6a | 498 | if (elem_type->atype != lttng_ust_ctl_atype_integer) { |
0d32d1a9 MD |
499 | ret = -EINVAL; |
500 | goto end; | |
501 | } | |
d0b96690 | 502 | ret = lttng_metadata_printf(session, |
da860cab | 503 | "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[%u];\n", |
d0b96690 DG |
504 | elem_type->u.basic.integer.size, |
505 | elem_type->u.basic.integer.alignment, | |
506 | elem_type->u.basic.integer.signedness, | |
b623cb6a | 507 | (elem_type->u.basic.integer.encoding == lttng_ust_ctl_encode_none) |
d0b96690 | 508 | ? "none" |
b623cb6a | 509 | : (elem_type->u.basic.integer.encoding == lttng_ust_ctl_encode_UTF8) |
d0b96690 DG |
510 | ? "UTF8" |
511 | : "ASCII", | |
512 | elem_type->u.basic.integer.base, | |
513 | elem_type->u.basic.integer.reverse_byte_order ? bo_reverse : bo_native, | |
0d32d1a9 MD |
514 | field->name, field->type.u.legacy.array.length); |
515 | (*iter_field)++; | |
516 | break; | |
517 | } | |
b623cb6a | 518 | case lttng_ust_ctl_atype_array_nestable: |
0d32d1a9 MD |
519 | { |
520 | uint32_t array_length; | |
b623cb6a MJ |
521 | const struct lttng_ust_ctl_field *array_nestable; |
522 | const struct lttng_ust_ctl_type *elem_type; | |
0d32d1a9 MD |
523 | |
524 | array_length = field->type.u.array_nestable.length; | |
525 | (*iter_field)++; | |
526 | ||
527 | if (*iter_field >= nr_fields) { | |
528 | ret = -EOVERFLOW; | |
529 | goto end; | |
530 | } | |
531 | array_nestable = &fields[*iter_field]; | |
532 | elem_type = &array_nestable->type; | |
533 | ||
534 | /* Only integers are currently supported in arrays. */ | |
b623cb6a | 535 | if (elem_type->atype != lttng_ust_ctl_atype_integer) { |
0d32d1a9 MD |
536 | ret = -EINVAL; |
537 | goto end; | |
538 | } | |
539 | ||
540 | if (field->type.u.array_nestable.alignment) { | |
541 | ret = print_tabs(session, nesting); | |
542 | if (ret) { | |
543 | goto end; | |
544 | } | |
545 | ret = lttng_metadata_printf(session, | |
546 | "struct { } align(%u) _%s_padding;\n", | |
547 | field->type.u.array_nestable.alignment * CHAR_BIT, | |
548 | field->name); | |
549 | if (ret) { | |
550 | goto end; | |
551 | } | |
552 | } | |
553 | ||
554 | ret = print_tabs(session, nesting); | |
555 | if (ret) { | |
556 | goto end; | |
557 | } | |
558 | ret = lttng_metadata_printf(session, | |
559 | "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[%u];\n", | |
560 | elem_type->u.integer.size, | |
561 | elem_type->u.integer.alignment, | |
562 | elem_type->u.integer.signedness, | |
b623cb6a | 563 | (elem_type->u.integer.encoding == lttng_ust_ctl_encode_none) |
0d32d1a9 | 564 | ? "none" |
b623cb6a | 565 | : (elem_type->u.integer.encoding == lttng_ust_ctl_encode_UTF8) |
0d32d1a9 MD |
566 | ? "UTF8" |
567 | : "ASCII", | |
568 | elem_type->u.integer.base, | |
569 | elem_type->u.integer.reverse_byte_order ? bo_reverse : bo_native, | |
570 | field->name, array_length); | |
da860cab | 571 | (*iter_field)++; |
d0b96690 DG |
572 | break; |
573 | } | |
b623cb6a | 574 | case lttng_ust_ctl_atype_sequence: |
d0b96690 | 575 | { |
b623cb6a MJ |
576 | const struct lttng_ust_ctl_basic_type *elem_type; |
577 | const struct lttng_ust_ctl_basic_type *length_type; | |
d0b96690 | 578 | |
0d32d1a9 MD |
579 | elem_type = &field->type.u.legacy.sequence.elem_type; |
580 | length_type = &field->type.u.legacy.sequence.length_type; | |
da860cab MD |
581 | ret = print_tabs(session, nesting); |
582 | if (ret) { | |
583 | goto end; | |
584 | } | |
0d32d1a9 MD |
585 | |
586 | /* Only integers are currently supported in sequences. */ | |
b623cb6a | 587 | if (elem_type->atype != lttng_ust_ctl_atype_integer) { |
0d32d1a9 MD |
588 | ret = -EINVAL; |
589 | goto end; | |
590 | } | |
591 | ||
d0b96690 | 592 | ret = lttng_metadata_printf(session, |
da860cab | 593 | "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n", |
d0b96690 DG |
594 | length_type->u.basic.integer.size, |
595 | (unsigned int) length_type->u.basic.integer.alignment, | |
596 | length_type->u.basic.integer.signedness, | |
b623cb6a | 597 | (length_type->u.basic.integer.encoding == lttng_ust_ctl_encode_none) |
d0b96690 | 598 | ? "none" |
b623cb6a | 599 | : ((length_type->u.basic.integer.encoding == lttng_ust_ctl_encode_UTF8) |
d0b96690 DG |
600 | ? "UTF8" |
601 | : "ASCII"), | |
602 | length_type->u.basic.integer.base, | |
603 | length_type->u.basic.integer.reverse_byte_order ? bo_reverse : bo_native, | |
604 | field->name); | |
da860cab MD |
605 | if (ret) { |
606 | goto end; | |
607 | } | |
d0b96690 | 608 | |
da860cab MD |
609 | ret = print_tabs(session, nesting); |
610 | if (ret) { | |
611 | goto end; | |
612 | } | |
d0b96690 | 613 | ret = lttng_metadata_printf(session, |
da860cab | 614 | "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[ __%s_length ];\n", |
d0b96690 DG |
615 | elem_type->u.basic.integer.size, |
616 | (unsigned int) elem_type->u.basic.integer.alignment, | |
617 | elem_type->u.basic.integer.signedness, | |
b623cb6a | 618 | (elem_type->u.basic.integer.encoding == lttng_ust_ctl_encode_none) |
d0b96690 | 619 | ? "none" |
b623cb6a | 620 | : ((elem_type->u.basic.integer.encoding == lttng_ust_ctl_encode_UTF8) |
d0b96690 DG |
621 | ? "UTF8" |
622 | : "ASCII"), | |
623 | elem_type->u.basic.integer.base, | |
624 | elem_type->u.basic.integer.reverse_byte_order ? bo_reverse : bo_native, | |
625 | field->name, | |
626 | field->name); | |
da860cab | 627 | (*iter_field)++; |
d0b96690 DG |
628 | break; |
629 | } | |
b623cb6a | 630 | case lttng_ust_ctl_atype_sequence_nestable: |
0d32d1a9 | 631 | { |
b623cb6a MJ |
632 | const struct lttng_ust_ctl_field *sequence_nestable; |
633 | const struct lttng_ust_ctl_type *elem_type; | |
0d32d1a9 MD |
634 | |
635 | (*iter_field)++; | |
636 | if (*iter_field >= nr_fields) { | |
637 | ret = -EOVERFLOW; | |
638 | goto end; | |
639 | } | |
640 | sequence_nestable = &fields[*iter_field]; | |
641 | elem_type = &sequence_nestable->type; | |
642 | ||
643 | /* Only integers are currently supported in sequences. */ | |
b623cb6a | 644 | if (elem_type->atype != lttng_ust_ctl_atype_integer) { |
0d32d1a9 MD |
645 | ret = -EINVAL; |
646 | goto end; | |
647 | } | |
648 | ||
649 | if (field->type.u.sequence_nestable.alignment) { | |
650 | ret = print_tabs(session, nesting); | |
651 | if (ret) { | |
652 | goto end; | |
653 | } | |
654 | ret = lttng_metadata_printf(session, | |
655 | "struct { } align(%u) _%s_padding;\n", | |
656 | field->type.u.sequence_nestable.alignment * CHAR_BIT, | |
657 | field->name); | |
658 | if (ret) { | |
659 | goto end; | |
660 | } | |
661 | } | |
d0b96690 | 662 | |
0d32d1a9 MD |
663 | ret = print_tabs(session, nesting); |
664 | if (ret) { | |
665 | goto end; | |
666 | } | |
667 | ret = lttng_metadata_printf(session, | |
668 | "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[ _%s ];\n", | |
669 | elem_type->u.integer.size, | |
670 | (unsigned int) elem_type->u.integer.alignment, | |
671 | elem_type->u.integer.signedness, | |
b623cb6a | 672 | (elem_type->u.integer.encoding == lttng_ust_ctl_encode_none) |
0d32d1a9 | 673 | ? "none" |
b623cb6a | 674 | : ((elem_type->u.integer.encoding == lttng_ust_ctl_encode_UTF8) |
0d32d1a9 MD |
675 | ? "UTF8" |
676 | : "ASCII"), | |
677 | elem_type->u.integer.base, | |
678 | elem_type->u.integer.reverse_byte_order ? bo_reverse : bo_native, | |
679 | field->name, | |
680 | field->type.u.sequence_nestable.length_name); | |
681 | (*iter_field)++; | |
682 | break; | |
683 | } | |
b623cb6a | 684 | case lttng_ust_ctl_atype_string: |
d0b96690 | 685 | /* Default encoding is UTF8 */ |
da860cab MD |
686 | ret = print_tabs(session, nesting); |
687 | if (ret) { | |
688 | goto end; | |
689 | } | |
d0b96690 | 690 | ret = lttng_metadata_printf(session, |
da860cab | 691 | "string%s _%s;\n", |
b623cb6a | 692 | field->type.u.string.encoding == lttng_ust_ctl_encode_ASCII ? |
d0b96690 DG |
693 | " { encoding = ASCII; }" : "", |
694 | field->name); | |
da860cab MD |
695 | (*iter_field)++; |
696 | break; | |
b623cb6a | 697 | case lttng_ust_ctl_atype_variant: |
0d32d1a9 MD |
698 | ret = _lttng_variant_statedump(session, |
699 | field->type.u.legacy.variant.nr_choices, | |
700 | field->type.u.legacy.variant.tag_name, | |
701 | 0, | |
702 | fields, nr_fields, iter_field, nesting); | |
703 | if (ret) { | |
704 | goto end; | |
705 | } | |
706 | break; | |
b623cb6a | 707 | case lttng_ust_ctl_atype_variant_nestable: |
0d32d1a9 MD |
708 | ret = _lttng_variant_statedump(session, |
709 | field->type.u.variant_nestable.nr_choices, | |
710 | field->type.u.variant_nestable.tag_name, | |
711 | field->type.u.variant_nestable.alignment, | |
712 | fields, nr_fields, iter_field, nesting); | |
da860cab MD |
713 | if (ret) { |
714 | goto end; | |
715 | } | |
716 | break; | |
b623cb6a | 717 | case lttng_ust_ctl_atype_struct: |
0d32d1a9 MD |
718 | if (field->type.u.legacy._struct.nr_fields != 0) { |
719 | /* Currently only 0-length structures are supported. */ | |
720 | ret = -EINVAL; | |
721 | goto end; | |
722 | } | |
da860cab MD |
723 | ret = print_tabs(session, nesting); |
724 | if (ret) { | |
725 | goto end; | |
726 | } | |
727 | ret = lttng_metadata_printf(session, | |
728 | "struct {} _%s;\n", | |
729 | field->name); | |
730 | (*iter_field)++; | |
d0b96690 | 731 | break; |
b623cb6a | 732 | case lttng_ust_ctl_atype_struct_nestable: |
0d32d1a9 MD |
733 | if (field->type.u.struct_nestable.nr_fields != 0) { |
734 | /* Currently only 0-length structures are supported. */ | |
735 | ret = -EINVAL; | |
736 | goto end; | |
737 | } | |
738 | ret = print_tabs(session, nesting); | |
739 | if (ret) { | |
740 | goto end; | |
741 | } | |
742 | if (field->type.u.struct_nestable.alignment) { | |
743 | ret = lttng_metadata_printf(session, | |
744 | "struct {} align(%u) _%s;\n", | |
745 | field->type.u.struct_nestable.alignment * CHAR_BIT, | |
746 | field->name); | |
747 | if (ret) { | |
748 | goto end; | |
749 | } | |
750 | } else { | |
751 | ret = lttng_metadata_printf(session, | |
752 | "struct {} _%s;\n", | |
753 | field->name); | |
754 | } | |
755 | (*iter_field)++; | |
756 | break; | |
b623cb6a | 757 | case lttng_ust_ctl_atype_enum_nestable: |
0d32d1a9 | 758 | { |
b623cb6a MJ |
759 | const struct lttng_ust_ctl_field *container_field; |
760 | const struct lttng_ust_ctl_type *container_type; | |
0d32d1a9 MD |
761 | |
762 | (*iter_field)++; | |
763 | if (*iter_field >= nr_fields) { | |
764 | ret = -EOVERFLOW; | |
765 | goto end; | |
766 | } | |
767 | container_field = &fields[*iter_field]; | |
768 | container_type = &container_field->type; | |
769 | ||
770 | /* Only integers are supported as container types. */ | |
b623cb6a | 771 | if (container_type->atype != lttng_ust_ctl_atype_integer) { |
0d32d1a9 MD |
772 | ret = -EINVAL; |
773 | goto end; | |
774 | } | |
775 | ret = ust_metadata_enum_statedump(session, | |
776 | field->type.u.enum_nestable.name, | |
777 | field->type.u.enum_nestable.id, | |
778 | &container_type->u.integer, | |
779 | field->name, iter_field, nesting); | |
780 | break; | |
781 | } | |
d0b96690 | 782 | default: |
da860cab | 783 | ret = -EINVAL; |
d0b96690 | 784 | } |
da860cab | 785 | end: |
d0b96690 DG |
786 | return ret; |
787 | } | |
788 | ||
789 | static | |
790 | int _lttng_context_metadata_statedump(struct ust_registry_session *session, | |
791 | size_t nr_ctx_fields, | |
b623cb6a | 792 | struct lttng_ust_ctl_field *ctx) |
d0b96690 DG |
793 | { |
794 | int ret = 0; | |
da860cab | 795 | size_t i = 0; |
d0b96690 DG |
796 | |
797 | if (!ctx) | |
798 | return 0; | |
da860cab MD |
799 | for (;;) { |
800 | if (i >= nr_ctx_fields) { | |
801 | break; | |
802 | } | |
803 | ret = _lttng_field_statedump(session, ctx, | |
804 | nr_ctx_fields, &i, 2); | |
805 | if (ret) { | |
806 | break; | |
807 | } | |
d0b96690 DG |
808 | } |
809 | return ret; | |
810 | } | |
811 | ||
812 | static | |
813 | int _lttng_fields_metadata_statedump(struct ust_registry_session *session, | |
814 | struct ust_registry_event *event) | |
815 | { | |
816 | int ret = 0; | |
da860cab | 817 | size_t i = 0; |
d0b96690 | 818 | |
da860cab MD |
819 | for (;;) { |
820 | if (i >= event->nr_fields) { | |
821 | break; | |
822 | } | |
823 | ret = _lttng_field_statedump(session, event->fields, | |
824 | event->nr_fields, &i, 2); | |
825 | if (ret) { | |
826 | break; | |
827 | } | |
d0b96690 DG |
828 | } |
829 | return ret; | |
830 | } | |
831 | ||
832 | /* | |
833 | * Should be called with session registry mutex held. | |
834 | */ | |
835 | int ust_metadata_event_statedump(struct ust_registry_session *session, | |
836 | struct ust_registry_channel *chan, | |
837 | struct ust_registry_event *event) | |
838 | { | |
839 | int ret = 0; | |
840 | ||
841 | /* Don't dump metadata events */ | |
842 | if (chan->chan_id == -1U) | |
843 | return 0; | |
844 | ||
bacc39bb SM |
845 | /* |
846 | * We don't want to output an event's metadata before its parent | |
847 | * stream's metadata. If the stream's metadata hasn't been output yet, | |
848 | * skip this event. Its metadata will be output when we output the | |
849 | * stream's metadata. | |
850 | */ | |
851 | if (!chan->metadata_dumped || event->metadata_dumped) { | |
852 | return 0; | |
853 | } | |
854 | ||
d0b96690 DG |
855 | ret = lttng_metadata_printf(session, |
856 | "event {\n" | |
857 | " name = \"%s\";\n" | |
858 | " id = %u;\n" | |
859 | " stream_id = %u;\n", | |
860 | event->name, | |
861 | event->id, | |
862 | chan->chan_id); | |
0d32d1a9 | 863 | if (ret) { |
d0b96690 | 864 | goto end; |
0d32d1a9 | 865 | } |
d0b96690 DG |
866 | |
867 | ret = lttng_metadata_printf(session, | |
868 | " loglevel = %d;\n", | |
2106efa0 | 869 | event->loglevel_value); |
0d32d1a9 | 870 | if (ret) { |
d0b96690 | 871 | goto end; |
0d32d1a9 | 872 | } |
d0b96690 DG |
873 | |
874 | if (event->model_emf_uri) { | |
875 | ret = lttng_metadata_printf(session, | |
876 | " model.emf.uri = \"%s\";\n", | |
877 | event->model_emf_uri); | |
0d32d1a9 | 878 | if (ret) { |
d0b96690 | 879 | goto end; |
0d32d1a9 | 880 | } |
d0b96690 DG |
881 | } |
882 | ||
d0b96690 DG |
883 | ret = lttng_metadata_printf(session, |
884 | " fields := struct {\n" | |
885 | ); | |
0d32d1a9 | 886 | if (ret) { |
d0b96690 | 887 | goto end; |
0d32d1a9 | 888 | } |
d0b96690 DG |
889 | |
890 | ret = _lttng_fields_metadata_statedump(session, event); | |
0d32d1a9 | 891 | if (ret) { |
d0b96690 | 892 | goto end; |
0d32d1a9 | 893 | } |
d0b96690 DG |
894 | |
895 | ret = lttng_metadata_printf(session, | |
896 | " };\n" | |
897 | "};\n\n"); | |
0d32d1a9 | 898 | if (ret) { |
d0b96690 | 899 | goto end; |
0d32d1a9 | 900 | } |
7972aab2 | 901 | event->metadata_dumped = 1; |
d0b96690 DG |
902 | |
903 | end: | |
904 | return ret; | |
905 | } | |
906 | ||
907 | /* | |
908 | * Should be called with session registry mutex held. | |
60f1b42d JG |
909 | * |
910 | * RCU read lock must be held by the caller. | |
d0b96690 DG |
911 | */ |
912 | int ust_metadata_channel_statedump(struct ust_registry_session *session, | |
913 | struct ust_registry_channel *chan) | |
914 | { | |
e4589ae2 | 915 | int ret; |
d0b96690 | 916 | |
60f1b42d JG |
917 | ASSERT_RCU_READ_LOCKED(); |
918 | ||
d0b96690 DG |
919 | /* Don't dump metadata events */ |
920 | if (chan->chan_id == -1U) | |
921 | return 0; | |
922 | ||
923 | if (!chan->header_type) | |
924 | return -EINVAL; | |
925 | ||
926 | ret = lttng_metadata_printf(session, | |
927 | "stream {\n" | |
928 | " id = %u;\n" | |
929 | " event.header := %s;\n" | |
930 | " packet.context := struct packet_context;\n", | |
931 | chan->chan_id, | |
b623cb6a | 932 | chan->header_type == LTTNG_UST_CTL_CHANNEL_HEADER_COMPACT ? |
d0b96690 DG |
933 | "struct event_header_compact" : |
934 | "struct event_header_large"); | |
0d32d1a9 | 935 | if (ret) { |
e4589ae2 | 936 | return ret; |
0d32d1a9 | 937 | } |
d0b96690 DG |
938 | |
939 | if (chan->ctx_fields) { | |
940 | ret = lttng_metadata_printf(session, | |
941 | " event.context := struct {\n"); | |
0d32d1a9 | 942 | if (ret) { |
e4589ae2 | 943 | return ret; |
0d32d1a9 | 944 | } |
d0b96690 DG |
945 | } |
946 | ret = _lttng_context_metadata_statedump(session, | |
947 | chan->nr_ctx_fields, | |
948 | chan->ctx_fields); | |
0d32d1a9 | 949 | if (ret) { |
e4589ae2 | 950 | return ret; |
0d32d1a9 | 951 | } |
d0b96690 DG |
952 | if (chan->ctx_fields) { |
953 | ret = lttng_metadata_printf(session, | |
954 | " };\n"); | |
0d32d1a9 | 955 | if (ret) { |
e4589ae2 | 956 | return ret; |
0d32d1a9 | 957 | } |
d0b96690 DG |
958 | } |
959 | ||
960 | ret = lttng_metadata_printf(session, | |
961 | "};\n\n"); | |
e4589ae2 SM |
962 | if (ret) { |
963 | return ret; | |
964 | } | |
965 | ||
7972aab2 DG |
966 | /* Flag success of metadata dump. */ |
967 | chan->metadata_dumped = 1; | |
d0b96690 | 968 | |
bacc39bb SM |
969 | /* |
970 | * Output the metadata of any existing event. | |
971 | * | |
972 | * Sort the events by id. This is not necessary, but it's nice to have | |
973 | * a more predictable order in the metadata file. | |
974 | */ | |
975 | std::vector<ust_registry_event *> events; | |
976 | { | |
977 | cds_lfht_iter event_iter; | |
978 | ust_registry_event *event; | |
979 | cds_lfht_for_each_entry(chan->events->ht, &event_iter, event, | |
980 | node.node) { | |
981 | events.push_back(event); | |
982 | } | |
983 | } | |
984 | ||
985 | std::sort(events.begin(), events.end(), | |
986 | [] (ust_registry_event *a, ust_registry_event *b) { | |
987 | return a->id < b->id; | |
988 | }); | |
989 | ||
990 | for (ust_registry_event *event : events) { | |
991 | ust_metadata_event_statedump(session, chan, event); | |
992 | } | |
993 | ||
e4589ae2 | 994 | return 0; |
d0b96690 DG |
995 | } |
996 | ||
997 | static | |
998 | int _lttng_stream_packet_context_declare(struct ust_registry_session *session) | |
999 | { | |
1000 | return lttng_metadata_printf(session, | |
1001 | "struct packet_context {\n" | |
1002 | " uint64_clock_monotonic_t timestamp_begin;\n" | |
1003 | " uint64_clock_monotonic_t timestamp_end;\n" | |
1004 | " uint64_t content_size;\n" | |
1005 | " uint64_t packet_size;\n" | |
0793bcc6 | 1006 | " uint64_t packet_seq_num;\n" |
d0b96690 DG |
1007 | " unsigned long events_discarded;\n" |
1008 | " uint32_t cpu_id;\n" | |
1009 | "};\n\n" | |
1010 | ); | |
1011 | } | |
1012 | ||
1013 | /* | |
1014 | * Compact header: | |
1015 | * id: range: 0 - 30. | |
1016 | * id 31 is reserved to indicate an extended header. | |
1017 | * | |
1018 | * Large header: | |
1019 | * id: range: 0 - 65534. | |
1020 | * id 65535 is reserved to indicate an extended header. | |
1021 | */ | |
1022 | static | |
1023 | int _lttng_event_header_declare(struct ust_registry_session *session) | |
1024 | { | |
1025 | return lttng_metadata_printf(session, | |
1026 | "struct event_header_compact {\n" | |
1027 | " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n" | |
1028 | " variant <id> {\n" | |
1029 | " struct {\n" | |
1030 | " uint27_clock_monotonic_t timestamp;\n" | |
1031 | " } compact;\n" | |
1032 | " struct {\n" | |
1033 | " uint32_t id;\n" | |
1034 | " uint64_clock_monotonic_t timestamp;\n" | |
1035 | " } extended;\n" | |
1036 | " } v;\n" | |
1037 | "} align(%u);\n" | |
1038 | "\n" | |
1039 | "struct event_header_large {\n" | |
1040 | " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n" | |
1041 | " variant <id> {\n" | |
1042 | " struct {\n" | |
1043 | " uint32_clock_monotonic_t timestamp;\n" | |
1044 | " } compact;\n" | |
1045 | " struct {\n" | |
1046 | " uint32_t id;\n" | |
1047 | " uint64_clock_monotonic_t timestamp;\n" | |
1048 | " } extended;\n" | |
1049 | " } v;\n" | |
1050 | "} align(%u);\n\n", | |
1051 | session->uint32_t_alignment, | |
1052 | session->uint16_t_alignment | |
1053 | ); | |
1054 | } | |
1055 | ||
dc113ec7 MD |
1056 | /* |
1057 | * The offset between monotonic and realtime clock can be negative if | |
1058 | * the system sets the REALTIME clock to 0 after boot. | |
dc113ec7 | 1059 | */ |
d0b96690 | 1060 | static |
8c645bb0 | 1061 | int measure_single_clock_offset(struct offset_sample *sample) |
d0b96690 | 1062 | { |
dc113ec7 | 1063 | uint64_t monotonic_avg, monotonic[2], measure_delta, realtime; |
fc0bb9fa | 1064 | uint64_t tcf = trace_clock_freq(); |
d0b96690 DG |
1065 | struct timespec rts = { 0, 0 }; |
1066 | int ret; | |
1067 | ||
1068 | monotonic[0] = trace_clock_read64(); | |
389fbf04 | 1069 | ret = lttng_clock_gettime(CLOCK_REALTIME, &rts); |
8c645bb0 MD |
1070 | if (ret < 0) { |
1071 | return ret; | |
1072 | } | |
d0b96690 | 1073 | monotonic[1] = trace_clock_read64(); |
8c645bb0 MD |
1074 | measure_delta = monotonic[1] - monotonic[0]; |
1075 | if (measure_delta > sample->measure_delta) { | |
1076 | /* | |
1077 | * Discard value if it took longer to read than the best | |
1078 | * sample so far. | |
1079 | */ | |
1080 | return 0; | |
1081 | } | |
dc113ec7 | 1082 | monotonic_avg = (monotonic[0] + monotonic[1]) >> 1; |
6e1b0543 MD |
1083 | realtime = (uint64_t) rts.tv_sec * tcf; |
1084 | if (tcf == NSEC_PER_SEC) { | |
1085 | realtime += rts.tv_nsec; | |
1086 | } else { | |
1087 | realtime += (uint64_t) rts.tv_nsec * tcf / NSEC_PER_SEC; | |
fc0bb9fa | 1088 | } |
c2636b57 | 1089 | sample->offset = (int64_t) realtime - monotonic_avg; |
8c645bb0 MD |
1090 | sample->measure_delta = measure_delta; |
1091 | return 0; | |
d0b96690 DG |
1092 | } |
1093 | ||
8c645bb0 MD |
1094 | /* |
1095 | * Approximation of NTP time of day to clock monotonic correlation, | |
1096 | * taken at start of trace. Keep the measurement that took the less time | |
1097 | * to complete, thus removing imprecision caused by preemption. | |
c2636b57 | 1098 | * May return a negative offset. |
8c645bb0 MD |
1099 | */ |
1100 | static | |
c2636b57 | 1101 | int64_t measure_clock_offset(void) |
8c645bb0 MD |
1102 | { |
1103 | int i; | |
1104 | struct offset_sample offset_best_sample = { | |
1105 | .offset = 0, | |
1106 | .measure_delta = UINT64_MAX, | |
1107 | }; | |
1108 | ||
1109 | for (i = 0; i < NR_CLOCK_OFFSET_SAMPLES; i++) { | |
1110 | if (measure_single_clock_offset(&offset_best_sample)) { | |
1111 | return 0; | |
1112 | } | |
1113 | } | |
1114 | return offset_best_sample.offset; | |
1115 | } | |
d0b96690 | 1116 | |
8de88061 JR |
1117 | static |
1118 | int print_metadata_session_information(struct ust_registry_session *registry) | |
1119 | { | |
1120 | int ret; | |
1121 | struct ltt_session *session = NULL; | |
1122 | char creation_datetime[ISO8601_STR_LEN]; | |
1123 | ||
1124 | rcu_read_lock(); | |
1125 | session = session_find_by_id(registry->tracing_id); | |
1126 | if (!session) { | |
1127 | ret = -1; | |
1128 | goto error; | |
1129 | } | |
1130 | ||
1131 | /* Print the trace name */ | |
1132 | ret = lttng_metadata_printf(registry, " trace_name = \""); | |
1133 | if (ret) { | |
1134 | goto error; | |
1135 | } | |
1136 | ||
1137 | /* | |
1138 | * This is necessary since the creation time is present in the session | |
1139 | * name when it is generated. | |
1140 | */ | |
1141 | if (session->has_auto_generated_name) { | |
1142 | ret = print_escaped_ctf_string(registry, DEFAULT_SESSION_NAME); | |
1143 | } else { | |
1144 | ret = print_escaped_ctf_string(registry, session->name); | |
1145 | } | |
1146 | if (ret) { | |
1147 | goto error; | |
1148 | } | |
1149 | ||
1150 | ret = lttng_metadata_printf(registry, "\";\n"); | |
1151 | if (ret) { | |
1152 | goto error; | |
1153 | } | |
1154 | ||
1155 | /* Prepare creation time */ | |
1156 | ret = time_to_iso8601_str(session->creation_time, creation_datetime, | |
1157 | sizeof(creation_datetime)); | |
1158 | if (ret) { | |
1159 | goto error; | |
1160 | } | |
1161 | ||
1162 | /* Output the reste of the information */ | |
1163 | ret = lttng_metadata_printf(registry, | |
1164 | " trace_creation_datetime = \"%s\";\n" | |
1165 | " hostname = \"%s\";\n", | |
1166 | creation_datetime, session->hostname); | |
1167 | if (ret) { | |
1168 | goto error; | |
1169 | } | |
1170 | ||
1171 | error: | |
1172 | if (session) { | |
1173 | session_put(session); | |
1174 | } | |
1175 | rcu_read_unlock(); | |
1176 | return ret; | |
1177 | } | |
1178 | ||
1179 | static | |
1180 | int print_metadata_app_information(struct ust_registry_session *registry, | |
1181 | struct ust_app *app) | |
1182 | { | |
1183 | int ret; | |
1184 | char datetime[ISO8601_STR_LEN]; | |
1185 | ||
1186 | if (!app) { | |
1187 | ret = 0; | |
1188 | goto end; | |
1189 | } | |
1190 | ||
1191 | ret = time_to_iso8601_str( | |
1192 | app->registration_time, datetime, sizeof(datetime)); | |
1193 | if (ret) { | |
1194 | goto end; | |
1195 | } | |
1196 | ||
1197 | ret = lttng_metadata_printf(registry, | |
1198 | " tracer_patchlevel = %u;\n" | |
1199 | " vpid = %d;\n" | |
1200 | " procname = \"%s\";\n" | |
1201 | " vpid_datetime = \"%s\";\n", | |
1202 | app->version.patchlevel, (int) app->pid, app->name, | |
1203 | datetime); | |
1204 | ||
1205 | end: | |
1206 | return ret; | |
1207 | } | |
1208 | ||
d0b96690 DG |
1209 | /* |
1210 | * Should be called with session registry mutex held. | |
1211 | */ | |
1212 | int ust_metadata_session_statedump(struct ust_registry_session *session, | |
af6142cf MD |
1213 | struct ust_app *app, |
1214 | uint32_t major, | |
1215 | uint32_t minor) | |
d0b96690 | 1216 | { |
c70636a7 MJ |
1217 | char uuid_s[LTTNG_UUID_STR_LEN], |
1218 | clock_uuid_s[LTTNG_UUID_STR_LEN]; | |
d0b96690 | 1219 | int ret = 0; |
d0b96690 | 1220 | |
a0377dfe | 1221 | LTTNG_ASSERT(session); |
7972aab2 | 1222 | |
c8e0c5f5 | 1223 | lttng_uuid_to_str(session->uuid, uuid_s); |
d0b96690 | 1224 | |
d7ba1388 MD |
1225 | /* For crash ABI */ |
1226 | ret = lttng_metadata_printf(session, | |
1227 | "/* CTF %u.%u */\n\n", | |
1228 | CTF_SPEC_MAJOR, | |
1229 | CTF_SPEC_MINOR); | |
1230 | if (ret) { | |
1231 | goto end; | |
1232 | } | |
1233 | ||
d0b96690 DG |
1234 | ret = lttng_metadata_printf(session, |
1235 | "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n" | |
1236 | "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n" | |
1237 | "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n" | |
1238 | "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n" | |
1239 | "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n" | |
1240 | "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n" | |
1241 | "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n" | |
1242 | "\n" | |
1243 | "trace {\n" | |
1244 | " major = %u;\n" | |
1245 | " minor = %u;\n" | |
1246 | " uuid = \"%s\";\n" | |
1247 | " byte_order = %s;\n" | |
1248 | " packet.header := struct {\n" | |
1249 | " uint32_t magic;\n" | |
1250 | " uint8_t uuid[16];\n" | |
1251 | " uint32_t stream_id;\n" | |
0793bcc6 | 1252 | " uint64_t stream_instance_id;\n" |
d0b96690 DG |
1253 | " };\n" |
1254 | "};\n\n", | |
1255 | session->uint8_t_alignment, | |
1256 | session->uint16_t_alignment, | |
1257 | session->uint32_t_alignment, | |
1258 | session->uint64_t_alignment, | |
1259 | session->bits_per_long, | |
1260 | session->long_alignment, | |
1261 | CTF_SPEC_MAJOR, | |
1262 | CTF_SPEC_MINOR, | |
1263 | uuid_s, | |
1264 | session->byte_order == BIG_ENDIAN ? "be" : "le" | |
1265 | ); | |
0d32d1a9 | 1266 | if (ret) { |
d0b96690 | 1267 | goto end; |
0d32d1a9 | 1268 | } |
d0b96690 | 1269 | |
d0b96690 DG |
1270 | ret = lttng_metadata_printf(session, |
1271 | "env {\n" | |
d0b96690 DG |
1272 | " domain = \"ust\";\n" |
1273 | " tracer_name = \"lttng-ust\";\n" | |
1274 | " tracer_major = %u;\n" | |
8de88061 JR |
1275 | " tracer_minor = %u;\n" |
1276 | " tracer_buffering_scheme = \"%s\";\n" | |
1277 | " tracer_buffering_id = %u;\n" | |
1278 | " architecture_bit_width = %u;\n", | |
af6142cf | 1279 | major, |
8de88061 JR |
1280 | minor, |
1281 | app ? "pid" : "uid", | |
1282 | app ? (int) app->pid : (int) session->tracing_uid, | |
1283 | session->bits_per_long); | |
1284 | if (ret) { | |
1285 | goto end; | |
1286 | } | |
1287 | ||
1288 | ret = print_metadata_session_information(session); | |
1289 | if (ret) { | |
d0b96690 | 1290 | goto end; |
8de88061 | 1291 | } |
d0b96690 DG |
1292 | |
1293 | /* | |
1294 | * If per-application registry, we can output extra information | |
1295 | * about the application. | |
1296 | */ | |
8de88061 JR |
1297 | ret = print_metadata_app_information(session, app); |
1298 | if (ret) { | |
1299 | goto end; | |
d0b96690 DG |
1300 | } |
1301 | ||
1302 | ret = lttng_metadata_printf(session, | |
1303 | "};\n\n" | |
1304 | ); | |
0d32d1a9 | 1305 | if (ret) { |
d0b96690 | 1306 | goto end; |
0d32d1a9 | 1307 | } |
d0b96690 DG |
1308 | |
1309 | ret = lttng_metadata_printf(session, | |
1310 | "clock {\n" | |
fc0bb9fa MD |
1311 | " name = \"%s\";\n", |
1312 | trace_clock_name() | |
d0b96690 | 1313 | ); |
0d32d1a9 | 1314 | if (ret) { |
d0b96690 | 1315 | goto end; |
0d32d1a9 | 1316 | } |
d0b96690 DG |
1317 | |
1318 | if (!trace_clock_uuid(clock_uuid_s)) { | |
1319 | ret = lttng_metadata_printf(session, | |
1320 | " uuid = \"%s\";\n", | |
1321 | clock_uuid_s | |
1322 | ); | |
0d32d1a9 | 1323 | if (ret) { |
d0b96690 | 1324 | goto end; |
0d32d1a9 | 1325 | } |
d0b96690 DG |
1326 | } |
1327 | ||
1328 | ret = lttng_metadata_printf(session, | |
fc0bb9fa | 1329 | " description = \"%s\";\n" |
d0b96690 DG |
1330 | " freq = %" PRIu64 "; /* Frequency, in Hz */\n" |
1331 | " /* clock value offset from Epoch is: offset * (1/freq) */\n" | |
c2636b57 | 1332 | " offset = %" PRId64 ";\n" |
d0b96690 | 1333 | "};\n\n", |
fc0bb9fa | 1334 | trace_clock_description(), |
d0b96690 DG |
1335 | trace_clock_freq(), |
1336 | measure_clock_offset() | |
1337 | ); | |
0d32d1a9 | 1338 | if (ret) { |
d0b96690 | 1339 | goto end; |
0d32d1a9 | 1340 | } |
d0b96690 DG |
1341 | |
1342 | ret = lttng_metadata_printf(session, | |
1343 | "typealias integer {\n" | |
1344 | " size = 27; align = 1; signed = false;\n" | |
fc0bb9fa | 1345 | " map = clock.%s.value;\n" |
d0b96690 DG |
1346 | "} := uint27_clock_monotonic_t;\n" |
1347 | "\n" | |
1348 | "typealias integer {\n" | |
1349 | " size = 32; align = %u; signed = false;\n" | |
fc0bb9fa | 1350 | " map = clock.%s.value;\n" |
d0b96690 DG |
1351 | "} := uint32_clock_monotonic_t;\n" |
1352 | "\n" | |
1353 | "typealias integer {\n" | |
1354 | " size = 64; align = %u; signed = false;\n" | |
fc0bb9fa | 1355 | " map = clock.%s.value;\n" |
d0b96690 | 1356 | "} := uint64_clock_monotonic_t;\n\n", |
fc0bb9fa | 1357 | trace_clock_name(), |
d0b96690 | 1358 | session->uint32_t_alignment, |
fc0bb9fa MD |
1359 | trace_clock_name(), |
1360 | session->uint64_t_alignment, | |
1361 | trace_clock_name() | |
d0b96690 | 1362 | ); |
0d32d1a9 | 1363 | if (ret) { |
d0b96690 | 1364 | goto end; |
0d32d1a9 | 1365 | } |
d0b96690 DG |
1366 | |
1367 | ret = _lttng_stream_packet_context_declare(session); | |
0d32d1a9 | 1368 | if (ret) { |
d0b96690 | 1369 | goto end; |
0d32d1a9 | 1370 | } |
d0b96690 DG |
1371 | |
1372 | ret = _lttng_event_header_declare(session); | |
0d32d1a9 | 1373 | if (ret) { |
d0b96690 | 1374 | goto end; |
0d32d1a9 | 1375 | } |
d0b96690 DG |
1376 | |
1377 | end: | |
1378 | return ret; | |
1379 | } |