stack_trace 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a44fbab04e5a7a787dd995fbee5ea3e503080172df937a91e122728eb4884744
-  data.tar.gz: c004c70f42efc53e0776520d9e39a902346015eca012614913dd9a04e9822344
+  metadata.gz: 4cc75d5b0a32aff0307977f6f1acdeac454f9a082d09c4ccfb61423ed3539ebb
+  data.tar.gz: '0806e5e196396576aeeeb5c4c11f7cb4f20aac5064c765a59c8b8b5e07a4a13a'
 SHA512:
-  metadata.gz: aab482726e6436266555c91fbd51a0b44d8b5d0b6b0f3e72cd11448eaac96ea0d49582df77ab828cbbd38be93d177214cddb50a606ad8e899bb541179c43ed0f
-  data.tar.gz: 4e57a54efcb00a4a2701a5169130642be00fcd1aff13c4d508b0ac663f933fa5443eceffc78d74199d0fcf2ced21054559eabe85675ec2190b2f8ec768a02dc3
+  metadata.gz: a818593e2040840020a056673fb37a512c707ac9491334b776b9c1c8eea918136233d151982e0dbbd53f76b3ddf2141109c81fc693286ecd68654a33f7376ae7
+  data.tar.gz: 74116cca420c09db1fbf5c92c42e9536d32d64d22b42e1976e6c5ecff2f86ee562a797f81f7fa608eb44388c051496319c62a1a0dd084de4ceb9b1476bd3d910

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:3.0.6-alpine
+
+RUN apk update
+RUN apk add build-base git --virtual build-dependencies
+
+RUN mkdir /stack_trace
+WORKDIR /stack_trace
+
+ENV BUNDLE_PATH=/bundle \
+    BUNDLE_BIN=/bundle/bin \
+    GEM_HOME=/bundle
+ENV PATH="${BUNDLE_BIN}:${PATH}"
+
+COPY . ./
+
+RUN gem install bundler
+RUN bundle install --jobs 20 --retry 5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stack_trace (0.6.0)
+    stack_trace (0.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -25,6 +25,7 @@ GEM
     rspec-support (3.12.0)
 
 PLATFORMS
+  aarch64-linux-musl
   arm64-darwin-21
 
 DEPENDENCIES

data/Makefile

@@ -0,0 +1,12 @@
+usage:
+	@echo "Available targets:"
+	@echo "  * build - Builds image"
+	@echo "  * dev   - Opens an ash session in the container"
+
+.PHONY: build
+build:
+	docker build . -t stack_trace
+
+.PHONY: dev
+dev:
+	docker run -it --rm -v $(PWD):/stack_trace stack_trace sh

data/README.md

@@ -31,8 +31,13 @@ StackTrace.configure do |config|
   config.inspect_return_values = true # Default `false` for performance reasons
   config.inspect_arguments = true # Default `false` for performance reasons
 
-  config.check_proc = -> (klass_name, method_name) do # If you want to limit the tracing for a set of classes
-    klass_name == "Bar"
+  config.check_proc = -> (self_klass_name, defined_klass_name, method_name) do # If you want to limit the tracing for a set of classes
+    self_klass_name == "Bar"
+
+    # If you use autoload and resolve the constant by klass names
+    # it's really likelly that you get a segfault: https://bugs.ruby-lang.org/issues/18120.
+    # Preload all the constants before running the `StackTrace.trace` if you want to
+    # constantize klass names.
   end
 end
 ```

data/ext/stack_trace/argument.c

@@ -4,7 +4,7 @@ void free_arguments(Argument *arguments, int count) {
   int i;
 
   for(i = 0; i < count; i++) {
-    free(arguments[i].value);
+    if(arguments[i].value != NULL) free(arguments[i].value);
   }
 
   free(arguments);

data/ext/stack_trace/current_trace.c

@@ -22,6 +22,14 @@ VALUE rb_create_trace(VALUE _self) {
   Span *span = malloc(sizeof(Span));
   span->children_count = 0;
   span->caller = NULL;
+  span->receiver = NULL;
+  span->klass = NULL;
+  span->self_klass = NULL;
+  span->return_value = NULL;
+  span->arguments = NULL;
+  span->arguments_count = 0;
+  span->exception = NULL;
+  span->children_count = 0;
 
   current_trace = malloc(sizeof(Trace));
   current_trace->finished = false;

data/ext/stack_trace/event_producer.c

@@ -14,16 +14,23 @@ struct MemoS {
 };
 
 static void copy_str(char **target, VALUE string) {
-  *target = malloc(sizeof(char) * RSTRING_LEN(string) + 1);
+  const char *cstr = StringValueCStr(string);
+  size_t len = strlen(cstr);
 
-  memcpy(*target, RSTRING_PTR(string), RSTRING_LEN(string));
+  *target = malloc(sizeof(char) * (len + 1));
+
+  memcpy(*target, cstr, (len + 1));
 }
 
 static int extract_kv(VALUE key, VALUE value, VALUE data) {
   struct MemoS *memo = (struct MemoS *)data;
 
   memo->arguments[memo->i].key = key;
-  copy_str(&memo->arguments[memo->i].value, value);
+
+  VALUE value_klass = rb_obj_class(value);
+  VALUE value_st_name = st_name(value, value_klass);
+
+  if(value_st_name != Qundef) copy_str(&memo->arguments[memo->i].value, value_st_name);
 
   memo->i++;
 
@@ -107,9 +114,10 @@ void create_event(VALUE tp_val, void *_data) {
   if(RTEST(get_inspect_return_values()) &&
      (event.event == RUBY_EVENT_RETURN || event.event == RUBY_EVENT_C_RETURN || event.event == RUBY_EVENT_B_RETURN)) {
     VALUE return_value = rb_tracearg_return_value(trace_arg);
-    VALUE return_value_st_name = rb_funcall(return_value, rb_intern("st_name"), 0);
+    VALUE return_value_class = rb_obj_class(return_value);
+    VALUE return_value_st_name = st_name(return_value, return_value_class);
 
-    copy_str(&event.return_value, return_value_st_name);
+    if(return_value_st_name != Qundef) copy_str(&event.return_value, return_value_st_name);
   }
 
   produce_event(event);

data/ext/stack_trace/event_store.c

@@ -38,8 +38,6 @@ static void wait_free_space() {
 
 static int wait_event() {
   if(free_space == SIZE) {
-    rb_thread_check_ints(); // Otherwise the GC stucks!
-
     struct timespec ts;
     clock_gettime(CLOCK_REALTIME, &ts);
     ts.tv_nsec += TEN_MILLISECONDS;
@@ -80,7 +78,6 @@ static void event_consumed() {
   pthread_cond_signal(&has_space);
 }
 
-// Takes a callback function which populates the event information.
 void produce_event(Event event) {
   pthread_mutex_lock(&lock);
 
@@ -93,14 +90,15 @@ void produce_event(Event event) {
   pthread_mutex_unlock(&lock);
 }
 
-// Takes a callback function which consumes the event.
-void consume_event(void(*processor_func)(Event *event)) {
+void get_event(Event *target, int *status) {
   pthread_mutex_lock(&lock);
+  *status = 1;
 
   Event *event = pull_event();
 
   if(event != NULL) {
-    processor_func(event);
+    *status = 0;
+    memcpy(target, event, sizeof(Event));
 
     event_consumed();
   }

data/ext/stack_trace/event_store.h

@@ -2,4 +2,4 @@
 
 void Init_event_store();
 void produce_event(Event event);
-void consume_event(void(*func)(Event *event));
+void get_event(Event *target, int *status);

data/ext/stack_trace/sidecar.c

@@ -4,15 +4,22 @@
 
 #include "event_store.h"
 #include "trace.h"
+#include "types/event.h"
 
 static bool running = false;
 static VALUE ractor;
 
 static VALUE listen_events(VALUE data, VALUE m, int _argc, const VALUE *_argv, VALUE _) {
   running = true;
+  Event event;
+  int status;
 
   while(running) {
-    consume_event(&process_event);
+    get_event(&event, &status);
+
+    if(status == 0) process_event(&event);
+
+    rb_thread_check_ints();
   }
 
   return Qtrue;

data/ext/stack_trace/span.c

@@ -92,7 +92,8 @@ VALUE serialize_arguments(Argument *arguments, int count) {
   int i;
 
   for(i = 0; i < count; i++) {
-    rb_hash_aset(hash, arguments[i].key, rb_str_new_cstr(arguments[i].value));
+    if(arguments[i].value != NULL)
+      rb_hash_aset(hash, arguments[i].key, rb_str_new_cstr(arguments[i].value));
   }
 
   return hash;

data/ext/stack_trace/trace.c

@@ -32,7 +32,7 @@ void set_check_proc(VALUE proc) {
 static VALUE call_proc(VALUE val) {
   Event *event = (Event *)val;
 
-  return rb_funcall(check_proc, rb_intern("call"), 2, rb_str_new_cstr(event->self_klass), event->method);
+  return rb_funcall(check_proc, rb_intern("call"), 3, rb_str_new_cstr(event->self_klass), rb_str_new_cstr(event->klass), event->method);
 }
 
 static bool is_tracked_event(Event *event) {

data/ext/stack_trace/utils.c

@@ -1,4 +1,7 @@
+#define _POSIX_C_SOURCE 199309L
+
 #include <sys/time.h>
+#include <time.h>
 
 long int get_monotonic_m_secs() {
   struct timespec at;

data/lib/stack_trace/argument_extractor.rb

@@ -7,7 +7,7 @@ module StackTrace
         trace_point.parameters
                   .map(&:last)
                   .each_with_object({}) do |parameter, memo|
-                    memo[parameter] = extract_argument(trace_point, parameter).st_name
+                    memo[parameter] = extract_argument(trace_point, parameter)
                   end
       end
 

data/lib/stack_trace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StackTrace
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stack_trace
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mehmet Emin INAC
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies: []
 description: StackTrace
 email:
@@ -21,9 +21,11 @@ files:
 - ".rspec"
 - ".tool-versions"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - ext/stack_trace/argument.c