metababel 1.1.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fef536b3f7091c580764b9e74b5a33cdfa268231fba8678a6097f71038b83ec
-  data.tar.gz: f715e0f2921b5542f0069e7b1a43624699d6381418a5052bface9c657d601f2d
+  metadata.gz: 59de2133e8a84ac9fb121c0a66ab94c7f8e8dc84b59d85f5dfc21fe68d7ff600
+  data.tar.gz: c18c4499cef1af36847f4dc4ced58107e3e52ec5cd9d3e8bfe69f1d3d50ef793
 SHA512:
-  metadata.gz: 1a802b99efa22f8e34def1c7ec1610fc0a3e25897f14f48faa80156a3af32e5696e297a2d95b6053f05e6b0015814aa067332d01af1623bbb5461d9e608e609e
-  data.tar.gz: 85206279e0e3b4971721c04b40bf484a23d103bb062f2e4ae3983b8a498673ab0ad34f304a6defe0943b7b8996fe40b9cc160840ffc139e44209185512230284
+  metadata.gz: d7ed22589acca08ad6ab56f7db2e209cdb13ffd4b4b1ddf11964c412ba6383b387dbf7a928aea61a12ac182dd057d43535756df896c616f4280b94b2d365b51d
+  data.tar.gz: '0291a811c6adc80c0ffa94bd4c04af15c66990efc491f479b6ac9e83fe40968bebb5da964a9fdfd1dfa4270990bf86772e2e72b137c458388da341ae7261d1c3'

data/lib/metababel/bt2_trace_class_generator.rb

@@ -44,23 +44,45 @@ module Babeltrace2Gen
     def rec_member_class
       is_a?(Babeltrace2Gen::BTMemberClass) ? self : @parent.rec_member_class
     end
+  end
+
+  class BTFieldLocation
+    include BTLocator
+    include BTPrinter
 
-    def resolve_path(path)
-      root, id = path.match(/^(PACKET_CONTEXT|EVENT_COMMON_CONTEXT|EVENT_SPECIFIC_CONTEXT|EVENT_PAYLOAD)\["?(.+)?"\]/).captures
+    # root_scope is the full babeltrace enum name, e.g.
+    # BT_FIELD_LOCATION_SCOPE_EVENT_PAYLOAD (mirrors the C bt_field_location API).
+    attr_reader :root_scope, :items
+
+    def initialize(parent:, root_scope:, items:)
+      raise "nested field locations are not supported (items: #{items})" unless items.size == 1
+
+      @parent = parent
+      @root_scope = root_scope
+      @items = items
+    end
+
+    def member
       field_class =
-        case root
-        when 'PACKET_CONTEXT'
+        case @root_scope.to_s
+        when 'BT_FIELD_LOCATION_SCOPE_PACKET_CONTEXT'
           rec_stream_class.packet_context_field_class
-        when 'EVENT_COMMON_CONTEXT'
+        when 'BT_FIELD_LOCATION_SCOPE_EVENT_COMMON_CONTEXT'
           rec_stream_class.event_common_context_field_class
-        when 'EVENT_SPECIFIC_CONTEXT'
+        when 'BT_FIELD_LOCATION_SCOPE_EVENT_SPECIFIC_CONTEXT'
           rec_event_class.specific_context_field_class
-        when 'EVENT_PAYLOAD'
+        when 'BT_FIELD_LOCATION_SCOPE_EVENT_PAYLOAD'
           rec_event_class.payload_field_class
         else
-          raise "invalid path #{path}"
+          raise "invalid field-location root scope #{@root_scope}"
         end
-      [field_class, id]
+      field_class[@items.first]
+    end
+
+    def get_declarator(trace_class:, variable:)
+      items_var = "#{variable}_items"
+      pr "const char *const #{items_var}[] = { #{@items.map { |i| "\"#{i}\"" }.join(', ')} };"
+      pr "#{variable} = bt_field_location_create(#{trace_class}, #{@root_scope}, #{items_var}, #{@items.length});"
     end
   end
 
@@ -394,6 +416,8 @@ module Babeltrace2Gen
         'string' => BTFieldClass::String,
         'array_static' => BTFieldClass::Array::Static,
         'array_dynamic' => BTFieldClass::Array::Dynamic,
+        'blob_static' => BTFieldClass::Blob::Static,
+        'blob_dynamic' => BTFieldClass::Blob::Dynamic,
         'structure' => BTFieldClass::Structure,
         'option_without_selector_field' => BTFieldClass::Option::WithoutSelectorField,
         'option_with_selector_field_bool' => BTFieldClass::Option::WithSelectorField::Bool,
@@ -718,17 +742,17 @@ module Babeltrace2Gen
     extend BTFromH
 
     module WithLengthField
