ruby-prof 1.4.3 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d823139ee13d55c54104dd034274b61316a525b54ac3802b90dcb111d8ccb3d2
-  data.tar.gz: c9ae3a108bbe1f9559848df06a943c4d42e10e4b62a450f8e0278d796ed90f80
+  metadata.gz: fb77381e6fdb509ca6b243a57dd21e4f7eceaeaeb658cbfa13c5660d94320657
+  data.tar.gz: d9de35cbf400aad32c6f451af75e4e8e549712f55e89b35e4036ec2eaecd3ce8
 SHA512:
-  metadata.gz: 505e983efedd32bed3cdadff2256e4c9c875551caba829999ec2dd87a36052024612eec9e70ebe586b05b3ee70b95d8c3dba3bd5b14bd01ca1243317a5336313
-  data.tar.gz: 9e3430bd9af49f2a045485bc9322f2deabe23bd43575ae00e0718316829d1468492db17476b7a428f6592f7d5fc65ad3f96e68de97a084ff606971ef89d5e14b
+  metadata.gz: fdd4b10b506be935b8ae272722b95745646c6ad2a1d1997a2869c7c9a8425c5d498dec449246c7cb3c1fc728ea2c2be92cfffa4e806a3ff8363fe075f71e385b
+  data.tar.gz: ff9453f7f7a7cd37e36303d92ccff7697f167776a578351efe8d778e9f92c0f6d4cd144d6792ea18afe93cae8b47a6099264304ec39759334d0b3e61c9ee688f

data/CHANGES

@@ -1,15 +1,36 @@
-1.4.3 (2021-02-15)
+1.4.5 (2022-12-27)
+=====================
+* Look for ruby_prof extension built on install in the lib directory (Charlie Savage)
+* Added Ruby 3.2.0 build for mingw-urct
+
+1.4.4 (2022-12-11)
+=====================
+* Update tests for Ruby 3.1 (Charlie Savage)
+* When tracing allocations always use the RUBY_INTERNAL_EVENT_NEWOBJ trace event. Previously GC stats could also be used, but that includes the creation of internal T_IMEMO objects makes reviewing results confusing (Charlie Savage)
+* Remove :profile option that lets a user set the prefix on callgrind output files since KCacheGrind will not automatically show these files in its open dialog. Fixes #313. (Charlie Savage)
+* Don't expose threads to Ruby that don't have a call tree. This can happen when a user is profiling memory usage and then sends a signint to the profiled process. New objects will be created in a new thread, but no method enter/exit trace events are generated by Ruby. Thus the thread has no call tree. Fixes #312 (Charlie Savage)
+* Update github Actions - change 3.0 to '3.0', add Windows mswin (MSP-Greg)
+* Add Ruby 3.1 to test matrix (Charlie Savage)
+* Use normal weight text instead of bold in call strack printer output. Fixes #297 (Charlie Savage)
+* Update VC project to Ruby 3.1 and Visual Studio 2022 (Charlie Savage)
+* Fix marshaling of profile measure. Fixes #315 (Charlie Savage)
+* CI: Omit duplicate 'bundle install'. PR #309 (Olle Jonsson)
+* Fix typo. s/perecent/percent/ (Paarth Madan)
+* Remove support for Ruby 2.5 and 2.6 which are now end of life (Charlie Savage)
+
+1.4.3 (2021-02-16)
 =====================
 * Remove trailing spaces (sergioro)
-* Enable loading ruby_prof.so from ext directory for development purposes (sergioro)
-* Create temp directory for test output (sergioro)
+* Load "ruby-prof.so" with require_relative (sergioro)
+* Use same file permissions for all test files (sergioro)
+* Create tmp directory for test output (sergioro)
+* Update git-ignore to add mkmf log (sergioro)
 * Fix minitest warning about using MT_CPU instead of N (sergioro)
-* Fix minitest warning "Use assert_nil if expecting nil"  (sergioro)
-* Fix file permissions (sergioro)
-* Fix failing test by forcing GC to run (Charlie Savage)
-* Switch to GitHub actions (Charlie Savage)
-* Switch to C11 (Charlie Savage)
-* Greatly slim down library size by removing symbols on GCC (Charlie Savage)
+* Fix minitest warning "Use assert_nil if expecting nil (sergioro)
+* Add xcode project (Charlie Savage)
+* Update test for Ruby 3.0 (Charlie Savage)
+* Remove Ruby 2.4 support since it is no longer maintained (Charlie Savage)
+* Replace travis status badge with github status badge (Charlie Savage)
 
 1.4.2 (2020-11-3)
 =====================

