/*
- * ust-metadata.c
- *
- * LTTng-UST metadata generation
- *
* Copyright (C) 2010-2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License, version 2 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#define _LGPL_SOURCE
int order;
order = fls(count) - 1;
- if (count & (count - 1))
+ if (count & (count - 1)) {
order++;
+ }
+ assert(order >= 0);
return order;
}
}
}
+static
+int print_escaped_ctf_string(struct ust_registry_session *session, const char *string)
+{
+ int ret = 0;
+ size_t i;
+ char cur;
+
+ i = 0;
+ cur = string[i];
+ while (cur != '\0') {
+ switch (cur) {
+ case '\n':
+ ret = lttng_metadata_printf(session, "%s", "\\n");
+ break;
+ case '\\':
+ case '"':
+ ret = lttng_metadata_printf(session, "%c", '\\');
+ if (ret) {
+ goto error;
+ }
+ /* We still print the current char */
+ /* Fallthrough */
+ default:
+ ret = lttng_metadata_printf(session, "%c", cur);
+ break;
+ }
+
+ if (ret) {
+ goto error;
+ }
+
+ cur = string[++i];
+ }
+error:
+ return ret;
+}
+
/* Called with session registry mutex held. */
static
int ust_metadata_enum_statedump(struct ust_registry_session *session,
static
int _lttng_variant_statedump(struct ust_registry_session *session,
+ uint32_t nr_choices, const char *tag_name,
+ uint32_t alignment,
const struct ustctl_field *fields, size_t nr_fields,
size_t *iter_field, size_t nesting)
{
const struct ustctl_field *variant = &fields[*iter_field];
- uint32_t nr_choices, i;
+ uint32_t i;
int ret;
char identifier[LTTNG_UST_SYM_NAME_LEN];
ret = -EINVAL;
goto end;
}
- nr_choices = variant->type.u.variant.nr_choices;
(*iter_field)++;
- sanitize_ctf_identifier(identifier, variant->type.u.variant.tag_name);
+ sanitize_ctf_identifier(identifier, tag_name);
+ if (alignment) {
+ ret = print_tabs(session, nesting);
+ if (ret) {
+ goto end;
+ }
+ ret = lttng_metadata_printf(session,
+ "struct { } align(%u) _%s_padding;\n",
+ alignment * CHAR_BIT,
+ variant->name);
+ if (ret) {
+ goto end;
+ }
+ }
ret = print_tabs(session, nesting);
if (ret) {
goto end;
}
ret = lttng_metadata_printf(session,
"integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s;\n",
- field->type.u.basic.integer.size,
- field->type.u.basic.integer.alignment,
- field->type.u.basic.integer.signedness,
- (field->type.u.basic.integer.encoding == ustctl_encode_none)
+ field->type.u.integer.size,
+ field->type.u.integer.alignment,
+ field->type.u.integer.signedness,
+ (field->type.u.integer.encoding == ustctl_encode_none)
? "none"
- : (field->type.u.basic.integer.encoding == ustctl_encode_UTF8)
+ : (field->type.u.integer.encoding == ustctl_encode_UTF8)
? "UTF8"
: "ASCII",
- field->type.u.basic.integer.base,
- field->type.u.basic.integer.reverse_byte_order ? bo_reverse : bo_native,
+ field->type.u.integer.base,
+ field->type.u.integer.reverse_byte_order ? bo_reverse : bo_native,
field->name);
(*iter_field)++;
break;
case ustctl_atype_enum:
ret = ust_metadata_enum_statedump(session,
- field->type.u.basic.enumeration.name,
- field->type.u.basic.enumeration.id,
- &field->type.u.basic.enumeration.container_type,
+ field->type.u.legacy.basic.enumeration.name,
+ field->type.u.legacy.basic.enumeration.id,
+ &field->type.u.legacy.basic.enumeration.container_type,
field->name, iter_field, nesting);
break;
case ustctl_atype_float:
}
ret = lttng_metadata_printf(session,
"floating_point { exp_dig = %u; mant_dig = %u; align = %u;%s } _%s;\n",
- field->type.u.basic._float.exp_dig,
- field->type.u.basic._float.mant_dig,
- field->type.u.basic._float.alignment,
- field->type.u.basic.integer.reverse_byte_order ? bo_reverse : bo_native,
+ field->type.u._float.exp_dig,
+ field->type.u._float.mant_dig,
+ field->type.u._float.alignment,
+ field->type.u._float.reverse_byte_order ? bo_reverse : bo_native,
field->name);
(*iter_field)++;
break;
if (ret) {
goto end;
}
- elem_type = &field->type.u.array.elem_type;
+ elem_type = &field->type.u.legacy.array.elem_type;
+ /* Only integers are currently supported in arrays. */
+ if (elem_type->atype != ustctl_atype_integer) {
+ ret = -EINVAL;
+ goto end;
+ }
ret = lttng_metadata_printf(session,
"integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[%u];\n",
elem_type->u.basic.integer.size,
: "ASCII",
elem_type->u.basic.integer.base,
elem_type->u.basic.integer.reverse_byte_order ? bo_reverse : bo_native,
- field->name, field->type.u.array.length);
+ field->name, field->type.u.legacy.array.length);
+ (*iter_field)++;
+ break;
+ }
+ case ustctl_atype_array_nestable:
+ {
+ uint32_t array_length;
+ const struct ustctl_field *array_nestable;
+ const struct ustctl_type *elem_type;
+
+ array_length = field->type.u.array_nestable.length;
+ (*iter_field)++;
+
+ if (*iter_field >= nr_fields) {
+ ret = -EOVERFLOW;
+ goto end;
+ }
+ array_nestable = &fields[*iter_field];
+ elem_type = &array_nestable->type;
+
+ /* Only integers are currently supported in arrays. */
+ if (elem_type->atype != ustctl_atype_integer) {
+ ret = -EINVAL;
+ goto end;
+ }
+
+ if (field->type.u.array_nestable.alignment) {
+ ret = print_tabs(session, nesting);
+ if (ret) {
+ goto end;
+ }
+ ret = lttng_metadata_printf(session,
+ "struct { } align(%u) _%s_padding;\n",
+ field->type.u.array_nestable.alignment * CHAR_BIT,
+ field->name);
+ if (ret) {
+ goto end;
+ }
+ }
+
+ ret = print_tabs(session, nesting);
+ if (ret) {
+ goto end;
+ }
+ ret = lttng_metadata_printf(session,
+ "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[%u];\n",
+ elem_type->u.integer.size,
+ elem_type->u.integer.alignment,
+ elem_type->u.integer.signedness,
+ (elem_type->u.integer.encoding == ustctl_encode_none)
+ ? "none"
+ : (elem_type->u.integer.encoding == ustctl_encode_UTF8)
+ ? "UTF8"
+ : "ASCII",
+ elem_type->u.integer.base,
+ elem_type->u.integer.reverse_byte_order ? bo_reverse : bo_native,
+ field->name, array_length);
(*iter_field)++;
break;
}
const struct ustctl_basic_type *elem_type;
const struct ustctl_basic_type *length_type;
- elem_type = &field->type.u.sequence.elem_type;
- length_type = &field->type.u.sequence.length_type;
+ elem_type = &field->type.u.legacy.sequence.elem_type;
+ length_type = &field->type.u.legacy.sequence.length_type;
ret = print_tabs(session, nesting);
if (ret) {
goto end;
}
+
+ /* Only integers are currently supported in sequences. */
+ if (elem_type->atype != ustctl_atype_integer) {
+ ret = -EINVAL;
+ goto end;
+ }
+
ret = lttng_metadata_printf(session,
"integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n",
length_type->u.basic.integer.size,
(*iter_field)++;
break;
}
+ case ustctl_atype_sequence_nestable:
+ {
+ const struct ustctl_field *sequence_nestable;
+ const struct ustctl_type *elem_type;
+
+ (*iter_field)++;
+ if (*iter_field >= nr_fields) {
+ ret = -EOVERFLOW;
+ goto end;
+ }
+ sequence_nestable = &fields[*iter_field];
+ elem_type = &sequence_nestable->type;
+
+ /* Only integers are currently supported in sequences. */
+ if (elem_type->atype != ustctl_atype_integer) {
+ ret = -EINVAL;
+ goto end;
+ }
+
+ if (field->type.u.sequence_nestable.alignment) {
+ ret = print_tabs(session, nesting);
+ if (ret) {
+ goto end;
+ }
+ ret = lttng_metadata_printf(session,
+ "struct { } align(%u) _%s_padding;\n",
+ field->type.u.sequence_nestable.alignment * CHAR_BIT,
+ field->name);
+ if (ret) {
+ goto end;
+ }
+ }
+ ret = print_tabs(session, nesting);
+ if (ret) {
+ goto end;
+ }
+ ret = lttng_metadata_printf(session,
+ "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[ _%s ];\n",
+ elem_type->u.integer.size,
+ (unsigned int) elem_type->u.integer.alignment,
+ elem_type->u.integer.signedness,
+ (elem_type->u.integer.encoding == ustctl_encode_none)
+ ? "none"
+ : ((elem_type->u.integer.encoding == ustctl_encode_UTF8)
+ ? "UTF8"
+ : "ASCII"),
+ elem_type->u.integer.base,
+ elem_type->u.integer.reverse_byte_order ? bo_reverse : bo_native,
+ field->name,
+ field->type.u.sequence_nestable.length_name);
+ (*iter_field)++;
+ break;
+ }
case ustctl_atype_string:
/* Default encoding is UTF8 */
ret = print_tabs(session, nesting);
}
ret = lttng_metadata_printf(session,
"string%s _%s;\n",
- field->type.u.basic.string.encoding == ustctl_encode_ASCII ?
+ field->type.u.string.encoding == ustctl_encode_ASCII ?
" { encoding = ASCII; }" : "",
field->name);
(*iter_field)++;
break;
case ustctl_atype_variant:
- ret = _lttng_variant_statedump(session, fields, nr_fields, iter_field, nesting);
+ ret = _lttng_variant_statedump(session,
+ field->type.u.legacy.variant.nr_choices,
+ field->type.u.legacy.variant.tag_name,
+ 0,
+ fields, nr_fields, iter_field, nesting);
+ if (ret) {
+ goto end;
+ }
+ break;
+ case ustctl_atype_variant_nestable:
+ ret = _lttng_variant_statedump(session,
+ field->type.u.variant_nestable.nr_choices,
+ field->type.u.variant_nestable.tag_name,
+ field->type.u.variant_nestable.alignment,
+ fields, nr_fields, iter_field, nesting);
if (ret) {
goto end;
}
break;
case ustctl_atype_struct:
+ if (field->type.u.legacy._struct.nr_fields != 0) {
+ /* Currently only 0-length structures are supported. */
+ ret = -EINVAL;
+ goto end;
+ }
ret = print_tabs(session, nesting);
if (ret) {
goto end;
field->name);
(*iter_field)++;
break;
+ case ustctl_atype_struct_nestable:
+ if (field->type.u.struct_nestable.nr_fields != 0) {
+ /* Currently only 0-length structures are supported. */
+ ret = -EINVAL;
+ goto end;
+ }
+ ret = print_tabs(session, nesting);
+ if (ret) {
+ goto end;
+ }
+ if (field->type.u.struct_nestable.alignment) {
+ ret = lttng_metadata_printf(session,
+ "struct {} align(%u) _%s;\n",
+ field->type.u.struct_nestable.alignment * CHAR_BIT,
+ field->name);
+ if (ret) {
+ goto end;
+ }
+ } else {
+ ret = lttng_metadata_printf(session,
+ "struct {} _%s;\n",
+ field->name);
+ }
+ (*iter_field)++;
+ break;
+ case ustctl_atype_enum_nestable:
+ {
+ const struct ustctl_field *container_field;
+ const struct ustctl_type *container_type;
+
+ (*iter_field)++;
+ if (*iter_field >= nr_fields) {
+ ret = -EOVERFLOW;
+ goto end;
+ }
+ container_field = &fields[*iter_field];
+ container_type = &container_field->type;
+
+ /* Only integers are supported as container types. */
+ if (container_type->atype != ustctl_atype_integer) {
+ ret = -EINVAL;
+ goto end;
+ }
+ ret = ust_metadata_enum_statedump(session,
+ field->type.u.enum_nestable.name,
+ field->type.u.enum_nestable.id,
+ &container_type->u.integer,
+ field->name, iter_field, nesting);
+ break;
+ }
default:
ret = -EINVAL;
}
event->name,
event->id,
chan->chan_id);
- if (ret)
+ if (ret) {
goto end;
+ }
ret = lttng_metadata_printf(session,
" loglevel = %d;\n",
event->loglevel_value);
- if (ret)
+ if (ret) {
goto end;
+ }
if (event->model_emf_uri) {
ret = lttng_metadata_printf(session,
" model.emf.uri = \"%s\";\n",
event->model_emf_uri);
- if (ret)
+ if (ret) {
goto end;
+ }
}
ret = lttng_metadata_printf(session,
" fields := struct {\n"
);
- if (ret)
+ if (ret) {
goto end;
+ }
ret = _lttng_fields_metadata_statedump(session, event);
- if (ret)
+ if (ret) {
goto end;
+ }
ret = lttng_metadata_printf(session,
" };\n"
"};\n\n");
- if (ret)
+ if (ret) {
goto end;
+ }
event->metadata_dumped = 1;
end:
chan->header_type == USTCTL_CHANNEL_HEADER_COMPACT ?
"struct event_header_compact" :
"struct event_header_large");
- if (ret)
+ if (ret) {
goto end;
+ }
if (chan->ctx_fields) {
ret = lttng_metadata_printf(session,
" event.context := struct {\n");
- if (ret)
+ if (ret) {
goto end;
+ }
}
ret = _lttng_context_metadata_statedump(session,
chan->nr_ctx_fields,
chan->ctx_fields);
- if (ret)
+ if (ret) {
goto end;
+ }
if (chan->ctx_fields) {
ret = lttng_metadata_printf(session,
" };\n");
- if (ret)
+ if (ret) {
goto end;
+ }
}
ret = lttng_metadata_printf(session,
return offset_best_sample.offset;
}
+static
+int print_metadata_session_information(struct ust_registry_session *registry)
+{
+ int ret;
+ struct ltt_session *session = NULL;
+ char creation_datetime[ISO8601_STR_LEN];
+
+ rcu_read_lock();
+ session = session_find_by_id(registry->tracing_id);
+ if (!session) {
+ ret = -1;
+ goto error;
+ }
+
+ /* Print the trace name */
+ ret = lttng_metadata_printf(registry, " trace_name = \"");
+ if (ret) {
+ goto error;
+ }
+
+ /*
+ * This is necessary since the creation time is present in the session
+ * name when it is generated.
+ */
+ if (session->has_auto_generated_name) {
+ ret = print_escaped_ctf_string(registry, DEFAULT_SESSION_NAME);
+ } else {
+ ret = print_escaped_ctf_string(registry, session->name);
+ }
+ if (ret) {
+ goto error;
+ }
+
+ ret = lttng_metadata_printf(registry, "\";\n");
+ if (ret) {
+ goto error;
+ }
+
+ /* Prepare creation time */
+ ret = time_to_iso8601_str(session->creation_time, creation_datetime,
+ sizeof(creation_datetime));
+ if (ret) {
+ goto error;
+ }
+
+ /* Output the reste of the information */
+ ret = lttng_metadata_printf(registry,
+ " trace_creation_datetime = \"%s\";\n"
+ " hostname = \"%s\";\n",
+ creation_datetime, session->hostname);
+ if (ret) {
+ goto error;
+ }
+
+error:
+ if (session) {
+ session_put(session);
+ }
+ rcu_read_unlock();
+ return ret;
+}
+
+static
+int print_metadata_app_information(struct ust_registry_session *registry,
+ struct ust_app *app)
+{
+ int ret;
+ char datetime[ISO8601_STR_LEN];
+
+ if (!app) {
+ ret = 0;
+ goto end;
+ }
+
+ ret = time_to_iso8601_str(
+ app->registration_time, datetime, sizeof(datetime));
+ if (ret) {
+ goto end;
+ }
+
+ ret = lttng_metadata_printf(registry,
+ " tracer_patchlevel = %u;\n"
+ " vpid = %d;\n"
+ " procname = \"%s\";\n"
+ " vpid_datetime = \"%s\";\n",
+ app->version.patchlevel, (int) app->pid, app->name,
+ datetime);
+
+end:
+ return ret;
+}
+
/*
* Should be called with session registry mutex held.
*/
uint32_t major,
uint32_t minor)
{
- char uuid_s[UUID_STR_LEN],
- clock_uuid_s[UUID_STR_LEN];
+ char uuid_s[LTTNG_UUID_STR_LEN],
+ clock_uuid_s[LTTNG_UUID_STR_LEN];
int ret = 0;
- char hostname[HOST_NAME_MAX];
assert(session);
uuid_s,
session->byte_order == BIG_ENDIAN ? "be" : "le"
);
- if (ret)
+ if (ret) {
goto end;
+ }
- /* ignore error, just use empty string if error. */
- hostname[0] = '\0';
- ret = gethostname(hostname, sizeof(hostname));
- if (ret && errno == ENAMETOOLONG)
- hostname[HOST_NAME_MAX - 1] = '\0';
ret = lttng_metadata_printf(session,
"env {\n"
- " hostname = \"%s\";\n"
" domain = \"ust\";\n"
" tracer_name = \"lttng-ust\";\n"
" tracer_major = %u;\n"
- " tracer_minor = %u;\n",
- hostname,
+ " tracer_minor = %u;\n"
+ " tracer_buffering_scheme = \"%s\";\n"
+ " tracer_buffering_id = %u;\n"
+ " architecture_bit_width = %u;\n",
major,
- minor
- );
- if (ret)
+ minor,
+ app ? "pid" : "uid",
+ app ? (int) app->pid : (int) session->tracing_uid,
+ session->bits_per_long);
+ if (ret) {
+ goto end;
+ }
+
+ ret = print_metadata_session_information(session);
+ if (ret) {
goto end;
+ }
/*
* If per-application registry, we can output extra information
* about the application.
*/
- if (app) {
- ret = lttng_metadata_printf(session,
- " tracer_patchlevel = %u;\n"
- " vpid = %d;\n"
- " procname = \"%s\";\n",
- app->version.patchlevel,
- (int) app->pid,
- app->name
- );
- if (ret)
- goto end;
+ ret = print_metadata_app_information(session, app);
+ if (ret) {
+ goto end;
}
ret = lttng_metadata_printf(session,
"};\n\n"
);
- if (ret)
+ if (ret) {
goto end;
-
+ }
ret = lttng_metadata_printf(session,
"clock {\n"
" name = \"%s\";\n",
trace_clock_name()
);
- if (ret)
+ if (ret) {
goto end;
+ }
if (!trace_clock_uuid(clock_uuid_s)) {
ret = lttng_metadata_printf(session,
" uuid = \"%s\";\n",
clock_uuid_s
);
- if (ret)
+ if (ret) {
goto end;
+ }
}
ret = lttng_metadata_printf(session,
trace_clock_freq(),
measure_clock_offset()
);
- if (ret)
+ if (ret) {
goto end;
+ }
ret = lttng_metadata_printf(session,
"typealias integer {\n"
session->uint64_t_alignment,
trace_clock_name()
);
- if (ret)
+ if (ret) {
goto end;
+ }
ret = _lttng_stream_packet_context_declare(session);
- if (ret)
+ if (ret) {
goto end;
+ }
ret = _lttng_event_header_declare(session);
- if (ret)
+ if (ret) {
goto end;
+ }
end:
return ret;