ruby-prof 0.18.0 → 1.2.0

data/ext/ruby_prof/rp_measure_process_time.c

@@ -1,71 +1,65 @@
-/* Copyright (C) 2005-2013 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
+/* 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 "ruby_prof.h"
+#include "rp_measurement.h"
 #include <time.h>
 
 static VALUE cMeasureProcessTime;
 
-static double
-measure_process_time()
+static double measure_process_time(rb_trace_arg_t* trace_arg)
 {
-#if defined(__linux__)
-    struct timespec clock;
-    clock_gettime(CLOCK_PROCESS_CPUTIME_ID , &clock);
-    return clock.tv_sec + (clock.tv_nsec/1000000000.0);
-#elif defined(_win32)
-	FILETIME createTime;
-	FILETIME exitTime;
-	FILETIME sysTime;
-	FILETIME cpuTime;
-
-	ULARGE_INTEGER sysTimeInt;
-	ULARGE_INTEGER cpuTimeInt;
-	ULONGLONG totalTime;
+#if defined(_WIN32)
+    FILETIME  createTime;
+    FILETIME  exitTime;
+    FILETIME  sysTime;
+    FILETIME  userTime;
 
-	GetProcessTimes(GetCurrentProcess(), &createTime, &exitTime, &sysTime, &cpuTime); 
+    ULARGE_INTEGER sysTimeInt;
+    ULARGE_INTEGER userTimeInt;
 
-	/* Doing this based on MSFT's recommendation in the FILETIME structure documentation at
-	  http://msdn.microsoft.com/en-us/library/ms724284%28VS.85%29.aspx*/
+    GetProcessTimes(GetCurrentProcess(), &createTime, &exitTime, &sysTime, &userTime);
 
-	sysTimeInt.LowPart = sysTime.dwLowDateTime;
-	sysTimeInt.HighPart = sysTime.dwHighDateTime;
-	cpuTimeInt.LowPart = cpuTime.dwLowDateTime;
-	cpuTimeInt.HighPart = cpuTime.dwHighDateTime;
+    sysTimeInt.LowPart = sysTime.dwLowDateTime;
+    sysTimeInt.HighPart = sysTime.dwHighDateTime;
+    userTimeInt.LowPart = userTime.dwLowDateTime;
+    userTimeInt.HighPart = userTime.dwHighDateTime;
 
-	totalTime = sysTimeInt.QuadPart + cpuTimeInt.QuadPart;
-
-	// Times are in 100-nanosecond time units.  So instead of 10-9 use 10-7
-	return totalTime / 10000000.0;
+    return sysTimeInt.QuadPart + userTimeInt.QuadPart;
+#elif !defined(CLOCK_PROCESS_CPUTIME_ID)
+    struct rusage usage;
+    getrusage(RUSAGE_SELF, &usage);
+    return usage.ru_stime.tv_sec + usage.ru_utime.tv_sec + ((usage.ru_stime.tv_usec + usage.ru_utime.tv_usec) / 1000000.0);
 #else
-    return ((double)clock()) / CLOCKS_PER_SEC;
+    struct timespec clock;
+    clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &clock);
+    return clock.tv_sec + (clock.tv_nsec / 1000000000.0);
 #endif
 }
 
-/* call-seq:
-   measure_process_time -> float
-
-Returns the process time.*/
-static VALUE
-prof_measure_process_time(VALUE self)
+static double multiplier_process_time(void)
 {
-    return rb_float_new(measure_process_time());
+#if defined(_WIN32)
+    // Times are in 100-nanosecond time units.  So instead of 10-9 use 10-7
+    return 1.0 / 10000000.0;
+#else
+    return 1.0;
+#endif
 }
 
-prof_measurer_t* prof_measurer_process_time()
+prof_measurer_t* prof_measurer_process_time(bool track_allocations)
 {
-  prof_measurer_t* measure = ALLOC(prof_measurer_t);
-  measure->measure = measure_process_time;
-  return measure;
+    prof_measurer_t* measure = ALLOC(prof_measurer_t);
+    measure->mode = MEASURE_PROCESS_TIME;
+    measure->measure = measure_process_time;
+    measure->multiplier = multiplier_process_time();
+    measure->track_allocations = track_allocations;
+    return measure;
 }
 
