4 * LTTng-UST metadata generation
6 * Copyright (C) 2010-2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License, version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 #include <common/common.h>
32 #include "ust-registry.h"
33 #include "ust-clock.h"
37 #define max_t(type, a, b) ((type) ((a) > (b) ? (a) : (b)))
40 #define NSEC_PER_SEC 1000000000ULL
41 #define NR_CLOCK_OFFSET_SAMPLES 10
43 struct offset_sample
{
44 int64_t offset
; /* correlation offset */
45 uint64_t measure_delta
; /* lower is better */
49 int _lttng_field_statedump(struct ust_registry_session
*session
,
50 const struct ustctl_field
*fields
, size_t nr_fields
,
51 size_t *iter_field
, size_t nesting
);
54 int fls(unsigned int x
)
60 if (!(x
& 0xFFFF0000U
)) {
64 if (!(x
& 0xFF000000U
)) {
68 if (!(x
& 0xF0000000U
)) {
72 if (!(x
& 0xC0000000U
)) {
76 if (!(x
& 0x80000000U
)) {
84 int get_count_order(unsigned int count
)
88 order
= fls(count
) - 1;
89 if (count
& (count
- 1))
95 * Returns offset where to write in metadata array, or negative error value on error.
98 ssize_t
metadata_reserve(struct ust_registry_session
*session
, size_t len
)
100 size_t new_len
= session
->metadata_len
+ len
;
101 size_t new_alloc_len
= new_len
;
102 size_t old_alloc_len
= session
->metadata_alloc_len
;
105 if (new_alloc_len
> (UINT32_MAX
>> 1))
107 if ((old_alloc_len
<< 1) > (UINT32_MAX
>> 1))
110 if (new_alloc_len
> old_alloc_len
) {
114 max_t(size_t, 1U << get_count_order(new_alloc_len
), old_alloc_len
<< 1);
115 newptr
= realloc(session
->metadata
, new_alloc_len
);
118 session
->metadata
= newptr
;
119 /* We zero directly the memory from start of allocation. */
120 memset(&session
->metadata
[old_alloc_len
], 0, new_alloc_len
- old_alloc_len
);
121 session
->metadata_alloc_len
= new_alloc_len
;
123 ret
= session
->metadata_len
;
124 session
->metadata_len
+= len
;
129 int metadata_file_append(struct ust_registry_session
*session
,
130 const char *str
, size_t len
)
134 if (session
->metadata_fd
< 0) {
137 /* Write to metadata file */
138 written
= lttng_write(session
->metadata_fd
, str
, len
);
139 if (written
!= len
) {
146 * We have exclusive access to our metadata buffer (protected by the
147 * ust_lock), so we can do racy operations such as looking for
148 * remaining space left in packet and write, since mutual exclusion
149 * protects us from concurrent writes.
152 int lttng_metadata_printf(struct ust_registry_session
*session
,
153 const char *fmt
, ...)
162 ret
= vasprintf(&str
, fmt
, ap
);
168 offset
= metadata_reserve(session
, len
);
173 memcpy(&session
->metadata
[offset
], str
, len
);
174 ret
= metadata_file_append(session
, str
, len
);
176 PERROR("Error appending to metadata file");
179 DBG3("Append to metadata: \"%s\"", str
);
188 int print_tabs(struct ust_registry_session
*session
, size_t nesting
)
192 for (i
= 0; i
< nesting
; i
++) {
195 ret
= lttng_metadata_printf(session
, " ");
204 void sanitize_ctf_identifier(char *out
, const char *in
)
208 for (i
= 0; i
< LTTNG_UST_SYM_NAME_LEN
; i
++) {
221 /* Called with session registry mutex held. */
223 int ust_metadata_enum_statedump(struct ust_registry_session
*session
,
224 const char *enum_name
,
226 const struct ustctl_integer_type
*container_type
,
227 const char *field_name
, size_t *iter_field
, size_t nesting
)
229 struct ust_registry_enum
*reg_enum
;
230 const struct ustctl_enum_entry
*entries
;
234 char identifier
[LTTNG_UST_SYM_NAME_LEN
];
237 reg_enum
= ust_registry_lookup_enum_by_id(session
, enum_name
, enum_id
);
239 /* reg_enum can still be used because session registry mutex is held. */
244 entries
= reg_enum
->entries
;
245 nr_entries
= reg_enum
->nr_entries
;
247 ret
= print_tabs(session
, nesting
);
251 ret
= lttng_metadata_printf(session
,
252 "enum : integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u; } {\n",
253 container_type
->size
,
254 container_type
->alignment
,
255 container_type
->signedness
,
256 (container_type
->encoding
== ustctl_encode_none
)
258 : (container_type
->encoding
== ustctl_encode_UTF8
)
261 container_type
->base
);
266 /* Dump all entries */
267 for (i
= 0; i
< nr_entries
; i
++) {
268 const struct ustctl_enum_entry
*entry
= &entries
[i
];
271 ret
= print_tabs(session
, nesting
);
275 ret
= lttng_metadata_printf(session
,
280 len
= strlen(entry
->string
);
281 /* Escape the character '"' */
282 for (j
= 0; j
< len
; j
++) {
283 char c
= entry
->string
[j
];
287 ret
= lttng_metadata_printf(session
,
291 ret
= lttng_metadata_printf(session
,
295 ret
= lttng_metadata_printf(session
,
303 ret
= lttng_metadata_printf(session
, "\"");
308 if (entry
->u
.extra
.options
&
309 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
) {
310 ret
= lttng_metadata_printf(session
, ",\n");
315 ret
= lttng_metadata_printf(session
,
321 if (entry
->start
.signedness
) {
322 ret
= lttng_metadata_printf(session
,
323 "%lld", (long long) entry
->start
.value
);
325 ret
= lttng_metadata_printf(session
,
326 "%llu", entry
->start
.value
);
332 if (entry
->start
.signedness
== entry
->end
.signedness
&&
333 entry
->start
.value
==
335 ret
= lttng_metadata_printf(session
, ",\n");
337 if (entry
->end
.signedness
) {
338 ret
= lttng_metadata_printf(session
,
340 (long long) entry
->end
.value
);
342 ret
= lttng_metadata_printf(session
,
353 sanitize_ctf_identifier(identifier
, field_name
);
354 ret
= print_tabs(session
, nesting
);
358 ret
= lttng_metadata_printf(session
, "} _%s;\n",
366 int _lttng_variant_statedump(struct ust_registry_session
*session
,
367 const struct ustctl_field
*fields
, size_t nr_fields
,
368 size_t *iter_field
, size_t nesting
)
370 const struct ustctl_field
*variant
= &fields
[*iter_field
];
371 uint32_t nr_choices
, i
;
373 char identifier
[LTTNG_UST_SYM_NAME_LEN
];
375 if (variant
->type
.atype
!= ustctl_atype_variant
) {
379 nr_choices
= variant
->type
.u
.variant
.nr_choices
;
381 sanitize_ctf_identifier(identifier
, variant
->type
.u
.variant
.tag_name
);
382 ret
= print_tabs(session
, nesting
);
386 ret
= lttng_metadata_printf(session
,
393 for (i
= 0; i
< nr_choices
; i
++) {
394 if (*iter_field
>= nr_fields
) {
398 ret
= _lttng_field_statedump(session
,
400 iter_field
, nesting
+ 1);
405 sanitize_ctf_identifier(identifier
, variant
->name
);
406 ret
= print_tabs(session
, nesting
);
407 ret
= lttng_metadata_printf(session
,
418 int _lttng_field_statedump(struct ust_registry_session
*session
,
419 const struct ustctl_field
*fields
, size_t nr_fields
,
420 size_t *iter_field
, size_t nesting
)
423 const char *bo_be
= " byte_order = be;";
424 const char *bo_le
= " byte_order = le;";
425 const char *bo_native
= "";
426 const char *bo_reverse
;
427 const struct ustctl_field
*field
;
429 if (*iter_field
>= nr_fields
) {
433 field
= &fields
[*iter_field
];
435 if (session
->byte_order
== BIG_ENDIAN
) {
441 switch (field
->type
.atype
) {
442 case ustctl_atype_integer
:
443 ret
= print_tabs(session
, nesting
);
447 ret
= lttng_metadata_printf(session
,
448 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s;\n",
449 field
->type
.u
.basic
.integer
.size
,
450 field
->type
.u
.basic
.integer
.alignment
,
451 field
->type
.u
.basic
.integer
.signedness
,
452 (field
->type
.u
.basic
.integer
.encoding
== ustctl_encode_none
)
454 : (field
->type
.u
.basic
.integer
.encoding
== ustctl_encode_UTF8
)
457 field
->type
.u
.basic
.integer
.base
,
458 field
->type
.u
.basic
.integer
.reverse_byte_order
? bo_reverse
: bo_native
,
462 case ustctl_atype_enum
:
463 ret
= ust_metadata_enum_statedump(session
,
464 field
->type
.u
.basic
.enumeration
.name
,
465 field
->type
.u
.basic
.enumeration
.id
,
466 &field
->type
.u
.basic
.enumeration
.container_type
,
467 field
->name
, iter_field
, nesting
);
469 case ustctl_atype_float
:
470 ret
= print_tabs(session
, nesting
);
474 ret
= lttng_metadata_printf(session
,
475 "floating_point { exp_dig = %u; mant_dig = %u; align = %u;%s } _%s;\n",
476 field
->type
.u
.basic
._float
.exp_dig
,
477 field
->type
.u
.basic
._float
.mant_dig
,
478 field
->type
.u
.basic
._float
.alignment
,
479 field
->type
.u
.basic
.integer
.reverse_byte_order
? bo_reverse
: bo_native
,
483 case ustctl_atype_array
:
485 const struct ustctl_basic_type
*elem_type
;
487 ret
= print_tabs(session
, nesting
);
491 elem_type
= &field
->type
.u
.array
.elem_type
;
492 ret
= lttng_metadata_printf(session
,
493 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[%u];\n",
494 elem_type
->u
.basic
.integer
.size
,
495 elem_type
->u
.basic
.integer
.alignment
,
496 elem_type
->u
.basic
.integer
.signedness
,
497 (elem_type
->u
.basic
.integer
.encoding
== ustctl_encode_none
)
499 : (elem_type
->u
.basic
.integer
.encoding
== ustctl_encode_UTF8
)
502 elem_type
->u
.basic
.integer
.base
,
503 elem_type
->u
.basic
.integer
.reverse_byte_order
? bo_reverse
: bo_native
,
504 field
->name
, field
->type
.u
.array
.length
);
508 case ustctl_atype_sequence
:
510 const struct ustctl_basic_type
*elem_type
;
511 const struct ustctl_basic_type
*length_type
;
513 elem_type
= &field
->type
.u
.sequence
.elem_type
;
514 length_type
= &field
->type
.u
.sequence
.length_type
;
515 ret
= print_tabs(session
, nesting
);
519 ret
= lttng_metadata_printf(session
,
520 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n",
521 length_type
->u
.basic
.integer
.size
,
522 (unsigned int) length_type
->u
.basic
.integer
.alignment
,
523 length_type
->u
.basic
.integer
.signedness
,
524 (length_type
->u
.basic
.integer
.encoding
== ustctl_encode_none
)
526 : ((length_type
->u
.basic
.integer
.encoding
== ustctl_encode_UTF8
)
529 length_type
->u
.basic
.integer
.base
,
530 length_type
->u
.basic
.integer
.reverse_byte_order
? bo_reverse
: bo_native
,
536 ret
= print_tabs(session
, nesting
);
540 ret
= lttng_metadata_printf(session
,
541 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[ __%s_length ];\n",
542 elem_type
->u
.basic
.integer
.size
,
543 (unsigned int) elem_type
->u
.basic
.integer
.alignment
,
544 elem_type
->u
.basic
.integer
.signedness
,
545 (elem_type
->u
.basic
.integer
.encoding
== ustctl_encode_none
)
547 : ((elem_type
->u
.basic
.integer
.encoding
== ustctl_encode_UTF8
)
550 elem_type
->u
.basic
.integer
.base
,
551 elem_type
->u
.basic
.integer
.reverse_byte_order
? bo_reverse
: bo_native
,
558 case ustctl_atype_string
:
559 /* Default encoding is UTF8 */
560 ret
= print_tabs(session
, nesting
);
564 ret
= lttng_metadata_printf(session
,
566 field
->type
.u
.basic
.string
.encoding
== ustctl_encode_ASCII
?
567 " { encoding = ASCII; }" : "",
571 case ustctl_atype_variant
:
572 ret
= _lttng_variant_statedump(session
, fields
, nr_fields
, iter_field
, nesting
);
577 case ustctl_atype_struct
:
578 ret
= print_tabs(session
, nesting
);
582 ret
= lttng_metadata_printf(session
,
595 int _lttng_context_metadata_statedump(struct ust_registry_session
*session
,
596 size_t nr_ctx_fields
,
597 struct ustctl_field
*ctx
)
605 if (i
>= nr_ctx_fields
) {
608 ret
= _lttng_field_statedump(session
, ctx
,
609 nr_ctx_fields
, &i
, 2);
618 int _lttng_fields_metadata_statedump(struct ust_registry_session
*session
,
619 struct ust_registry_event
*event
)
625 if (i
>= event
->nr_fields
) {
628 ret
= _lttng_field_statedump(session
, event
->fields
,
629 event
->nr_fields
, &i
, 2);
638 * Should be called with session registry mutex held.
640 int ust_metadata_event_statedump(struct ust_registry_session
*session
,
641 struct ust_registry_channel
*chan
,
642 struct ust_registry_event
*event
)
646 /* Don't dump metadata events */
647 if (chan
->chan_id
== -1U)
650 ret
= lttng_metadata_printf(session
,
654 " stream_id = %u;\n",
661 ret
= lttng_metadata_printf(session
,
663 event
->loglevel_value
);
667 if (event
->model_emf_uri
) {
668 ret
= lttng_metadata_printf(session
,
669 " model.emf.uri = \"%s\";\n",
670 event
->model_emf_uri
);
675 ret
= lttng_metadata_printf(session
,
676 " fields := struct {\n"
681 ret
= _lttng_fields_metadata_statedump(session
, event
);
685 ret
= lttng_metadata_printf(session
,
690 event
->metadata_dumped
= 1;
697 * Should be called with session registry mutex held.
699 int ust_metadata_channel_statedump(struct ust_registry_session
*session
,
700 struct ust_registry_channel
*chan
)
704 /* Don't dump metadata events */
705 if (chan
->chan_id
== -1U)
708 if (!chan
->header_type
)
711 ret
= lttng_metadata_printf(session
,
714 " event.header := %s;\n"
715 " packet.context := struct packet_context;\n",
717 chan
->header_type
== USTCTL_CHANNEL_HEADER_COMPACT
?
718 "struct event_header_compact" :
719 "struct event_header_large");
723 if (chan
->ctx_fields
) {
724 ret
= lttng_metadata_printf(session
,
725 " event.context := struct {\n");
729 ret
= _lttng_context_metadata_statedump(session
,
734 if (chan
->ctx_fields
) {
735 ret
= lttng_metadata_printf(session
,
741 ret
= lttng_metadata_printf(session
,
743 /* Flag success of metadata dump. */
744 chan
->metadata_dumped
= 1;
751 int _lttng_stream_packet_context_declare(struct ust_registry_session
*session
)
753 return lttng_metadata_printf(session
,
754 "struct packet_context {\n"
755 " uint64_clock_monotonic_t timestamp_begin;\n"
756 " uint64_clock_monotonic_t timestamp_end;\n"
757 " uint64_t content_size;\n"
758 " uint64_t packet_size;\n"
759 " uint64_t packet_seq_num;\n"
760 " unsigned long events_discarded;\n"
761 " uint32_t cpu_id;\n"
769 * id 31 is reserved to indicate an extended header.
772 * id: range: 0 - 65534.
773 * id 65535 is reserved to indicate an extended header.
776 int _lttng_event_header_declare(struct ust_registry_session
*session
)
778 return lttng_metadata_printf(session
,
779 "struct event_header_compact {\n"
780 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
783 " uint27_clock_monotonic_t timestamp;\n"
787 " uint64_clock_monotonic_t timestamp;\n"
792 "struct event_header_large {\n"
793 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
796 " uint32_clock_monotonic_t timestamp;\n"
800 " uint64_clock_monotonic_t timestamp;\n"
804 session
->uint32_t_alignment
,
805 session
->uint16_t_alignment
810 * The offset between monotonic and realtime clock can be negative if
811 * the system sets the REALTIME clock to 0 after boot.
814 int measure_single_clock_offset(struct offset_sample
*sample
)
816 uint64_t monotonic_avg
, monotonic
[2], measure_delta
, realtime
;
817 uint64_t tcf
= trace_clock_freq();
818 struct timespec rts
= { 0, 0 };
821 monotonic
[0] = trace_clock_read64();
822 ret
= clock_gettime(CLOCK_REALTIME
, &rts
);
826 monotonic
[1] = trace_clock_read64();
827 measure_delta
= monotonic
[1] - monotonic
[0];
828 if (measure_delta
> sample
->measure_delta
) {
830 * Discard value if it took longer to read than the best
835 monotonic_avg
= (monotonic
[0] + monotonic
[1]) >> 1;
836 realtime
= (uint64_t) rts
.tv_sec
* tcf
;
837 if (tcf
== NSEC_PER_SEC
) {
838 realtime
+= rts
.tv_nsec
;
840 realtime
+= (uint64_t) rts
.tv_nsec
* tcf
/ NSEC_PER_SEC
;
842 sample
->offset
= (int64_t) realtime
- monotonic_avg
;
843 sample
->measure_delta
= measure_delta
;
848 * Approximation of NTP time of day to clock monotonic correlation,
849 * taken at start of trace. Keep the measurement that took the less time
850 * to complete, thus removing imprecision caused by preemption.
851 * May return a negative offset.
854 int64_t measure_clock_offset(void)
857 struct offset_sample offset_best_sample
= {
859 .measure_delta
= UINT64_MAX
,
862 for (i
= 0; i
< NR_CLOCK_OFFSET_SAMPLES
; i
++) {
863 if (measure_single_clock_offset(&offset_best_sample
)) {
867 return offset_best_sample
.offset
;
871 * Should be called with session registry mutex held.
873 int ust_metadata_session_statedump(struct ust_registry_session
*session
,
878 unsigned char *uuid_c
;
879 char uuid_s
[UUID_STR_LEN
],
880 clock_uuid_s
[UUID_STR_LEN
];
882 char hostname
[HOST_NAME_MAX
];
886 uuid_c
= session
->uuid
;
888 snprintf(uuid_s
, sizeof(uuid_s
),
889 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
890 uuid_c
[0], uuid_c
[1], uuid_c
[2], uuid_c
[3],
891 uuid_c
[4], uuid_c
[5], uuid_c
[6], uuid_c
[7],
892 uuid_c
[8], uuid_c
[9], uuid_c
[10], uuid_c
[11],
893 uuid_c
[12], uuid_c
[13], uuid_c
[14], uuid_c
[15]);
896 ret
= lttng_metadata_printf(session
,
897 "/* CTF %u.%u */\n\n",
904 ret
= lttng_metadata_printf(session
,
905 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
906 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
907 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
908 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
909 "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n"
910 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
911 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
917 " byte_order = %s;\n"
918 " packet.header := struct {\n"
920 " uint8_t uuid[16];\n"
921 " uint32_t stream_id;\n"
922 " uint64_t stream_instance_id;\n"
925 session
->uint8_t_alignment
,
926 session
->uint16_t_alignment
,
927 session
->uint32_t_alignment
,
928 session
->uint64_t_alignment
,
929 session
->bits_per_long
,
930 session
->long_alignment
,
934 session
->byte_order
== BIG_ENDIAN
? "be" : "le"
939 /* ignore error, just use empty string if error. */
941 ret
= gethostname(hostname
, sizeof(hostname
));
942 if (ret
&& errno
== ENAMETOOLONG
)
943 hostname
[HOST_NAME_MAX
- 1] = '\0';
944 ret
= lttng_metadata_printf(session
,
946 " hostname = \"%s\";\n"
947 " domain = \"ust\";\n"
948 " tracer_name = \"lttng-ust\";\n"
949 " tracer_major = %u;\n"
950 " tracer_minor = %u;\n",
959 * If per-application registry, we can output extra information
960 * about the application.
963 ret
= lttng_metadata_printf(session
,
964 " tracer_patchlevel = %u;\n"
966 " procname = \"%s\";\n",
967 app
->version
.patchlevel
,
975 ret
= lttng_metadata_printf(session
,
982 ret
= lttng_metadata_printf(session
,
990 if (!trace_clock_uuid(clock_uuid_s
)) {
991 ret
= lttng_metadata_printf(session
,
999 ret
= lttng_metadata_printf(session
,
1000 " description = \"%s\";\n"
1001 " freq = %" PRIu64
"; /* Frequency, in Hz */\n"
1002 " /* clock value offset from Epoch is: offset * (1/freq) */\n"
1003 " offset = %" PRId64
";\n"
1005 trace_clock_description(),
1007 measure_clock_offset()
1012 ret
= lttng_metadata_printf(session
,
1013 "typealias integer {\n"
1014 " size = 27; align = 1; signed = false;\n"
1015 " map = clock.%s.value;\n"
1016 "} := uint27_clock_monotonic_t;\n"
1018 "typealias integer {\n"
1019 " size = 32; align = %u; signed = false;\n"
1020 " map = clock.%s.value;\n"
1021 "} := uint32_clock_monotonic_t;\n"
1023 "typealias integer {\n"
1024 " size = 64; align = %u; signed = false;\n"
1025 " map = clock.%s.value;\n"
1026 "} := uint64_clock_monotonic_t;\n\n",
1028 session
->uint32_t_alignment
,
1030 session
->uint64_t_alignment
,
1036 ret
= _lttng_stream_packet_context_declare(session
);
1040 ret
= _lttng_event_header_declare(session
);