wip

Author: zah

examples/selective_tracing.rb

@@ -1,13 +1,9 @@
 #!/usr/bin/env ruby
 
-# Load the native extension only if RubyRecorder is not already available
-# (e.g., when running directly without the codetracer wrapper)
-unless defined?(CodeTracerNativeRecorder)
-  ext_base = File.expand_path('../gems/codetracer-ruby-recorder/ext/native_tracer/target/release/libcodetracer_ruby_recorder', __dir__)
-  require ext_base
-end
+ext_base = File.expand_path('../gems/codetracer-ruby-recorder/ext/native_tracer/target/release/libcodetracer_ruby_recorder', __dir__)
+require ext_base
 
-recorder = CodeTracerNativeRecorder.new
+recorder = CodeTracer::RubyRecorder.new
 
 puts 'start trace'
 recorder.disable_tracing

examples/selective_tracing_pure.rb

@@ -1,18 +1,14 @@
 #!/usr/bin/env ruby
 
-# Load the pure Ruby tracer library if RubyRecorder is not already defined
-unless defined?(CodeTracerNativeRecorder)
-  lib_base = File.expand_path('../gems/codetracer-pure-ruby-recorder/lib/codetracer_pure_ruby_recorder', __dir__)
-  require lib_base
-end
+lib_base = File.expand_path('../gems/codetracer-pure-ruby-recorder/lib/codetracer_pure_ruby_recorder', __dir__)
+require lib_base
 
-recorder = CodeTracerNativeRecorder.new
+recorder = CodeTracer::PureRubyRecorder.new
 
 puts 'start trace'
-recorder.disable_tracing
+recorder.stop
 puts 'this will not be traced'
-recorder.enable_tracing
-puts 'this will be traced'
-recorder.disable_tracing
+recorder.start
+recorder.stop
 puts 'tracing disabled'
 recorder.flush_trace(Dir.pwd)

gems/codetracer-pure-ruby-recorder/bin/codetracer-pure-ruby-recorder

@@ -6,4 +6,4 @@ lib_dir = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'codetracer_pure_ruby_recorder'
 
-exit Codetracer::PureRubyRecorder.parse_argv_and_trace_ruby_file(ARGV)
+exit CodeTracer::PureRubyRecorder.parse_argv_and_trace_ruby_file(ARGV)

gems/codetracer-pure-ruby-recorder/lib/codetracer/kernel_patches.rb

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT
 
-module Codetracer
+module CodeTracer
   module KernelPatches
     @@tracers = []
 
@@ -53,11 +53,7 @@ def self.uninstall(tracer)
         Kernel.module_eval do
           alias_method :p, :codetracer_original_p
           alias_method :puts, :codetracer_original_puts
-          alias_method :print, :codetracer_original_print
-
-          remove_method :codetracer_original_p
-          remove_method :codetracer_original_puts
-          remove_method :codetracer_original_print
+          alias_method :print, :codetracer_oirginal_print
         end
       end
     end

gems/codetracer-pure-ruby-recorder/lib/codetracer_pure_ruby_recorder.rb

@@ -7,7 +7,7 @@
 require_relative 'recorder'
 require_relative 'codetracer/kernel_patches'
 
-module Codetracer
+module CodeTracer
   class PureRubyRecorder
     attr_accessor :calls_tracepoint, :return_tracepoint,
                   :line_tracepoint, :raise_tracepoint, :tracing
@@ -61,23 +61,13 @@ def self.trace_ruby_file(program, out_dir, program_args = [])
           Kernel.load(program)
         rescue Exception => e
           if tracer.debug
-            if Kernel.respond_to?(:codetracer_original_puts, true)
-              Kernel.codetracer_original_puts ''
-              Kernel.codetracer_original_puts '==== trace.rb error while tracing program ==='
-              Kernel.codetracer_original_puts 'ERROR'
-              Kernel.codetracer_original_puts e
-              Kernel.codetracer_original_puts e.backtrace
-              Kernel.codetracer_original_puts '====================='
-              Kernel.codetracer_original_puts ''
-            else
-              puts ''
-              puts '==== trace.rb error while tracing program ==='
-              puts 'ERROR'
-              puts e
-              puts e.backtrace
-              puts '====================='
-              puts ''
-            end
+            codetracer_original_puts ''
+            codetracer_original_puts '==== trace.rb error while tracing program ==='
+            codetracer_original_puts 'ERROR'
+            codetracer_original_puts e
+            codetracer_original_puts e.backtrace
+            codetracer_original_puts '====================='
+            codetracer_original_puts ''
           end
         ensure
           # Restore original ARGV
@@ -109,27 +99,27 @@ def ignore(path)
 
     def setup_tracepoints
       @calls_tracepoint = TracePoint.new(:call) do |tp|
-        deactivate
+        disable_tracepoints
         record_call(tp)
-        activate
+        enable_tracepoints
       end
 
       @return_tracepoint = TracePoint.new(:return) do |tp|
-        deactivate
+        disable_tracepoints
         record_return(tp)
-        activate
+        enable_tracepoints
       end
 
       @line_tracepoint = TracePoint.new(:line) do |tp|
-        deactivate
+        disable_tracepoints
         record_step(tp)
-        activate
+        enable_tracepoints
       end
 
       @raise_tracepoint = TracePoint.new(:raise) do |tp|
-        deactivate
+        disable_tracepoints
         record_exception(tp)
-        activate
+        enable_tracepoints
       end
     end
 
@@ -172,15 +162,10 @@ def record_call(tp)
         module_name = tp.self.class.name
         method_name_prefix = module_name == 'Object' ? '' :  "#{module_name}#"
         method_name = "#{method_name_prefix}#{tp.method_id}"