-
 void rp_init_measure_process_time()
 {
     rb_define_const(mProf, "CLOCKS_PER_SEC", INT2NUM(CLOCKS_PER_SEC));
     rb_define_const(mProf, "PROCESS_TIME", INT2NUM(MEASURE_PROCESS_TIME));
-	rb_define_const(mProf, "PROCESS_TIME_ENABLED", Qtrue);
 
     cMeasureProcessTime = rb_define_class_under(mMeasure, "ProcessTime", rb_cObject);
-    rb_define_singleton_method(cMeasureProcessTime, "measure", prof_measure_process_time, 0);
 }

data/ext/ruby_prof/rp_measure_wall_time.c

@@ -1,45 +1,64 @@
 /* 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 */
 
-/* :nodoc: */
-#include "ruby_prof.h"
-#if HAVE_GETTIMEOFDAY && !defined(_WIN32)
-#include <sys/time.h>
+   /* :nodoc: */
+#include "rp_measurement.h"
+
+#if defined(__APPLE__)
+#include <mach/mach_time.h>
+#elif !defined(_WIN32)
+#include <time.h>
 #endif
 
 static VALUE cMeasureWallTime;
 
-static double
-measure_wall_time()
+static double measure_wall_time(rb_trace_arg_t* trace_arg)
 {
+#if defined(_WIN32)
+    LARGE_INTEGER time;
+    QueryPerformanceCounter(&time);
+    return time.QuadPart;
+#elif defined(__APPLE__)
+    return mach_absolute_time();// * (uint64_t)mach_timebase.numer / (uint64_t)mach_timebase.denom;
+#elif defined(__linux__)
+    struct timespec tv;
+    clock_gettime(CLOCK_MONOTONIC, &tv);
+    return tv.tv_sec + (tv.tv_nsec / 1000000000.0);
+#else
     struct timeval tv;
     gettimeofday(&tv, NULL);
-    return tv.tv_sec + (tv.tv_usec/1000000.0);
+    return tv.tv_sec + (tv.tv_usec / 1000000.0);
+#endif
 }
 
-prof_measurer_t* prof_measurer_wall_time()
+static double multiplier_wall_time(void)
 {
-  prof_measurer_t* measure = ALLOC(prof_measurer_t);
-  measure->measure = measure_wall_time;
-  return measure;
+#if defined(_WIN32)
+    LARGE_INTEGER frequency;
+    QueryPerformanceFrequency(&frequency);
+    return 1.0 / frequency.QuadPart;
+#elif defined(__APPLE__)
+    mach_timebase_info_data_t mach_timebase;
+    mach_timebase_info(&mach_timebase);
+    return (uint64_t)mach_timebase.numer / (uint64_t)mach_timebase.denom / 1000000000.0;
+#else
+    return 1.0;
+#endif
 }
 
-/* Document-method: prof_measure_wall_time
-   call-seq:
-     measure_wall_time -> float
-
-Returns the wall time.*/
-static VALUE
-prof_measure_wall_time(VALUE self)
+prof_measurer_t* prof_measurer_wall_time(bool track_allocations)
 {
-    return rb_float_new(measure_wall_time());
+    prof_measurer_t* measure = ALLOC(prof_measurer_t);
+    measure->mode = MEASURE_WALL_TIME;
+    measure->measure = measure_wall_time;
+    measure->multiplier = multiplier_wall_time();
+    measure->track_allocations = track_allocations;
+    return measure;
 }
 
 void rp_init_measure_wall_time()
 {
     rb_define_const(mProf, "WALL_TIME", INT2NUM(MEASURE_WALL_TIME));
-    rb_define_const(mProf, "WALL_TIME_ENABLED", Qtrue);
 
     cMeasureWallTime = rb_define_class_under(mMeasure, "WallTime", rb_cObject);
-    rb_define_singleton_method(cMeasureWallTime, "measure", prof_measure_wall_time, 0);
 }

data/ext/ruby_prof/rp_measurement.c

