From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-3.8 required=3.0 tests=AWL,BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_PASS,UNPARSEABLE_RELAY,URIBL_BLOCKED shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from neon.ruby-lang.org (neon.ruby-lang.org [221.186.184.75]) by dcvr.yhbt.net (Postfix) with ESMTP id 4CAD61F66E for ; Fri, 28 Aug 2020 21:35:13 +0000 (UTC) Received: from neon.ruby-lang.org (localhost [IPv6:::1]) by neon.ruby-lang.org (Postfix) with ESMTP id B5795120ACB; Sat, 29 Aug 2020 06:34:37 +0900 (JST) Received: from xtrwkhkc.outbound-mail.sendgrid.net (xtrwkhkc.outbound-mail.sendgrid.net [167.89.16.28]) by neon.ruby-lang.org (Postfix) with ESMTPS id 14D47120ABB for ; Sat, 29 Aug 2020 06:34:34 +0900 (JST) Received: by filterdrecv-p3las1-75ccf54874-hfzq9 with SMTP id filterdrecv-p3las1-75ccf54874-hfzq9-17-5F497887-3B 2020-08-28 21:35:03.560539834 +0000 UTC m=+99297.350230453 Received: from herokuapp.com (unknown) by ismtpd0084p1mdw1.sendgrid.net (SG) with ESMTP id lTArQ73ISPCJQyrgH0gMKw for ; Fri, 28 Aug 2020 21:35:03.400 +0000 (UTC) Date: Fri, 28 Aug 2020 21:35:03 +0000 (UTC) From: merch-redmine@jeremyevans.net Message-ID: References: Mime-Version: 1.0 X-Redmine-MailingListIntegration-Message-Ids: 75591 X-Redmine-Project: ruby-master X-Redmine-Issue-Tracker: Bug X-Redmine-Issue-Id: 16983 X-Redmine-Issue-Author: pocke X-Redmine-Sender: jeremyevans0 X-Mailer: Redmine X-Redmine-Host: bugs.ruby-lang.org X-Redmine-Site: Ruby Issue Tracking System X-Auto-Response-Suppress: All Auto-Submitted: auto-generated X-SG-EID: =?us-ascii?Q?RVE3t853K5scBhbmJHUzZTFFeVC=2FZSUmHZ0Dc+26wcEi2CTgsF1oz0wTSSxGGN?= =?us-ascii?Q?BI8WA0NLMaTTgyKv1mD+0VuO0npSJx7zuMbmWoy?= =?us-ascii?Q?Tq9vd=2FNu4oeb+wlAuIeYv1LXyYGbqqnrFVGUNnR?= =?us-ascii?Q?vrSgNYNI7qgVDwfHje9lo5o6vH9dDThklspnWLZ?= =?us-ascii?Q?ER99SeKdZvDI7+wsF7tdo6ouInu0F73Sqjeu6V9?= =?us-ascii?Q?ezukDJnjpD36NnR=2FM=3D?= To: ruby-core@ruby-lang.org X-ML-Name: ruby-core X-Mail-Count: 99759 Subject: [ruby-core:99759] [Ruby master Bug#16983] RubyVM::AbstractSyntaxTree.of(method) returns meaningless node if the method is defined in eval X-BeenThere: ruby-core@ruby-lang.org X-Mailman-Version: 2.1.15 Precedence: list Reply-To: Ruby developers List-Id: Ruby developers List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ruby-core-bounces@ruby-lang.org Sender: "ruby-core" Issue #16983 has been updated by jeremyevans0 (Jeremy Evans). I'm not sure if this is a bug, but it does seem like a fundamental and significant limitation with the design of RubyVM::AbstractSyntaxTree.of. RubyVM::AbstractSyntaxTree.of reparses the file the method is defined in and cannot handle any cases where `eval` or similar are used. You'll get a node completely different from what you would expect. Here's another example: ```ruby eval DATA.read, binding, __FILE__, 14 method = method(:foo) pp RubyVM::AbstractSyntaxTree.of(method) __END__ def foo end ``` Output: ``` (VCALL@1:16-1:23 :binding) ``` Because it reparses the file, you'll also get the wrong result if the file is modified: ```ruby def bar end File.write(__FILE__, File.read(__FILE__).gsub('def bar', "def foo\nbar")) method = method(:bar) pp RubyVM::AbstractSyntaxTree.of(method) ``` Output: ``` (SCOPE@1:0-3:3 tbl: [] args: (ARGS@1:7-1:7 pre_num: 0 pre_init: nil opt: nil first_post: nil post_num: 0 post_init: nil rest: nil kw: nil kwrest: nil block: nil) body: (VCALL@2:0-2:3 :bar)) ``` And if the interpreter can no longer access the file (chroot, file deletion, permission change, or other file system access limiting), you get an error. I can't think of a way to fix this without all iseq methods holding a reference to the string used to parse them, and having RubyVM::AbstractSyntaxTree.of work off that string. I'm not sure how much extra memory use that would cause, or if such an approach is considered acceptable. ---------------------------------------- Bug #16983: RubyVM::AbstractSyntaxTree.of(method) returns meaningless node if the method is defined in eval https://bugs.ruby-lang.org/issues/16983#change-87263 * Author: pocke (Masataka Kuwabara) * Status: Open * Priority: Normal * ruby -v: ruby 2.8.0dev (2020-06-23T13:58:26Z master dc351ff984) [x86_64-linux] * Backport: 2.5: UNKNOWN, 2.6: UNKNOWN, 2.7: UNKNOWN ---------------------------------------- # Problem `RubyVM::AST.of(method)` returns a meaningless node if the method is defined in eval. For example: ```ruby p 'blah' eval <<~RUBY, binding, __FILE__, __LINE__ + 1 def foo end RUBY method = method(:foo) pp RubyVM::AbstractSyntaxTree.of(method) # => (STR@3:5-3:12 "def foo\n" + "end\n") ``` I expect the node of `foo` method, or `nil`. But it returns a `STR` node. It becomes a big problem when `AST.of` receives arbitrary methods. Because we can't distinguish a method is defined in `eval` or not. It means we can't believe the returned value of `AST.of` if the method may receive a method defined in `eval`. For example: ```ruby def do_something_for_each_method_ast(klass) klass.instance_methods(false).each do |m| ast = RubyVM::AbstractSyntaxTree.of(klass.instance_method(m)) next unless ast do_something ast end end class A eval <<~RUBY, binding, __FILE__, __LINE__ + 1 def foo end RUBY end do_something_for_each_method_ast A ``` In the example, I expect the `do_something` method receives only node for a method definition, but it may pass a wrong node if any method is defined in `eval`. # Cause (I guess) I guess the cause is misleading node number. In and out of an `eval` block uses different sequences of node number. So if I specify `__FILE__` to `eval`, the actual file and code in `eval` may have the same node number. For example ```ruby p 'blah' # Node number for 'blah' is 1, file name is "test.rb" eval <<~RUBY, binding, __FILE__, __LINE__ + 1 def foo # Node number for `def` is also 1, file name is also "test.rb" end RUBY method = method(:foo) # It finds a node from node number 1 by reading "test.rb", so it get the str node. pp RubyVM::AbstractSyntaxTree.of(method) # => (STR@3:5-3:12 "def foo\n" + "end\n") ``` -- https://bugs.ruby-lang.org/