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


566799efd08b2016e7ce24edeeadb3cd70937d04
[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 #include <vector>
19
20 #include "ust-registry.hpp"
21 #include "ust-clock.hpp"
22 #include "ust-app.hpp"
23
24 #define NR_CLOCK_OFFSET_SAMPLES 10
25
26 struct offset_sample {
27 int64_t offset; /* correlation offset */
28 uint64_t measure_delta; /* lower is better */
29 };
30
31 static
32 int _lttng_field_statedump(struct ust_registry_session *session,
33 const struct lttng_ust_ctl_field *fields, size_t nr_fields,
34 size_t *iter_field, size_t nesting);
35
36 static inline
37 int get_count_order(unsigned int count)
38 {
39 int order;
40
41 order = lttng_fls(count) - 1;
42 if (count & (count - 1)) {
43 order++;
44 }
45 LTTNG_ASSERT(order >= 0);
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 =
69 std::max<size_t>(1U << get_count_order(new_alloc_len), old_alloc_len << 1);
70 newptr = (char *) realloc(session->metadata, new_alloc_len);
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
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
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 */
106 static ATTR_FORMAT_PRINTF(2, 3)
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);
129 ret = metadata_file_append(session, str, len);
130 if (ret) {
131 PERROR("Error appending to metadata file");
132 goto end;
133 }
134 DBG3("Append to metadata: \"%s\"", str);
135 ret = 0;
136
137 end:
138 free(str);
139 return ret;
140 }
141
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
158 static
159 void sanitize_ctf_identifier(char *out, const char *in)
160 {
161 size_t i;
162
163 for (i = 0; i < LTTNG_UST_ABI_SYM_NAME_LEN; i++) {
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
176 static
177 int print_escaped_ctf_string(struct ust_registry_session *session, const char *string)
178 {
179 int ret = 0;
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
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,
218 const struct lttng_ust_ctl_integer_type *container_type,
219 const char *field_name, size_t *iter_field, size_t nesting)
220 {
221 struct ust_registry_enum *reg_enum;
222 const struct lttng_ust_ctl_enum_entry *entries;
223 size_t nr_entries;
224 int ret = 0;
225 size_t i;
226 char identifier[LTTNG_UST_ABI_SYM_NAME_LEN];
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
239 ret = print_tabs(session, nesting);
240 if (ret) {
241 goto end;
242 }
243 ret = lttng_metadata_printf(session,
244 "enum : integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u; } {\n",
245 container_type->size,
246 container_type->alignment,
247 container_type->signedness,
248 (container_type->encoding == lttng_ust_ctl_encode_none)
249 ? "none"
250 : (container_type->encoding == lttng_ust_ctl_encode_UTF8)
251 ? "UTF8"
252 : "ASCII",
253 container_type->base);
254 if (ret) {
255 goto end;
256 }
257 nesting++;
258 /* Dump all entries */
259 for (i = 0; i < nr_entries; i++) {
260 const struct lttng_ust_ctl_enum_entry *entry = &entries[i];
261 int j, len;
262
263 ret = print_tabs(session, nesting);
264 if (ret) {
265 goto end;
266 }
267 ret = lttng_metadata_printf(session,
268 "\"");
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 }
295 ret = lttng_metadata_printf(session, "\"");
296 if (ret) {
297 goto end;
298 }
299
300 if (entry->u.extra.options &
301 LTTNG_UST_CTL_UST_ENUM_ENTRY_OPTION_IS_AUTO) {
302 ret = lttng_metadata_printf(session, ",\n");
303 if (ret) {
304 goto end;
305 }
306 } else {
307 ret = lttng_metadata_printf(session,
308 " = ");
309 if (ret) {
310 goto end;
311 }
312
313 if (entry->start.signedness) {
314 ret = lttng_metadata_printf(session,
315 "%" PRId64, entry->start.value);
316 } else {
317 ret = lttng_metadata_printf(session,
318 "%" PRIu64, entry->start.value);
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,
331 " ... %" PRId64 ",\n",
332 entry->end.value);
333 } else {
334 ret = lttng_metadata_printf(session,
335 " ... %" PRIu64 ",\n",
336 entry->end.value);
337 }
338 }
339 if (ret) {
340 goto end;
341 }
342 }
343 }
344 nesting--;
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);
352 end:
353 (*iter_field)++;
354 return ret;
355 }
356
357 static
358 int _lttng_variant_statedump(struct ust_registry_session *session,
359 uint32_t nr_choices, const char *tag_name,
360 uint32_t alignment,
361 const struct lttng_ust_ctl_field *fields, size_t nr_fields,
362 size_t *iter_field, size_t nesting)
363 {
364 const struct lttng_ust_ctl_field *variant = &fields[*iter_field];
365 uint32_t i;
366 int ret;
367 char identifier[LTTNG_UST_ABI_SYM_NAME_LEN];
368
369 (*iter_field)++;
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 }
384 ret = print_tabs(session, nesting);
385 if (ret) {
386 goto end;
387 }
388 ret = lttng_metadata_printf(session,
389 "variant <_%s> {\n",
390 identifier);
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);
403 if (ret) {
404 goto end;
405 }
406 }
407 sanitize_ctf_identifier(identifier, variant->name);
408 ret = print_tabs(session, nesting);
409 if (ret) {
410 goto end;
411 }
412 ret = lttng_metadata_printf(session,
413 "} _%s;\n",
414 identifier);
415 if (ret) {
416 goto end;
417 }
418 end:
419 return ret;
420 }
421
422 static
423 int _lttng_field_statedump(struct ust_registry_session *session,
424 const struct lttng_ust_ctl_field *fields, size_t nr_fields,
425 size_t *iter_field, size_t nesting)
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;
432 const struct lttng_ust_ctl_field *field;
433
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) {
441 bo_reverse = bo_le;
442 } else {
443 bo_reverse = bo_be;
444 }
445
446 switch (field->type.atype) {
447 case lttng_ust_ctl_atype_integer:
448 ret = print_tabs(session, nesting);
449 if (ret) {
450 goto end;
451 }
452 ret = lttng_metadata_printf(session,
453 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s;\n",
454 field->type.u.integer.size,
455 field->type.u.integer.alignment,
456 field->type.u.integer.signedness,
457 (field->type.u.integer.encoding == lttng_ust_ctl_encode_none)
458 ? "none"
459 : (field->type.u.integer.encoding == lttng_ust_ctl_encode_UTF8)
460 ? "UTF8"
461 : "ASCII",
462 field->type.u.integer.base,
463 field->type.u.integer.reverse_byte_order ? bo_reverse : bo_native,
464 field->name);
465 (*iter_field)++;
466 break;
467 case lttng_ust_ctl_atype_enum:
468 ret = ust_metadata_enum_statedump(session,
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,
472 field->name, iter_field, nesting);
473 break;
474 case lttng_ust_ctl_atype_float:
475 ret = print_tabs(session, nesting);
476 if (ret) {
477 goto end;
478 }
479 ret = lttng_metadata_printf(session,
480 "floating_point { exp_dig = %u; mant_dig = %u; align = %u;%s } _%s;\n",
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,
485 field->name);
486 (*iter_field)++;
487 break;
488 case lttng_ust_ctl_atype_array:
489 {
490 const struct lttng_ust_ctl_basic_type *elem_type;
491
492 ret = print_tabs(session, nesting);
493 if (ret) {
494 goto end;
495 }
496 elem_type = &field->type.u.legacy.array.elem_type;
497 /* Only integers are currently supported in arrays. */
498 if (elem_type->atype != lttng_ust_ctl_atype_integer) {
499 ret = -EINVAL;
500 goto end;
501 }
502 ret = lttng_metadata_printf(session,
503 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[%u];\n",
504 elem_type->u.basic.integer.size,
505 elem_type->u.basic.integer.alignment,
506 elem_type->u.basic.integer.signedness,
507 (elem_type->u.basic.integer.encoding == lttng_ust_ctl_encode_none)
508 ? "none"
509 : (elem_type->u.basic.integer.encoding == lttng_ust_ctl_encode_UTF8)
510 ? "UTF8"
511 : "ASCII",
512 elem_type->u.basic.integer.base,
513 elem_type->u.basic.integer.reverse_byte_order ? bo_reverse : bo_native,
514 field->name, field->type.u.legacy.array.length);
515 (*iter_field)++;
516 break;
517 }
518 case lttng_ust_ctl_atype_array_nestable:
519 {
520 uint32_t array_length;
521 const struct lttng_ust_ctl_field *array_nestable;
522 const struct lttng_ust_ctl_type *elem_type;
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. */
535 if (elem_type->atype != lttng_ust_ctl_atype_integer) {
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,
563 (elem_type->u.integer.encoding == lttng_ust_ctl_encode_none)
564 ? "none"
565 : (elem_type->u.integer.encoding == lttng_ust_ctl_encode_UTF8)
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);
571 (*iter_field)++;
572 break;
573 }
574 case lttng_ust_ctl_atype_sequence:
575 {
576 const struct lttng_ust_ctl_basic_type *elem_type;
577 const struct lttng_ust_ctl_basic_type *length_type;
578
579 elem_type = &field->type.u.legacy.sequence.elem_type;
580 length_type = &field->type.u.legacy.sequence.length_type;
581 ret = print_tabs(session, nesting);
582 if (ret) {
583 goto end;
584 }
585
586 /* Only integers are currently supported in sequences. */
587 if (elem_type->atype != lttng_ust_ctl_atype_integer) {
588 ret = -EINVAL;
589 goto end;
590 }
591
592 ret = lttng_metadata_printf(session,
593 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n",
594 length_type->u.basic.integer.size,
595 (unsigned int) length_type->u.basic.integer.alignment,
596 length_type->u.basic.integer.signedness,
597 (length_type->u.basic.integer.encoding == lttng_ust_ctl_encode_none)
598 ? "none"
599 : ((length_type->u.basic.integer.encoding == lttng_ust_ctl_encode_UTF8)
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);
605 if (ret) {
606 goto end;
607 }
608
609 ret = print_tabs(session, nesting);
610 if (ret) {
611 goto end;
612 }
613 ret = lttng_metadata_printf(session,
614 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[ __%s_length ];\n",
615 elem_type->u.basic.integer.size,
616 (unsigned int) elem_type->u.basic.integer.alignment,
617 elem_type->u.basic.integer.signedness,
618 (elem_type->u.basic.integer.encoding == lttng_ust_ctl_encode_none)
619 ? "none"
620 : ((elem_type->u.basic.integer.encoding == lttng_ust_ctl_encode_UTF8)
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);
627 (*iter_field)++;
628 break;
629 }
630 case lttng_ust_ctl_atype_sequence_nestable:
631 {
632 const struct lttng_ust_ctl_field *sequence_nestable;
633 const struct lttng_ust_ctl_type *elem_type;
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. */
644 if (elem_type->atype != lttng_ust_ctl_atype_integer) {
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 }
662
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,
672 (elem_type->u.integer.encoding == lttng_ust_ctl_encode_none)
673 ? "none"
674 : ((elem_type->u.integer.encoding == lttng_ust_ctl_encode_UTF8)
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 }
684 case lttng_ust_ctl_atype_string:
685 /* Default encoding is UTF8 */
686 ret = print_tabs(session, nesting);
687 if (ret) {
688 goto end;
689 }
690 ret = lttng_metadata_printf(session,
691 "string%s _%s;\n",
692 field->type.u.string.encoding == lttng_ust_ctl_encode_ASCII ?
693 " { encoding = ASCII; }" : "",
694 field->name);
695 (*iter_field)++;
696 break;
697 case lttng_ust_ctl_atype_variant:
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;
707 case lttng_ust_ctl_atype_variant_nestable:
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);
713 if (ret) {
714 goto end;
715 }
716 break;
717 case lttng_ust_ctl_atype_struct:
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 }
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)++;
731 break;
732 case lttng_ust_ctl_atype_struct_nestable:
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;
757 case lttng_ust_ctl_atype_enum_nestable:
758 {
759 const struct lttng_ust_ctl_field *container_field;
760 const struct lttng_ust_ctl_type *container_type;
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. */
771 if (container_type->atype != lttng_ust_ctl_atype_integer) {
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 }
782 default:
783 ret = -EINVAL;
784 }
785 end:
786 return ret;
787 }
788
789 static
790 int _lttng_context_metadata_statedump(struct ust_registry_session *session,
791 size_t nr_ctx_fields,
792 struct lttng_ust_ctl_field *ctx)
793 {
794 int ret = 0;
795 size_t i = 0;
796
797 if (!ctx)
798 return 0;
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 }
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;
817 size_t i = 0;
818
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 }
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
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
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);
863 if (ret) {
864 goto end;
865 }
866
867 ret = lttng_metadata_printf(session,
868 " loglevel = %d;\n",
869 event->loglevel_value);
870 if (ret) {
871 goto end;
872 }
873
874 if (event->model_emf_uri) {
875 ret = lttng_metadata_printf(session,
876 " model.emf.uri = \"%s\";\n",
877 event->model_emf_uri);
878 if (ret) {
879 goto end;
880 }
881 }
882
883 ret = lttng_metadata_printf(session,
884 " fields := struct {\n"
885 );
886 if (ret) {
887 goto end;
888 }
889
890 ret = _lttng_fields_metadata_statedump(session, event);
891 if (ret) {
892 goto end;
893 }
894
895 ret = lttng_metadata_printf(session,
896 " };\n"
897 "};\n\n");
898 if (ret) {
899 goto end;
900 }
901 event->metadata_dumped = 1;
902
903 end:
904 return ret;
905 }
906
907 /*
908 * Should be called with session registry mutex held.
909 */
910 int ust_metadata_channel_statedump(struct ust_registry_session *session,
911 struct ust_registry_channel *chan)
912 {
913 int ret;
914
915 /* Don't dump metadata events */
916 if (chan->chan_id == -1U)
917 return 0;
918
919 if (!chan->header_type)
920 return -EINVAL;
921
922 ret = lttng_metadata_printf(session,
923 "stream {\n"
924 " id = %u;\n"
925 " event.header := %s;\n"
926 " packet.context := struct packet_context;\n",
927 chan->chan_id,
928 chan->header_type == LTTNG_UST_CTL_CHANNEL_HEADER_COMPACT ?
929 "struct event_header_compact" :
930 "struct event_header_large");
931 if (ret) {
932 return ret;
933 }
934
935 if (chan->ctx_fields) {
936 ret = lttng_metadata_printf(session,
937 " event.context := struct {\n");
938 if (ret) {
939 return ret;
940 }
941 }
942 ret = _lttng_context_metadata_statedump(session,
943 chan->nr_ctx_fields,
944 chan->ctx_fields);
945 if (ret) {
946 return ret;
947 }
948 if (chan->ctx_fields) {
949 ret = lttng_metadata_printf(session,
950 " };\n");
951 if (ret) {
952 return ret;
953 }
954 }
955
956 ret = lttng_metadata_printf(session,
957 "};\n\n");
958 if (ret) {
959 return ret;
960 }
961
962 /* Flag success of metadata dump. */
963 chan->metadata_dumped = 1;
964
965 /*
966 * Output the metadata of any existing event.
967 *
968 * Sort the events by id. This is not necessary, but it's nice to have
969 * a more predictable order in the metadata file.
970 */
971 std::vector<ust_registry_event *> events;
972 {
973 cds_lfht_iter event_iter;
974 ust_registry_event *event;
975 cds_lfht_for_each_entry(chan->events->ht, &event_iter, event,
976 node.node) {
977 events.push_back(event);
978 }
979 }
980
981 std::sort(events.begin(), events.end(),
982 [] (ust_registry_event *a, ust_registry_event *b) {
983 return a->id < b->id;
984 });
985
986 for (ust_registry_event *event : events) {
987 ust_metadata_event_statedump(session, chan, event);
988 }
989
990 return 0;
991 }
992
993 static
994 int _lttng_stream_packet_context_declare(struct ust_registry_session *session)
995 {
996 return lttng_metadata_printf(session,
997 "struct packet_context {\n"
998 " uint64_clock_monotonic_t timestamp_begin;\n"
999 " uint64_clock_monotonic_t timestamp_end;\n"
1000 " uint64_t content_size;\n"
1001 " uint64_t packet_size;\n"
1002 " uint64_t packet_seq_num;\n"
1003 " unsigned long events_discarded;\n"
1004 " uint32_t cpu_id;\n"
1005 "};\n\n"
1006 );
1007 }
1008
1009 /*
1010 * Compact header:
1011 * id: range: 0 - 30.
1012 * id 31 is reserved to indicate an extended header.
1013 *
1014 * Large header:
1015 * id: range: 0 - 65534.
1016 * id 65535 is reserved to indicate an extended header.
1017 */
1018 static
1019 int _lttng_event_header_declare(struct ust_registry_session *session)
1020 {
1021 return lttng_metadata_printf(session,
1022 "struct event_header_compact {\n"
1023 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
1024 " variant <id> {\n"
1025 " struct {\n"
1026 " uint27_clock_monotonic_t timestamp;\n"
1027 " } compact;\n"
1028 " struct {\n"
1029 " uint32_t id;\n"
1030 " uint64_clock_monotonic_t timestamp;\n"
1031 " } extended;\n"
1032 " } v;\n"
1033 "} align(%u);\n"
1034 "\n"
1035 "struct event_header_large {\n"
1036 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
1037 " variant <id> {\n"
1038 " struct {\n"
1039 " uint32_clock_monotonic_t timestamp;\n"
1040 " } compact;\n"
1041 " struct {\n"
1042 " uint32_t id;\n"
1043 " uint64_clock_monotonic_t timestamp;\n"
1044 " } extended;\n"
1045 " } v;\n"
1046 "} align(%u);\n\n",
1047 session->uint32_t_alignment,
1048 session->uint16_t_alignment
1049 );
1050 }
1051
1052 /*
1053 * The offset between monotonic and realtime clock can be negative if
1054 * the system sets the REALTIME clock to 0 after boot.
1055 */
1056 static
1057 int measure_single_clock_offset(struct offset_sample *sample)
1058 {
1059 uint64_t monotonic_avg, monotonic[2], measure_delta, realtime;
1060 uint64_t tcf = trace_clock_freq();
1061 struct timespec rts = { 0, 0 };
1062 int ret;
1063
1064 monotonic[0] = trace_clock_read64();
1065 ret = lttng_clock_gettime(CLOCK_REALTIME, &rts);
1066 if (ret < 0) {
1067 return ret;
1068 }
1069 monotonic[1] = trace_clock_read64();
1070 measure_delta = monotonic[1] - monotonic[0];
1071 if (measure_delta > sample->measure_delta) {
1072 /*
1073 * Discard value if it took longer to read than the best
1074 * sample so far.
1075 */
1076 return 0;
1077 }
1078 monotonic_avg = (monotonic[0] + monotonic[1]) >> 1;
1079 realtime = (uint64_t) rts.tv_sec * tcf;
1080 if (tcf == NSEC_PER_SEC) {
1081 realtime += rts.tv_nsec;
1082 } else {
1083 realtime += (uint64_t) rts.tv_nsec * tcf / NSEC_PER_SEC;
1084 }
1085 sample->offset = (int64_t) realtime - monotonic_avg;
1086 sample->measure_delta = measure_delta;
1087 return 0;
1088 }
1089
1090 /*
1091 * Approximation of NTP time of day to clock monotonic correlation,
1092 * taken at start of trace. Keep the measurement that took the less time
1093 * to complete, thus removing imprecision caused by preemption.
1094 * May return a negative offset.
1095 */
1096 static
1097 int64_t measure_clock_offset(void)
1098 {
1099 int i;
1100 struct offset_sample offset_best_sample = {
1101 .offset = 0,
1102 .measure_delta = UINT64_MAX,
1103 };
1104
1105 for (i = 0; i < NR_CLOCK_OFFSET_SAMPLES; i++) {
1106 if (measure_single_clock_offset(&offset_best_sample)) {
1107 return 0;
1108 }
1109 }
1110 return offset_best_sample.offset;
1111 }
1112
1113 static
1114 int print_metadata_session_information(struct ust_registry_session *registry)
1115 {
1116 int ret;
1117 struct ltt_session *session = NULL;
1118 char creation_datetime[ISO8601_STR_LEN];
1119
1120 rcu_read_lock();
1121 session = session_find_by_id(registry->tracing_id);
1122 if (!session) {
1123 ret = -1;
1124 goto error;
1125 }
1126
1127 /* Print the trace name */
1128 ret = lttng_metadata_printf(registry, " trace_name = \"");
1129 if (ret) {
1130 goto error;
1131 }
1132
1133 /*
1134 * This is necessary since the creation time is present in the session
1135 * name when it is generated.
1136 */
1137 if (session->has_auto_generated_name) {
1138 ret = print_escaped_ctf_string(registry, DEFAULT_SESSION_NAME);
1139 } else {
1140 ret = print_escaped_ctf_string(registry, session->name);
1141 }
1142 if (ret) {
1143 goto error;
1144 }
1145
1146 ret = lttng_metadata_printf(registry, "\";\n");
1147 if (ret) {
1148 goto error;
1149 }
1150
1151 /* Prepare creation time */
1152 ret = time_to_iso8601_str(session->creation_time, creation_datetime,
1153 sizeof(creation_datetime));
1154 if (ret) {
1155 goto error;
1156 }
1157
1158 /* Output the reste of the information */
1159 ret = lttng_metadata_printf(registry,
1160 " trace_creation_datetime = \"%s\";\n"
1161 " hostname = \"%s\";\n",
1162 creation_datetime, session->hostname);
1163 if (ret) {
1164 goto error;
1165 }
1166
1167 error:
1168 if (session) {
1169 session_put(session);
1170 }
1171 rcu_read_unlock();
1172 return ret;
1173 }
1174
1175 static
1176 int print_metadata_app_information(struct ust_registry_session *registry,
1177 struct ust_app *app)
1178 {
1179 int ret;
1180 char datetime[ISO8601_STR_LEN];
1181
1182 if (!app) {
1183 ret = 0;
1184 goto end;
1185 }
1186
1187 ret = time_to_iso8601_str(
1188 app->registration_time, datetime, sizeof(datetime));
1189 if (ret) {
1190 goto end;
1191 }
1192
1193 ret = lttng_metadata_printf(registry,
1194 " tracer_patchlevel = %u;\n"
1195 " vpid = %d;\n"
1196 " procname = \"%s\";\n"
1197 " vpid_datetime = \"%s\";\n",
1198 app->version.patchlevel, (int) app->pid, app->name,
1199 datetime);
1200
1201 end:
1202 return ret;
1203 }
1204
1205 /*
1206 * Should be called with session registry mutex held.
1207 */
1208 int ust_metadata_session_statedump(struct ust_registry_session *session,
1209 struct ust_app *app,
1210 uint32_t major,
1211 uint32_t minor)
1212 {
1213 char uuid_s[LTTNG_UUID_STR_LEN],
1214 clock_uuid_s[LTTNG_UUID_STR_LEN];
1215 int ret = 0;
1216
1217 LTTNG_ASSERT(session);
1218
1219 lttng_uuid_to_str(session->uuid, uuid_s);
1220
1221 /* For crash ABI */
1222 ret = lttng_metadata_printf(session,
1223 "/* CTF %u.%u */\n\n",
1224 CTF_SPEC_MAJOR,
1225 CTF_SPEC_MINOR);
1226 if (ret) {
1227 goto end;
1228 }
1229
1230 ret = lttng_metadata_printf(session,
1231 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
1232 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
1233 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
1234 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
1235 "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n"
1236 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
1237 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
1238 "\n"
1239 "trace {\n"
1240 " major = %u;\n"
1241 " minor = %u;\n"
1242 " uuid = \"%s\";\n"
1243 " byte_order = %s;\n"
1244 " packet.header := struct {\n"
1245 " uint32_t magic;\n"
1246 " uint8_t uuid[16];\n"
1247 " uint32_t stream_id;\n"
1248 " uint64_t stream_instance_id;\n"
1249 " };\n"
1250 "};\n\n",
1251 session->uint8_t_alignment,
1252 session->uint16_t_alignment,
1253 session->uint32_t_alignment,
1254 session->uint64_t_alignment,
1255 session->bits_per_long,
1256 session->long_alignment,
1257 CTF_SPEC_MAJOR,
1258 CTF_SPEC_MINOR,
1259 uuid_s,
1260 session->byte_order == BIG_ENDIAN ? "be" : "le"
1261 );
1262 if (ret) {
1263 goto end;
1264 }
1265
1266 ret = lttng_metadata_printf(session,
1267 "env {\n"
1268 " domain = \"ust\";\n"
1269 " tracer_name = \"lttng-ust\";\n"
1270 " tracer_major = %u;\n"
1271 " tracer_minor = %u;\n"
1272 " tracer_buffering_scheme = \"%s\";\n"
1273 " tracer_buffering_id = %u;\n"
1274 " architecture_bit_width = %u;\n",
1275 major,
1276 minor,
1277 app ? "pid" : "uid",
1278 app ? (int) app->pid : (int) session->tracing_uid,
1279 session->bits_per_long);
1280 if (ret) {
1281 goto end;
1282 }
1283
1284 ret = print_metadata_session_information(session);
1285 if (ret) {
1286 goto end;
1287 }
1288
1289 /*
1290 * If per-application registry, we can output extra information
1291 * about the application.
1292 */
1293 ret = print_metadata_app_information(session, app);
1294 if (ret) {
1295 goto end;
1296 }
1297
1298 ret = lttng_metadata_printf(session,
1299 "};\n\n"
1300 );
1301 if (ret) {
1302 goto end;
1303 }
1304
1305 ret = lttng_metadata_printf(session,
1306 "clock {\n"
1307 " name = \"%s\";\n",
1308 trace_clock_name()
1309 );
1310 if (ret) {
1311 goto end;
1312 }
1313
1314 if (!trace_clock_uuid(clock_uuid_s)) {
1315 ret = lttng_metadata_printf(session,
1316 " uuid = \"%s\";\n",
1317 clock_uuid_s
1318 );
1319 if (ret) {
1320 goto end;
1321 }
1322 }
1323
1324 ret = lttng_metadata_printf(session,
1325 " description = \"%s\";\n"
1326 " freq = %" PRIu64 "; /* Frequency, in Hz */\n"
1327 " /* clock value offset from Epoch is: offset * (1/freq) */\n"
1328 " offset = %" PRId64 ";\n"
1329 "};\n\n",
1330 trace_clock_description(),
1331 trace_clock_freq(),
1332 measure_clock_offset()
1333 );
1334 if (ret) {
1335 goto end;
1336 }
1337
1338 ret = lttng_metadata_printf(session,
1339 "typealias integer {\n"
1340 " size = 27; align = 1; signed = false;\n"
1341 " map = clock.%s.value;\n"
1342 "} := uint27_clock_monotonic_t;\n"
1343 "\n"
1344 "typealias integer {\n"
1345 " size = 32; align = %u; signed = false;\n"
1346 " map = clock.%s.value;\n"
1347 "} := uint32_clock_monotonic_t;\n"
1348 "\n"
1349 "typealias integer {\n"
1350 " size = 64; align = %u; signed = false;\n"
1351 " map = clock.%s.value;\n"
1352 "} := uint64_clock_monotonic_t;\n\n",
1353 trace_clock_name(),
1354 session->uint32_t_alignment,
1355 trace_clock_name(),
1356 session->uint64_t_alignment,
1357 trace_clock_name()
1358 );
1359 if (ret) {
1360 goto end;
1361 }
1362
1363 ret = _lttng_stream_packet_context_declare(session);
1364 if (ret) {
1365 goto end;
1366 }
1367
1368 ret = _lttng_event_header_declare(session);
1369 if (ret) {
1370 goto end;
1371 }
1372
1373 end:
1374 return ret;
1375 }
LTTng 2.0 tools and control repository
This page took 0.099752 seconds and 4 git commands to generate.