projects / lttng-tools.git / blob
? search:


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