ruby-prof 0.18.0 → 1.2.0

data/ext/ruby_prof/rp_aggregate_call_tree.h

@@ -0,0 +1,13 @@
+/* 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_AGGREGATE_CALL_TREE_H__
+#define __RP_AGGREGATE_CALL_TREE_H__
+
+#include "ruby_prof.h"
+#include "rp_call_tree.h"
+
+void rp_init_aggregate_call_tree(void);
+VALUE prof_aggregate_call_tree_wrap(prof_call_tree_t* call_tree);
+
+#endif //__RP_AGGREGATE_CALL_TREE_H__

data/ext/ruby_prof/rp_allocation.c

@@ -0,0 +1,259 @@
+/* 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 */
+
+#include "rp_allocation.h"
+
+VALUE cRpAllocation;
+
+prof_allocation_t* allocations_table_lookup(st_table* table, st_data_t key)
+{
+    prof_allocation_t* result = NULL;
+    st_data_t value;
+    if (rb_st_lookup(table, key, &value))
+    {
+        result = (prof_allocation_t*)value;
+    }
+
+    return result;
+}
+
+void allocations_table_insert(st_table* table, st_data_t key, prof_allocation_t* allocation)
+{
+    rb_st_insert(table, (st_data_t)key, (st_data_t)allocation);
+}
+
+st_data_t allocations_key(VALUE klass, int source_line)
+{
+    return (klass << 4) + source_line;
+}
+
+/* ======   prof_allocation_t  ====== */
+prof_allocation_t* prof_allocation_create(void)
+{
+    prof_allocation_t* result = ALLOC(prof_allocation_t);
+    result->count = 0;
+    result->klass = Qnil;
+    result->klass_name = Qnil;
+    result->object = Qnil;
+    result->memory = 0;
+    result->source_line = 0;
+    result->source_file = Qnil;
+    result->key = 0;
+
+    return result;
+}
+
+prof_allocation_t* prof_allocate_increment(prof_method_t* method, rb_trace_arg_t* trace_arg)
+{
+    VALUE object = rb_tracearg_object(trace_arg);
+    if (BUILTIN_TYPE(object) == T_IMEMO)
+        return NULL;
+
+    VALUE klass = rb_obj_class(object);
+
+    int source_line = FIX2INT(rb_tracearg_lineno(trace_arg));
+    st_data_t key = allocations_key(klass, source_line);
+
+    prof_allocation_t* allocation = allocations_table_lookup(method->allocations_table, key);
+    if (!allocation)
+    {
+        allocation = prof_allocation_create();
+        allocation->source_line = source_line;
+        allocation->source_file = rb_tracearg_path(trace_arg);
+        allocation->klass_flags = 0;
+        allocation->klass = resolve_klass(klass, &allocation->klass_flags);
+
+        allocation->key = key;
+        allocations_table_insert(method->allocations_table, key, allocation);
+    }
+
+    allocation->count++;
+    allocation->memory += rb_obj_memsize_of(object);
+
+    return allocation;
+}
+
+static void prof_allocation_ruby_gc_free(void* data)
+{
+    prof_allocation_t* allocation = (prof_allocation_t*)data;
+    allocation->object = Qnil;
+}
+
+void prof_allocation_free(prof_allocation_t* allocation)
+{
+    /* Has this allocation object been accessed by Ruby?  If
+       yes clean it up so to avoid a segmentation fault. */
+    if (allocation->object != Qnil)
+    {
+        RDATA(allocation->object)->dmark = NULL;
+        RDATA(allocation->object)->dfree = NULL;
+        RDATA(allocation->object)->data = NULL;
+        allocation->object = Qnil;
+    }
+
+    xfree(allocation);
+}
+
+size_t prof_allocation_size(const void* data)
+{
+    return sizeof(prof_allocation_t);
+}
+
+void prof_allocation_mark(void* data)
+{
+    prof_allocation_t* allocation = (prof_allocation_t*)data;
+    if (allocation->object != Qnil)
+        rb_gc_mark(allocation->object);
+
+    if (allocation->klass != Qnil)
+        rb_gc_mark(allocation->klass);
+
+    if (allocation->klass_name != Qnil)
+        rb_gc_mark(allocation->klass_name);
+
+    if (allocation->source_file != Qnil)
+        rb_gc_mark(allocation->source_file);
+}
+
+VALUE prof_allocation_wrap(prof_allocation_t* allocation)
+{
+    if (allocation->object == Qnil)
+    {
+        allocation->object = Data_Wrap_Struct(cRpAllocation, prof_allocation_mark, prof_allocation_ruby_gc_free, allocation);
+    }
+    return allocation->object;
+}
+
+static VALUE prof_allocation_allocate(VALUE klass)
+{
+    prof_allocation_t* allocation = prof_allocation_create();
+    allocation->object = prof_allocation_wrap(allocation);
+    return allocation->object;
+}
+
+prof_allocation_t* prof_allocation_get(VALUE self)
+{
+    /* Can't use Data_Get_Struct because that triggers the event hook
+       ending up in endless recursion. */
+    prof_allocation_t* result = DATA_PTR(self);
+    if (!result)
+        rb_raise(rb_eRuntimeError, "This RubyProf::Allocation instance has already been freed, likely because its profile has been freed.");
+
+    return result;
+}
+
+/* call-seq:
+   klass -> Class
+
+Returns the type of Class being allocated. */
+static VALUE prof_allocation_klass_name(VALUE self)
+{
+    prof_allocation_t* allocation = prof_allocation_get(self);
+
+    if (allocation->klass_name == Qnil)
+        allocation->klass_name = resolve_klass_name(allocation->klass, &allocation->klass_flags);
+
+    return allocation->klass_name;
+}
+
+/* call-seq:
+   klass_flags -> integer
+
+Returns the klass flags */
+
+static VALUE prof_allocation_klass_flags(VALUE self)
+{
+    prof_allocation_t* allocation = prof_allocation_get(self);
+    return INT2FIX(allocation->klass_flags);
+}
+
+/* call-seq:
+   source_file -> string
+
+Returns the the line number where objects were allocated. */
+static VALUE prof_allocation_source_file(VALUE self)
+{
+    prof_allocation_t* allocation = prof_allocation_get(self);
+    return allocation->source_file;
+}
+
+/* call-seq:
+   line -> number
+
+Returns the the line number where objects were allocated. */
+static VALUE prof_allocation_source_line(VALUE self)
+{
+    prof_allocation_t* allocation = prof_allocation_get(self);
+    return INT2FIX(allocation->source_line);
+}
+
+/* call-seq:
+   count -> number
+
+Returns the number of times this class has been allocated. */
+static VALUE prof_allocation_count(VALUE self)
+{
+    prof_allocation_t* allocation = prof_allocation_get(self);
+    return INT2FIX(allocation->count);
+}
+
+/* call-seq:
+   memory -> number
+
+Returns the amount of memory allocated. */
+static VALUE prof_allocation_memory(VALUE self)
+{
+    prof_allocation_t* allocation = prof_allocation_get(self);
+    return ULL2NUM(allocation->memory);
+}
+
+/* :nodoc: */
+static VALUE prof_allocation_dump(VALUE self)
+{
+    prof_allocation_t* allocation = DATA_PTR(self);
+
+    VALUE result = rb_hash_new();
+
+    rb_hash_aset(result, ID2SYM(rb_intern("key")), INT2FIX(allocation->key));
+    rb_hash_aset(result, ID2SYM(rb_intern("klass_name")), prof_allocation_klass_name(self));
+    rb_hash_aset(result, ID2SYM(rb_intern("klass_flags")), INT2FIX(allocation->klass_flags));
+    rb_hash_aset(result, ID2SYM(rb_intern("source_file")), allocation->source_file);
+    rb_hash_aset(result, ID2SYM(rb_intern("source_line")), INT2FIX(allocation->source_line));
+    rb_hash_aset(result, ID2SYM(rb_intern("count")), INT2FIX(allocation->count));
+    rb_hash_aset(result, ID2SYM(rb_intern("memory")), LONG2FIX(allocation->memory));
+
+    return result;
+}
+
+/* :nodoc: */
+static VALUE prof_allocation_load(VALUE self, VALUE data)
+{
+    prof_allocation_t* allocation = DATA_PTR(self);
+    allocation->object = self;
+
+    allocation->key = FIX2LONG(rb_hash_aref(data, ID2SYM(rb_intern("key"))));
+    allocation->klass_name = rb_hash_aref(data, ID2SYM(rb_intern("klass_name")));
+    allocation->klass_flags = FIX2INT(rb_hash_aref(data, ID2SYM(rb_intern("klass_flags"))));
+    allocation->source_file = rb_hash_aref(data, ID2SYM(rb_intern("source_file")));
+    allocation->source_line = FIX2INT(rb_hash_aref(data, ID2SYM(rb_intern("source_line"))));
+    allocation->count = FIX2INT(rb_hash_aref(data, ID2SYM(rb_intern("count"))));
+    allocation->memory = FIX2LONG(rb_hash_aref(data, ID2SYM(rb_intern("memory"))));
+
+    return data;
+}
+
+void rp_init_allocation(void)
+{
+    cRpAllocation = rb_define_class_under(mProf, "Allocation", rb_cData);
+    rb_undef_method(CLASS_OF(cRpAllocation), "new");
+    rb_define_alloc_func(cRpAllocation, prof_allocation_allocate);
+
+    rb_define_method(cRpAllocation, "klass_name", prof_allocation_klass_name, 0);
+    rb_define_method(cRpAllocation, "klass_flags", prof_allocation_klass_flags, 0);
+    rb_define_method(cRpAllocation, "source_file", prof_allocation_source_file, 0);
+    rb_define_method(cRpAllocation, "line", prof_allocation_source_line, 0);
+    rb_define_method(cRpAllocation, "count", prof_allocation_count, 0);
+    rb_define_method(cRpAllocation, "memory", prof_allocation_memory, 0);
+    rb_define_method(cRpAllocation, "_dump_data", prof_allocation_dump, 0);
+    rb_define_method(cRpAllocation, "_load_data", prof_allocation_load, 1);
+}

