Module: Rrtrace

Defined in:

lib/rrtrace.rb,
lib/rrtrace.rb,
lib/rrtrace/version.rb

Constant Summary

VERSION =

"0.2.0"

Class Method Summary

• .native_start(visualizer) ⇒ Object
• .native_started? ⇒ Boolean
• .native_stop ⇒ Object
• .start ⇒ Object
• .started? ⇒ Boolean
• .stop ⇒ Object
• .visualizer_path ⇒ Object

Class Method Details

.native_start(visualizer) ⇒ Object

# File 'ext/rrtrace/rrtrace.c', line 211

static VALUE rrtrace_native_start(VALUE self, VALUE visualizer) {
  TraceContext *context = &trace_context;
  VALUE visualizer_path = rb_str_dup(StringValue(visualizer));
  char *visualizer_path_cstr = StringValueCStr(visualizer_path);

  if (context->started) return Qfalse;

  atomic_store_explicit(&context->next_thread_id, 1, memory_order_relaxed);

  char shm_name[64];
  generate_shared_memory_name(shm_name, sizeof(shm_name));
  context->shared_memory = open_shared_memory(shm_name, sizeof(RRTraceEventRingBuffer));
  if (!shared_memory_opened(context->shared_memory)) {
    rb_raise(rb_eRuntimeError, "Failed to create shared memory for rrtrace");
    return Qfalse;
  }

  RRTraceEventRingBuffer *ringbuffer = shared_memory_ptr(&context->shared_memory);
  rrtrace_event_ringbuffer_init(ringbuffer);
  context->event_ringbuffer = ringbuffer;

#ifdef RRTRACE_WRITE_DEBUG_LOG
  fprintf(context->log, "Visualizer: %s\n", visualizer_path_cstr);
  fprintf(context->log, "Shared Memory: %s\n", shm_name);
#endif
  init_base_timestamp();
  process_id pid = spawn_process(visualizer_path_cstr, (char * const[]){visualizer_path_cstr, shm_name, NULL});
  if (pid == invalid_process_id()) {
    cleanup_context(context);
    rb_raise(rb_eRuntimeError, "Failed to spawn visualizer process");
    return Qfalse;
  }
  context->visualizer_process_id = pid;

  ThreadData *main_thread_data = malloc(sizeof(ThreadData));
  main_thread_data->thread_id = 0;
  VALUE thread = rb_thread_current();
  rb_internal_thread_specific_set(thread, context->thread_data_key, main_thread_data);

  context->trace_call = rb_tracepoint_new(RUBY_Qnil, RUBY_EVENT_CALL | RUBY_EVENT_C_CALL, tracepoint_call_handler, context);
  rb_gc_register_address(&context->trace_call);
  context->trace_return = rb_tracepoint_new(RUBY_Qnil, RUBY_EVENT_RETURN | RUBY_EVENT_C_RETURN, tracepoint_return_handler, context);
  rb_gc_register_address(&context->trace_return);
  context->trace_gc_start = rb_tracepoint_new(RUBY_Qnil, RUBY_INTERNAL_EVENT_GC_ENTER, tracepoint_gc_start_handler, context);
  rb_gc_register_address(&context->trace_gc_start);
  context->trace_gc_end = rb_tracepoint_new(RUBY_Qnil, RUBY_INTERNAL_EVENT_GC_EXIT, tracepoint_gc_end_handler, context);
  rb_gc_register_address(&context->trace_gc_end);
  context->thread_start_hook = rb_internal_thread_add_event_hook(thread_start_handler, RUBY_INTERNAL_THREAD_EVENT_STARTED, context);
  context->thread_ready_hook = rb_internal_thread_add_event_hook(thread_ready_handler, RUBY_INTERNAL_THREAD_EVENT_READY, context);
  context->thread_suspended_hook = rb_internal_thread_add_event_hook(thread_suspended_handler, RUBY_INTERNAL_THREAD_EVENT_SUSPENDED, context);
  context->thread_resume_hook = rb_internal_thread_add_event_hook(thread_resume_handler, RUBY_INTERNAL_THREAD_EVENT_RESUMED, context);
  context->thread_exit_hook = rb_internal_thread_add_event_hook(thread_exit_handler, RUBY_INTERNAL_THREAD_EVENT_EXITED, context);

  rb_tracepoint_enable(context->trace_call);
  rb_tracepoint_enable(context->trace_return);
  rb_tracepoint_enable(context->trace_gc_start);
  rb_tracepoint_enable(context->trace_gc_end);

  context->started = 1;
  return Qtrue;
}

.native_started? ⇒ Boolean

Returns:

• (Boolean)

# File 'ext/rrtrace/rrtrace.c', line 200

static VALUE rrtrace_native_started_p(VALUE self) {
  return trace_context.started ? Qtrue : Qfalse;
}

.native_stop ⇒ Object

# File 'ext/rrtrace/rrtrace.c', line 204

static VALUE rrtrace_native_stop(VALUE self) {
  if (!trace_context.started) return Qfalse;

  cleanup_context(&trace_context);
  return Qtrue;
}

.start ⇒ Object

# File 'lib/rrtrace.rb', line 13

def start
  native_start(visualizer_path)
end

.started? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/rrtrace.rb', line 21

def started?
  native_started?
end

.stop ⇒ Object

# File 'lib/rrtrace.rb', line 17

def stop
  native_stop
end

.visualizer_path ⇒ Object

# File 'lib/rrtrace.rb', line 9

def visualizer_path
  @visualizer_path ||= default_visualizer_path
end