ruby-static-tracing 0.0.2 → 0.0.3

data/lib/ruby-static-tracing/provider.rb

@@ -16,6 +16,22 @@ module StaticTracing
         end
       end
 
+      def enable!
+        providers.values.each do |provider|
+          provider.enable
+        end
+      end
+
+      def disable!
+        providers.values.each do |provider|
+          provider.disable
+        end
+      end
+
+      def clean
+        @providers = {}
+      end
+
       private
 
       def providers
@@ -26,7 +42,8 @@ module StaticTracing
     attr_reader :namespace
 
     def initialize(namespace)
-      if StaticTracing::Platform.linux?
+      if StaticTracing::Platform.linux? ||
+         StaticTracing::Platform.darwin?
         provider_initialize(namespace)
       else
         StaticTracing.issue_disabled_tracepoints_warning

data/lib/ruby-static-tracing/tracepoint.rb

@@ -3,7 +3,17 @@
 module StaticTracing
   class Tracepoint #:nodoc:
 
-    class InvalidArgumentError < StandardError; end
+    class InvalidArgumentError < StandardError
+      def initialize(argument, expected_type)
+        error_message = <<~ERROR_MESSAGE
+
+          We expected the fire arguments to match with the ones specified on the creation of the Tracepoint
+
+          You passed #{argument} => #{argument.class} and we expected the argument to be type #{expected_type}
+        ERROR_MESSAGE
+        super(error_message)
+      end
+    end
     class InvalidArgType < StandardError; end
 
     VALID_ARGS_TYPES = [Integer, String]
@@ -16,7 +26,8 @@ module StaticTracing
       validate_args(args)
       @args = args
 
-      if StaticTracing::Platform.linux?
+      if StaticTracing::Platform.linux? ||
+         StaticTracing::Platform.darwin?
         tracepoint_initialize(provider, name, args)
       else
         StaticTracing.issue_disabled_tracepoints_warning
@@ -25,8 +36,9 @@ module StaticTracing
 
     def fire(*values)
       values.each_with_index do |arg, i|
-        raise InvalidArgumentError unless arg.is_a?(args[i])
+        raise InvalidArgumentError.new(arg, args[i]) unless arg.is_a?(args[i])
       end
+      _fire_tracepoint(values)
     end
 
     def enabled?

data/lib/ruby-static-tracing/tracepoints.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module StaticTracing
+  class Tracepoints
+    class ProviderMissingError < StandardError; end
+    class TracepointMissingError < StandardError; end
+
+    class << self
+      def add(provider, name, data_types)
+        tracepoints[provider][name.to_s] ||= begin
+          StaticTracing::Tracepoint.new(provider, name.to_s, *data_types)
+        end
+      end
+
+      def get(provider, name)
+        tracepoints
+          .fetch(provider) { raise_error(ProviderMissingError) }
+          .fetch(name) { raise_error(TracepointMissingError) }
+      end
+
+      def clean
+        @tracepoints ||= Hash.new { |hash, key| hash[key] = {} }
+      end
+
+      private
+
+      def tracepoints
+        @tracepoints ||= Hash.new { |hash, key| hash[key] = {} }
+      end
+
+      def raise_error(error)
+        raise error
+      end
+    end
+  end
+end

data/lib/ruby-static-tracing/tracers.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative 'tracers/latency_tracer'
+require_relative 'tracers/stack_tracer'

data/lib/ruby-static-tracing/tracers/base.rb