data/ext/ruby_prof/rp_allocation.h

@@ -0,0 +1,31 @@
+/* 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_ALLOCATION_
+#define _RP_ALLOCATION_
+
+#include "ruby_prof.h"
+#include "rp_method.h"
+
+typedef struct
+{
+    st_data_t key;                    /* Key in hash table */
+    unsigned int klass_flags;         /* Information about the type of class */
+    VALUE klass;                      /* Klass that was created */
+    VALUE klass_name;                 /* Name of the class that was created */
+    VALUE source_file;                /* Line number where allocation happens */
+    int source_line;                  /* Line number where allocation happens */
+    int count;                        /* Number of allocations */
+    size_t memory;                    /* Amount of allocated memory */
+    VALUE object;                     /* Cache to wrapped object */
+} prof_allocation_t;
+
+void rp_init_allocation(void);
+void prof_allocation_free(prof_allocation_t* allocation);
+void prof_allocation_mark(void* data);
+VALUE prof_allocation_wrap(prof_allocation_t* allocation);
+prof_allocation_t* prof_allocation_get(VALUE self);
+prof_allocation_t* prof_allocate_increment(prof_method_t* method, rb_trace_arg_t* trace_arg);
+
+
+#endif //_RP_ALLOCATION_

data/ext/ruby_prof/rp_call_tree.c

