metababel 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29d62dad7a8e18caa6eae836db0caf7b0e7dd5012c6d83492e51140d9c4ab110
-  data.tar.gz: 9781c211009fbb238c4a96b3faf0341607da2b202155179f58aa545d75f45809
+  metadata.gz: 94a55badce2025551858542b3ad05ec6f2fadfa18ea7a3d32e43dfc8fa588505
+  data.tar.gz: 861f4853f64c5de23d47f6678e8a369b49b1e5f84cd4ad1944b077a32e5a8a87
 SHA512:
-  metadata.gz: d0fef46f9f4461770e2b1994e087788a53dfe3b198d8a529e9e0486320a788f6eac20b4230605f612dbd7cdcbc69746b93e9605f06086353f78a70f6da5774f0
-  data.tar.gz: '0791014239ed111d63148bdb45c2a8d48f45ad0e51a2440fc9171e2220465add097e1f7a4340fef82aca2f4f2b303e1083803ab9d76a6252cfbf9795fc72dfbe'
+  metadata.gz: 10357d19a20bb264699f6f586f49fd2d5229a7da0ea7dd51234d5b5733bee78340c83f564a2084a26a99db9d13073332ad211c67def4b469c6251e2f219b4efa
+  data.tar.gz: 92a55fb2d187388088d13d30a827548b1543bec100f81ff4fa58a7dae41d77ad52f53268b33abd93a1149ea9479c838354b3d1b1773e6dbdf8f2b54a0ae1351b

data/README.md

@@ -38,8 +38,8 @@ stateDiagram-v2
 
 ```mermaid
 stateDiagram-v2
-    [*] --> BTX_SOURCE_STATE_INITIALIZING
-    BTX_SOURCE_STATE_INITIALIZING --> BTX_FILTER_PROCESSING
+    [*] --> BTX_FILTER_STATE_INITIALIZING
+    BTX_FILTER_STATE_INITIALIZING --> BTX_FILTER_PROCESSING
     state BTX_FILTER_PROCESSING {
         [*] --> BTX_FILTER_PROCESSING_STATE_READING
         [*] --> BTX_FILTER_PROCESSING_STATE_SENDING

data/bin/btx_gen_source_callbacks

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'yaml'
+require 'erb'
+require 'time'
+
+REGEXT_PRETTY = /
+ =\s            # We are interested to the right of the equal sign
+ (
+    ""|         # Empty string
+    ".*?[^\\]"| # String who can contain space and quoted string
+    [^\s,]+     # Anything except space and comma
+ )
+/x.freeze
+
+SOURCE_TEMPLATE = <<~TEXT.freeze
+  /* Code generated by #{__FILE__} */
+
+  #include <metababel/metababel.h>
+
+  void btx_push_usr_messages(void *btx_handle, void *usr_data, btx_source_status_t *status) {
+      <%- if not data.empty? and not data.first[:hostname].nil? -%>
+      btx_downstream_set_environment_hostname(btx_handle, "<%= data.first[:hostname] %>");
+      <%- end -%>
+
+      <%- data.each do | entry | -%>
+      <%- entry.fetch(:times,1).times do -%>
+      btx_push_message_<%= entry[:name] %>(btx_handle<%= ', ' if not entry[:field_values].empty? %><%= entry[:field_values].join(", ") %>);
+      <%- end -%>
+      <%- end -%>
+
+      *status = BTX_SOURCE_END;
+  }
+
+  void btx_register_usr_callbacks(void *btx_handle) {
+    btx_register_callbacks_push_usr_messages(btx_handle, &btx_push_usr_messages);
+  }
+TEXT
+
+def parse_event(line)
+  h = { hostname: nil,
+        name: nil,
+        field_values: [] }
+  # Parse a token one at a time
+  head, tail = line.split(nil, 2)
+  # Timestamp?
+  if head.start_with?('[')
+    t = Time.parse(head[1...-1])
+    # Need to convert in nasosecond
+    h[:field_values] << ((t.to_i * 1_000_000_000) + t.nsec)
+    # discard next token, the offset "(+x.xxxxxxxx)", which
+    # always follows the bracketed timestamp
+    _, head, tail = tail.split(nil, 3)
+  end
+  # Hostname?
+  unless head.end_with?(':')
+    h[:hostname] = head
+    head, tail = tail.split(nil, 2)
+  end
+  h[:name] = head.chop.gsub(/[^0-9A-Za-z-]/, '_')
+  # Handle the fields
+  h[:field_values] += tail.scan(REGEXT_PRETTY).flatten
+  h
+end
+
+def parse_log(input_path)
+  File.open(input_path, 'r') do |file|
+    file.each_line.map do |line|
+      parse_event(line)
+    end
+  end
+end
+
+def render_and_save(data, output_path)
+  renderer = ERB.new(SOURCE_TEMPLATE, trim_mode: '-')
+  output = renderer.result(binding)
+  File.write(output_path, output, mode: 'w')
+end
+
+DOCS = <<-DOCS.freeze
+  Usage: #{$0}.rb [options]
+
+  Example:
+    ruby #{$0} -y stream_classes.yaml -i btx_log.txt -o callbacks.c
+DOCS
+
+# Display help if no arguments.
+ARGV << '-h' if ARGV.empty?
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = DOCS
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+
+  opts.on('-i', '--log PATH', '[Mandatory] Path to btx_log.txt.') do |p|
+    options[:input_path] = p
+  end
+
+  opts.on('-o', '--output PATH', '[Mandatory] Path to the bt2 SOURCE file.') do |p|
+    options[:output_path] = p
+  end
+end.parse!
+
+raise OptionParser::MissingArgument if options[:output_path].nil?
+
+data = options.key?(:input_path) ? parse_log(options[:input_path]) : []
+render_and_save(data, options[:output_path])

data/bin/metababel

@@ -412,7 +412,20 @@ class ContextBuilder
         t.get_declarator(variable: '_trace_class', self_component: '_self_component')
       end
 
+      downstream_environements = if t.environment.nil?
+                                   []
+                                 else
+                                   t.environment.entries.map do |e|
+                                     args = {}
+                                     body = "\n" + Babeltrace2Gen.context(indent: 1) do
+                                       e.get_setter(trace: '_trace', arg_variables: args)
+                                     end
+                                     [args['outputs'].first, body]
+                                   end
+                                 end
+
       { body_declarator_classes: body_declarator_classes,
+        downstream_environements: downstream_environements,
         downstream_events: downstream_events,
         stream_classes: t.stream_classes,
         event_name: event_name }

data/lib/metababel/bt2_trace_class_generator.rb

@@ -100,8 +100,6 @@ module Babeltrace2Gen
     end
 
     def get_declarator(variable:, self_component:)
-      raise NotImplementedError, "':environment' keyword not supported in downstream model" if environment
-
       pr "#{variable} = bt_trace_class_create(#{self_component});"
       bt_set_conditionally(@assigns_automatic_stream_class_id) do |v|
         pr "bt_trace_class_set_assigns_automatic_stream_class_id(#{variable}, #{v});"
@@ -985,15 +983,20 @@ module Babeltrace2Gen
     end
 
     def get_getter(trace:, arg_variables:)
-      var_name = @name
-      arg_variables.fetch_append('outputs', bt_get_variable)
-      bt_func_get = self.class.instance_variable_get(:@bt_func)
+      var_name = bt_get_variable(arg_variables).name
       pr "const bt_value *#{var_name}_value = bt_trace_borrow_environment_entry_value_by_name_const(#{trace}, \"#{var_name}\");"
-      pr "#{var_name} = #{bt_func_get}(#{var_name}_value);"
+      pr "#{var_name} = bt_value_#{@type}_get(#{var_name}_value);"
     end
 
-    def bt_get_variable()
-      GeneratedArg.new(self.class.instance_variable_get(:@bt_type), @name)
+    def get_setter(trace:, arg_variables:)
+      var_name = bt_get_variable(arg_variables).name
+      bt_type_set = self.class.instance_variable_get(:@bt_type_set)
+      pr "bt_trace_set_environment_entry_#{bt_type_set}(#{trace}, \"#{var_name}\", #{var_name});"
+    end
+
+    def bt_get_variable(arg_variables={})
+      var = GeneratedArg.new(self.class.instance_variable_get(:@bt_type), @name)
+      arg_variables.fetch_append('outputs', var)
     end
   end
 
@@ -1005,13 +1008,14 @@ module Babeltrace2Gen
     extend BTFromH
 
     @bt_type = 'const char*'
-    @bt_func = 'bt_value_string_get'
+    @bt_type_set = 'string'
   end
 
   class BTEntryClass::IntegerSigned < BTEntryClass
     extend BTFromH
 
     @bt_type = 'int64_t'
-    @bt_func = 'bt_value_integer_signed_get'
+    # Sadly it's ` bt_trace_set_environment_entry_integer() ` and not ` bt_trace_set_environment_entry_integer_signed()`
+    @bt_type_set = 'integer'
   end
 end

data/lib/metababel/version.rb

@@ -1,3 +1,3 @@
 module Metababel
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/template/downstream.c.erb

@@ -173,3 +173,12 @@ void btx_push_message_<%= e.name_sanitized %>(
   btx_downstream_push_message(_message_iterator_private_data, _message);
 }
 <% end %>
+
+<% downstream_environements.each do |arg, body| %>
+void btx_downstream_set_environment_<%= arg.name%>(void *btx_handle,
+                                                   <%= arg.type%> <%= arg.name%>) {
+  common_data_t *common_data = (common_data_t *)btx_handle;
+  bt_trace *_trace = common_data->downstream_trace;
+  <%= body %>
+}
+<% end %>

data/template/downstream.h.erb

@@ -42,6 +42,11 @@ void btx_register_on_downstream_message_callback(
     void *btx_handle, on_downstream_message_callback_f *callback);
 <% end %>
 
+<% downstream_environements.each do |arg, body| %>
+void btx_downstream_set_environment_<%= arg.name%>(void *btx_handle,
+                                                   <%= arg.type%> <%= arg.name%>);
+<% end %>
+
 #ifdef __cplusplus
 }
 #endif

data/template/filter.c.erb

@@ -347,18 +347,6 @@ filter_initialize(bt_self_component_filter *self_component_filter,
   common_data->btx_params = (btx_params_t *)calloc(1, sizeof(btx_params_t));
   common_data->params = params;
 
-  /* Read parameters */
-  btx_populate_params(common_data);
-  bt_value_get_ref(common_data->params);
-
-  /* Register User Callbacks */
-  btx_register_usr_callbacks((void *)common_data);
-  /* Call initialize_processing*/
-  btx_call_callbacks_initialize_component(common_data, &common_data->usr_data);
-  /* Call read callbacks */
-  btx_call_callbacks_read_params(common_data, common_data->usr_data,
-                                 common_data->btx_params);
-
   /* Set the component's user data to our private data structure */
   bt_self_component_set_data(
       bt_self_component_filter_as_self_component(self_component_filter),
@@ -406,6 +394,18 @@ filter_initialize(bt_self_component_filter *self_component_filter,
   btx_streams_get_ref(common_data->downstream_trace); // ??
   bt_trace_class_put_ref(trace_class);
 
+  /* Read parameters */
+  btx_populate_params(common_data);
+  bt_value_get_ref(common_data->params);
+
+  /* Register User Callbacks */
+  btx_register_usr_callbacks((void *)common_data);
+  /* Call initialize_processing*/
+  btx_call_callbacks_initialize_component(common_data, &common_data->usr_data);
+  /* Call read callbacks */
+  btx_call_callbacks_read_params(common_data, common_data->usr_data,
+      common_data->btx_params);
+
   return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
 }
 

data/template/source.c.erb

@@ -96,18 +96,6 @@ source_initialize(bt_self_component_source *self_component_source,
   common_data->btx_params = (btx_params_t *)calloc(1, sizeof(btx_params_t));
   common_data->params = params;
 
-  /* Read parameters */
-  btx_populate_params(common_data);
-  bt_value_get_ref(common_data->params);
-
-  /* Register User Callbacks */
-  btx_register_usr_callbacks((void *)common_data);
-  /* Call initialize_processing*/
-  btx_call_callbacks_initialize_component(common_data, &common_data->usr_data);
-  /* Call read callbacks */
-  btx_call_callbacks_read_params(common_data, common_data->usr_data,
-                                 common_data->btx_params);
-
   /* Upcast `self_component_source` to the `bt_self_component` type */
   bt_self_component *self_component =
       bt_self_component_source_as_self_component(self_component_source);
@@ -134,6 +122,18 @@ source_initialize(bt_self_component_source *self_component_source,
   bt_self_component_source_add_output_port(self_component_source, "out", NULL,
                                            NULL);
 
+  /* Read parameters */
+  btx_populate_params(common_data);
+  bt_value_get_ref(common_data->params);
+
+  /* Register User Callbacks */
+  btx_register_usr_callbacks((void *)common_data);
+  /* Call initialize_processing*/
+  btx_call_callbacks_initialize_component(common_data, &common_data->usr_data);
+  /* Call read callbacks */
+  btx_call_callbacks_read_params(common_data, common_data->usr_data,
+      common_data->btx_params);
+
   return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metababel
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Thomas Applencourt
@@ -10,16 +10,18 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-05 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
 executables:
 - metababel
+- btx_gen_source_callbacks
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/btx_gen_source_callbacks
 - bin/metababel
 - lib/metababel.rb
 - lib/metababel/bt2_generator_utils.rb
@@ -57,8 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.3
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Helper for creation Babeltrace plugins