ruby-prof 1.0.0

data/ext/ruby_prof/rp_profile.h

@@ -0,0 +1,36 @@
+/* Copyright (C) 2005-2019 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
+   Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RP_PROFILE_H__
+#define __RP_PROFILE_H__
+
+#include "ruby_prof.h"
+#include "rp_measurement.h"
+#include "rp_thread.h"
+
+extern VALUE cProfile;
+
+typedef struct
+{
+    VALUE running;
+    VALUE paused;
+
+    prof_measurer_t* measurer;
+    VALUE threads;
+
+    VALUE tracepoints;
+
+    st_table* threads_tbl;
+    st_table* exclude_threads_tbl;
+    st_table* include_threads_tbl;
+    st_table* exclude_methods_tbl;
+    thread_data_t* last_thread_data;
+    double measurement_at_pause_resume;
+    bool allow_exceptions;
+} prof_profile_t;
+
+void rp_init_profile(void);
+prof_profile_t* prof_get_profile(VALUE self);
+
+
+#endif //__RP_PROFILE_H__

data/ext/ruby_prof/rp_stack.c

@@ -0,0 +1,196 @@
+/* Copyright (C) 2005-2019 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
+   Please see the LICENSE file for copyright and distribution information */
+
+#include "rp_stack.h"
+
+#define INITIAL_STACK_SIZE 32
+
+void
+prof_frame_pause(prof_frame_t *frame, double current_measurement)
+{
+    if (frame && prof_frame_is_unpaused(frame))
+        frame->pause_time = current_measurement;
+}
+
+void
+prof_frame_unpause(prof_frame_t *frame, double current_measurement)
+{
+    if (frame && prof_frame_is_paused(frame))
+    {
+        frame->dead_time += (current_measurement - frame->pause_time);
+        frame->pause_time = -1;
+    }
+}
+
+/* Creates a stack of prof_frame_t to keep track
+   of timings for active methods. */
+prof_stack_t *
+prof_stack_create()
+{
+    prof_stack_t *stack = ALLOC(prof_stack_t);
+    stack->start = ZALLOC_N(prof_frame_t, INITIAL_STACK_SIZE);
+    stack->ptr = stack->start;
+    stack->end = stack->start + INITIAL_STACK_SIZE;
+
+    return stack;
+}
+
+void
+prof_stack_free(prof_stack_t *stack)
+{
+    xfree(stack->start);
+    xfree(stack);
+}
+
+prof_frame_t *
+prof_stack_push(prof_stack_t *stack, prof_call_info_t *call_info, double measurement, int paused)
+{
+    prof_frame_t *result;
+    prof_frame_t* parent_frame;
+
+    /* Is there space on the stack?  If not, double
+     its size. */
+    if (stack->ptr == stack->end - 1)
+    {
+        size_t len = stack->ptr - stack->start;
+        size_t new_capacity = (stack->end - stack->start) * 2;
+        REALLOC_N(stack->start, prof_frame_t, new_capacity);
+
+        /* Memory just got moved, reset pointers */
+        stack->ptr = stack->start + len;
+        stack->end = stack->start + new_capacity;
+    }
+
+    parent_frame = stack->ptr;
+    stack->ptr++;
+
+    result = stack->ptr;
+    result->call_info = call_info;
+    result->call_info->depth = (int)(stack->ptr - stack->start); // shortening of 64 bit into 32;
+    result->passes = 0;
+
+    result->start_time = measurement;
+    result->pause_time = -1; // init as not paused.
+    result->switch_time = 0;
+    result->wait_time = 0;
+    result->child_time = 0;
+    result->dead_time = 0;
+    result->source_file = Qnil;
+    result->source_line = 0;
+
+    call_info->measurement->called++;
+    call_info->visits++;
+
+    if (call_info->method->visits > 0)
+    {
+        call_info->method->recursive = true;
+    }
+    call_info->method->measurement->called++;
+    call_info->method->visits++;
+
+    // Unpause the parent frame, if it exists.
+    // If currently paused then:
+    //   1) The child frame will begin paused.
+    //   2) The parent will inherit the child's dead time.
+    prof_frame_unpause(parent_frame, measurement);
+
+    if (paused)
+    {
+        prof_frame_pause(result, measurement);
+    }
+
+    // Return the result
+    return result;
+}
+
+prof_frame_t *
+prof_stack_pop(prof_stack_t *stack, double measurement)
+{
+  prof_frame_t *frame;
+  prof_frame_t *parent_frame;
+  prof_call_info_t *call_info;
+
+  double total_time;
+  double self_time;
+
+  if (stack->ptr == stack->start)
+      return NULL;
+
+  frame = stack->ptr;
+
+  /* Match passes until we reach the frame itself. */
+  if (prof_frame_is_pass(frame))
+  {
+    frame->passes--;
+    /* Additional frames can be consumed. See pop_frames(). */
+    return frame;
+  }
+
+  /* Consume this frame. */
+  stack->ptr--;
+
+  parent_frame = stack->ptr;
+
+  /* Calculate the total time this method took */
+  prof_frame_unpause(frame, measurement);
+  
+  total_time = measurement - frame->start_time - frame->dead_time;
+  self_time = total_time - frame->child_time - frame->wait_time;
+
+  /* Update information about the current method */
+  call_info = frame->call_info;
+
+  // Update method measurement
+  call_info->method->measurement->self_time += self_time;
+  call_info->method->measurement->wait_time += frame->wait_time;
+  if (call_info->method->visits == 1)
+    call_info->method->measurement->total_time += total_time;
+
+  call_info->method->visits--;
+
+  // Update method measurement
+  call_info->measurement->self_time += self_time;
+  call_info->measurement->wait_time += frame->wait_time;
+  if (call_info->visits == 1)
+      call_info->measurement->total_time += total_time;
+
+  call_info->visits--;
+
+  if (parent_frame)
+  {
+      parent_frame->child_time += total_time;
+      parent_frame->dead_time += frame->dead_time;
+  }
+
+  return frame;
+}
+
+prof_frame_t *
+prof_stack_pass(prof_stack_t *stack)
+{
+    prof_frame_t* frame = stack->ptr;
+    if (frame)
+    {
+        frame->passes++;
+    }
+    return frame;
+}
+
+prof_method_t*
+prof_find_method(prof_stack_t* stack, VALUE source_file, int source_line)
+{
+    prof_frame_t* frame = stack->ptr;
+    while (frame >= stack->start)
+    {
+        if (!frame->call_info)
+            return NULL;
+
+        if (rb_str_equal(source_file, frame->call_info->method->source_file) &&
+            source_line >= frame->call_info->method->source_line)
+        {
+            return frame->call_info->method;
+        }
+        frame--;
+    }
+    return NULL;
+}

