8250625: Compiler implementation of Pattern Matching for instanceof (Final) #559

lahodaj · 2020-10-08T11:49:17Z

This is the current proposed patch for the upcoming JEP 394, for pattern matching for instanceof.

A summary of changes:
-making the feature permanent (non-preview)
-making the binding variables non-final (as per current specification proposal)
-producing a compile-time error for the case where the expression's type is a subtype of the type test pattern's type (as per current specification proposal)
-changing the AST structure so that the binding variable has a VariableTree in the AST. BindingPatternTree is preserved and encloses the VariableTree. The reason is better consistency in the API, with nodes like CatchTree, EnhancedForLoop Tree, etc.

This change will not be integrated until JEP 394 is targetted.

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Testing

	Linux x64	Linux x86	Windows x64	macOS x64
Build	✔️ (5/5 passed)	✔️ (2/2 passed)	✔️ (2/2 passed)	✔️ (2/2 passed)
Test (tier1)	✔️ (9/9 passed)	✔️ (9/9 passed)	❌ (2/9 failed)	❌ (1/9 failed)

Failed test tasks

Issue

JDK-8250625: Compiler implementation of Pattern Matching for instanceof (Final)

Reviewers

Vicente Romero (@vicente-romero-oracle - Reviewer) ⚠️ Review applies to 77468e2

Download

$ git fetch https://git.openjdk.java.net/jdk pull/559/head:pull/559
$ git checkout pull/559

bridgekeeper · 2020-10-08T11:49:31Z

👋 Welcome back jlahoda! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2020-10-08T11:50:41Z

@lahodaj The following labels will be automatically applied to this pull request:

build
compiler
core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

lahodaj · 2020-10-08T11:52:33Z

/csr

openjdk · 2020-10-08T11:53:15Z

@lahodaj this pull request will not be integrated until the CSR request JDK-8254235 for issue JDK-8250625 has been approved.

mlbridge · 2020-10-08T11:55:50Z

Webrevs

erikj79 · 2020-10-08T12:57:22Z

/label remove build

openjdk · 2020-10-08T12:58:45Z

@erikj79
The build label was successfully removed.

vicente-romero-oracle · 2020-10-20T03:02:03Z

test/langtools/tools/javac/patterns/BindingsTest1.java

@@ -25,8 +25,8 @@
 * @test
 * @bug 8231827
 * @summary Basic tests for bindings from instanceof
- * @compile --enable-preview -source ${jdk.version} BindingsTest1.java
- * @run main/othervm --enable-preview BindingsTest1
+ * @compile BindingsTest1.java


the @compile can be removed

I guess I prefer to keep @compile for javac non-programatic tests. The reason is that, for these tests, we can expect we modify javac, but not the test. And if @build (implicit or explicit) is used, the test will not be re-compiled unless their timestamp changes. So we can actually execute an older (already built) version of the test's class file, instead of a newly built class file, which would reflect the changes in javac. So, for tests like this, I prefer to have an explicit @compile, as that ensures the file is compiled every time, regardless how the working directories are set-up, etc.

vicente-romero-oracle · 2020-10-20T03:06:20Z

test/langtools/tools/javac/patterns/BindingsTest1.java

- * @compile --enable-preview -source ${jdk.version} BindingsTest1.java
- * @run main/othervm --enable-preview BindingsTest1
+ * @compile BindingsTest1.java
+ * @run main BindingsTest1


and this line too

vicente-romero-oracle · 2020-10-20T03:07:34Z

test/langtools/tools/javac/patterns/ExamplesFromProposal.java

+ * @compile ExamplesFromProposal.java
+ * @run main ExamplesFromProposal


these two lines can be removed now, there are other tests in this commit in which they can also be eliminated

vicente-romero-oracle · 2020-10-20T03:09:27Z

test/langtools/tools/javac/patterns/LocalVariableTable.java

 * @modules jdk.jdeps/com.sun.tools.classfile
- * @compile -g --enable-preview -source ${jdk.version} LocalVariableTable.java
- * @run main/othervm --enable-preview LocalVariableTable
+ * @compile -g LocalVariableTable.java


I believe all tests are always compiled with -g option set, not related to your patch but we could probably remove that line as superfluous

I believe plain jtreg invocations may not be always setting "-g". So probably better to be explicitly clear we need -g, as the test itself requires the debugging info/LocalVariableTable?

sure I understand that the -g option is necessary. I was just wondering if -g is not passed always by jtreg. If the option is passed by default then it is superfluous, although just a comment, I understand that it is safer to pass it

I tried with a plain jtreg invocation, and it didn't pass -g (and the test failed). But it depends on how jtreg is run, of course - some runs may have -g set.

vicente-romero-oracle · 2020-10-20T03:13:35Z

test/langtools/tools/javac/patterns/PatternsSimpleVisitorTest.java

