ruby-static-tracing 0.0.13 → 0.0.14

data/ext/ruby-static-tracing/darwin/tracepoint.h

@@ -8,14 +8,14 @@
 // FIXME move this to shared header
 typedef union {
   unsigned long long intval;
-  char *             strval;
+  char *strval;
 } Tracepoint_fire_arg;
 
 typedef struct {
   char *name;
   usdt_probedef_t *usdt_tracepoint_def;
-  usdt_probe_t    *usdt_tracepoint;
-  //Tracepoint_arg_types *args;
+  usdt_probe_t *usdt_tracepoint;
+  // Tracepoint_arg_types *args;
 } static_tracing_tracepoint_t;
 
 /*
@@ -49,4 +49,4 @@ tracepoint_enabled(VALUE self);
 VALUE
 static_tracing_tracepoint_alloc(VALUE klass);
 
-#endif //STATIC_TRACING_TRACEPOINT_H
+#endif // STATIC_TRACING_TRACEPOINT_H

data/ext/ruby-static-tracing/extconf.rb

@@ -1,83 +1,87 @@
-$LOAD_PATH.unshift File.expand_path("../../../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __dir__).freeze
 
 require 'mkmf'
 require 'ruby-static-tracing/platform'
 
-BASE_DIR=File.expand_path(File.dirname(__FILE__)) 
-LIB_DIR  = File.expand_path('../../../lib/ruby-static-tracing', __FILE__)
+BASE_DIR = __dir__
+LIB_DIR = File.expand_path('../../lib/ruby-static-tracing', __dir__)
 
-MKMF_TARGET='ruby-static-tracing/ruby_static_tracing'
+MKMF_TARGET = 'ruby-static-tracing/ruby_static_tracing'
 
 def platform_dir(platform)
   File.expand_path("../../../ext/ruby-static-tracing/#{platform}/", __FILE__)
 end
 
 def lib_dir
-  File.expand_path("../../../lib/ruby-static-tracing/", __FILE__)
+  File.expand_path('../../lib/ruby-static-tracing', __dir__)
 end
 #  - Linux, via libstapsdt
 if StaticTracing::Platform.linux?
 
-  LIB_DIRS = [LIB_DIR, RbConfig::CONFIG['libdir']]
+  LIB_DIRS = [LIB_DIR, RbConfig::CONFIG['libdir']].freeze
   HEADER_DIRS = [
-                 File.join(BASE_DIR, 'include'),
-                 File.join(BASE_DIR, 'lib', 'libstapsdt', 'src'),
-                 RbConfig::CONFIG['includedir']
-                ]
+    File.join(BASE_DIR, 'include'),
+    File.join(BASE_DIR, 'lib', 'libstapsdt', 'src'),
+    RbConfig::CONFIG['includedir']
+  ].freeze
 
+  puts HEADER_DIRS.inspect
   dir_config(MKMF_TARGET, HEADER_DIRS, LIB_DIRS)
 
   abort 'libstapsdt.h is missing, please install libstapsdt' unless find_header('libstapsdt.h')
   have_header 'libstapsdt.h'
+  have_header 'ruby_static_tracing.h'
 
   unless have_library('stapsdt')
-    abort "libstapsdt is missing, please install it"
+    abort 'libstapsdt is missing, please install it'
   end
 
-  $CFLAGS = "-D_GNU_SOURCE -Wall " # -Werror  complaining
-  if ENV.key?('DEBUG')
-    $CFLAGS << "-O0 -g -DDEBUG"
-  else
-    $CFLAGS << "-O3"
-  end
+  $CFLAGS = '-D_GNU_SOURCE -Wall ' # -Werror  complaining
+  $CFLAGS += if ENV.key?('DEBUG')
+               '-O0 -g -DDEBUG'
+             else
+               '-O3'
+             end
 
   $LDFLAGS += " -Wl,-rpath='\$\$ORIGIN/../ruby-static-tracing' "
 
-  create_makefile(MKMF_TARGET, platform_dir("linux"))
+  create_makefile(MKMF_TARGET, platform_dir('linux'))
 
 #  - Darwin/BSD and other dtrace platforms, via libusdt
 elsif StaticTracing::Platform.darwin?
-  abort 'dtrace is missing, this platform is not supported' unless have_library("dtrace", "dtrace_open")
+  abort 'dtrace is missing, this platform is not supported' unless have_library('dtrace', 'dtrace_open')
 
-  LIB_DIRS = [LIB_DIR, RbConfig::CONFIG['libdir']]
+  LIB_DIRS = [LIB_DIR, RbConfig::CONFIG['libdir']].freeze
   puts LIB_DIRS.inspect
   HEADER_DIRS = [
-                 File.join(BASE_DIR, 'include'),
-                 File.join(BASE_DIR, 'lib', 'libusdt'),
-                 RbConfig::CONFIG['includedir']
-                ]
+    File.join(BASE_DIR, 'include'),
+    File.join(BASE_DIR, 'lib', 'libusdt'),
+    RbConfig::CONFIG['includedir']
+  ].freeze
 
   dir_config(MKMF_TARGET, HEADER_DIRS, LIB_DIRS)
 
   have_header('usdt.h')
-  abort "ERROR: libusdt is required. It is included, so this failure is an error." unless have_library('usdt')
+  abort 'ERROR: libusdt is required. It is included, so this failure is an error.' unless have_library('usdt')
 
-  $CFLAGS = "-D_GNU_SOURCE -Wall " # -Werror  complaining
-  if ENV.key?('DEBUG')
-    $CFLAGS << "-O0 -g -DDEBUG"
-  else
-    $CFLAGS << "-O3"
-  end
+  $CFLAGS = '-D_GNU_SOURCE -Wall ' # -Werror  complaining
+  $CFLAGS << if ENV.key?('DEBUG')
+               '-O0 -g -DDEBUG'
+             else
+               '-O3'
+             end
 
   create_makefile(MKMF_TARGET, platform_dir('darwin'))
 else
   #  - Stub, for other platforms that support neither
   # for now, we will yolo stub this to leave room to handle platforms
   # that support properly support conventional dtrace
-  File.write "Makefile", <<MAKEFILE
-all:
-clean:
-install:
-MAKEFILE
+  File.write 'Makefile', <<~MAKEFILE
+    all:
+    clean:
+    install:
+  MAKEFILE
   exit
 end

data/ext/ruby-static-tracing/include/ruby_static_tracing.h

@@ -7,10 +7,11 @@ Implements Init_ruby_static_tracing, which is used as C/Ruby entrypoint.
 #define RUBY_STATIC_TRACING_H
 
 #include "ruby.h"
+
 #include "provider.h"
 #include "tracepoint.h"
 
 void Init_ruby_static_tracing();
 extern VALUE eUSDT, eInternal;
 
-#endif //RUBY_STATIC_TRACING_H
+#endif // RUBY_STATIC_TRACING_H

data/ext/ruby-static-tracing/lib/deps-extconf.rb

@@ -1,25 +1,27 @@
-$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)
 
 require 'mkmf'
 require 'ruby-static-tracing/platform'
 
-BASE_DIR = File.expand_path(File.dirname(__FILE__))
-LIB_DIR  = File.expand_path('../../../../lib/ruby-static-tracing', __FILE__)
+BASE_DIR = __dir__
+LIB_DIR  = File.expand_path('../../../lib/ruby-static-tracing', __dir__)
 
-# FIXME have this install libstapsdt
+# FIXME: have this install libstapsdt
 if StaticTracing::Platform.linux?
   # This is a bit of a hack to compile libstapsdt.so
   # and "trick" extconf into thinking it's just another .so
-  File.write "Makefile", <<MAKEFILE
-all:
-	cd #{File.join(BASE_DIR, 'libstapsdt')} && make CFLAGS_EXTRA=-DLIBSTAPSDT_MEMORY_BACKED_FD
-	touch deps.so # HACK
-	cp #{File.join(BASE_DIR, 'libstapsdt', 'out/libstapsdt.so.0')} #{LIB_DIR}
-	cd #{LIB_DIR} && ln -sf libstapsdt.so.0 libstapsdt.so
-clean:
-	cd #{File.join(BASE_DIR, 'libstapsdt')} && make clean
-install:
-MAKEFILE
+  File.write 'Makefile', <<~MAKEFILE
+    all:
+    	cd #{File.join(BASE_DIR, 'libstapsdt')} && make CFLAGS_EXTRA=-DLIBSTAPSDT_MEMORY_BACKED_FD
+    	touch deps.so # HACK
+    	cp #{File.join(BASE_DIR, 'libstapsdt', 'out/libstapsdt.so.0')} #{LIB_DIR}
+    	cd #{LIB_DIR} && ln -sf libstapsdt.so.0 libstapsdt.so
+    clean:
+    	cd #{File.join(BASE_DIR, 'libstapsdt')} && make clean
+    install:
+  MAKEFILE
   exit
 # We'll build libusdt and install and update linker info
 elsif StaticTracing::Platform.darwin?
@@ -27,22 +29,22 @@ elsif StaticTracing::Platform.darwin?
   # and "trick" extconf into thinking it's just another .bundle
   # After installing it (in post-extconf), we forcefully update the load path for
   # ruby_static_tracing.bundle to find it in the same directory
-  File.write "Makefile", <<MAKEFILE
-all:
-	cd #{File.join(BASE_DIR, 'libusdt')} && make libusdt.dylib
-	touch deps.bundle # HACK
-	cp #{File.join(BASE_DIR, 'libusdt', 'libusdt.dylib')} #{LIB_DIR}
-clean:
-	cd #{File.join(BASE_DIR, 'libusdt')} && make clean
-install:
-MAKEFILE
+  File.write 'Makefile', <<~MAKEFILE
+    all:
+    	cd #{File.join(BASE_DIR, 'libusdt')} && make libusdt.dylib
+    	touch deps.bundle # HACK
+    	cp #{File.join(BASE_DIR, 'libusdt', 'libusdt.dylib')} #{LIB_DIR}
+    clean:
+    	cd #{File.join(BASE_DIR, 'libusdt')} && make clean
+    install:
+  MAKEFILE
   exit
 else
   #  - Stub, for other platforms that we don't support, we write an empty makefile
-  File.write "Makefile", <<MAKEFILE
-all:
-clean:
-install:
-MAKEFILE
+  File.write 'Makefile', <<~MAKEFILE
+    all:
+    clean:
+    install:
+  MAKEFILE
   exit
 end

data/ext/ruby-static-tracing/lib/post-extconf.rb

@@ -1,37 +1,39 @@
-$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)
 
 require 'mkmf'
 require 'ruby-static-tracing/platform'
 
-BASE_DIR = File.expand_path(File.dirname(__FILE__))
-LIB_DIR  = File.expand_path('../../../../lib/ruby-static-tracing', __FILE__)
+BASE_DIR = __dir__
+LIB_DIR  = File.expand_path('../../../lib/ruby-static-tracing', __dir__)
 
 # Linux is a noop
 if StaticTracing::Platform.linux?
-  File.write "Makefile", <<MAKEFILE
-all:
-	touch post.so
-clean:
-install:
-MAKEFILE
+  File.write 'Makefile', <<~MAKEFILE
+    all:
+    	touch post.so
+    clean:
+    install:
+  MAKEFILE
   exit
 # We'll build libusdt and install and update linker info
 elsif StaticTracing::Platform.darwin?
   # This is done to ensure that the bundle will look in its local directory for the library
-  File.write "Makefile", <<MAKEFILE
-all:
-	touch post.bundle
-	install_name_tool -change libusdt.dylib @loader_path/../ruby-static-tracing/libusdt.dylib #{File.join(LIB_DIR, 'ruby_static_tracing.bundle')}
-clean:
-install:
-MAKEFILE
+  File.write 'Makefile', <<~MAKEFILE
+    all:
+    	touch post.bundle
+    	install_name_tool -change libusdt.dylib @loader_path/../ruby-static-tracing/libusdt.dylib #{File.join(LIB_DIR, 'ruby_static_tracing.bundle')}
+    clean:
+    install:
+  MAKEFILE
   exit
 else
   #  - Stub, for other platforms that we don't support, we write an empty makefile
-  File.write "Makefile", <<MAKEFILE
-all:
-clean:
-install:
-MAKEFILE
+  File.write 'Makefile', <<~MAKEFILE
+    all:
+    clean:
+    install:
+  MAKEFILE
   exit
 end

data/ext/ruby-static-tracing/linux/provider.c

@@ -1,18 +1,17 @@
 #include "provider.h"
 
-static const rb_data_type_t
-static_tracing_provider_type;
+#include <string.h>
+
+static const rb_data_type_t static_tracing_provider_type;
 
 // Forward decls
-static const char*
-check_name_arg(VALUE name);
+static const char *check_name_arg(VALUE name);
 
 /*
   Wraps ProviderInit from libstapsdt
 */
 VALUE