data/ext/ruby_prof/rp_stack.h

@@ -0,0 +1,56 @@
+/* Copyright (C) 2005-2019 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
+   Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RP_STACK__
+#define __RP_STACK__
+
+#include "ruby_prof.h"
+#include "rp_call_info.h"
+
+/* Temporary object that maintains profiling information
+   for active methods.  They are created and destroyed
+   as the program moves up and down its stack. */
+typedef struct
+{
+    /* Caching prof_method_t values significantly
+       increases performance. */
+    prof_call_info_t *call_info;
+
+    VALUE source_file;
+    unsigned int source_line;
+    unsigned int passes; /* Count of "pass" frames, _after_ this one. */
+
+    double start_time;
+    double switch_time;  /* Time at switch to different thread */
+    double wait_time;
+    double child_time;
+    double pause_time; // Time pause() was initiated
+    double dead_time; // Time to ignore (i.e. total amount of time between pause/resume blocks)
+} prof_frame_t;
+
+#define prof_frame_is_real(f) ((f)->passes == 0)
+#define prof_frame_is_pass(f) ((f)->passes > 0)
+
+#define prof_frame_is_paused(f) (f->pause_time >= 0)
+#define prof_frame_is_unpaused(f) (f->pause_time < 0)
+
+void prof_frame_pause(prof_frame_t*, double current_measurement);
+void prof_frame_unpause(prof_frame_t*, double current_measurement);
+
+/* Current stack of active methods.*/
+typedef struct
+{
+    prof_frame_t *start;
+    prof_frame_t *end;
+    prof_frame_t *ptr;
+} prof_stack_t;
+
+prof_stack_t *prof_stack_create(void);
+void prof_stack_free(prof_stack_t *stack);
+
+prof_frame_t *prof_stack_push(prof_stack_t *stack, prof_call_info_t *call_info, double measurement, int paused);
+prof_frame_t *prof_stack_pop(prof_stack_t *stack, double measurement);
+prof_frame_t *prof_stack_pass(prof_stack_t *stack);
+prof_method_t *prof_find_method(prof_stack_t* stack, VALUE source_file, int source_line);
+
+#endif //__RP_STACK__