@@ -0,0 +1,353 @@
+/* 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_call_tree.h"
+
+#define INITIAL_CALL_TREES_SIZE 2
+
+VALUE cRpCallTree;
+
+/* =======  prof_call_tree_t   ========*/
+prof_call_tree_t* prof_call_tree_create(prof_method_t* method, prof_call_tree_t* parent, VALUE source_file, int source_line)
+{
+    prof_call_tree_t* result = ALLOC(prof_call_tree_t);
+    result->method = method;
+    result->parent = parent;
+    result->children = rb_st_init_numtable();
+    result->object = Qnil;
+    result->measurement = prof_measurement_create();
+
+    result->visits = 0;
+
+    result->source_line = source_line;
+    result->source_file = source_file;
+
+    return result;
+}
+
+prof_call_tree_t* prof_call_tree_copy(prof_call_tree_t* other)
+{
+    prof_call_tree_t* result = ALLOC(prof_call_tree_t);
+    result->children = rb_st_init_numtable();
+    result->object = Qnil;
+    result->visits = 0;
+
+    result->method = other->method;
+    result->parent = other->parent;
+    result->source_line = other->source_line;
+    result->source_file = other->source_file;
+
+    result->measurement = prof_measurement_create();
+    result->measurement->called = other->measurement->called;
+    result->measurement->total_time = other->measurement->total_time;
+    result->measurement->self_time = other->measurement->self_time;
+    result->measurement->wait_time = other->measurement->wait_time;
+    result->measurement->object = Qnil;
+
+    return result;
+}
+
+void prof_call_tree_merge(prof_call_tree_t* result, prof_call_tree_t* other)
+{
+    result->measurement->called += other->measurement->called;
+    result->measurement->total_time += other->measurement->total_time;
+    result->measurement->self_time += other->measurement->self_time;
+    result->measurement->wait_time += other->measurement->wait_time;
+}
+
+static int prof_call_tree_collect_children(st_data_t key, st_data_t value, st_data_t result)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)value;
+    VALUE arr = (VALUE)result;
+    rb_ary_push(arr, prof_call_tree_wrap(call_tree));
+    return ST_CONTINUE;
+}
+
+static int prof_call_tree_mark_children(st_data_t key, st_data_t value, st_data_t data)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)value;
+    rb_st_foreach(call_tree->children, prof_call_tree_mark_children, data);
+    prof_call_tree_mark(call_tree);
+    return ST_CONTINUE;
+}
+
+void prof_call_tree_mark(void* data)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)data;
+
+    if (call_tree->object != Qnil)
+        rb_gc_mark(call_tree->object);
+
+    if (call_tree->source_file != Qnil)
+        rb_gc_mark(call_tree->source_file);
+
+    prof_measurement_mark(call_tree->measurement);
+
+    // Recurse down through the whole call tree but only from the top node
+    // to avoid calling mark over and over and over.
+    if (!call_tree->parent)
+        rb_st_foreach(call_tree->children, prof_call_tree_mark_children, 0);
+}
+
+static void prof_call_tree_ruby_gc_free(void* data)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)data;
+    call_tree->object = Qnil;
+}
+
+static int prof_call_tree_free_children(st_data_t key, st_data_t value, st_data_t data)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)value;
+    prof_call_tree_free(call_tree);
+    return ST_CONTINUE;
+}
+
+void prof_call_tree_free(prof_call_tree_t* call_tree_data)
+{
+    /* Has this call info object been accessed by Ruby?  If
+       yes clean it up so to avoid a segmentation fault. */
+    if (call_tree_data->object != Qnil)
+    {
+        RDATA(call_tree_data->object)->dmark = NULL;
+        RDATA(call_tree_data->object)->dfree = NULL;
+        RDATA(call_tree_data->object)->data = NULL;
+        call_tree_data->object = Qnil;
+    }
+
+    // Free children
+    rb_st_foreach(call_tree_data->children, prof_call_tree_free_children, 0);
+    rb_st_free_table(call_tree_data->children);
+
+    // Free measurement
+    prof_measurement_free(call_tree_data->measurement);
+
+    // Finally free self
+    xfree(call_tree_data);
+}
+
+size_t prof_call_tree_size(const void* data)
+{
+    return sizeof(prof_call_tree_t);
+}
+
+VALUE prof_call_tree_wrap(prof_call_tree_t* call_tree)
+{
+    if (call_tree->object == Qnil)
+    {
+        call_tree->object = Data_Wrap_Struct(cRpCallTree, prof_call_tree_mark, prof_call_tree_ruby_gc_free, call_tree);
+    }
+    return call_tree->object;
+}
+
+static VALUE prof_call_tree_allocate(VALUE klass)
+{
+    prof_call_tree_t* call_tree = prof_call_tree_create(NULL, NULL, Qnil, 0);
+    call_tree->object = prof_call_tree_wrap(call_tree);
+    return call_tree->object;
+}
+
+prof_call_tree_t* prof_get_call_tree(VALUE self)
+{
+    /* Can't use Data_Get_Struct because that triggers the event hook
+       ending up in endless recursion. */
+    prof_call_tree_t* result = DATA_PTR(self);
+
+    if (!result)
+        rb_raise(rb_eRuntimeError, "This RubyProf::CallTree instance has already been freed, likely because its profile has been freed.");
+
+    return result;
+}
+
+/* =======  Call Tree Table   ========*/
+static size_t call_tree_table_insert(st_table* table, st_data_t key, prof_call_tree_t* val)
+{
+    return rb_st_insert(table, (st_data_t)key, (st_data_t)val);
+}
+
+prof_call_tree_t* call_tree_table_lookup(st_table* table, st_data_t key)
+{
+    st_data_t val;
+    if (rb_st_lookup(table, (st_data_t)key, &val))
+    {
+        return (prof_call_tree_t*)val;
+    }
+    else
+    {
+        return NULL;
+    }
+}
+
+uint32_t prof_call_figure_depth(prof_call_tree_t* call_tree_data)
+{
+    uint32_t result = 0;
+
+    while (call_tree_data->parent)
+    {
+        result++;
+        call_tree_data = call_tree_data->parent;
+    }
+
+    return result;
+}
+
+void prof_call_tree_add_parent(prof_call_tree_t* self, prof_call_tree_t* parent)
+{
+    prof_call_tree_add_child(parent, self);
+    self->parent = parent;
+}
+
+void prof_call_tree_add_child(prof_call_tree_t* self, prof_call_tree_t* child)
+{
+    call_tree_table_insert(self->children, child->method->key, child);
+}
+
+/* =======  RubyProf::CallTree   ========*/
+
+/* call-seq:
+   parent -> call_tree
+
+Returns the CallTree parent call_tree object (the method that called this method).*/
+static VALUE prof_call_tree_parent(VALUE self)
+{
+    prof_call_tree_t* call_tree = prof_get_call_tree(self);
+    if (call_tree->parent)
+        return prof_call_tree_wrap(call_tree->parent);
+    else
+        return Qnil;
+}
+
+/* call-seq:
+   callees -> array
+
+Returns an array of call info objects that this method called (ie, children).*/
+static VALUE prof_call_tree_children(VALUE self)
+{
+    prof_call_tree_t* call_tree = prof_get_call_tree(self);
+    VALUE result = rb_ary_new();
+    rb_st_foreach(call_tree->children, prof_call_tree_collect_children, result);
+    return result;
+}
+
+/* call-seq:
+   called -> MethodInfo
+
+Returns the target method. */
+static VALUE prof_call_tree_target(VALUE self)
+{
+    prof_call_tree_t* call_tree = prof_get_call_tree(self);
+    return prof_method_wrap(call_tree->method);
+}
+
+/* call-seq:
+   called -> Measurement
+
+Returns the measurement associated with this call_tree. */
+static VALUE prof_call_tree_measurement(VALUE self)
+{
+    prof_call_tree_t* call_tree = prof_get_call_tree(self);
+    return prof_measurement_wrap(call_tree->measurement);
+}
+
+/* call-seq:
+   depth -> int
+
+   returns the depth of this call info in the call graph */
+static VALUE prof_call_tree_depth(VALUE self)
+{
+    prof_call_tree_t* call_tree_data = prof_get_call_tree(self);
+    uint32_t depth = prof_call_figure_depth(call_tree_data);
+    return rb_int_new(depth);
+}
+
+/* call-seq:
+   source_file => string
+
+return the source file of the method
+*/
+static VALUE prof_call_tree_source_file(VALUE self)
+{
+    prof_call_tree_t* result = prof_get_call_tree(self);
+    return result->source_file;
+}
+
+/* call-seq:
+   line_no -> int
+
+   returns the line number of the method */
+static VALUE prof_call_tree_line(VALUE self)
+{
+    prof_call_tree_t* result = prof_get_call_tree(self);
+    return INT2FIX(result->source_line);
+}
+
+/* :nodoc: */
+static VALUE prof_call_tree_dump(VALUE self)
+{
+    prof_call_tree_t* call_tree_data = prof_get_call_tree(self);
+    VALUE result = rb_hash_new();
+
+    rb_hash_aset(result, ID2SYM(rb_intern("measurement")), prof_measurement_wrap(call_tree_data->measurement));
+
+    rb_hash_aset(result, ID2SYM(rb_intern("source_file")), call_tree_data->source_file);
+    rb_hash_aset(result, ID2SYM(rb_intern("source_line")), INT2FIX(call_tree_data->source_line));
+
+    rb_hash_aset(result, ID2SYM(rb_intern("parent")), prof_call_tree_parent(self));
+    rb_hash_aset(result, ID2SYM(rb_intern("children")), prof_call_tree_children(self));
+    rb_hash_aset(result, ID2SYM(rb_intern("target")), prof_call_tree_target(self));
+
+    return result;
+}
+
+/* :nodoc: */
+static VALUE prof_call_tree_load(VALUE self, VALUE data)
+{
+    VALUE target = Qnil;
+    VALUE parent = Qnil;
+    prof_call_tree_t* call_tree = prof_get_call_tree(self);
+    call_tree->object = self;
+
+    VALUE measurement = rb_hash_aref(data, ID2SYM(rb_intern("measurement")));
+    call_tree->measurement = prof_get_measurement(measurement);
+
+    call_tree->source_file = rb_hash_aref(data, ID2SYM(rb_intern("source_file")));
+    call_tree->source_line = FIX2INT(rb_hash_aref(data, ID2SYM(rb_intern("source_line"))));
+
+    parent = rb_hash_aref(data, ID2SYM(rb_intern("parent")));
+    if (parent != Qnil)
+        call_tree->parent = prof_get_call_tree(parent);
+
+    VALUE callees = rb_hash_aref(data, ID2SYM(rb_intern("children")));
+    for (int i = 0; i < rb_array_len(callees); i++)
+    {
+        VALUE call_tree_object = rb_ary_entry(callees, i);
+        prof_call_tree_t* call_tree_data = prof_get_call_tree(call_tree_object);
+
+        st_data_t key = call_tree_data->method ? call_tree_data->method->key : method_key(Qnil, 0);
+        call_tree_table_insert(call_tree->children, key, call_tree_data);
+    }
+
+    target = rb_hash_aref(data, ID2SYM(rb_intern("target")));
+    call_tree->method = prof_get_method(target);
+
+    return data;
+}
+
+void rp_init_call_tree()
+{
+    /* CallTree */
+    cRpCallTree = rb_define_class_under(mProf, "CallTree", rb_cData);
+    rb_undef_method(CLASS_OF(cRpCallTree), "new");
+    rb_define_alloc_func(cRpCallTree, prof_call_tree_allocate);
+
+    rb_define_method(cRpCallTree, "parent", prof_call_tree_parent, 0);
+    rb_define_method(cRpCallTree, "children", prof_call_tree_children, 0);
+    rb_define_method(cRpCallTree, "target", prof_call_tree_target, 0);
+    rb_define_method(cRpCallTree, "measurement", prof_call_tree_measurement, 0);
+
+    rb_define_method(cRpCallTree, "depth", prof_call_tree_depth, 0);
+    rb_define_method(cRpCallTree, "source_file", prof_call_tree_source_file, 0);
+    rb_define_method(cRpCallTree, "line", prof_call_tree_line, 0);
+
+    rb_define_method(cRpCallTree, "_dump_data", prof_call_tree_dump, 0);
+    rb_define_method(cRpCallTree, "_load_data", prof_call_tree_load, 1);
+}