@@ -105,7 +105,7 @@ private CompilationUnitTree parse(String code) throws IOException {

        StringWriter out = new StringWriter();
        JavacTask ct = (JavacTask) tool.getTask(out, null, noErrors,
-            List.of("--enable-preview", "-source", Integer.toString(Runtime.version().feature())), null,
+            List.of(), null,


nit: what about passing null instead of List.of()?

…iler.getTask

vicente-romero-oracle · 2020-10-20T20:15:52Z

src/jdk.compiler/share/classes/com/sun/source/tree/BindingPatternTree.java

     */
-    Tree getType();
+    @Deprecated


shouldn't we use @Deprecated(since=versionNumber)

vicente-romero-oracle · 2020-10-21T03:11:28Z

src/jdk.compiler/share/classes/com/sun/source/tree/PatternTree.java

 * A tree node used as the base class for the different kinds of
 * statements.
 *
- * @since 14
+ * @since 16
 */
 public interface PatternTree extends Tree {}


I think that this interface is there for forward compatibility, and I don't like empty interfaces but I found that we already did that with com.sun.source.tree.DirectiveTree

We have multiple such interfaces - like StatementTree and ExpressionTree. It is a forward-looking interface, but I think necessary: InstanceofTree.getPattern() needs to return something, and having a PatternTree is (I think) better than returning generic Tree, or BindingPatternTree (the latter is likely to be insufficient sometime soon).

vicente-romero-oracle · 2020-10-21T03:12:08Z

src/jdk.compiler/share/classes/com/sun/source/tree/PatternTree.java

- *           feature of the Java language. Preview features
- *           may be removed in a future release, or upgraded to permanent
- *           features of the Java language.}
- *
 * A tree node used as the base class for the different kinds of


the javadoc seems to need an update, probably:
A tree node used as the base class for the different kinds of pattern matching expressions?

Patterns are not really expressions - they are a new kind of trees. Basically, before we had "statements" and "expressions" (+declarations, which are a bit special, ClassTree and VariableTree are "statements", but MethodTree, ModuleTree and PackageTree subtype Tree directly, so there is no common supertype). Now we have "patterns" in addition to that.

For example, having: o instanceof String s, this is an expression, but String s is not - it is a pattern. It cannot stand on its own as an expression, it is a special part of the expression.

lahodaj · 2020-10-22T12:09:56Z

Based on an offline feedback, I've removed the old, preview, deprecated methods from BindingPatternTree.

vicente-romero-oracle

looks good!

openjdk · 2020-11-03T03:07:02Z

@lahodaj This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8250625: Compiler implementation of Pattern Matching for instanceof (Final)

Reviewed-by: vromero

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 15 new commits pushed to the master branch:

60e4aca: 8255890: Zero: remove unused methods from BytecodeInterpreter
397bae2: 8255860: Clean up CDS logging related to lambda
97a81ce: 8253385: annotation processors remove varargs information from record components
166c728: 8255858: Add debug agent support for storing thread names
a0ade22: 8255900: x86: Reduce impact when VerifyOops is disabled
29db1dc: 8255886: Shenandoah: Resolve cset address truncation and register clash in interpreter LRB
26e7ef7: 8252870: Finalize (remove "incubator" from) jpackage
804bd72: 8255128: linux x86 build failure with libJNIPoint.c
160759c: 8255838: Use 32-bit immediate movslq in macro assembler if 64-bit value fits in 32 bits on x86_64
94ace03: 8255863: Clean up test/jdk/java/lang/invoke/defineHiddenClass/BasicTest.java
... and 5 more: https://git.openjdk.java.net/jdk/compare/7f4d873dd9492c128e98737eb4651a29387269e8...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

lahodaj · 2020-11-05T08:00:15Z

/integrate

openjdk · 2020-11-05T08:01:48Z

@lahodaj Since your change was applied there have been 15 commits pushed to the master branch:

60e4aca: 8255890: Zero: remove unused methods from BytecodeInterpreter
397bae2: 8255860: Clean up CDS logging related to lambda
97a81ce: 8253385: annotation processors remove varargs information from record components
166c728: 8255858: Add debug agent support for storing thread names
a0ade22: 8255900: x86: Reduce impact when VerifyOops is disabled
29db1dc: 8255886: Shenandoah: Resolve cset address truncation and register clash in interpreter LRB
26e7ef7: 8252870: Finalize (remove "incubator" from) jpackage
804bd72: 8255128: linux x86 build failure with libJNIPoint.c
160759c: 8255838: Use 32-bit immediate movslq in macro assembler if 64-bit value fits in 32 bits on x86_64
94ace03: 8255863: Clean up test/jdk/java/lang/invoke/defineHiddenClass/BasicTest.java
... and 5 more: https://git.openjdk.java.net/jdk/compare/7f4d873dd9492c128e98737eb4651a29387269e8...master

Your commit was automatically rebased without conflicts.

Pushed as commit 18bc95b.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

…Final) Reviewed-by: vromero

lahodaj added 13 commits September 18, 2020 10:16

Pattern instanceof should not be allowed to use a total pattern.

c4da180

Binding variables should not be final.

d1d7562

Making pattern matching in instanceof final.

f6d0882

Cleanup.

e7b94fc

Updating tests.

05f6e7f

Merge branch 'master' into patterns-instanceof3