@@ -0,0 +1,68 @@
+require 'unmixer'
+using Unmixer
+
+require 'ruby-static-tracing/tracers/helpers'
+
+module StaticTracing
+  module Tracers
+    class Base
+      class << self
+        include Tracers::Helpers
+
+        def register(klass, *method_names, provider: nil)
+          provider ||= underscore(klass.name)
+          method_overrides = function_wrapper.new(provider, @wrapping_function, @data_types)
+          modified_classes[klass] ||= method_overrides
+          modified_classes[klass].add_override(method_names.flatten)
+        end
+
+        def enable!
+          modified_classes.each do |klass, wrapped_methods|
+            klass.prepend(wrapped_methods)
+          end
+        end
+
+        def disable!
+          modified_classes.each do |klass, wrapped_methods|
+            klass.instance_eval { unprepend(wrapped_methods) }
+          end
+        end
+
+        private
+
+        def function_wrapper
+          Class.new(Module) do
+            def initialize(provider, wrapping_function, data_types)
+              @provider = provider
+              @wrapping_function = wrapping_function
+              @data_types = data_types
+            end
+
+            def add_override(methods)
+              methods.each do |method|
+                Tracepoints.add(@provider, method, @data_types)
+                define_method(method.to_s, @wrapping_function)
+              end
+            end
+          end
+        end
+
+        def modified_classes
+          @modified_classes ||= {}
+        end
+
+        def set_tracepoint_data_types(*args)
+          @data_types = *args
+        end
+
+        def tracepoint_data_types
+          @data_types
+        end
+
+        def set_wrapping_function(callable)
+          @wrapping_function = callable
+        end
+      end
+    end
+  end
+end

data/lib/ruby-static-tracing/tracers/helpers.rb

@@ -0,0 +1,17 @@
+module StaticTracing
+  module Tracers
+    module Helpers
+      extend self
+
+      def underscore(class_name)
+        class_name.gsub(/::/, '_').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+      end
+    end
+  end
+end
+
+

data/lib/ruby-static-tracing/tracers/latency_tracer.rb

@@ -1,67 +1,20 @@
 # frozen_string_literal: true
-require 'unmixer'
-
-using Unmixer
+require 'ruby-static-tracing/tracers/base'
 
 module StaticTracing
   module Tracers
-    class LatencyTracer
-      class LatencyModuleGenerator < Module
-        def initialize(provider, methods)
-          methods.each do |method|
-            define_method(method) do |*args, &block|
-              start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
-              result = super(*args, &block)
-              duration = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond) - start_time
-              LatencyTracer.fire_tracepoint(provider, method, duration)
-              result
-            end
-          end
-        end
-      end
-
-      class << self
-        def register(klass, method_names, provider: nil)
-          provider ||= underscore(klass.name)
-          latency_module = LatencyModuleGenerator.new(provider, Array(method_names))
-          modified_classes[klass] = latency_module
-        end
-
-        def enable!
-          modified_classes.each do |klass, latency_module|
-            klass.prepend latency_module
-          end
-        end
-
-        def disable!
-          modified_classes.each do |klass, latency_module|
-            klass.instance_eval { unprepend latency_module }
-          end
-        end
-
-        def fire_tracepoint(provider, name, duration)
-          return
-          tracepoint(provider, name).fire(name, duration)
-        end
-
-        private
-
-        def tracepoint(provider, name)
-          @tracepoints[name] ||= StaticTracing::Tracepoint.new(provider, name, String, Interger)
-        end
-
-        def modified_classes
-          @modified_classes ||= {}
-        end
-
-        def underscore(class_name)
-          class_name.gsub(/::/, '_').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
-          tr("-", "_").
-          downcase
-        end
-      end
+    class LatencyTracer < Base
+      set_wrapping_function -> (*args, &block) {
+        start_time = StaticTracing.nsec
+        result = super(*args, &block)
+        duration = StaticTracing.nsec - start_time
+        method_name = __method__.to_s
+        provider = Tracers::Helpers.underscore(self.class.name)
+        Tracepoints.get(provider, method_name).fire(method_name, duration)
+        result
+      }
+
+      set_tracepoint_data_types(String, Integer)
     end
   end
 end

data/lib/ruby-static-tracing/tracers/stack_tracer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'ruby-static-tracing/tracers/base'
+
+module StaticTracing
+  module Tracers
+    class StackTracer < Base
+      set_wrapping_function -> (*args, &block) {
+        current_stack = self.send(:caller).join("\n")
+        method_name = __method__.to_s
+        provider = Tracers::Helpers.underscore(self.class.name)
+        Tracepoints.get(provider, method_name).fire(method_name, current_stack)
+        super(*args, &block)
+      }
+
+      set_tracepoint_data_types(String, String)
+    end
+  end
+end