@@ -0,0 +1,221 @@
+/* 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_measurement.h"
+
+VALUE mMeasure;
+VALUE cRpMeasurement;
+
+prof_measurer_t* prof_measurer_allocations(bool track_allocations);
+prof_measurer_t* prof_measurer_memory(bool track_allocations);
+prof_measurer_t* prof_measurer_process_time(bool track_allocations);
+prof_measurer_t* prof_measurer_wall_time(bool track_allocations);
+
+void rp_init_measure_allocations(void);
+void rp_init_measure_memory(void);
+void rp_init_measure_process_time(void);
+void rp_init_measure_wall_time(void);
+
+prof_measurer_t* prof_get_measurer(prof_measure_mode_t measure, bool track_allocations)
+{
+    switch (measure)
+    {
+    case MEASURE_WALL_TIME:
+        return prof_measurer_wall_time(track_allocations);
+    case MEASURE_PROCESS_TIME:
+        return prof_measurer_process_time(track_allocations);
+    case MEASURE_ALLOCATIONS:
+        return prof_measurer_allocations(track_allocations);
+    case MEASURE_MEMORY:
+        return prof_measurer_memory(track_allocations);
+    default:
+        rb_raise(rb_eArgError, "Unknown measure mode: %d", measure);
+    }
+};
+
+double prof_measure(prof_measurer_t* measurer, rb_trace_arg_t* trace_arg)
+{
+    double measurement = measurer->measure(trace_arg);
+    return measurement * measurer->multiplier;
+}
+
+/* =======  prof_measurement_t   ========*/
+prof_measurement_t* prof_measurement_create(void)
+{
+    prof_measurement_t* result = ALLOC(prof_measurement_t);
+    result->total_time = 0;
+    result->self_time = 0;
+    result->wait_time = 0;
+    result->called = 0;
+    result->object = Qnil;
+    return result;
+}
+
+void prof_measurement_mark(void* data)
+{
+    prof_measurement_t* measurement_data = (prof_measurement_t*)data;
+
+    if (measurement_data->object != Qnil)
+        rb_gc_mark(measurement_data->object);
+}
+
+static void prof_measurement_ruby_gc_free(void* data)
+{
+    // Measurements are freed by their owning object (call info or method)
+    prof_measurement_t* measurement = (prof_measurement_t*)data;
+    measurement->object = Qnil;
+}
+
+void prof_measurement_free(prof_measurement_t* measurement)
+{
+    /* Has this measurement object been accessed by Ruby?  If
+       yes clean it up so to avoid a segmentation fault. */
+    if (measurement->object != Qnil)
+    {
+        RDATA(measurement->object)->dmark = NULL;
+        RDATA(measurement->object)->dfree = NULL;
+        RDATA(measurement->object)->data = NULL;
+        measurement->object = Qnil;
+    }
+
+    xfree(measurement);
+}
+
+size_t prof_measurement_size(const void* data)
+{
+    return sizeof(prof_measurement_t);
+}
+
+VALUE prof_measurement_wrap(prof_measurement_t* measurement)
+{
+    if (measurement->object == Qnil)
+    {
+        measurement->object = Data_Wrap_Struct(cRpMeasurement, NULL, prof_measurement_ruby_gc_free, measurement);
+    }
+    return measurement->object;
+}
+
+static VALUE prof_measurement_allocate(VALUE klass)
+{
+    prof_measurement_t* measurement = prof_measurement_create();
+    measurement->object = prof_measurement_wrap(measurement);
+    return measurement->object;
+}
+
+prof_measurement_t* prof_get_measurement(VALUE self)
+{
+    /* Can't use Data_Get_Struct because that triggers the event hook
+       ending up in endless recursion. */
+    prof_measurement_t* result = DATA_PTR(self);
+
+    if (!result)
+        rb_raise(rb_eRuntimeError, "This RubyProf::Measurement instance has already been freed, likely because its profile has been freed.");
+
+    return result;
+}
+
+/* call-seq:
+   total_time -> float
+
+Returns the total amount of time spent in this method and its children. */
+static VALUE prof_measurement_total_time(VALUE self)
+{
+    prof_measurement_t* result = prof_get_measurement(self);
+    return rb_float_new(result->total_time);
+}
+
+/* call-seq:
+   self_time -> float
+
+Returns the total amount of time spent in this method. */
+static VALUE
+prof_measurement_self_time(VALUE self)
+{
+    prof_measurement_t* result = prof_get_measurement(self);
+
+    return rb_float_new(result->self_time);
+}
+
+/* call-seq:
+   wait_time -> float
+
+Returns the total amount of time this method waited for other threads. */
+static VALUE prof_measurement_wait_time(VALUE self)
+{
+    prof_measurement_t* result = prof_get_measurement(self);
+
+    return rb_float_new(result->wait_time);
+}
+
+/* call-seq:
+   called -> int
+
+Returns the total amount of times this method was called. */
+static VALUE prof_measurement_called(VALUE self)
+{
+    prof_measurement_t* result = prof_get_measurement(self);
+    return INT2NUM(result->called);
+}
+
+/* call-seq:
+   called=n -> n
+
+Sets the call count to n. */
+static VALUE prof_measurement_set_called(VALUE self, VALUE called)
+{
+    prof_measurement_t* result = prof_get_measurement(self);
+    result->called = NUM2INT(called);
+    return called;
+}
+
+/* :nodoc: */
+static VALUE
+prof_measurement_dump(VALUE self)
+{
+    prof_measurement_t* measurement_data = prof_get_measurement(self);
+    VALUE result = rb_hash_new();
+
+    rb_hash_aset(result, ID2SYM(rb_intern("total_time")), rb_float_new(measurement_data->total_time));
+    rb_hash_aset(result, ID2SYM(rb_intern("self_time")), rb_float_new(measurement_data->self_time));
+    rb_hash_aset(result, ID2SYM(rb_intern("wait_time")), rb_float_new(measurement_data->wait_time));
+    rb_hash_aset(result, ID2SYM(rb_intern("called")), INT2FIX(measurement_data->called));
+
+    return result;
+}
+
+/* :nodoc: */
+static VALUE
+prof_measurement_load(VALUE self, VALUE data)
+{
+    prof_measurement_t* measurement = prof_get_measurement(self);
+    measurement->object = self;
+
+    measurement->total_time = rb_num2dbl(rb_hash_aref(data, ID2SYM(rb_intern("total_time"))));
+    measurement->self_time = rb_num2dbl(rb_hash_aref(data, ID2SYM(rb_intern("self_time"))));
+    measurement->wait_time = rb_num2dbl(rb_hash_aref(data, ID2SYM(rb_intern("wait_time"))));
+    measurement->called = FIX2INT(rb_hash_aref(data, ID2SYM(rb_intern("called"))));
+
+    return data;
+}
+
+void rp_init_measure()
+{
+    mMeasure = rb_define_module_under(mProf, "Measure");
+    rp_init_measure_wall_time();
+    rp_init_measure_process_time();
+    rp_init_measure_allocations();
+    rp_init_measure_memory();
+
+    cRpMeasurement = rb_define_class_under(mProf, "Measurement", rb_cData);
+    rb_undef_method(CLASS_OF(cRpMeasurement), "new");
+    rb_define_alloc_func(cRpMeasurement, prof_measurement_allocate);
+
+    rb_define_method(cRpMeasurement, "called", prof_measurement_called, 0);
+    rb_define_method(cRpMeasurement, "called=", prof_measurement_set_called, 1);
+    rb_define_method(cRpMeasurement, "total_time", prof_measurement_total_time, 0);
+    rb_define_method(cRpMeasurement, "self_time", prof_measurement_self_time, 0);
+    rb_define_method(cRpMeasurement, "wait_time", prof_measurement_wait_time, 0);
+
+    rb_define_method(cRpMeasurement, "_dump_data", prof_measurement_dump, 0);
+    rb_define_method(cRpMeasurement, "_load_data", prof_measurement_load, 1);
+}