-provider_initialize(VALUE self, VALUE name)
-{
+provider_initialize(VALUE self, VALUE name) {
   const char *c_name_str = NULL;
   static_tracing_provider_t *res = NULL;
 
@@ -20,30 +19,51 @@ provider_initialize(VALUE self, VALUE name)
   c_name_str = check_name_arg(name);
 
   // Build provider structure
-  TypedData_Get_Struct(self, static_tracing_provider_t, &static_tracing_provider_type, res);
+  TypedData_Get_Struct(self, static_tracing_provider_t,
+                       &static_tracing_provider_type, res);
   res->sdt_provider = providerInit(c_name_str);
   return self;
 }
 
 // Internal function used to register a tracepoint against a provider instance
-SDTProbe_t
-*provider_add_tracepoint_internal(VALUE self, const char* name, int argc, Tracepoint_arg_types *args)
-{
+SDTProbe_t *provider_add_tracepoint_internal(VALUE self, const char *name,
+                                             int argc,
+                                             Tracepoint_arg_types *args) {
   static_tracing_provider_t *res = NULL;
   SDTProbe_t *probe;
 
-  TypedData_Get_Struct(self, static_tracing_provider_t, &static_tracing_provider_type, res);
-
-  switch(argc)
-  {
-    case 0: probe = providerAddProbe(res->sdt_provider, name, 0); break;
-    case 1: probe = providerAddProbe(res->sdt_provider, name, argc, args[0]); break;
-    case 2: probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1]); break;
-    case 3: probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1], args[2]); break;
-    case 4: probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1], args[2], args[3]); break;
-    case 5: probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1], args[2], args[3], args[4]); break;
-    case 6: probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1], args[2], args[3], args[4], args[5]); break;
-    default: probe = providerAddProbe(res->sdt_provider, name, 0); break;
+  TypedData_Get_Struct(self, static_tracing_provider_t,
+                       &static_tracing_provider_type, res);
+
+  switch (argc) {
+  case 0:
+    probe = providerAddProbe(res->sdt_provider, name, 0);
+    break;
+  case 1:
+    probe = providerAddProbe(res->sdt_provider, name, argc, args[0]);
+    break;
+  case 2:
+    probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1]);
+    break;
+  case 3:
+    probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1],
+                             args[2]);
+    break;
+  case 4:
+    probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1],
+                             args[2], args[3]);
+    break;
+  case 5:
+    probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1],
+                             args[2], args[3], args[4]);
+    break;
+  case 6:
+    probe = providerAddProbe(res->sdt_provider, name, argc, args[0], args[1],
+                             args[2], args[3], args[4], args[5]);
+    break;
+  default:
+    probe = providerAddProbe(res->sdt_provider, name, 0);
+    break;
   }
 
   return probe;