data/{README.rdoc → README.md}

@@ -1,5 +1,5 @@
-= ruby-prof
+# ruby-prof
 
 ![ruby-prof](https://github.com/ruby-prof/ruby-prof/workflows/ruby-prof/badge.svg)
 
-For an overview of ruby-prof please see https://ruby-prof.github.io
+For an overview of ruby-prof please see https://ruby-prof.github.io

data/Rakefile

@@ -42,7 +42,7 @@ end
 Rake::Task[:package].enhance [:rdoc]
 
 # Setup Windows Gem
-if RUBY_PLATFORM.match(/win32|mingw32/)
+if RUBY_PLATFORM.match(/mswin|mingw/)
   # Windows specification
   win_spec = default_spec.clone
   win_spec.platform = Gem::Platform::CURRENT
@@ -65,13 +65,13 @@ RDoc::Task.new("rdoc") do |rdoc|
   # Show source inline with line numbers
   rdoc.options << "--line-numbers"
   # Make the readme file the start page for the generated html
-  rdoc.options << '--main' << 'README.rdoc'
+  rdoc.options << '--main' << 'README.md'
   rdoc.rdoc_files.include('bin/*',
                           'doc/*.rdoc',
                           'lib/**/*.rb',
                           'ext/ruby_prof/*.c',
                           'ext/ruby_prof/*.h',
-                          'README.rdoc',
+                          'README.md',
                           'LICENSE')
 end
 

data/ext/ruby_prof/rp_call_tree.c

@@ -3,8 +3,6 @@
 
 #include "rp_call_tree.h"
 
-#define INITIAL_CALL_TREES_SIZE 2
-
 VALUE cRpCallTree;
 
 /* =======  prof_call_tree_t   ========*/

data/ext/ruby_prof/rp_call_tree.h

@@ -38,6 +38,6 @@ uint32_t prof_call_figure_depth(prof_call_tree_t* call_tree_data);
 prof_call_tree_t* prof_get_call_tree(VALUE self);
 VALUE prof_call_tree_wrap(prof_call_tree_t* call_tree);
 void prof_call_tree_free(prof_call_tree_t* call_tree);
-void rp_init_call_tree(void);
+void rp_init_call_tree();
 
 #endif //__RP_CALL_TREE_H__

data/ext/ruby_prof/rp_measure_allocations.c

@@ -8,20 +8,20 @@
 static VALUE cMeasureAllocations;
 VALUE total_allocated_objects_key;
 
-static double measure_allocations_via_gc_stats(rb_trace_arg_t* trace_arg)
-{
-    return (double)rb_gc_stat(total_allocated_objects_key);
-}
-
-static double measure_allocations_via_tracing(rb_trace_arg_t* trace_arg)
+static double measure_allocations(rb_trace_arg_t* trace_arg)
 {
     static double result = 0;
 
     if (trace_arg)
     {
+        // Only process creation of new objects
         rb_event_flag_t event = rb_tracearg_event_flag(trace_arg);
-        if (event == RUBY_INTERNAL_EVENT_NEWOBJ)
-            result++;
+        if (event == RUBY_INTERNAL_EVENT_NEWOBJ) {
+            // Don't count allocations of internal IMemo objects
+            VALUE object = rb_tracearg_object(trace_arg);
+            if (BUILTIN_TYPE(object) != T_IMEMO)
+                result++;
+        }
     }
     return result;
 }
@@ -30,14 +30,11 @@ prof_measurer_t* prof_measurer_allocations(bool track_allocations)
 {
     prof_measurer_t* measure = ALLOC(prof_measurer_t);
     measure->mode = MEASURE_ALLOCATIONS;
+    measure->measure = measure_allocations;
     measure->multiplier = 1;
+    // Need to track allocations to get RUBY_INTERNAL_EVENT_NEWOBJ event
     measure->track_allocations = track_allocations;
 
-    if (track_allocations)
-        measure->measure = measure_allocations_via_tracing;
-    else
-        measure->measure = measure_allocations_via_gc_stats;
-
     return measure;
 }
 

data/ext/ruby_prof/rp_measure_memory.c

@@ -7,20 +7,23 @@
 
 static VALUE cMeasureMemory;
 
-static double
-measure_memory_via_tracing(rb_trace_arg_t* trace_arg)
+static double measure_memory(rb_trace_arg_t* trace_arg)
 {
     static double result = 0;
 
     if (trace_arg)
     {
+        // Only process creation of new objects
         rb_event_flag_t event = rb_tracearg_event_flag(trace_arg);
         if (event == RUBY_INTERNAL_EVENT_NEWOBJ)
         {
+            // Don't count allocations of internal IMemo objects
             VALUE object = rb_tracearg_object(trace_arg);
-            result += rb_obj_memsize_of(object);
+            if (BUILTIN_TYPE(object) != T_IMEMO)
+                result += rb_obj_memsize_of(object);
         }
     }
+
     return result;
 }
 
@@ -28,8 +31,9 @@ prof_measurer_t* prof_measurer_memory(bool track_allocations)
 {
   prof_measurer_t* measure = ALLOC(prof_measurer_t);
   measure->mode = MEASURE_MEMORY;
-  measure->measure = measure_memory_via_tracing;
+  measure->measure = measure_memory;
   measure->multiplier = 1;
+  // Need to track allocations to get RUBY_INTERNAL_EVENT_NEWOBJ event
   measure->track_allocations = true;
   return measure;
 }

data/ext/ruby_prof/rp_measure_process_time.c

@@ -11,21 +11,22 @@ static double measure_process_time(rb_trace_arg_t* trace_arg)
 #if defined(_WIN32)
     FILETIME  createTime;
     FILETIME  exitTime;
-    FILETIME  sysTime;
+    FILETIME  kernelTime;
     FILETIME  userTime;
 
-    ULARGE_INTEGER sysTimeInt;
+    ULARGE_INTEGER kernelTimeInt;
     ULARGE_INTEGER userTimeInt;
 
-    GetProcessTimes(GetCurrentProcess(), &createTime, &exitTime, &sysTime, &userTime);
+    GetProcessTimes(GetCurrentProcess(), &createTime, &exitTime, &kernelTime, &userTime);
 
-    sysTimeInt.LowPart = sysTime.dwLowDateTime;
-    sysTimeInt.HighPart = sysTime.dwHighDateTime;
+    kernelTimeInt.LowPart = kernelTime.dwLowDateTime;
+    kernelTimeInt.HighPart = kernelTime.dwHighDateTime;
     userTimeInt.LowPart = userTime.dwLowDateTime;
     userTimeInt.HighPart = userTime.dwHighDateTime;
 
-    return (double)(sysTimeInt.QuadPart + userTimeInt.QuadPart);
+    return (double)(kernelTimeInt.QuadPart + userTimeInt.QuadPart);
 #elif !defined(CLOCK_PROCESS_CPUTIME_ID)
+    #include <sys/resource.h>
     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);