f1a120d

Cleaning up preview comments in javadoc.

026c91b

Merge branch 'master' into patterns-instanceof3

70de0fc

Updating @SInCE tags.

fb50336

Merge branch 'master' into patterns-instanceof3

5920f8e

Improve the AST model.

1f079c4

Correcting positions.

13da982

Fixing more tests.

69c7dce

openjdk bot added the rfr Pull request is ready for review label Oct 8, 2020

openjdk bot added build build-dev@openjdk.org core-libs core-libs-dev@openjdk.org compiler compiler-dev@openjdk.org labels Oct 8, 2020

openjdk bot added the csr Pull request needs approved CSR before integration label Oct 8, 2020

openjdk bot removed the build build-dev@openjdk.org label Oct 8, 2020

vicente-romero-oracle suggested changes Oct 20, 2020

View reviewed changes

lahodaj added 2 commits October 20, 2020 12:29

Merge branch 'master' into patterns-instanceof3

f84e905

Cleanup: using a null instead of List.of() as a parameter to JavaComp…

5978bca

…iler.getTask

vicente-romero-oracle reviewed Oct 21, 2020

View reviewed changes

vicente-romero-oracle suggested changes Oct 21, 2020

View reviewed changes

lahodaj added 3 commits October 21, 2020 14:25

Fixing review comments.

5699194

Merge branch 'master' into patterns-instanceof3

8deab10

Removing the preview deprecated methods from BindingPatternTree.

77468e2

vicente-romero-oracle approved these changes Oct 24, 2020

View reviewed changes

Merging master into patterns-instanceof3

8fbed8c

openjdk bot removed the csr Pull request needs approved CSR before integration label Nov 3, 2020

openjdk bot added the ready Pull request is ready to be integrated label Nov 3, 2020

Merge branch 'master' into patterns-instanceof3

325f96a

openjdk bot closed this Nov 5, 2020

openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 5, 2020

openjdk-notifier bot referenced this pull request Nov 5, 2020

8250625: Compiler implementation of Pattern Matching for instanceof (…

18bc95b

…Final) Reviewed-by: vromero

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8250625: Compiler implementation of Pattern Matching for instanceof (Final) #559

8250625: Compiler implementation of Pattern Matching for instanceof (Final) #559

lahodaj commented Oct 8, 2020 •

edited by openjdk bot

Loading

bridgekeeper bot commented Oct 8, 2020

openjdk bot commented Oct 8, 2020

lahodaj commented Oct 8, 2020

openjdk bot commented Oct 8, 2020

mlbridge bot commented Oct 8, 2020 •

edited

Loading

erikj79 commented Oct 8, 2020

openjdk bot commented Oct 8, 2020

vicente-romero-oracle Oct 20, 2020

lahodaj Oct 20, 2020

vicente-romero-oracle Oct 20, 2020

vicente-romero-oracle Oct 20, 2020

vicente-romero-oracle Oct 20, 2020

lahodaj Oct 20, 2020

vicente-romero-oracle Oct 21, 2020

lahodaj Oct 21, 2020

vicente-romero-oracle Oct 20, 2020

vicente-romero-oracle Oct 20, 2020

vicente-romero-oracle Oct 21, 2020 •

edited

Loading

lahodaj Oct 21, 2020

vicente-romero-oracle Oct 21, 2020 •

edited

Loading

lahodaj Oct 22, 2020

lahodaj commented Oct 22, 2020

vicente-romero-oracle left a comment

openjdk bot commented Nov 3, 2020 •

edited

Loading

lahodaj commented Nov 5, 2020

openjdk bot commented Nov 5, 2020

		* @compile ExamplesFromProposal.java
		* @run main ExamplesFromProposal

8250625: Compiler implementation of Pattern Matching for instanceof (Final) #559

8250625: Compiler implementation of Pattern Matching for instanceof (Final) #559

Conversation

lahodaj commented Oct 8, 2020 • edited by openjdk bot Loading

Progress

Testing

Issue

Reviewers

Download

bridgekeeper bot commented Oct 8, 2020

openjdk bot commented Oct 8, 2020

lahodaj commented Oct 8, 2020

openjdk bot commented Oct 8, 2020

mlbridge bot commented Oct 8, 2020 • edited Loading

Webrevs

erikj79 commented Oct 8, 2020

openjdk bot commented Oct 8, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vicente-romero-oracle Oct 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vicente-romero-oracle Oct 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lahodaj commented Oct 22, 2020

vicente-romero-oracle left a comment

Choose a reason for hiding this comment

openjdk bot commented Nov 3, 2020 • edited Loading

lahodaj commented Nov 5, 2020

openjdk bot commented Nov 5, 2020

lahodaj commented Oct 8, 2020 •

edited by openjdk bot

Loading

mlbridge bot commented Oct 8, 2020 •

edited

Loading

vicente-romero-oracle Oct 21, 2020 •

edited

Loading

vicente-romero-oracle Oct 21, 2020 •

edited

Loading

openjdk bot commented Nov 3, 2020 •

edited

Loading