@@ -53,10 +73,10 @@ SDTProbe_t
   Wraps providerLoad from libstapsdt
 */
 VALUE
-provider_enable(VALUE self)
-{
+provider_enable(VALUE self) {
   static_tracing_provider_t *res = NULL;
-  TypedData_Get_Struct(self, static_tracing_provider_t, &static_tracing_provider_type, res);
+  TypedData_Get_Struct(self, static_tracing_provider_t,
+                       &static_tracing_provider_type, res);
   return providerLoad(res->sdt_provider) == 0 ? Qtrue : Qfalse;
 }
 
@@ -64,38 +84,54 @@ provider_enable(VALUE self)
   Wraps providerUnload from libstapsdt
 */
 VALUE
-provider_disable(VALUE self)
-{
+provider_disable(VALUE self) {
   static_tracing_provider_t *res = NULL;
-  TypedData_Get_Struct(self, static_tracing_provider_t, &static_tracing_provider_type, res);
+  TypedData_Get_Struct(self, static_tracing_provider_t,
+                       &static_tracing_provider_type, res);
+  res->sdt_provider->_filename = NULL; // FIXME upstream should do this
   return providerUnload(res->sdt_provider) == 0 ? Qtrue : Qfalse;
 }
 
 /*
-  Wraps providerUnload from libstapsdt
+  Wraps providerDestroy from libstapsdt
 */
 VALUE
-provider_destroy(VALUE self)
-{
+provider_destroy(VALUE self) {
   static_tracing_provider_t *res = NULL;
-  TypedData_Get_Struct(self, static_tracing_provider_t, &static_tracing_provider_type, res);
+  TypedData_Get_Struct(self, static_tracing_provider_t,
+                       &static_tracing_provider_type, res);
   providerDestroy(res->sdt_provider);
   return Qnil;
 }
 
+VALUE
+provider_path(VALUE self) {
+  VALUE path;
+  char *_path;
+  static_tracing_provider_t *res = NULL;
+  TypedData_Get_Struct(self, static_tracing_provider_t,
+                       &static_tracing_provider_type, res);
+
+  if (res != NULL && res->sdt_provider != NULL &&
+      res->sdt_provider->_filename != NULL) {
+    _path = res->sdt_provider->_filename;
+    path = strlen(_path) > 0 ? rb_str_new_cstr(_path) : rb_str_new_cstr("");
+  } else {
+    path = rb_str_new_cstr("");
+  }
+  return path;
+}
+
 // Allocate a static_tracing_provider_type struct for ruby memory management
 VALUE
-static_tracing_provider_alloc(VALUE klass)
-{
+static_tracing_provider_alloc(VALUE klass) {
   static_tracing_provider_t *res;
-  VALUE obj = TypedData_Make_Struct(klass, static_tracing_provider_t, &static_tracing_provider_type, res);
+  VALUE obj = TypedData_Make_Struct(klass, static_tracing_provider_t,
+                                    &static_tracing_provider_type, res);
   return obj;
 }
 
-
-static const char*
-check_name_arg(VALUE name)
-{
+static const char *check_name_arg(VALUE name) {
   const char *c_name_str = NULL;
 
   if (TYPE(name) != T_SYMBOL && TYPE(name) != T_STRING) {
@@ -110,36 +146,26 @@ check_name_arg(VALUE name)
   return c_name_str;
 }
 
-static inline void
-static_tracing_provider_mark(void *ptr)
-{
-  /* noop */
+static inline void static_tracing_provider_mark(void *ptr) { /* noop */
 }
 
-static inline void
-static_tracing_provider_free(void *ptr)
-{
-  static_tracing_provider_t *res = (static_tracing_provider_t *) ptr;
-  //if (res->name) {
+static inline void static_tracing_provider_free(void *ptr) {
+  static_tracing_provider_t *res = (static_tracing_provider_t *)ptr;
+  // if (res->name) {
   //  free(res->name);
   //  res->name = NULL;
   //}
   xfree(res);
 }
 
-static inline size_t
-static_tracing_provider_memsize(const void *ptr)
-{
+static inline size_t static_tracing_provider_memsize(const void *ptr) {
   return sizeof(static_tracing_provider_t);
 }
 
-static const rb_data_type_t
-static_tracing_provider_type = {
-  "static_tracing_provider",
-  {
-    static_tracing_provider_mark,
-    static_tracing_provider_free,
-    static_tracing_provider_memsize
-  },
-  NULL, NULL, RUBY_TYPED_FREE_IMMEDIATELY
-};
+static const rb_data_type_t static_tracing_provider_type = {
+    "static_tracing_provider",
+    {static_tracing_provider_mark, static_tracing_provider_free,
+     static_tracing_provider_memsize},
+    NULL,
+    NULL,
+    RUBY_TYPED_FREE_IMMEDIATELY};