data/ext/ruby_prof/rp_measurement.c

@@ -16,7 +16,7 @@ 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)
+prof_measurer_t* prof_measurer_create(prof_measure_mode_t measure, bool track_allocations)
 {
     switch (measure)
     {

data/ext/ruby_prof/rp_measurement.h

@@ -36,7 +36,7 @@ typedef struct prof_measurement_t
     VALUE object;
 } prof_measurement_t;
 
-prof_measurer_t* prof_get_measurer(prof_measure_mode_t measure, bool track_allocations);
+prof_measurer_t* prof_measurer_create(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);

data/ext/ruby_prof/rp_profile.c

@@ -211,7 +211,7 @@ static void prof_event_hook(VALUE trace_point, void* data)
     }
 
     /* Special case - skip any methods from the mProf
-     module since they clutter the results but aren't important to them results. */
+     module since they clutter the results but aren't important. */
     if (self == mProf)
         return;
 
@@ -226,6 +226,8 @@ static void prof_event_hook(VALUE trace_point, void* data)
         {
             prof_frame_t* frame = prof_frame_current(thread_data->stack);
 
+            /* If there is no frame then this is either the first method being profiled or we have climbed the
+               call stack higher than where we started. */
             if (!frame)
             {
                 prof_method_t* method = check_method(profile, trace_arg, event, thread_data);
@@ -236,11 +238,13 @@ static void prof_event_hook(VALUE trace_point, void* data)
                 prof_call_tree_t* call_tree = prof_call_tree_create(method, NULL, method->source_file, method->source_line);
                 prof_add_call_tree(method->call_trees, call_tree);
 
+                // We have climbed higher in the stack then where we started
                 if (thread_data->call_tree)
                 {
                     prof_call_tree_add_parent(thread_data->call_tree, call_tree);
                     frame = prof_frame_unshift(thread_data->stack, call_tree, thread_data->call_tree, measurement);
                 }
+                // This is the first method to be profiled
                 else
                 {
                     frame = prof_frame_push(thread_data->stack, call_tree, measurement, RTEST(profile_t->paused));
@@ -374,7 +378,7 @@ prof_profile_t* prof_get_profile(VALUE self)
 static int collect_threads(st_data_t key, st_data_t value, st_data_t result)
 {
     thread_data_t* thread_data = (thread_data_t*)value;
-    if (thread_data->trace)
+    if (thread_data->trace && thread_data->call_tree)
     {
         VALUE threads_array = (VALUE)result;
         rb_ary_push(threads_array, prof_thread_wrap(thread_data));
@@ -565,7 +569,7 @@ static VALUE prof_initialize(int argc, VALUE* argv, VALUE self)
     {
         Check_Type(mode, T_FIXNUM);
     }
-    profile->measurer = prof_get_measurer(NUM2INT(mode), track_allocations == Qtrue);
+    profile->measurer = prof_measurer_create(NUM2INT(mode), track_allocations == Qtrue);
     profile->allow_exceptions = (allow_exceptions == Qtrue);
 
     if (exclude_threads != Qnil)
@@ -854,8 +858,14 @@ static VALUE prof_exclude_method(VALUE self, VALUE klass, VALUE msym)
 /* :nodoc: */
 VALUE prof_profile_dump(VALUE self)
 {
+    prof_profile_t* profile = prof_get_profile(self);
+  
     VALUE result = rb_hash_new();
     rb_hash_aset(result, ID2SYM(rb_intern("threads")), prof_threads(self));
+    rb_hash_aset(result, ID2SYM(rb_intern("measurer_mode")), INT2NUM(profile->measurer->mode));
+    rb_hash_aset(result, ID2SYM(rb_intern("measurer_track_allocations")), 
+                 profile->measurer->track_allocations ? Qtrue : Qfalse);
+
     return result;
 }
 
@@ -864,6 +874,11 @@ VALUE prof_profile_load(VALUE self, VALUE data)
 {
     prof_profile_t* profile = prof_get_profile(self);
 
+    VALUE measurer_mode = rb_hash_aref(data, ID2SYM(rb_intern("measurer_mode")));
+    VALUE measurer_track_allocations = rb_hash_aref(data, ID2SYM(rb_intern("measurer_track_allocations")));
+    profile->measurer = prof_measurer_create((prof_measure_mode_t)(NUM2INT(measurer_mode)),
+                                              measurer_track_allocations == Qtrue ? true : false);
+
     VALUE threads = rb_hash_aref(data, ID2SYM(rb_intern("threads")));
     for (int i = 0; i < rb_array_len(threads); i++)
     {

data/ext/ruby_prof/vc/ruby_prof.vcxproj

@@ -29,19 +29,21 @@
     <ConfigurationType>DynamicLibrary</ConfigurationType>
     <UseDebugLibraries>true</UseDebugLibraries>
     <CharacterSet>Unicode</CharacterSet>
+    <PlatformToolset>v143</PlatformToolset>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
     <ConfigurationType>DynamicLibrary</ConfigurationType>
     <UseDebugLibraries>false</UseDebugLibraries>
     <WholeProgramOptimization>true</WholeProgramOptimization>
     <CharacterSet>Unicode</CharacterSet>
+    <PlatformToolset>v143</PlatformToolset>
   </PropertyGroup>
   <PropertyGroup Label="Configuration" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
-    <PlatformToolset>v142</PlatformToolset>
+    <PlatformToolset>v143</PlatformToolset>
     <ConfigurationType>DynamicLibrary</ConfigurationType>
   </PropertyGroup>
   <PropertyGroup Label="Configuration" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
-    <PlatformToolset>v142</PlatformToolset>
+    <PlatformToolset>v143</PlatformToolset>
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
   <ImportGroup Label="ExtensionSettings">
@@ -64,7 +66,7 @@
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <TargetExt>.so</TargetExt>
-    <OutDir>..\..\..\lib\</OutDir>
+    <OutDir>$(SolutionDir)\..</OutDir>
   </PropertyGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
     <ClCompile>
@@ -102,14 +104,14 @@
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <ClCompile>
-      <AdditionalIncludeDirectories>C:\msys64\usr\local\ruby-2.7.2vc\include\ruby-2.7.0\x64-mswin64_140;C:\msys64\usr\local\ruby-2.7.2vc\include\ruby-2.7.0;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>C:\msys64\usr\local\ruby-3.1.2-vc\include\ruby-3.1.0\x64-mswin64_140;C:\msys64\usr\local\ruby-3.1.2-vc\include\ruby-3.1.0;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <Optimization>Disabled</Optimization>
       <PreprocessorDefinitions>%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <WarningLevel>Level3</WarningLevel>
     </ClCompile>
     <Link>
-      <AdditionalLibraryDirectories>C:\msys64\usr\local\ruby-2.7.2vc\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
-      <AdditionalDependencies>x64-vcruntime140-ruby270.lib;%(AdditionalDependencies)</AdditionalDependencies>
+      <AdditionalLibraryDirectories>C:\msys64\usr\local\ruby-3.1.2-vc\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
+      <AdditionalDependencies>x64-vcruntime140-ruby310.lib;%(AdditionalDependencies)</AdditionalDependencies>
       <ModuleDefinitionFile>ruby_prof.def</ModuleDefinitionFile>
       <SubSystem>Console</SubSystem>
     </Link>

data/lib/ruby-prof/assets/call_stack_printer.html.erb

@@ -3,7 +3,7 @@
   <head>
     <meta http-equiv="content-type" content="text/html; charset=utf-8">
     <title>ruby-prof call tree</title>
-    <style type="text/css">
+    <style>
       body {
         font-size: 70%;
         padding: 0;
@@ -19,6 +19,7 @@
         margin-bottom: 0px;
         padding-left: 0px;
         list-style-type: none;
+        font-weight: normal;
       }
 
       li {

data/lib/ruby-prof/printers/call_tree_printer.rb

@@ -100,21 +100,17 @@ module RubyProf
       true
     end
 
-    def base_name
-      @options[:profile] || "profile"
-    end
-
     def remove_subsidiary_files_from_previous_profile_runs
-      pattern = [base_name, "callgrind.out", $$, "*"].join(".")
+      pattern = ["callgrind.out", $$, "*"].join(".")
       files = Dir.glob(File.join(path, pattern))
       FileUtils.rm_f(files)
     end
 
     def file_name_for_thread(thread)
       if thread.fiber_id == Fiber.current.object_id
-        [base_name, "callgrind.out", $$].join(".")
+        ["callgrind.out", $$].join(".")
       else
-        [base_name, "callgrind.out", $$, thread.fiber_id].join(".")
+        ["callgrind.out", $$, thread.fiber_id].join(".")
       end
     end
 

data/lib/ruby-prof/printers/graph_html_printer.rb

@@ -29,7 +29,7 @@ module RubyProf
     end
 
     # Creates a link to a method.  Note that we do not create
-    # links to methods which are under the min_perecent
+    # links to methods which are under the min_percent
     # specified by the user, since they will not be
     # printed out.
     def create_link(thread, overall_time, method)

data/lib/ruby-prof/version.rb

@@ -1,3 +1,3 @@
 module RubyProf
-  VERSION = "1.4.3"
+  VERSION = "1.4.5"
 end

data/lib/ruby-prof.rb

@@ -6,7 +6,7 @@ begin
   version = Gem::Version.new(RUBY_VERSION)
   require "#{version.segments[0..1].join('.')}/ruby_prof.so"
 rescue LoadError
-  require_relative "../ext/ruby_prof/ruby_prof.so"
+  require "ruby_prof.so"
 end
 
 require 'ruby-prof/version'

data/ruby-prof.gemspec

@@ -36,7 +36,7 @@ EOF
   spec.files = Dir['CHANGES',
                    'LICENSE',
                    'Rakefile',
-                   'README.rdoc',
+                   'README.md',
                    'ruby-prof.gemspec',
                    'bin/ruby-prof',
                    'bin/ruby-prof-check-trace',
@@ -56,10 +56,9 @@ EOF
                    'test/*.rb']
 
   spec.test_files = Dir["test/test_*.rb"]
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7.0'
   spec.date = Time.now.strftime('%Y-%m-%d')
   spec.homepage = 'https://github.com/ruby-prof/ruby-prof'
   spec.add_development_dependency('minitest')
   spec.add_development_dependency('rake-compiler')
-  spec.add_development_dependency('rdoc')
 end