-      attr_reader :length_field_path
+      attr_reader :length_field_location
     end
     using HashRefinements
 
-    def initialize(parent:, element_field_class:, length_field_path: nil)
+    def initialize(parent:, element_field_class:, length_field_location: nil)
       super(parent: parent, element_field_class: element_field_class)
-      return unless length_field_path
+      return unless length_field_location
 
       extend(WithLengthField)
 
-      @length_field_path = length_field_path
+      @length_field_location = BTFieldLocation.new(parent: self, **length_field_location)
     end
 
     def get_declarator(trace_class:, variable:)
@@ -736,34 +760,26 @@ module Babeltrace2Gen
       scope do
         pr "bt_field_class *#{element_field_class_variable};"
         @element_field_class.get_declarator(trace_class: trace_class, variable: element_field_class_variable)
-        if @length_field_path
-          element_field_class_variable_length = "#{element_field_class_variable}_length"
-          pr "bt_field_class *#{element_field_class_variable_length};"
+        if @length_field_location
+          # MIP 1: reference the length field via a field-location instead of a
+          # length field class (bt_field_class_array_dynamic_create is MIP 0 only).
+          loc = "#{element_field_class_variable}_length_loc"
+          pr "const bt_field_location *#{loc};"
           scope do
-            element_field_class_variable_length_sm = "#{element_field_class_variable_length}_sm"
-            pr "bt_field_class_structure_member *#{element_field_class_variable_length_sm};"
-            field_class, id = resolve_path(@length_field_path)
-            id.scan(/(\w+)|(\d+)/).each do |name, index|
-              # String
-              if name
-                pr "#{element_field_class_variable_length_sm} = bt_field_class_structure_borrow_member_by_name(#{field_class.variable}, \"#{name}\");"
-              else
-                pr "#{element_field_class_variable_length_sm} = bt_field_class_structure_borrow_member_by_index(#{field_class.variable}, #{index});"
-              end
-            end
-            pr "#{element_field_class_variable_length} = bt_field_class_structure_member_borrow_field_class(#{element_field_class_variable_length_sm});"
+            @length_field_location.get_declarator(trace_class: trace_class, variable: loc)
           end
-          pr "#{variable} = bt_field_class_array_dynamic_create(#{trace_class}, #{element_field_class_variable}, #{element_field_class_variable_length});"
+          pr "#{variable} = bt_field_class_array_dynamic_with_length_field_location_create(#{trace_class}, #{element_field_class_variable}, #{loc});"
+          pr "bt_field_location_put_ref(#{loc});"
           pr "bt_field_class_put_ref(#{element_field_class_variable});"
         else
-          pr "#{variable} = bt_field_class_array_dynamic_create(#{trace_class}, #{element_field_class_variable}, NULL);"
+          pr "#{variable} = bt_field_class_array_dynamic_without_length_field_location_create(#{trace_class}, #{element_field_class_variable});"
+          pr "bt_field_class_put_ref(#{element_field_class_variable});"
         end
       end
     end
 
     def get_setter(field:, arg_variables:)
-      field_class, id = resolve_path(@length_field_path)
-      length_field = field_class[id]
+      length_field = @length_field_location.member
       pr "bt_field_array_dynamic_set_length(#{field}, #{length_field.name});"
       usr_var = bt_get_variable(arg_variables, is_array: true)
       pr "for(uint64_t _i=0; _i < #{length_field.name} ; _i++)"
@@ -790,6 +806,92 @@ module Babeltrace2Gen
     end
   end
 
