Bug #14817: TracePoint#parameters for bmethod's return event should return the same value as its Method#parameters

• Status: Assigned
• Priority: Normal
• Assignee: ko1 (Koichi Sasada)
• Target version: -
• ruby -v: ruby 2.6.0dev (2018-06-03 master 63562) [x86_64-linux]
• Backport: 2.3: UNKNOWN, 2.4: UNKNOWN, 2.5: UNKNOWN
• Tags: tracepoint

[ktsj (Kazuki Tsujimoto)]

define_methodしたメソッド(bmethod)のcall/returnイベント中にTracePoint#parametersを呼び出すと
以下の結果となります。

$ cat t.rb
define_method(:bm) {|a|}

p method_parameters: method(:bm).parameters

trace = TracePoint.new(:call, :return){|tp|
  mid = tp.method_id
  if mid == :bm
    p mid: mid, event: tp.event, tp_parameters: tp.parameters
  end
}
trace.enable{
  bm(0)
}

$ ruby -v t.rb
ruby 2.6.0dev (2018-06-03 master 63562) [x86_64-linux]
{:method_parameters=>[[:req, :a]]}
{:mid=>:bm, :event=>:call, :tp_parameters=>[[:req, :a]]}
{:mid=>:bm, :event=>:return, :tp_parameters=>[]}         #=> expected: {:mid=>:bm, :event=>:return, :tp_parameters=>[[:req, :a]]}

現状、callイベントに限ってその戻り値がbmethodのMethod#parametersの呼び出し結果と一致しますが
returnイベント時も同様となるべきだと思います。

[mame (Yusuke Endoh)]

TracePoint#parameters の問題ではなく、define_method + TracePoint 全般の問題のようです。

define_method(:bm) {|a|}

trace = TracePoint.new(:call, :return){|tp|
  p [tp.event, tp.lineno] if tp.method_id == :bm
}
trace.enable{
  bm(0)
}

$ ./miniruby test.rb
[:call, 1]
[:return, 7] #=> [:return, 1] になるべき？

[mame (Yusuke Endoh)]

• Assignee changed from mame (Yusuke Endoh) to ko1 (Koichi Sasada)

invoke_bmethod で vm_exec が終わったあとに EXEC_EVENT_HOOK(ec, RUBY_EVENT_RETURN, ...) するため、このような挙動になっているようです。
これは仕様でしょうか。とりあえずささださんに振ります。

[ko1 (Koichi Sasada)]

見逃してました。

これ、実装見てたら、どーしょーもない気がするんで、制限のある仕様、ってことで駄目でしょうか。駄目かなあ。実装アイディア募集。

[ko1 (Koichi Sasada)]

• Status changed from Assigned to Feedback

[ko1 (Koichi Sasada)]

2.6では known issue にします。
2.7 で、define_method したら ISeq 作るようにするとどうかな、と思っているので、それで一気に解決します。

[ko1 (Koichi Sasada)]

• Target version changed from 2.6 to 2.7

[naruse (Yui NARUSE)]

• Target version deleted (2.7)

[ko1 (Koichi Sasada)]

• Status changed from Feedback to Assigned

2.7 で、define_method したら ISeq 作るようにするとどうかな、と思っているので、それで一気に解決します。

これでうまくいかない、ということがわかったので、ちょっと宙ぶらりんです。

考えていた解決案：

• (1) proc を受け取る
• (2) proc のパラメータとまったく同じ method iseq を作る
• (3) 受け取ったパラメータを proc に渡す

こんな感じです。

foo_body = proc{|a, b| xxx}
def foo(a, b) # foo_body.parameters を見て、パラメータリストを作る
  foo_body[a, b]
end

これでいけるじゃん、天才だなと思ってたんですが、optional 引数 o = expr が入ると、うまくいかないことがわかりました。optional 引数の分を、rest で受け取っちゃう、ってのも手だけど、それだと実際に rest が居たときに面倒そうかなぁ。ああ、foo の method parameter が rest になっちゃうから良くないですね。

この問題について、解決案が全然思い浮かびません。

[jeremyevans0 (Jeremy Evans)]

• Related to Bug #13392: TracePoint return event location is incorrect for methods defined with define_method added

[jeremyevans0 (Jeremy Evans)]

The cause of this issue is the same as #13392. I've verified the pull request I submitted for that issue (https://github.com/ruby/ruby/pull/4588) will also fix this issue.