-
-        if @debug && Kernel.respond_to?(:codetracer_original_puts, true)
-          Kernel.codetracer_original_puts "call #{method_name} with #{tp.parameters}"
-        elsif @debug
-          puts "call #{method_name} with #{tp.parameters}"
+        if @debug
+          codetracer_original_puts "call #{method_name} with #{tp.parameters}"
         end
-
         arg_records = prepare_args(tp)
-
         @record.register_step(tp.path, tp.lineno)
         @record.register_call(tp.path, tp.lineno, method_name, arg_records)
       else
@@ -189,10 +174,8 @@ def record_call(tp)
 
     def record_return(tp)
       if self.tracks_call?(tp)
-        if @debug && Kernel.respond_to?(:codetracer_original_puts, true)
-          Kernel.codetracer_original_puts 'return'
-        elsif @debug
-          puts 'return'
+        if @debug
+          codetracer_original_puts 'return'
         end
         return_value = @record.to_value(tp.return_value)
         @record.register_step(tp.path, tp.lineno)
@@ -237,32 +220,24 @@ def record_exception(tp)
       @record.events << [:Event, RecordEvent.new(EVENT_KIND_ERROR, tp.raised_exception.to_s, "")]
     end
 
-    def activate
-      @calls_tracepoint.enable
-      @return_tracepoint.enable
-      @line_tracepoint.enable
-      @raise_tracepoint.enable
-      @tracing = true
-      ::Codetracer::KernelPatches.install(self)
+    def start
+      ::CodeTracer::KernelPatches.install(self)
+      enable_tracepoints
     end
 
-    def deactivate
-      ::Codetracer::KernelPatches.uninstall(self)
-      @tracing = false
-      @calls_tracepoint.disable
-      @return_tracepoint.disable
-      @line_tracepoint.disable
-      @raise_tracepoint.disable
+    def stop
+      disable_tracepoints
+      ::CodeTracer::KernelPatches.uninstall(self)
     end
 
     def trace_block(&block)
       raise ArgumentError, "no block given" unless block_given?
 
-      activate
+      start
       begin
         yield
       ensure
-        deactivate
+        stop
       end
     end
 
@@ -273,6 +248,26 @@ def flush_trace(out_dir)
 
     private
 
+    def enable_tracepoints
+      @calls_tracepoint.enable
+      @return_tracepoint.enable
+      @raise_tracepoint.enable
+      @tracing = true
+      # We intentionally enable the line tracepoint after the other tracepoints
+      # to avoid recording the initial activation call as a line event.
+      @line_tracepoint.enable
+    end
+
+    def disable_tracepoints
+      # We disable the line tracepoint first to avoid recording the deactivation
+      # call as a line event.
+      @line_tracepoint.disable
+      @calls_tracepoint.disable
+      @return_tracepoint.disable
+      @raise_tracepoint.disable
+      @tracing = false
+    end
+
     def load_variables(binding)
       if !binding.nil?
         # $stdout.write binding.local_variables

gems/codetracer-pure-ruby-recorder/lib/recorder.rb

@@ -362,6 +362,7 @@ def nil_value
   MAX_COUNT = 5000
 
   def to_value(v, depth=10)
+    codetracer_original_p v
     if depth <= 0
       return nil_value
     end
@@ -394,7 +395,7 @@ def to_value(v, depth=10)
         end)
       end
     when Hash
-      if v.count > MAX_COUNT
+      if true or v.count > MAX_COUNT
         not_supported_value
       else
         pairs = v.map do |k, val|

gems/codetracer-ruby-recorder/lib/codetracer/kernel_patches.rb

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT
 
-module Codetracer
+module CodeTracer
   module KernelPatches
     @@tracers = []
 
@@ -54,10 +54,6 @@ def self.uninstall(tracer)
           alias_method :p, :codetracer_original_p
           alias_method :puts, :codetracer_original_puts
           alias_method :print, :codetracer_original_print
-
-          remove_method :codetracer_original_p
-          remove_method :codetracer_original_puts
-          remove_method :codetracer_original_print
         end
       end
     end

gems/codetracer-ruby-recorder/lib/codetracer_ruby_recorder.rb

@@ -42,7 +42,7 @@ def self.trace_ruby_file(program, out_dir, program_args = [])
 
       ENV['CODETRACER_RUBY_RECORDER_OUT_DIR'] = out_dir
 
-      recorder.activate
+      recorder.start
       begin
         # Set ARGV to contain the program arguments
         original_argv = ARGV.dup
@@ -55,7 +55,7 @@ def self.trace_ruby_file(program, out_dir, program_args = [])
         ARGV.clear
         ARGV.concat(original_argv)
 
-        recorder.deactivate
+        recorder.stop
         recorder.flush_trace(out_dir)
       end
       0
@@ -72,20 +72,20 @@ def initialize
       load_native_recorder
     end
 
-    # Activate the recorder and install kernel patches
-    def activate
+    # Start the recorder and install kernel patches
+    def start
       return if @active || @recorder.nil?
 
       @recorder.enable_tracing
-      Codetracer::KernelPatches.install(self)
+      CodeTracer::KernelPatches.install(self)
       @active = true
     end
 
-    # Deactivate the recorder and remove kernel patches
-    def deactivate
+    # Stop the recorder and remove kernel patches
+    def stop
       return unless @active
 
-      Codetracer::KernelPatches.uninstall(self)
+      CodeTracer::KernelPatches.uninstall(self)
       @recorder.disable_tracing if @recorder
       @active = false
     end