data/ext/ruby_prof/rp_thread.c

@@ -0,0 +1,338 @@
+/* Copyright (C) 2005-2013 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
+   Please see the LICENSE file for copyright and distribution information */
+
+/* Document-class: RubyProf::Thread
+
+The Thread class contains profile results for a single fiber (note a Ruby thread can run multiple fibers).
+You cannot create an instance of RubyProf::Thread, instead you access it from a RubyProf::Profile object.
+
+  profile = RubyProf::Profile.profile do
+              ...
+            end
+
+  profile.threads.each do |thread|
+    thread.root_methods.sort.each do |method|
+      puts method.total_time
+    end
+  end
+*/
+
+#include "rp_thread.h"
+#include "rp_profile.h"
+
+VALUE cRpThread;
+
+/* ======   thread_data_t  ====== */
+thread_data_t*
+thread_data_create(void)
+{
+    thread_data_t* result = ALLOC(thread_data_t);
+    result->stack = prof_stack_create();
+    result->method_table = method_table_create();
+    result->object = Qnil;
+    result->methods = Qnil;
+    result->fiber_id = Qnil;
+    result->thread_id = Qnil;
+    result->trace = true;
+    result->fiber = Qnil;
+    return result;
+}
+
+static void
+prof_thread_free(thread_data_t* thread_data)
+{
+    method_table_free(thread_data->method_table);
+    prof_stack_free(thread_data->stack);
+
+    xfree(thread_data);
+}
+
+static int
+mark_methods(st_data_t key, st_data_t value, st_data_t result)
+{
+    prof_method_t *method = (prof_method_t *) value;
+    prof_method_mark(method);
+    return ST_CONTINUE;
+}
+
+size_t
+prof_thread_size(const void *data)
+{
+    return sizeof(prof_call_info_t);
+}
+
+void
+prof_thread_mark(void *data)
+{
+    thread_data_t *thread = (thread_data_t*)data;
+    
+    if (thread->object != Qnil)
+        rb_gc_mark(thread->object);
+    
+    if (thread->methods != Qnil)
+        rb_gc_mark(thread->methods);
+    
+    if (thread->fiber_id != Qnil)
+        rb_gc_mark(thread->fiber_id);
+    
+    if (thread->thread_id != Qnil)
+        rb_gc_mark(thread->thread_id);
+    
+    st_foreach(thread->method_table, mark_methods, 0);
+}
+
+static const rb_data_type_t thread_type =
+{
+    .wrap_struct_name = "ThreadInfo",
+    .function =
+    {
+        .dmark = prof_thread_mark,
+        .dfree = NULL, /* The profile class frees its thread table which frees each underlying thread_data instance */
+        .dsize = prof_thread_size,
+    },
+    .data = NULL,
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+VALUE
+prof_thread_wrap(thread_data_t *thread)
+{
+    if (thread->object == Qnil)
+    {
+        thread->object = TypedData_Wrap_Struct(cRpThread, &thread_type, thread);
+    }
+    return thread->object;
+}
+
+static VALUE
+prof_thread_allocate(VALUE klass)
+{
+    thread_data_t* thread_data = thread_data_create();
+    thread_data->object = prof_thread_wrap(thread_data);
+    return thread_data->object;
+}
+
+static thread_data_t*
+prof_get_thread(VALUE self)
+{
+    /* Can't use Data_Get_Struct because that triggers the event hook
+       ending up in endless recursion. */
+    thread_data_t* result = DATA_PTR(self);
+    if (!result)
+        rb_raise(rb_eRuntimeError, "This RubyProf::Thread instance has already been freed, likely because its profile has been freed.");
+
+    return result;
+}
+
+/* ======   Thread Table  ====== */
+/* The thread table is hash keyed on ruby thread_id that stores instances
+   of thread_data_t. */
+
+st_table *
+threads_table_create()
+{
+    return st_init_numtable();
+}
+
+static int
+thread_table_free_iterator(st_data_t key, st_data_t value, st_data_t dummy)
+{
+    prof_thread_free((thread_data_t*)value);
+    return ST_CONTINUE;
+}
+
+void
+threads_table_free(st_table *table)
+{
+    st_foreach(table, thread_table_free_iterator, 0);
+    st_free_table(table);
+}
+
+thread_data_t *
+threads_table_lookup(void *prof, VALUE fiber)
+{
+    prof_profile_t *profile = prof;
+    thread_data_t* result = NULL;
+    st_data_t val;
+
+    if (st_lookup(profile->threads_tbl, fiber, &val))
+    {
+        result = (thread_data_t*)val;
+    }
+
+    return result;
+}
+
+thread_data_t*
+threads_table_insert(void *prof, VALUE fiber)
+{
+    prof_profile_t *profile = prof;
+    thread_data_t *result = thread_data_create();
+    VALUE thread = rb_thread_current();
+
+    result->fiber = fiber;
+    result->fiber_id = rb_obj_id(fiber);
+    result->thread_id = rb_obj_id(thread);
+    st_insert(profile->threads_tbl, (st_data_t)fiber, (st_data_t)result);
+
+    // Are we tracing this thread?
+    if (profile->include_threads_tbl && !st_lookup(profile->include_threads_tbl, thread, 0))
+    {
+        result->trace= false;
+    }
+    else if (profile->exclude_threads_tbl && st_lookup(profile->exclude_threads_tbl, thread, 0))
+    {
+        result->trace = false;
+    }
+    else
+    {
+        result->trace = true;
+    }
+    
+    return result;
+}
+
+void
+switch_thread(void *prof, thread_data_t *thread_data, double measurement)
+{
+    prof_profile_t *profile = prof;
+
+    /* Get current frame for this thread */
+    prof_frame_t* frame = thread_data->stack->ptr;
+    frame->wait_time += measurement - frame->switch_time;
+    frame->switch_time = measurement;
+ 
+    /* Save on the last thread the time of the context switch
+       and reset this thread's last context switch to 0.*/
+    if (profile->last_thread_data)
+    {
+        prof_frame_t* last_frame = profile->last_thread_data->stack->ptr;
+        if (last_frame)
+            last_frame->switch_time = measurement;
+    }
+
+    profile->last_thread_data = thread_data;
+}
+
+int pause_thread(st_data_t key, st_data_t value, st_data_t data)
+{
+    thread_data_t* thread_data = (thread_data_t *) value;
+    prof_profile_t* profile = (prof_profile_t*)data;
+
+    prof_frame_t* frame = thread_data->stack->ptr;
+    prof_frame_pause(frame, profile->measurement_at_pause_resume);
+
+    return ST_CONTINUE;
+}
+
+int unpause_thread(st_data_t key, st_data_t value, st_data_t data)
+{
+    thread_data_t* thread_data = (thread_data_t *) value;
+    prof_profile_t* profile = (prof_profile_t*)data;
+
+    prof_frame_t* frame = thread_data->stack->ptr;
+    prof_frame_unpause(frame, profile->measurement_at_pause_resume);
+
+    return ST_CONTINUE;
+}
+
+static int
+collect_methods(st_data_t key, st_data_t value, st_data_t result)
+{
+    /* Called for each method stored in a thread's method table.
+       We want to store the method info information into an array.*/
+    VALUE methods = (VALUE) result;
+    prof_method_t *method = (prof_method_t *) value;
+
+    if (!method->excluded)
+    {
+      rb_ary_push(methods, prof_method_wrap(method));
+    }
+
+    return ST_CONTINUE;
+}
+
+/* call-seq:
+   id -> number
+
+Returns the thread id of this thread. */
+static VALUE
+prof_thread_id(VALUE self)
+{
+    thread_data_t* thread = prof_get_thread(self);
+    return thread->thread_id;
+}
+
+/* call-seq:
+   fiber_id -> number
+
+Returns the fiber id of this thread. */
+static VALUE
+prof_fiber_id(VALUE self)
+{
+    thread_data_t* thread = prof_get_thread(self);
+    return thread->fiber_id;
+}
+
+/* call-seq:
+   methods -> [RubyProf::MethodInfo]
+
+Returns an array of methods that were called from this
+thread during program execution. */
+static VALUE
+prof_thread_methods(VALUE self)
+{
+    thread_data_t* thread = prof_get_thread(self);
+    if (thread->methods == Qnil)
+    {
+        thread->methods = rb_ary_new();
+        st_foreach(thread->method_table, collect_methods, thread->methods);
+    }
+    return thread->methods;
+}
+
+/* :nodoc: */
+static VALUE
+prof_thread_dump(VALUE self)
+{
+    thread_data_t* thread_data = DATA_PTR(self);
+
+    VALUE result = rb_hash_new();
+    rb_hash_aset(result, ID2SYM(rb_intern("fiber_id")), thread_data->fiber_id);
+    rb_hash_aset(result, ID2SYM(rb_intern("methods")), prof_thread_methods(self));
+
+    return result;
+}
+
+/* :nodoc: */
+static VALUE
+prof_thread_load(VALUE self, VALUE data)
+{
+    thread_data_t* thread_data = DATA_PTR(self);
+    thread_data->object = self;
+
+    thread_data->fiber_id = rb_hash_aref(data, ID2SYM(rb_intern("fiber_id")));
+    VALUE methods = rb_hash_aref(data, ID2SYM(rb_intern("methods")));
+
+    for (int i = 0; i < rb_array_len(methods); i++)
+    {
+        VALUE method = rb_ary_entry(methods, i);
+        prof_method_t *method_data = DATA_PTR(method);
+        method_table_insert(thread_data->method_table, method_data->key, method_data);
+    }
+
+    return data;
+}
+
+void rp_init_thread(void)
+{
+    cRpThread = rb_define_class_under(mProf, "Thread", rb_cData);
+    rb_undef_method(CLASS_OF(cRpThread), "new");
+    rb_define_alloc_func(cRpThread, prof_thread_allocate);
+
+    rb_define_method(cRpThread, "id", prof_thread_id, 0);
+    rb_define_method(cRpThread, "fiber_id", prof_fiber_id, 0);
+    rb_define_method(cRpThread, "methods", prof_thread_methods, 0);
+    rb_define_method(cRpThread, "_dump_data", prof_thread_dump, 0);
+    rb_define_method(cRpThread, "_load_data", prof_thread_load, 1);
+}