data/lib/ruby-static-tracing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StaticTracing
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-static-tracing
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dale Hamel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -85,30 +85,66 @@ description: "    A Ruby C extension that enables defining static tracepoints\n
 email: dale.hamel@srvthe.net
 executables: []
 extensions:
+- ext/ruby-static-tracing/lib/deps-extconf.rb
 - ext/ruby-static-tracing/extconf.rb
+- ext/ruby-static-tracing/lib/post-extconf.rb
 extra_rdoc_files: []
 files:
+- ext/ruby-static-tracing/darwin/provider.c
+- ext/ruby-static-tracing/darwin/provider.h
+- ext/ruby-static-tracing/darwin/ruby_static_tracing.c
+- ext/ruby-static-tracing/darwin/tracepoint.c
+- ext/ruby-static-tracing/darwin/tracepoint.h
 - ext/ruby-static-tracing/extconf.rb
+- ext/ruby-static-tracing/include/ruby_static_tracing.h
+- ext/ruby-static-tracing/lib/deps-extconf.rb
+- ext/ruby-static-tracing/lib/libstapsdt/example/demo.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/dynamic-symbols.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/dynamic-symbols.h
+- ext/ruby-static-tracing/lib/libstapsdt/src/errors.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/errors.h
+- ext/ruby-static-tracing/lib/libstapsdt/src/hash-table.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/hash-table.h
+- ext/ruby-static-tracing/lib/libstapsdt/src/libstapsdt.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/libstapsdt.h
+- ext/ruby-static-tracing/lib/libstapsdt/src/sdtnote.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/sdtnote.h
+- ext/ruby-static-tracing/lib/libstapsdt/src/section.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/section.h
+- ext/ruby-static-tracing/lib/libstapsdt/src/shared-lib.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/shared-lib.h
+- ext/ruby-static-tracing/lib/libstapsdt/src/string-table.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/string-table.h
+- ext/ruby-static-tracing/lib/libstapsdt/src/util.c
+- ext/ruby-static-tracing/lib/libstapsdt/src/util.h
+- ext/ruby-static-tracing/lib/libstapsdt/tests/test-errors.c
+- ext/ruby-static-tracing/lib/libstapsdt/tests/test-memory-leaks.c
+- ext/ruby-static-tracing/lib/post-extconf.rb
 - ext/ruby-static-tracing/linux/provider.c
 - ext/ruby-static-tracing/linux/provider.h
 - ext/ruby-static-tracing/linux/ruby_static_tracing.c
-- ext/ruby-static-tracing/linux/ruby_static_tracing.h
 - ext/ruby-static-tracing/linux/tracepoint.c
 - ext/ruby-static-tracing/linux/tracepoint.h
+- ext/ruby-static-tracing/linux/types.h
 - lib/ruby-static-tracing.rb
 - lib/ruby-static-tracing/configuration.rb
 - lib/ruby-static-tracing/platform.rb
 - lib/ruby-static-tracing/provider.rb
 - lib/ruby-static-tracing/tracepoint.rb
+- lib/ruby-static-tracing/tracepoints.rb
 - lib/ruby-static-tracing/tracers.rb
+- lib/ruby-static-tracing/tracers/base.rb
 - lib/ruby-static-tracing/tracers/concerns/latency_tracer.rb
+- lib/ruby-static-tracing/tracers/helpers.rb
 - lib/ruby-static-tracing/tracers/latency_tracer.rb
+- lib/ruby-static-tracing/tracers/stack_tracer.rb
 - lib/ruby-static-tracing/version.rb
 homepage: https://github.com/dalehamel/ruby-static-tracing
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n    WARNING: you will need a new kernel (4.14+) that supports
+  eBPF.\n\n    You should use the newest possible version of bpftrace\n    "
 rdoc_options: []
 require_paths:
 - lib
@@ -124,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: USDT tracing for Ruby