Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert StackProf.run / StackProf.result to Ruby #154

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Convert StackProf.run / StackProf.result to Ruby #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
86622c8
Convert StackProf.run / StackProf.result to Ruby
tenderlove May 4, 2021
9c36791
run the build
tenderlove May 5, 2021
bf4167e
testing
tenderlove May 5, 2021
0b05968
testing
tenderlove May 5, 2021
8cd73fa
I don't want to support this many Ruby versions
tenderlove May 5, 2021
70f3910
testing
tenderlove May 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
strategy:
fail-fast: false
matrix:
ruby: [ ruby-head, '3.1', '3.0', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', truffleruby ]
ruby: [ ruby-head, '3.2', '3.1', '3.0', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', truffleruby ]
steps:
- name: Checkout
uses: actions/checkout@v2
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Inspired heavily by [gperftools](https://code.google.com/p/gperftools/), and wri

## Requirements

* Ruby 2.2+
* Ruby 2.7+
* Linux-based OS

## Getting Started
Expand Down
37 changes: 8 additions & 29 deletions ext/stackprof/stackprof.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ static struct {

VALUE mode;
VALUE interval;
VALUE out;
VALUE metadata;
int ignore_gc;

Expand Down Expand Up @@ -131,7 +130,7 @@ static struct {

static VALUE sym_object, sym_wall, sym_cpu, sym_custom, sym_name, sym_file, sym_line;
static VALUE sym_samples, sym_total_samples, sym_missed_samples, sym_edges, sym_lines;
static VALUE sym_version, sym_mode, sym_interval, sym_raw, sym_metadata, sym_frames, sym_ignore_gc, sym_out;
static VALUE sym_version, sym_mode, sym_interval, sym_raw, sym_metadata, sym_frames, sym_ignore_gc;
static VALUE sym_aggregate, sym_raw_sample_timestamps, sym_raw_timestamp_deltas, sym_state, sym_marking, sym_sweeping;
static VALUE sym_gc_samples, objtracer;
static VALUE gc_hook;
Expand All @@ -145,7 +144,7 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
{
struct sigaction sa;
struct itimerval timer;
VALUE opts = Qnil, mode = Qnil, interval = Qnil, metadata = rb_hash_new(), out = Qfalse;
VALUE opts = Qnil, mode = Qnil, interval = Qnil, metadata = rb_hash_new();
int ignore_gc = 0;
int raw = 0, aggregate = 1;
VALUE metadata_val;
Expand All @@ -158,7 +157,6 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
if (RTEST(opts)) {
mode = rb_hash_aref(opts, sym_mode);
interval = rb_hash_aref(opts, sym_interval);
out = rb_hash_aref(opts, sym_out);
if (RTEST(rb_hash_aref(opts, sym_ignore_gc))) {
ignore_gc = 1;
}
Expand Down Expand Up @@ -220,7 +218,6 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
_stackprof.interval = interval;
_stackprof.ignore_gc = ignore_gc;
_stackprof.metadata = metadata;
_stackprof.out = out;
_stackprof.target_thread = pthread_self();

if (raw) {
Expand Down Expand Up @@ -343,7 +340,7 @@ frame_i(st_data_t key, st_data_t val, st_data_t arg)
}

static VALUE
stackprof_results(int argc, VALUE *argv, VALUE self)
stackprof_results(VALUE self, VALUE io)
{
VALUE results, frames;

Expand Down Expand Up @@ -409,35 +406,22 @@ stackprof_results(int argc, VALUE *argv, VALUE self)
_stackprof.raw = 0;
}

if (argc == 1)
_stackprof.out = argv[0];

if (RTEST(_stackprof.out)) {
if (RTEST(io)) {
VALUE file;
if (rb_respond_to(_stackprof.out, rb_intern("to_io"))) {
file = rb_io_check_io(_stackprof.out);
if (rb_respond_to(io, rb_intern("to_io"))) {
file = rb_io_check_io(io);
} else {
file = rb_file_open_str(_stackprof.out, "w");
file = rb_file_open_str(io, "w");
}

rb_marshal_dump(results, file);
rb_io_flush(file);
_stackprof.out = Qnil;
return file;
} else {
return results;
}
}

static VALUE
stackprof_run(int argc, VALUE *argv, VALUE self)
{
rb_need_block();
stackprof_start(argc, argv, self);
rb_ensure(rb_yield, Qundef, stackprof_stop, self);
return stackprof_results(0, 0, self);
}

static VALUE
stackprof_running_p(VALUE self)
{
Expand Down Expand Up @@ -799,9 +783,6 @@ stackprof_gc_mark(void *data)
if (RTEST(_stackprof.metadata))
rb_gc_mark(_stackprof.metadata);

if (RTEST(_stackprof.out))
rb_gc_mark(_stackprof.out);

if (_stackprof.frames)
st_foreach(_stackprof.frames, frame_mark_i, 0);
}
Expand Down Expand Up @@ -875,7 +856,6 @@ Init_stackprof(void)
S(raw);
S(raw_sample_timestamps);
S(raw_timestamp_deltas);
S(out);
S(metadata);
S(ignore_gc);
S(frames);
Expand Down Expand Up @@ -910,10 +890,9 @@ Init_stackprof(void)

rb_mStackProf = rb_define_module("StackProf");
rb_define_singleton_method(rb_mStackProf, "running?", stackprof_running_p, 0);
rb_define_singleton_method(rb_mStackProf, "run", stackprof_run, -1);
rb_define_singleton_method(rb_mStackProf, "start", stackprof_start, -1);
rb_define_singleton_method(rb_mStackProf, "stop", stackprof_stop, 0);
rb_define_singleton_method(rb_mStackProf, "results", stackprof_results, -1);
rb_define_singleton_method(rb_mStackProf, "_results", stackprof_results, 1);
rb_define_singleton_method(rb_mStackProf, "sample", stackprof_sample, 0);
rb_define_singleton_method(rb_mStackProf, "use_postponed_job!", stackprof_use_postponed_job_l, 0);

Expand Down
22 changes: 22 additions & 0 deletions lib/stackprof.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,28 @@

module StackProf
VERSION = '0.2.23'

class << self
private :_results

def run(mode: :wall, out: nil, interval: nil, raw: nil, metadata: nil, debug: nil, &block)
raise unless block_given?

start(mode: mode, interval: interval, raw: raw, metadata: metadata, debug: nil)

begin
yield
ensure
stop
end

results out
end

def results(io = nil)
_results io
end
end
end

StackProf.autoload :Report, "stackprof/report.rb"
Expand Down
16 changes: 13 additions & 3 deletions test/test_stackprof.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,12 @@ def test_object_allocation
assert_equal :object, profile[:mode]
assert_equal 1, profile[:interval]
if RUBY_VERSION >= '3'
assert_equal 4, profile[:samples]
begin
assert_equal 4, profile[:samples]
rescue Exception => e
p profile
raise
end
else
assert_equal 2, profile[:samples]
end
Expand All @@ -65,7 +70,12 @@ def test_object_allocation
if RUBY_VERSION >= '3'
assert_equal [4, 0], frame[:lines][profile_base_line]
else
assert_equal [2, 0], frame[:lines][profile_base_line]
begin
assert_equal [2, 0], frame[:lines][profile_base_line]
rescue Exception => e
p frame[:lines]
raise e
end
end
end

Expand All @@ -77,7 +87,7 @@ def test_object_allocation_interval
end

def test_cputime
profile = StackProf.run(mode: :cpu, interval: 500) do
profile = StackProf.run(mode: :cpu, interval: 1000) do
math
end

Expand Down