+  # BLOB fields (CTF2 / MIP 1): a raw byte buffer with an associated IANA media
+  # type. Used by THAPI to record structs/unions and opaque byte buffers as
+  # uninterpreted bytes instead of smuggling them through text sequences.
+  class BTFieldClass::Blob < BTFieldClass
+    DEFAULT_MEDIA_TYPE = 'application/octet-stream'
+
+    attr_reader :media_type
+
+    # Emit the media-type assignment shared by static and dynamic blobs.
+    def declare_media_type(variable)
+      pr "bt_field_class_blob_set_media_type(#{variable}, \"#{@media_type || DEFAULT_MEDIA_TYPE}\");"
+    end
+  end
+
+  class BTFieldClass::Blob::Static < BTFieldClass::Blob
+    extend BTFromH
+
+    attr_reader :length
+
+    def initialize(parent:, length:, media_type: nil)
+      @parent = parent
+      @length = length
+      @media_type = media_type
+    end
+
+    def get_declarator(trace_class:, variable:)
+      pr "#{variable} = bt_field_class_blob_static_create(#{trace_class}, #{@length});"
+      declare_media_type(variable)
+    end
+
+    # A fixed-length blob carries the raw bytes of a struct/union; reconstruct it
+    # by memcpy, mirroring BTFieldClass::String with cast_type_is_struct.
+    def get_setter(field:, arg_variables:)
+      variable = bt_get_variable(arg_variables).name
+      pr "memcpy(bt_field_blob_get_data(#{field}), &#{variable}, #{@length});"
+    end
+
+    def get_getter(field:, arg_variables:)
+      variable = bt_get_variable(arg_variables).name
+      pr "memcpy(&#{variable}, bt_field_blob_get_data_const(#{field}), #{@length});"
+    end
+  end
+
+  class BTFieldClass::Blob::Dynamic < BTFieldClass::Blob
+    extend BTFromH
+
+    attr_reader :length_field_location
+
+    @bt_type = 'uint8_t*'
+
+    def initialize(parent:, length_field_location: nil, media_type: nil)
+      @parent = parent
+      @length_field_location = BTFieldLocation.new(parent: self, **length_field_location) if length_field_location
+      @media_type = media_type
+    end
+
+    def get_declarator(trace_class:, variable:)
+      if @length_field_location
+        loc = "#{variable}_length_loc"
+        pr "const bt_field_location *#{loc};"
+        scope do
+          @length_field_location.get_declarator(trace_class: trace_class, variable: loc)
+        end
+        pr "#{variable} = bt_field_class_blob_dynamic_with_length_field_location_create(#{trace_class}, #{loc});"
+        pr "bt_field_location_put_ref(#{loc});"
+      else
+        pr "#{variable} = bt_field_class_blob_dynamic_without_length_field_location_create(#{trace_class});"
+      end
+      declare_media_type(variable)
+    end
+
+    def get_setter(field:, arg_variables:)
+      length_field = @length_field_location.member
+      usr_var = bt_get_variable(arg_variables)
+      pr "bt_field_blob_dynamic_set_length(#{field}, #{length_field.name});"
+      pr "memcpy(bt_field_blob_get_data(#{field}), #{usr_var.name}, #{length_field.name});"
+    end
+
+    # The returned pointer is valid until the field is modified, so hand it to the
+    # callback directly instead of copying (mirrors BTFieldClass::String).
+    def get_getter(field:, arg_variables:)
+      usr_var = bt_get_variable(arg_variables)
+      pr "#{usr_var.name} = (#{usr_var.type})bt_field_blob_get_data_const(#{field});"
+    end
+  end
+
   class BTMemberClass
     include BTMatch
     include BTLocator

data/lib/metababel/bt2_values_generator.rb

@@ -46,12 +46,10 @@ module Babeltrace2Gen
       default_value = @usr_default_value || bt_default_value
 
       pr "if (#{val} != NULL) {"
-      if bt_type_is
-        pr "  if (#{bt_type_is}(#{val}) != BT_TRUE) {"
-        pr "    fprintf(stderr,\"Bad value for command line argument '%s' the value must be '%s'. \\n\",\"#{@name}\",\"#{bt_type}\");"
-        pr '    exit(1);'
-        pr '  }'
-      end
+      pr "  if (#{bt_type_is}(#{val}) != BT_TRUE) {"
+      pr "    fprintf(stderr,\"Bad value for command line argument '%s' the value must be '%s'. \\n\",\"#{@name}\",\"#{bt_type}\");"
+      pr '    exit(1);'
+      pr '  }'
       pr "  #{name} = #{cast_func}bt_value_#{bt_type}_get(#{val});"
       pr '} else {'
       pr "  #{name} = #{cast_func}#{default_value};"
@@ -122,9 +120,9 @@ module Babeltrace2Gen
 
   class BTValueCLass::IntegerUnsigned < BTValueCLass::Scalar
     @bt_type = 'integer_unsigned'
-    @bt_type_is = nil # 'bt_value_is_unsigned_integer'. Workarround `isIntegerUnsigned` broken
+    @bt_type_is = 'bt_value_is_unsigned_integer'
     @bt_return_type = 'uint64_t'
-    @bt_default_value = '0'
+    @bt_default_value = '+0'
 
     def initialize(name, usr_default_value)
       bt_type = self.class.instance_variable_get(:@bt_type)

data/lib/metababel/version.rb

@@ -1,3 +1,3 @@
 module Metababel
-  VERSION = '1.1.4'
+  VERSION = '2.0.0'
 end

data/template/filter.c.erb

@@ -523,6 +523,20 @@ static void filter_message_iterator_finalize(
   free(message_iterator_private_data);
 }
 
