vivarium 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0e7e80cef690342f163fde6c05fed6859c3ef81aa794fe532c87b00fbe11cd5
-  data.tar.gz: 4f2de93c9795fe93ecb0d8291f86a117ac0f595c8c12e2c7b41caabaae7c3273
+  metadata.gz: 6549be32807adc904ffe18fbefc055600cf14c85c68b106a3abfd7dce354e8b1
+  data.tar.gz: 1f9c961424d4712b2c43ad3df8d81ee679ea2190acaa8ea24e78a4f88b92f452
 SHA512:
-  metadata.gz: 9a116f2c50b978a368a05cca351411f9724686746820085b651038d060c8452a8546170cb6e6ac885ab8a721aa20bcf42c5746639d32cbfea0ba8a9452b9687e
-  data.tar.gz: fb5b4b5307682fa84b77dcfaa2165a71a5e16deef8d7b7d21d6b3267e82b5a12ce1f73dee946193605e039a247d59613a9c2dffca15ef96ddb502a17c9ce742d
+  metadata.gz: ebe88587a6328a37703899da2f0c8275f9321d7ea34e1af9806dccfaf929a6ee45bce68378356aeb2171708936b74ebb33545ada8a7eace2774aa60783b31b24
+  data.tar.gz: f707b190642345628ddf613038942a87cd95585877b45a264e13ffb1c243da0b7576712d6b5e5eb65e336dab06ff95a01f329b383bdb0007aec879629c30d2eb

data/examples/drop_demo.rb

@@ -14,16 +14,15 @@ require "vivarium"
 require "vivarium/correlator"
 require "vivarium/tree_renderer"
 require "vivarium/display_filter"
-require "vivarium_usdt"
 
-t0        = 1_000_000_000  # base ktime_ns
-pid       = Process.pid
-tid       = Process.pid
-method_id = 0x0001_0001
+t0  = 1_000_000_000  # base ktime_ns
+pid = Process.pid
+tid = Process.pid
 