data/ext/ruby_prof/rp_measurement.h

@@ -0,0 +1,50 @@
+/* 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_measurementMENT_H__
+#define __rp_measurementMENT_H__
+
+#include "ruby_prof.h"
+
+extern VALUE mMeasure;
+
+typedef double (*get_measurement)(rb_trace_arg_t* trace_arg);
+
+typedef enum
+{
+    MEASURE_WALL_TIME,
+    MEASURE_PROCESS_TIME,
+    MEASURE_ALLOCATIONS,
+    MEASURE_MEMORY
+} prof_measure_mode_t;
+
+typedef struct
+{
+    get_measurement measure;
+    prof_measure_mode_t mode;
+    double multiplier;
+    bool track_allocations;
+} prof_measurer_t;
+
+/* Callers and callee information for a method. */
+typedef struct prof_measurement_t
+{
+    double total_time;
+    double self_time;
+    double wait_time;
+    int called;
+    VALUE object;
+} prof_measurement_t;
+
+prof_measurer_t* prof_get_measurer(prof_measure_mode_t measure, bool track_allocations);
+double prof_measure(prof_measurer_t* measurer, rb_trace_arg_t* trace_arg);
+
+prof_measurement_t* prof_measurement_create(void);
+void prof_measurement_free(prof_measurement_t* measurement);
+VALUE prof_measurement_wrap(prof_measurement_t* measurement);
+prof_measurement_t* prof_get_measurement(VALUE self);
+void prof_measurement_mark(void* data);
+
+void rp_init_measure(void);
+
+#endif //__rp_measurementMENT_H__