+/* Advertise support for MIP version 1, required for CTF2 features such as
+ * BLOB fields. Without this method a component defaults to MIP 0 only. */
+static bt_component_class_get_supported_mip_versions_method_status
+filter_get_supported_mip_versions(
+    bt_self_component_class_filter *self_component_class,
+    const bt_value *params, void *initialize_method_data,
+    bt_logging_level logging_level,
+    bt_integer_range_set_unsigned *supported_versions) {
+  if (bt_integer_range_set_unsigned_add_range(supported_versions, 1, 1) !=
+      BT_INTEGER_RANGE_SET_ADD_RANGE_STATUS_OK)
+    return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_MEMORY_ERROR;
+  return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_OK;
+}
+
 /* Mandatory */
 BT_PLUGIN_MODULE();
 
@@ -530,6 +544,8 @@ BT_PLUGIN(<%= options[:'plugin-name'] %>);
 BT_PLUGIN_FILTER_COMPONENT_CLASS(<%= options[:'component-name'] %>,
                                  filter_message_iterator_next);
 
+BT_PLUGIN_FILTER_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD(
+    <%= options[:'component-name'] %>, filter_get_supported_mip_versions);
 BT_PLUGIN_FILTER_COMPONENT_CLASS_INITIALIZE_METHOD(
     <%= options[:'component-name'] %>, filter_initialize);
 BT_PLUGIN_FILTER_COMPONENT_CLASS_FINALIZE_METHOD(

data/template/sink.c.erb

@@ -160,12 +160,28 @@ sink_graph_is_configured(bt_self_component_sink *self_component_sink) {
   return BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK;
 }
 
+/* Advertise support for MIP version 1, required for CTF2 features such as
+ * BLOB fields. Without this method a component defaults to MIP 0 only. */
+static bt_component_class_get_supported_mip_versions_method_status
+sink_get_supported_mip_versions(
+    bt_self_component_class_sink *self_component_class,
+    const bt_value *params, void *initialize_method_data,
+    bt_logging_level logging_level,
+    bt_integer_range_set_unsigned *supported_versions) {
+  if (bt_integer_range_set_unsigned_add_range(supported_versions, 1, 1) !=
+      BT_INTEGER_RANGE_SET_ADD_RANGE_STATUS_OK)
+    return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_MEMORY_ERROR;
+  return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_OK;
+}
+
 /* Mandatory */
 BT_PLUGIN_MODULE();
 
 BT_PLUGIN(<%= options[:'plugin-name'] %>);
 BT_PLUGIN_SINK_COMPONENT_CLASS(<%= options[:'component-name'] %>, sink_consume);
 
+BT_PLUGIN_SINK_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD(
+    <%= options[:'component-name'] %>, sink_get_supported_mip_versions);
 BT_PLUGIN_SINK_COMPONENT_CLASS_INITIALIZE_METHOD(
     <%= options[:'component-name'] %>, sink_initialize);
 BT_PLUGIN_SINK_COMPONENT_CLASS_FINALIZE_METHOD(

data/template/source.c.erb

@@ -206,6 +206,20 @@ static void source_message_iterator_finalize(
   free(message_iterator_private_data);
 }
 
+/* Advertise support for MIP version 1, required for CTF2 features such as
+ * BLOB fields. Without this method a component defaults to MIP 0 only. */
+static bt_component_class_get_supported_mip_versions_method_status
+source_get_supported_mip_versions(
+    bt_self_component_class_source *self_component_class,
+    const bt_value *params, void *initialize_method_data,
+    bt_logging_level logging_level,
+    bt_integer_range_set_unsigned *supported_versions) {
+  if (bt_integer_range_set_unsigned_add_range(supported_versions, 1, 1) !=
+      BT_INTEGER_RANGE_SET_ADD_RANGE_STATUS_OK)
+    return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_MEMORY_ERROR;
+  return BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_OK;
+}
+
 /* Mandatory */
 BT_PLUGIN_MODULE();
 
@@ -213,6 +227,8 @@ BT_PLUGIN(<%= options[:'plugin-name'] %>);
 BT_PLUGIN_SOURCE_COMPONENT_CLASS(<%= options[:'component-name'] %>,
                                  source_message_iterator_next);
 
+BT_PLUGIN_SOURCE_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD(
+    <%= options[:'component-name'] %>, source_get_supported_mip_versions);
 BT_PLUGIN_SOURCE_COMPONENT_CLASS_INITIALIZE_METHOD(
     <%= options[:'component-name'] %>, source_initialize);
 BT_PLUGIN_SOURCE_COMPONENT_CLASS_FINALIZE_METHOD(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metababel
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Thomas Applencourt
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-11-03 00:00:00.000000000 Z
+date: 2026-09-21 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: Helper for creation Babeltrace plugins