-# span_start payload: method_id (8B) + file_id (8B) + lineno (8B)
-span_start_payload = [method_id, 0, 10].pack("q<q<q<")
-                                        .ljust(Vivarium::EVENT_PAYLOAD_SIZE, "\x00")
+# span_start payload: method_name (128B) + file_name (120B) + lineno (8B)
+span_start_payload = "MyClass#my_method".ljust(Vivarium::SPAN_METHOD_SIZE, "\x00") +
+                     "drop_demo.rb".ljust(Vivarium::SPAN_FILE_SIZE, "\x00") +
+                     [10].pack("q<")
 
 events = [
   Vivarium::Correlator::RawEvent.new(
@@ -67,7 +66,6 @@ events = [
 
 Vivarium::TreeRenderer.new(
   events: events,
-  method_table: { method_id => "MyClass#my_method" },
   observer_pid: pid,
   main_tid: tid,
   session_start_iso: "2026-06-02T00:00:00.000Z",

data/lib/vivarium/correlator.rb

@@ -23,17 +23,15 @@ module Vivarium
 
     POLL_TIMEOUT_MS = 200
 
-    def initialize(pin_dir:, observer_pid:, main_tid:, method_id_queue:, filter: nil, dest: $stdout)
+    def initialize(pin_dir:, observer_pid:, main_tid:, filter: nil, dest: $stdout)
       @pin_dir = pin_dir
       @observer_pid = observer_pid
       @main_tid = main_tid
-      @method_id_queue = method_id_queue
       @filter = filter
       @dest = dest
 
       @events = []
       @events_mutex = Mutex.new
-      @method_table = {}
       @stop_flag = false
       @started = false
 
@@ -66,15 +64,12 @@ module Vivarium
       @session_stop_ktime = Vivarium.monotonic_ktime_ns
 
       3.times { safe_poll(50) }
-      drain_method_id_queue
 
       events_snapshot = @events_mutex.synchronize { @events.dup }
-      method_table_snapshot = @method_table.dup
       @stopped = true
 
       TreeRenderer.new(
         events: events_snapshot,
-        method_table: method_table_snapshot,
         observer_pid: @observer_pid,
         main_tid: @main_tid,
         session_start_iso: @session_start_iso,
@@ -91,7 +86,6 @@ module Vivarium
     def run
       until @stop_flag
         safe_poll(POLL_TIMEOUT_MS)
-        drain_method_id_queue
       end
     end
 
@@ -126,17 +120,5 @@ module Vivarium
       warn "[vivarium correlator] capture error: #{e.class}: #{e.message}"
     end
 
-    def drain_method_id_queue
-      loop do
-        msg = begin
-          @method_id_queue.pop(true)
-        rescue ThreadError
-          return
-        end
-
-        method_id, signature = msg
-        @method_table[method_id] = signature
-      end
-    end
   end
 end

data/lib/vivarium/tree_renderer.rb

@@ -28,7 +28,7 @@ module Vivarium
     UNRESOLVED_METHOD_PREFIX = "<method_id="
 
     Span = Struct.new(
-      :tid, :method_id, :file_id, :lineno, :start_ktime, :stop_ktime, :exit_kind,
+      :tid, :method_name, :file_name, :lineno, :start_ktime, :stop_ktime, :exit_kind,
       :events, :descendant_pids, :synthetic, :raised,
       keyword_init: true
     ) do
@@ -52,11 +52,10 @@ module Vivarium
     EventNode = Struct.new(:kind, :name, :target, :offset_ns, :child_proc, keyword_init: true)
     ProcNode = Struct.new(:pid, :comm, :parent_pid, :children, keyword_init: true)
 
-    def initialize(events:, method_table:, observer_pid:, main_tid:,
+    def initialize(events:, observer_pid:, main_tid:,
                    session_start_iso:, session_start_ktime:,
                    session_stop_iso:, session_stop_ktime:, filter: nil, dest:)
       @events = events
-      @method_table = method_table
       @observer_pid = observer_pid
       @main_tid = main_tid
       @session_start_iso = session_start_iso
@@ -68,7 +67,6 @@ module Vivarium
 
       @pid_comm = { observer_pid => "ruby" }
       @pid_parent = {}
-      @unresolved_method_ids = []
     end
 
     def render
@@ -101,11 +99,11 @@ module Vivarium
       events.each do |ev|
         case ev.event_name
         when "span_start"
-          mid, fid, lno = read_span_payload(ev.payload)
+          method_name, file_name, lno = read_span_payload(ev.payload)
           span = Span.new(
             tid: ev.tid,
-            method_id: mid,
-            file_id: fid,
+            method_name: method_name,
+            file_name: file_name,
             lineno: lno,
             start_ktime: ev.ktime_ns,
             stop_ktime: nil,
@@ -195,8 +193,8 @@ module Vivarium
     def synthetic_span(start_ktime, stop_ktime)
       Span.new(
         tid: @main_tid,
-        method_id: nil,
-        file_id: nil,
+        method_name: nil,
+        file_name: nil,
         lineno: nil,
         start_ktime: start_ktime,
         stop_ktime: stop_ktime,
@@ -262,9 +260,6 @@ module Vivarium
     end
 
     def print_warnings
-      @unresolved_method_ids.uniq.each do |mid|
-        @dest.puts format("# warning method_id=0x%016X unresolved at render time", mid & 0xFFFF_FFFF_FFFF_FFFF)
-      end
     end
 
     def print_observer_proc(spans)
@@ -301,25 +296,17 @@ module Vivarium
 
     def span_file_info(span)
       return "" if span.synthetic
-      return "" unless span.file_id && span.file_id != -1
-
-      file_name = Vivarium::Usdt.get_file_name(span.file_id)
-      return "" unless file_name
+      return "" if span.file_name.nil? || span.file_name.empty?
 
       lno = span.lineno && span.lineno > 0 ? ":#{span.lineno}" : ""
-      "  at=#{File.basename(file_name)}#{lno}"
+      "  at=#{File.basename(span.file_name)}#{lno}"
     end
 
     def span_display_name(span)
       return SYNTHETIC_SPAN_NAME if span.synthetic
-      return SYNTHETIC_SPAN_NAME if span.method_id.nil?
-
-      name = @method_table[span.method_id]
-      name ||= Vivarium::Usdt.get_method_name(span.method_id)
-      return name if name
+      return SYNTHETIC_SPAN_NAME if span.method_name.nil? || span.method_name.empty?
 
-      @unresolved_method_ids << span.method_id
-      format("#{UNRESOLVED_METHOD_PREFIX}0x%016X>", span.method_id & 0xFFFF_FFFF_FFFF_FFFF)
+      span.method_name
     end
 
     def build_span_children(span)
@@ -548,28 +535,20 @@ module Vivarium
 
     def render_raise_target(ev)
       bytes = ev.payload.to_s.b
-      return "-" if bytes.bytesize < 8
-
-      error_id = bytes[0, 8].unpack1("q<")
-      message_id = bytes.bytesize >= 16 ? bytes[8, 8].unpack1("q<") : -1
-      file_id = bytes.bytesize >= 24 ? bytes[16, 8].unpack1("q<") : -1
-      lineno = bytes.bytesize >= 32 ? bytes[24, 8].unpack1("q<") : -1
-
-      error_name = Vivarium::Usdt.get_error_name(error_id) ||
-                   format("0x%016X", error_id & 0xFFFF_FFFF_FFFF_FFFF)
-
-      parts = ["error=#{error_name}"]
-
-      if message_id != -1
-        msg = Vivarium::Usdt.get_message_name(message_id)
-        parts << "message=#{msg.inspect}" if msg
-      end
-
-      if file_id != -1 && (file_name = Vivarium::Usdt.get_file_name(file_id))
-        lno = lineno && lineno > 0 ? ":#{lineno}" : ""
+      return "-" if bytes.empty?
+
+      slot = Vivarium::SPAN_RAISE_SLOT_SIZE
+      error_name = Vivarium.c_string(bytes[0, slot])
+      message    = Vivarium.c_string(bytes[slot, slot])
+      file_name  = Vivarium.c_string(bytes[slot * 2, slot])
+      lineno     = bytes.bytesize > Vivarium::SPAN_RAISE_LINENO_OFFSET ? bytes[Vivarium::SPAN_RAISE_LINENO_OFFSET, 8].unpack1("q<") : -1
+
+      parts = ["error=#{error_name.empty? ? '?' : error_name}"]
+      parts << "message=#{message.inspect}" unless message.empty?
+      unless file_name.empty?
+        lno = lineno > 0 ? ":#{lineno}" : ""
         parts << "at=#{File.basename(file_name)}#{lno}"
       end
-
       parts.join(" ")
     end
 
@@ -589,12 +568,12 @@ module Vivarium
 
     def read_span_payload(payload)
       bytes = payload.to_s.b
-      return [0, -1, -1] if bytes.bytesize < 8
+      return [nil, nil, -1] if bytes.empty?
 
-      method_id = bytes[0, 8].unpack1("q<")
-      file_id = bytes.bytesize >= 16 ? bytes[8, 8].unpack1("q<") : -1
-      lineno = bytes.bytesize >= 24 ? bytes[16, 8].unpack1("q<") : -1
-      [method_id, file_id, lineno]
+      method_name = Vivarium.c_string(bytes[0, Vivarium::SPAN_METHOD_SIZE])
+      file_name   = Vivarium.c_string(bytes[Vivarium::SPAN_METHOD_SIZE, Vivarium::SPAN_FILE_SIZE])
+      lineno      = bytes.bytesize > Vivarium::SPAN_LINENO_OFFSET ? bytes[Vivarium::SPAN_LINENO_OFFSET, 8].unpack1("q<") : -1
+      [method_name, file_name, lineno]
     end
 
     def read_proc_fork_child_pid(payload)

data/lib/vivarium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vivarium
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/vivarium.rb

@@ -33,6 +33,15 @@ module Vivarium
   EVENT_DROPPED_OFFSET = 288
   EVENTS_RINGBUF_PAGES = 256
 
+  SPAN_METHOD_SIZE     = 128
+  SPAN_FILE_SIZE       = 120
+  SPAN_LINENO_OFFSET   = SPAN_METHOD_SIZE + SPAN_FILE_SIZE  # 248
+  SPAN_FILE_ARG_MAX    = SPAN_FILE_SIZE - 1
+
+  SPAN_RAISE_SLOT_SIZE     = 80
+  SPAN_RAISE_LINENO_OFFSET = SPAN_RAISE_SLOT_SIZE * 3        # 240
+  SPAN_RAISE_FILE_ARG_MAX  = SPAN_RAISE_SLOT_SIZE - 1
+
   SSL_WRITE_PAYLOAD_DATA_LEN_OFFSET = 0
   SSL_WRITE_PAYLOAD_CAP_LEN_OFFSET = 4
   SSL_WRITE_PAYLOAD_DATA_OFFSET = 8
@@ -149,6 +158,16 @@ module Vivarium
     str[0, nul]
   end
 
+  def self.tail_fit_string(value, max_bytes, marker: "...")
+    str = value.to_s.b
+    return str if str.bytesize <= max_bytes
+    return str.byteslice(-max_bytes, max_bytes) || "" if max_bytes <= marker.bytesize
+
+    tail_size = max_bytes - marker.bytesize
+    tail = str.byteslice(-tail_size, tail_size) || ""
+    "#{marker}#{tail}"
+  end
+
   def self.event_severity(event_name)
     EVENT_SEVERITY_HIGH.include?(event_name.to_s) ? "high" : "medium"
   end
@@ -1394,19 +1413,19 @@ module Vivarium
           return 0;
         }
 
-        u64 method_id = 0;
-        u64 file_id = 0;
-        u64 lineno = 0;
-        bpf_usdt_readarg(1, ctx, &method_id);
-        bpf_usdt_readarg(2, ctx, &file_id);
+        u64 method_str_ptr = 0;
+        u64 file_str_ptr = 0;
+        s64 lineno = 0;
+        bpf_usdt_readarg(1, ctx, &method_str_ptr);
+        bpf_usdt_readarg(2, ctx, &file_str_ptr);
         bpf_usdt_readarg(3, ctx, &lineno);
 
         struct event_t ev = {};
         ev.pid = pid;
         __builtin_memcpy(ev.event_name, "span_start", 11);
-        __builtin_memcpy(&ev.payload[0], &method_id, sizeof(method_id));
-        __builtin_memcpy(&ev.payload[8], &file_id, sizeof(file_id));
-        __builtin_memcpy(&ev.payload[16], &lineno, sizeof(lineno));
+        bpf_probe_read_user_str(&ev.payload[0], #{SPAN_METHOD_SIZE}, (void*)method_str_ptr);
+        bpf_probe_read_user_str(&ev.payload[#{SPAN_METHOD_SIZE}], #{SPAN_FILE_SIZE}, (void*)file_str_ptr);
+        __builtin_memcpy(&ev.payload[#{SPAN_LINENO_OFFSET}], &lineno, sizeof(lineno));
         submit_event(&ev);
         return 0;
       }
@@ -1421,19 +1440,19 @@ module Vivarium
           return 0;
         }
 
-        u64 method_id = 0;
-        u64 file_id = 0;
-        u64 lineno = 0;
-        bpf_usdt_readarg(1, ctx, &method_id);
-        bpf_usdt_readarg(2, ctx, &file_id);
+        u64 method_str_ptr = 0;
+        u64 file_str_ptr = 0;
+        s64 lineno = 0;
+        bpf_usdt_readarg(1, ctx, &method_str_ptr);
+        bpf_usdt_readarg(2, ctx, &file_str_ptr);
         bpf_usdt_readarg(3, ctx, &lineno);
 
         struct event_t ev = {};
         ev.pid = pid;
         __builtin_memcpy(ev.event_name, "span_stop", 10);
-        __builtin_memcpy(&ev.payload[0], &method_id, sizeof(method_id));
-        __builtin_memcpy(&ev.payload[8], &file_id, sizeof(file_id));
-        __builtin_memcpy(&ev.payload[16], &lineno, sizeof(lineno));
+        bpf_probe_read_user_str(&ev.payload[0], #{SPAN_METHOD_SIZE}, (void*)method_str_ptr);
+        bpf_probe_read_user_str(&ev.payload[#{SPAN_METHOD_SIZE}], #{SPAN_FILE_SIZE}, (void*)file_str_ptr);
+        __builtin_memcpy(&ev.payload[#{SPAN_LINENO_OFFSET}], &lineno, sizeof(lineno));
         submit_event(&ev);
         return 0;
       }
@@ -1510,22 +1529,22 @@ module Vivarium
           return 0;
         }
 
-        u64 error_id = 0;
-        u64 message_id = 0;
-        u64 file_id = 0;
-        u64 lineno = 0;
-        bpf_usdt_readarg(1, ctx, &error_id);
-        bpf_usdt_readarg(2, ctx, &message_id);
-        bpf_usdt_readarg(3, ctx, &file_id);
+        u64 error_str_ptr = 0;
+        u64 message_str_ptr = 0;
+        u64 file_str_ptr = 0;
+        s64 lineno = 0;
+        bpf_usdt_readarg(1, ctx, &error_str_ptr);
+        bpf_usdt_readarg(2, ctx, &message_str_ptr);
+        bpf_usdt_readarg(3, ctx, &file_str_ptr);
         bpf_usdt_readarg(4, ctx, &lineno);
 
         struct event_t ev = {};
         ev.pid = pid;
         __builtin_memcpy(ev.event_name, "span_raise", 11);
-        __builtin_memcpy(&ev.payload[0], &error_id, sizeof(error_id));
-        __builtin_memcpy(&ev.payload[8], &message_id, sizeof(message_id));
-        __builtin_memcpy(&ev.payload[16], &file_id, sizeof(file_id));
-        __builtin_memcpy(&ev.payload[24], &lineno, sizeof(lineno));
+        bpf_probe_read_user_str(&ev.payload[0], #{SPAN_RAISE_SLOT_SIZE}, (void*)error_str_ptr);
+        bpf_probe_read_user_str(&ev.payload[#{SPAN_RAISE_SLOT_SIZE}], #{SPAN_RAISE_SLOT_SIZE}, (void*)message_str_ptr);
+        bpf_probe_read_user_str(&ev.payload[#{SPAN_RAISE_SLOT_SIZE * 2}], #{SPAN_RAISE_SLOT_SIZE}, (void*)file_str_ptr);
+        __builtin_memcpy(&ev.payload[#{SPAN_RAISE_LINENO_OFFSET}], &lineno, sizeof(lineno));
         submit_event(&ev);
         return 0;
       }
@@ -1806,20 +1825,18 @@ module Vivarium
     pid = Process.pid
     store.register_pid(pid)
 
-    method_id_queue = Thread::Queue.new
     main_tid = gettid
 
     correlator = Correlator.new(
       pin_dir: pin_dir,
       observer_pid: pid,
       main_tid: main_tid,
-      method_id_queue: method_id_queue,
       filter: filter,
       dest: dest
     )
     correlator.start
 
-    tracer = build_observe_tracepoint(method_id_queue)
+    tracer = build_observe_tracepoint
     tracer.enable
 
     session = ObservationSession.new(
@@ -1836,20 +1853,18 @@ module Vivarium
     pid = Process.pid
     store.register_pid(pid)
 
-    method_id_queue = Thread::Queue.new
     main_tid = gettid
 
     correlator = Correlator.new(
       pin_dir: pin_dir,
       observer_pid: pid,
       main_tid: main_tid,
-      method_id_queue: method_id_queue,
       filter: filter,
       dest: dest
     )
     correlator.start
 
-    tracer = build_observe_tracepoint(method_id_queue)
+    tracer = build_observe_tracepoint
     tracer.enable
 
     yield
@@ -1859,20 +1874,19 @@ module Vivarium
     correlator&.stop
   end
 
-  def self.build_observe_tracepoint(method_id_queue)
+  def self.build_observe_tracepoint
     allow_classes = SPAN_ALLOWCLASSES
     allowlist = SPAN_ALLOWLIST
     TracePoint.new(:call, :c_call, :return, :c_return, :raise) do |tp|
       if tp.event == :raise
         # FIXME: handle threaded events in the future
-        if tp.raised_exception.kind_of?(ThreadError)
-          next
-        end
+        next if tp.raised_exception.kind_of?(ThreadError)
 
+        file_arg = tail_fit_string(tp.path, SPAN_RAISE_FILE_ARG_MAX)
         Vivarium::Usdt.raise(
           tp.raised_exception.class.to_s,
           tp.raised_exception.message.to_s,
-          file: tp.path,
+          file: file_arg,
           lineno: tp.lineno
         )
         next
@@ -1884,12 +1898,12 @@ module Vivarium
         allow_classes.any? { |klass| tp.defined_class == klass.singleton_class }
       next unless is_target
 
+      file_arg = tail_fit_string(tp.path, SPAN_FILE_ARG_MAX)
       case tp.event
       when :call, :c_call
-        method_id = Vivarium::Usdt.start(tp.defined_class.to_s, tp.method_id.to_s, file: tp.path, lineno: tp.lineno)
-        method_id_queue << [method_id, signature]
+        Vivarium::Usdt.start(tp.defined_class.to_s, tp.method_id.to_s, file: file_arg, lineno: tp.lineno)
       when :return, :c_return
-        Vivarium::Usdt.stop(tp.defined_class.to_s, tp.method_id.to_s, file: tp.path, lineno: tp.lineno)
+        Vivarium::Usdt.stop(tp.defined_class.to_s, tp.method_id.to_s, file: file_arg, lineno: tp.lineno)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vivarium
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Uchio Kondo
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement