X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fbin%2Flttng-sessiond%2Fust-field-convert.cpp;h=21fd3e0c968bc2c5018adf3762339a1fa4399852;hb=63c3462c3dbd028a08f7a9b504c45e178371248d;hp=6864440d6881174adbdd5fa5dba49e60abe435c9;hpb=eda1aa02582ba8af1f30d40f131f4a32d2b372ab;p=lttng-tools.git diff --git a/src/bin/lttng-sessiond/ust-field-convert.cpp b/src/bin/lttng-sessiond/ust-field-convert.cpp index 6864440d6..21fd3e0c9 100644 --- a/src/bin/lttng-sessiond/ust-field-convert.cpp +++ b/src/bin/lttng-sessiond/ust-field-convert.cpp @@ -7,6 +7,7 @@ #include "ust-field-convert.hpp" +#include #include #include @@ -37,23 +38,30 @@ public: }; /* Used to publish fields on which a field being decoded has an implicit dependency. */ -using publish_field_fn = std::function; +using publish_field_fn = std::function; + +/* Look-up field from a field location. */ +using lookup_field_fn = std::function; lst::type::cuptr create_type_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes, const lttng_ust_ctl_field **next_ust_ctl_field, publish_field_fn publish_field, + lookup_field_fn lookup_field, lst::field_location::root lookup_root, - lst::field_location::elements& current_field_location_elements); + lst::field_location::elements& current_field_location_elements, + lsu::ctl_field_quirks quirks); void create_field_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes, const lttng_ust_ctl_field **next_ust_ctl_field, publish_field_fn publish_field, + lookup_field_fn lookup_field, lst::field_location::root lookup_root, - lst::field_location::elements& current_field_location_elements); + lst::field_location::elements& current_field_location_elements, + lsu::ctl_field_quirks quirks); template enum lst::null_terminated_string_type::encoding ust_ctl_encoding_to_string_field_encoding(UstCtlEncodingType encoding) @@ -98,7 +106,8 @@ enum lst::integer_type::base ust_ctl_base_to_integer_field_base(UstCtlBaseType b lst::type::cuptr create_integer_type_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes, - const lttng_ust_ctl_field **next_ust_ctl_field) + const lttng_ust_ctl_field **next_ust_ctl_field, + lsu::ctl_field_quirks quirks __attribute__((unused))) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -123,7 +132,8 @@ lst::type::cuptr create_integer_type_from_ust_ctl_fields(const lttng_ust_ctl_fie lst::type::cuptr create_floating_point_type_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes, - const lttng_ust_ctl_field **next_ust_ctl_field) + const lttng_ust_ctl_field **next_ust_ctl_field, + lsu::ctl_field_quirks quirks __attribute__((unused))) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -150,7 +160,8 @@ lst::type::cuptr create_floating_point_type_from_ust_ctl_fields(const lttng_ust_ lst::type::cuptr create_enumeration_type_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes, - const lttng_ust_ctl_field **next_ust_ctl_field) + const lttng_ust_ctl_field **next_ust_ctl_field, + lsu::ctl_field_quirks quirks __attribute__((unused))) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -222,7 +233,8 @@ lst::type::cuptr create_enumeration_type_from_ust_ctl_fields(const lttng_ust_ctl lst::type::cuptr create_string_type_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes __attribute__((unused)), - const lttng_ust_ctl_field **next_ust_ctl_field) + const lttng_ust_ctl_field **next_ust_ctl_field, + lsu::ctl_field_quirks quirks __attribute__((unused))) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -263,7 +275,8 @@ lst::type::cuptr create_integer_type_from_ust_ctl_basic_type( lst::type::cuptr create_array_type_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes, - const lttng_ust_ctl_field **next_ust_ctl_field) + const lttng_ust_ctl_field **next_ust_ctl_field, + lsu::ctl_field_quirks quirks __attribute__((unused))) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -321,8 +334,10 @@ lst::type::cuptr create_array_nestable_type_from_ust_ctl_fields(const lttng_ust_ const session_attributes& session_attributes, const lttng_ust_ctl_field **next_ust_ctl_field, publish_field_fn publish_field, + lookup_field_fn lookup_field, lst::field_location::root lookup_root, - lst::field_location::elements ¤t_field_location_elements) + lst::field_location::elements ¤t_field_location_elements, + lsu::ctl_field_quirks quirks) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -343,8 +358,8 @@ lst::type::cuptr create_array_nestable_type_from_ust_ctl_fields(const lttng_ust_ /* next_ust_ctl_field is updated as needed. */ element_type = create_type_from_ust_ctl_fields(&element_uctl_field, end, session_attributes, - next_ust_ctl_field, publish_field, lookup_root, - current_field_location_elements); + next_ust_ctl_field, publish_field, lookup_field, lookup_root, + current_field_location_elements, quirks); if (element_uctl_field.type.atype == lttng_ust_ctl_atype_integer && element_uctl_field.type.u.integer.encoding != lttng_ust_ctl_encode_none) { /* Element represents a text character. */ @@ -381,7 +396,8 @@ lst::type::cuptr create_sequence_type_from_ust_ctl_fields(const lttng_ust_ctl_fi const lttng_ust_ctl_field **next_ust_ctl_field, publish_field_fn publish_field, lst::field_location::root lookup_root, - lst::field_location::elements ¤t_field_location_elements) + lst::field_location::elements ¤t_field_location_elements, + lsu::ctl_field_quirks quirks __attribute__((unused))) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -457,8 +473,10 @@ lst::type::cuptr create_sequence_nestable_type_from_ust_ctl_fields( const session_attributes& session_attributes, const lttng_ust_ctl_field **next_ust_ctl_field, publish_field_fn publish_field, + lookup_field_fn lookup_field, lst::field_location::root lookup_root, - lst::field_location::elements ¤t_field_location_elements) + lst::field_location::elements ¤t_field_location_elements, + lsu::ctl_field_quirks quirks) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -483,8 +501,8 @@ lst::type::cuptr create_sequence_nestable_type_from_ust_ctl_fields( /* next_ust_ctl_field is updated as needed. */ auto element_type = create_type_from_ust_ctl_fields(&element_uctl_field, end, - session_attributes, next_ust_ctl_field, publish_field, lookup_root, - current_field_location_elements); + session_attributes, next_ust_ctl_field, publish_field, lookup_field, + lookup_root, current_field_location_elements, quirks); if (lttng_strnlen(sequence_uctl_field.type.u.sequence_nestable.length_name, sizeof(sequence_uctl_field.type.u.sequence_nestable.length_name)) == @@ -492,7 +510,6 @@ lst::type::cuptr create_sequence_nestable_type_from_ust_ctl_fields( LTTNG_THROW_PROTOCOL_ERROR("Sequence length field name is not null terminated"); } - lst::field_location::elements length_field_location_elements = current_field_location_elements; length_field_location_elements.emplace_back(std::move(length_field_name)); @@ -500,6 +517,14 @@ lst::type::cuptr create_sequence_nestable_type_from_ust_ctl_fields( const lst::field_location length_field_location{ lookup_root, std::move(length_field_location_elements)}; + /* Validate existence of length field (throws if not found). */ + const auto &length_field = lookup_field(length_field_location); + const auto *integer_selector_field = + dynamic_cast(&length_field.get_type()); + if (!integer_selector_field) { + LTTNG_THROW_PROTOCOL_ERROR("Invalid selector field type referenced from sequence: expected integer or enumeration"); + } + if (element_encoding) { const auto integer_element_size = static_cast(*element_type).size; @@ -522,7 +547,8 @@ lst::type::cuptr create_sequence_nestable_type_from_ust_ctl_fields( lst::type::cuptr create_structure_field_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes __attribute__((unused)), - const lttng_ust_ctl_field **next_ust_ctl_field) + const lttng_ust_ctl_field **next_ust_ctl_field, + lsu::ctl_field_quirks quirks __attribute__((unused))) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -552,12 +578,78 @@ lst::type::cuptr create_structure_field_from_ust_ctl_fields(const lttng_ust_ctl_ return lttng::make_unique(alignment, lst::structure_type::fields()); } +template +typename lst::variant_type::choices create_typed_variant_choices( + const lttng_ust_ctl_field *current, + const lttng_ust_ctl_field *end, + const session_attributes& session_attributes, + const lttng_ust_ctl_field **next_ust_ctl_field, + lookup_field_fn lookup_field, + lst::field_location::root lookup_root, + lst::field_location::elements& current_field_location_elements, + unsigned int choice_count, + const lst::field& selector_field, + lsu::ctl_field_quirks quirks) +{ + typename lst::variant_type::choices choices; + const auto& typed_enumeration = static_cast< + const lst::typed_enumeration_type&>( + selector_field.get_type()); + + for (unsigned int i = 0; i < choice_count; i++) { + create_field_from_ust_ctl_fields( + current, end, session_attributes, next_ust_ctl_field, + [&choices, typed_enumeration, &selector_field, quirks]( + lst::field::uptr field) { + /* + * Find the enumeration mapping that matches the + * field's name. + */ + const auto mapping_it = std::find_if( + typed_enumeration.mappings_->begin(), + typed_enumeration.mappings_->end(), + [&field, quirks](const typename std::remove_reference< + decltype(typed_enumeration)>::type:: + mapping& mapping) { + if (static_cast(quirks & lsu::ctl_field_quirks::UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS)) { + /* + * Check if they match with + * a prepended underscore + * and, if not, perform the + * regular check. + */ + if ((std::string("_") + field->name) == mapping.name) { + return true; + } + } + + return mapping.name == field->name; + }); + + if (mapping_it == typed_enumeration.mappings_->end()) { + LTTNG_THROW_PROTOCOL_ERROR(fmt::format( + "Invalid variant choice: `{}` does not match any mapping in `{}` enumeration", + field->name, selector_field.name)); + } + + choices.emplace_back(*mapping_it, field->move_type()); + }, + lookup_field, lookup_root, current_field_location_elements, quirks); + + current = *next_ust_ctl_field; + } + + return choices; +} + lst::type::cuptr create_variant_field_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, const session_attributes& session_attributes, const lttng_ust_ctl_field **next_ust_ctl_field, + lookup_field_fn lookup_field, lst::field_location::root lookup_root, - lst::field_location::elements ¤t_field_location_elements) + lst::field_location::elements ¤t_field_location_elements, + lsu::ctl_field_quirks quirks) { if (current >= end) { LTTNG_THROW_PROTOCOL_ERROR( @@ -589,21 +681,39 @@ lst::type::cuptr create_variant_field_from_ust_ctl_fields(const lttng_ust_ctl_fi const lst::field_location selector_field_location{ lookup_root, std::move(selector_field_location_elements)}; + /* Validate existence of selector field (throws if not found). */ + const auto &selector_field = lookup_field(selector_field_location); + const auto *enumeration_selector_type = + dynamic_cast(&selector_field.get_type()); + if (!enumeration_selector_type) { + LTTNG_THROW_PROTOCOL_ERROR("Invalid selector field type referenced from variant: expected enumeration"); + } + + const bool selector_is_signed = enumeration_selector_type->signedness_ == + lst::integer_type::signedness::SIGNED; + /* Choices follow. next_ust_ctl_field is updated as needed. */ - lst::variant_type::choices choices; - for (unsigned int i = 0; i < choice_count; i++) { - create_field_from_ust_ctl_fields( - current, end, session_attributes, next_ust_ctl_field, - [&choices](lst::field::cuptr field) { - choices.emplace_back(std::move(field)); - }, - lookup_root, current_field_location_elements); + if (selector_is_signed) { + lst::variant_type:: + choices choices = create_typed_variant_choices(current, + end, session_attributes, next_ust_ctl_field, + lookup_field, lookup_root, + current_field_location_elements, choice_count, + selector_field, quirks); + + return lttng::make_unique>( + alignment, std::move(selector_field_location), std::move(choices)); + } else { + lst::variant_type:: + choices choices = create_typed_variant_choices(current, + end, session_attributes, next_ust_ctl_field, + lookup_field, lookup_root, + current_field_location_elements, choice_count, + selector_field, quirks); - current = *next_ust_ctl_field; + return lttng::make_unique>( + alignment, std::move(selector_field_location), std::move(choices)); } - - return lttng::make_unique( - alignment, std::move(selector_field_location), std::move(choices)); } lst::type::cuptr create_type_from_ust_ctl_fields(const lttng_ust_ctl_field *current, @@ -611,46 +721,49 @@ lst::type::cuptr create_type_from_ust_ctl_fields(const lttng_ust_ctl_field *curr const session_attributes& session_attributes, const lttng_ust_ctl_field **next_ust_ctl_field, publish_field_fn publish_field, + lookup_field_fn lookup_field, lst::field_location::root lookup_root, - lst::field_location::elements ¤t_field_location_elements) + lst::field_location::elements& current_field_location_elements, + lsu::ctl_field_quirks quirks) { switch (current->type.atype) { case lttng_ust_ctl_atype_integer: return create_integer_type_from_ust_ctl_fields( - current, end, session_attributes, next_ust_ctl_field); + current, end, session_attributes, next_ust_ctl_field, quirks); case lttng_ust_ctl_atype_enum: case lttng_ust_ctl_atype_enum_nestable: return create_enumeration_type_from_ust_ctl_fields( - current, end, session_attributes, next_ust_ctl_field); + current, end, session_attributes, next_ust_ctl_field, quirks); case lttng_ust_ctl_atype_float: return create_floating_point_type_from_ust_ctl_fields( - current, end, session_attributes, next_ust_ctl_field); + current, end, session_attributes, next_ust_ctl_field, quirks); case lttng_ust_ctl_atype_string: return create_string_type_from_ust_ctl_fields( - current, end, session_attributes, next_ust_ctl_field); + current, end, session_attributes, next_ust_ctl_field, quirks); case lttng_ust_ctl_atype_array: - return create_array_type_from_ust_ctl_fields(current, end, session_attributes, - next_ust_ctl_field); + return create_array_type_from_ust_ctl_fields( + current, end, session_attributes, next_ust_ctl_field, quirks); case lttng_ust_ctl_atype_array_nestable: return create_array_nestable_type_from_ust_ctl_fields(current, end, - session_attributes, next_ust_ctl_field, publish_field, lookup_root, - current_field_location_elements); + session_attributes, next_ust_ctl_field, publish_field, lookup_field, + lookup_root, current_field_location_elements, quirks); case lttng_ust_ctl_atype_sequence: return create_sequence_type_from_ust_ctl_fields(current, end, session_attributes, next_ust_ctl_field, publish_field, lookup_root, - current_field_location_elements); + current_field_location_elements, quirks); case lttng_ust_ctl_atype_sequence_nestable: return create_sequence_nestable_type_from_ust_ctl_fields(current, end, - session_attributes, next_ust_ctl_field, publish_field, lookup_root, - current_field_location_elements); + session_attributes, next_ust_ctl_field, publish_field, lookup_field, + lookup_root, current_field_location_elements, quirks); case lttng_ust_ctl_atype_struct: case lttng_ust_ctl_atype_struct_nestable: return create_structure_field_from_ust_ctl_fields( - current, end, session_attributes, next_ust_ctl_field); + current, end, session_attributes, next_ust_ctl_field, quirks); case lttng_ust_ctl_atype_variant: case lttng_ust_ctl_atype_variant_nestable: return create_variant_field_from_ust_ctl_fields(current, end, session_attributes, - next_ust_ctl_field, lookup_root, current_field_location_elements); + next_ust_ctl_field, lookup_field, lookup_root, + current_field_location_elements, quirks); default: LTTNG_THROW_PROTOCOL_ERROR(fmt::format( "Unknown {} value `{}` encountered while converting {} to {}", @@ -664,8 +777,10 @@ void create_field_from_ust_ctl_fields(const lttng_ust_ctl_field *current, const session_attributes& session_attributes, const lttng_ust_ctl_field **next_ust_ctl_field, publish_field_fn publish_field, + lookup_field_fn lookup_field, lst::field_location::root lookup_root, - lst::field_location::elements& current_field_location_elements) + lst::field_location::elements& current_field_location_elements, + lsu::ctl_field_quirks quirks) { LTTNG_ASSERT(current < end); @@ -676,9 +791,37 @@ void create_field_from_ust_ctl_fields(const lttng_ust_ctl_field *current, publish_field(lttng::make_unique(current->name, create_type_from_ust_ctl_fields(current, end, session_attributes, - next_ust_ctl_field, publish_field, - lookup_root, - current_field_location_elements))); + next_ust_ctl_field, publish_field, lookup_field, + lookup_root, current_field_location_elements, quirks))); +} + +std::vector::iterator lookup_field_in_vector( + std::vector& fields, const lst::field_location& location) +{ + if (location.elements_.size() != 1) { + LTTNG_THROW_ERROR(fmt::format( + "Unexpected field location received during field look-up: location = {}", + location)); + } + + /* + * In the context of fields received from LTTng-UST, field + * look-up is extremely naive as the protocol can only + * express empty structures. It is safe to assume that + * location has a depth of 1 and directly refers to a field + * in the 'fields' vector. + */ + const auto field_it = std::find_if(fields.begin(), fields.end(), + [location](lst::field::cuptr &field) { + return field->name == location.elements_[0]; + }); + + if (field_it == fields.end()) { + LTTNG_THROW_PROTOCOL_ERROR( + fmt::format("Failed to look-up field: location = {}", location)); + } + + return field_it; } /* @@ -693,7 +836,8 @@ std::vector create_fields_from_ust_ctl_fields( const lsu::registry_session& session, const lttng_ust_ctl_field *current, const lttng_ust_ctl_field *end, - lst::field_location::root lookup_root) + lst::field_location::root lookup_root, + lsu::ctl_field_quirks quirks) { std::vector fields; const auto trace_native_byte_order = session.abi.byte_order; @@ -717,12 +861,19 @@ std::vector create_fields_from_ust_ctl_fields( * The lambda allows the factory functions to push as many fields as * needed depending on the decoded field's type. */ - create_field_from_ust_ctl_fields(current, end, session_attributes, &next_field, + create_field_from_ust_ctl_fields( + current, end, session_attributes, &next_field, [&fields](lst::field::cuptr field) { + /* Publishing a field simply adds it to the converted + * fields. */ fields.emplace_back(std::move(field)); }, - lookup_root, - current_field_location_elements); + [&fields](const lst::field_location& location) + -> lookup_field_fn::result_type { + /* Resolve location to a previously-constructed field. */ + return **lookup_field_in_vector(fields, location); + }, + lookup_root, current_field_location_elements, quirks); current = next_field; } @@ -735,7 +886,9 @@ std::vector lsu::create_trace_fields_from_ust_ctl_fields( const lsu::registry_session& session, const lttng_ust_ctl_field *fields, std::size_t field_count, - lst::field_location::root lookup_root) + lst::field_location::root lookup_root, + lsu::ctl_field_quirks quirks) { - return create_fields_from_ust_ctl_fields(session, fields, fields + field_count, lookup_root); + return create_fields_from_ust_ctl_fields( + session, fields, fields + field_count, lookup_root, quirks); }