Class: RubyProf::MethodInfo
- Inherits:
-
Object
- Object
- RubyProf::MethodInfo
- Includes:
- Comparable
- Defined in:
- ext/ruby_prof/rp_method.c,
lib/ruby-prof/method_info.rb,
ext/ruby_prof/rp_method.c
Overview
The RubyProf::MethodInfo class stores profiling data for a method. One instance of the RubyProf::MethodInfo class is created per method called per thread. Thus, if a method is called in two different thread then there will be two RubyProf::MethodInfo objects created. RubyProf::MethodInfo objects can be accessed via the RubyProf::Profile object.
Instance Method Summary collapse
- #<=>(other) ⇒ Object
- #aggregate_children ⇒ Object
- #aggregate_parents ⇒ Object
-
#call_infos ⇒ Array of call_info
Returns an array of call info objects that contain profiling information about the current method.
- #called ⇒ Object
-
#calltree_name ⇒ String
Returns the full name of this method in the calltree format.
- #children ⇒ Object
- #children_time ⇒ Object
-
#eliminate! ⇒ Object
remove method from the call graph.
-
#full_name ⇒ String
Returns the full name of this method in the format Object#method.
-
#method_class ⇒ Object
Returns the Ruby klass that owns this method.
-
#klass_name ⇒ String
Returns the name of this method’s class.
-
#line_no ⇒ Integer
returns the line number of the method.
-
#method_id ⇒ Object
Returns the id of this method.
-
#method_name ⇒ String
Returns the name of this method in the format Object#method.
- #min_depth ⇒ Object
- #parents ⇒ Object
-
#recursive? ⇒ Boolean
Returns the true if this method is recursive.
- #root? ⇒ Boolean
- #self_time ⇒ Object
-
#source_file ⇒ String
return the source file of the method.
-
#source_klass ⇒ Object
Returns the Ruby klass of the natural source-level definition.
- #to_s ⇒ Object
- #total_time ⇒ Object
- #wait_time ⇒ Object
Instance Method Details
#<=>(other) ⇒ Object
7 8 9 10 11 12 13 14 15 16 17 18 19 |
# File 'lib/ruby-prof/method_info.rb', line 7 def <=>(other) if self.total_time < other.total_time -1 elsif self.total_time > other.total_time 1 elsif self.min_depth < other.min_depth 1 elsif self.min_depth > other.min_depth -1 else self.full_name <=> other.full_name end end |
#aggregate_children ⇒ Object
97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/ruby-prof/method_info.rb', line 97 def aggregate_children # group call infos based on their targets groups = self.children.each_with_object({}) do |call_info, hash| key = call_info.target (hash[key] ||= []) << call_info end groups.map do |key, value| AggregateCallInfo.new(value, self) end end |
#aggregate_parents ⇒ Object
85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/ruby-prof/method_info.rb', line 85 def aggregate_parents # group call infos based on their parents groups = self.call_infos.each_with_object({}) do |call_info, hash| key = call_info.parent ? call_info.parent.target : self (hash[key] ||= []) << call_info end groups.map do |key, value| AggregateCallInfo.new(value, self) end end |
#call_infos ⇒ Array of call_info
Returns an array of call info objects that contain profiling information about the current method.
566 567 568 569 570 571 572 573 574 |
# File 'ext/ruby_prof/rp_method.c', line 566
static VALUE
prof_method_call_infos(VALUE self)
{
prof_method_t *method = get_prof_method(self);
if (method->call_infos->object == Qnil) {
method->call_infos->object = prof_call_infos_wrap(method->call_infos);
}
return method->call_infos->object;
}
|
#called ⇒ Object
21 22 23 24 25 26 27 |
# File 'lib/ruby-prof/method_info.rb', line 21 def called @called ||= begin call_infos.inject(0) do |sum, call_info| sum + call_info.called end end end |
#calltree_name ⇒ String
Returns the full name of this method in the calltree format.
603 604 605 606 607 608 609 |
# File 'ext/ruby_prof/rp_method.c', line 603
static VALUE
prof_calltree_name(VALUE self)
{
prof_method_t *method = get_prof_method(self);
volatile VALUE source_klass = resolve_source_klass(method);
return calltree_name(source_klass, method->relation, method->key->mid);
}
|
#children ⇒ Object
77 78 79 |
# File 'lib/ruby-prof/method_info.rb', line 77 def children @children ||= call_infos.map(&:children).flatten end |
#children_time ⇒ Object
56 57 58 59 60 61 62 63 |
# File 'lib/ruby-prof/method_info.rb', line 56 def children_time @children_time ||= begin call_infos.inject(0) do |sum, call_info| sum += call_info.children_time if !call_info.recursive? sum end end end |
#eliminate! ⇒ Object
remove method from the call graph. should not be called directly.
114 115 116 117 118 |
# File 'lib/ruby-prof/method_info.rb', line 114 def eliminate! # $stderr.puts "eliminating #{self}" call_infos.each{ |call_info| call_info.eliminate! } call_infos.clear end |
#full_name ⇒ String
Returns the full name of this method in the format Object#method.
554 555 556 557 558 559 |
# File 'ext/ruby_prof/rp_method.c', line 554
static VALUE
prof_full_name(VALUE self)
{
prof_method_t *method = get_prof_method(self);
return full_name(method->key->klass, method->key->mid);
}
|
#method_class ⇒ Object
Returns the Ruby klass that owns this method.
505 506 507 508 509 510 |
# File 'ext/ruby_prof/rp_method.c', line 505
static VALUE
prof_method_klass(VALUE self)
{
prof_method_t *result = get_prof_method(self);
return result->key->klass;
}
|
#klass_name ⇒ String
Returns the name of this method’s class. Singleton classes will have the form <Object::Object>.
529 530 531 532 533 534 |
# File 'ext/ruby_prof/rp_method.c', line 529
static VALUE
prof_klass_name(VALUE self)
{
prof_method_t *method = get_prof_method(self);
return klass_name(method->key->klass);
}
|
#line_no ⇒ Integer
returns the line number of the method
478 479 480 481 482 483 |
# File 'ext/ruby_prof/rp_method.c', line 478
static VALUE
prof_method_line(VALUE self)
{
int line = get_prof_method(self)->line;
return rb_int_new(line);
}
|
#method_id ⇒ Object
Returns the id of this method.
516 517 518 519 520 521 |
# File 'ext/ruby_prof/rp_method.c', line 516
static VALUE
prof_method_id(VALUE self)
{
prof_method_t *result = get_prof_method(self);
return ID2SYM(result->key->mid);
}
|
#method_name ⇒ String
Returns the name of this method in the format Object#method. Singletons methods will be returned in the format <Object::Object>#method.
542 543 544 545 546 547 |
# File 'ext/ruby_prof/rp_method.c', line 542
static VALUE
prof_method_name(VALUE self)
{
prof_method_t *method = get_prof_method(self);
return method_name(method->key->mid);
}
|
#min_depth ⇒ Object
65 66 67 |
# File 'lib/ruby-prof/method_info.rb', line 65 def min_depth @min_depth ||= call_infos.map(&:depth).min end |
#parents ⇒ Object
81 82 83 |
# File 'lib/ruby-prof/method_info.rb', line 81 def parents @parents ||= call_infos.map(&:parent) end |
#recursive? ⇒ Boolean
Returns the true if this method is recursive
580 581 582 583 584 585 |
# File 'ext/ruby_prof/rp_method.c', line 580
static VALUE
prof_method_recursive(VALUE self)
{
prof_method_t *method = get_prof_method(self);
return method->recursive ? Qtrue : Qfalse;
}
|
#root? ⇒ Boolean
69 70 71 72 73 74 75 |
# File 'lib/ruby-prof/method_info.rb', line 69 def root? @root ||= begin call_infos.find do |call_info| not call_info.root? end.nil? end end |
#self_time ⇒ Object
38 39 40 41 42 43 44 45 |
# File 'lib/ruby-prof/method_info.rb', line 38 def self_time @self_time ||= begin call_infos.inject(0) do |sum, call_info| sum += call_info.self_time if !call_info.recursive? sum end end end |
#source_file ⇒ String
return the source file of the method
490 491 492 493 494 495 496 497 498 |
# File 'ext/ruby_prof/rp_method.c', line 490
static VALUE prof_method_source_file(VALUE self)
{
const char* sf = get_prof_method(self)->source_file;
if(!sf) {
return rb_str_new2("ruby_runtime");
} else {
return rb_str_new2(sf);
}
}
|
#source_klass ⇒ Object
Returns the Ruby klass of the natural source-level definition.
591 592 593 594 595 596 |
# File 'ext/ruby_prof/rp_method.c', line 591
static VALUE
prof_source_klass(VALUE self)
{
prof_method_t *method = get_prof_method(self);
return resolve_source_klass(method);
}
|
#to_s ⇒ Object
109 110 111 |
# File 'lib/ruby-prof/method_info.rb', line 109 def to_s "#{self.full_name} (c: #{self.called}, tt: #{self.total_time}, st: #{self.self_time}, wt: #{wait_time}, ct: #{self.children_time})" end |
#total_time ⇒ Object
29 30 31 32 33 34 35 36 |
# File 'lib/ruby-prof/method_info.rb', line 29 def total_time @total_time ||= begin call_infos.inject(0) do |sum, call_info| sum += call_info.total_time if !call_info.recursive? sum end end end |
#wait_time ⇒ Object
47 48 49 50 51 52 53 54 |
# File 'lib/ruby-prof/method_info.rb', line 47 def wait_time @wait_time ||= begin call_infos.inject(0) do |sum, call_info| sum += call_info.wait_time if !call_info.recursive? sum end end end |