8260931: Implement JEP 382: New macOS Rendering Pipeline #2403

aghaisas · 2021-02-04T10:35:02Z

Description :
This is the implementation of JEP 382 : New macOS Rendering Pipeline
It implements a Java 2D internal rendering pipeline for macOS using the Apple Metal API.
The entire work on this was done under OpenJDK Project - Lanai

We iterated through several Early Access (EA) builds and have reached a stage where it is ready to be integrated to openjdk/jdk. The latest EA build is available at - https://jdk.java.net/lanai/

A new option -Dsun.java2d.metal=true | True needs to be used to use this pipeline.

Testing :
This implementation has been tested with the tests present at - Test Plan for JEP 382: New macOS Rendering Pipeline

Note to reviewers :

Default rendering pipeline on macOS has not been changed by this PR. OpenGL still stays as the default rendering pipeline and Metal rendering pipeline is optional to choose.
To apply and test this PR -
To enable the metal pipeline you must specify on command line -Dsun.java2d.metal=true (No message will be printed in this case) or -Dsun.java2d.metal=True (A message indicating Metal rendering pipeline is enabled gets printed)
Review comments (including some preliminary informal review comments) are tracked with JBS issues - https://bugs.openjdk.java.net/issues/?filter=40598

Progress

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

Issue

JDK-8260931: Implement JEP 382: New macOS Rendering Pipeline

Reviewers

Magnus Ihse Bursie (@magicus - Reviewer) ⚠️ Review applies to 0b8d96b
Alexey Ushakov (@avu - no project role) ⚠️ Review applies to 3980ecb
Kevin Rushforth (@kevinrushforth - Author)
Gerard Ziemski (@gerard-ziemski - Committer) ⚠️ Review applies to 7b0b0dc
Phil Race (@prrace - Reviewer)
Alexander Zuev (@azuev-java - Reviewer)
Jayathirth D V (@jayathirthrao - Reviewer)
Prasanta Sadhukhan (@prsadhuk - Reviewer)
Sergey Bylokhov (@mrserb - Reviewer)

Contributors

Jayathirth D V <jdv@openjdk.org>
Alexey Ushakov <avu@openjdk.org>
Artem Bochkarev <abochkarev@openjdk.org>
Prasanta Sadhukhan <psadhukhan@openjdk.org>
Denis Konoplev <dkonoplev@openjdk.org>
Phil Race <prr@openjdk.org>
Kevin Rushforth <kcr@openjdk.org>
Magnus Ihse Bursie <ihse@openjdk.org>
Ajit Ghaisas <aghaisas@openjdk.org>

Download

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

bridgekeeper · 2021-02-04T10:35:21Z

👋 Welcome back aghaisas! 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 · 2021-02-04T10:36:36Z

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

2d
awt
build

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.

aghaisas · 2021-02-04T10:43:34Z

/reviewers 3

openjdk · 2021-02-04T10:43:59Z

@aghaisas
The number of required reviews for this PR is now set to 3 (with at least 1 of role reviewers).

aghaisas · 2021-02-04T16:10:05Z

/contributor add jdv

openjdk · 2021-02-04T16:10:31Z

@aghaisas
Contributor Jayathirth D V <jdv@openjdk.org> successfully added.

aghaisas · 2021-02-04T16:10:41Z

/contributor add avu

openjdk · 2021-02-04T16:10:56Z

@aghaisas
Contributor Alexey Ushakov <avu@openjdk.org> successfully added.

aghaisas · 2021-02-04T16:11:46Z

/contributor add abochkarev

openjdk · 2021-02-04T16:11:54Z

@aghaisas
Contributor Artem Bochkarev <abochkarev@openjdk.org> successfully added.

aghaisas · 2021-02-04T16:12:19Z

/contributor add psadhukhan

openjdk · 2021-02-04T16:12:26Z

@aghaisas
Contributor Prasanta Sadhukhan <psadhukhan@openjdk.org> successfully added.

aghaisas · 2021-02-04T16:13:46Z

/contributor add dkonoplev

openjdk · 2021-02-04T16:13:54Z

@aghaisas
Contributor Denis Konoplev <dkonoplev@openjdk.org> successfully added.

aghaisas · 2021-02-04T16:50:20Z

/contributor add prr

openjdk · 2021-02-04T16:50:44Z

@aghaisas
Contributor Phil Race <prr@openjdk.org> successfully added.

aghaisas · 2021-02-04T16:51:00Z

/contributor add kcr

openjdk · 2021-02-04T16:51:09Z

@aghaisas
Contributor Kevin Rushforth <kcr@openjdk.org> successfully added.

aghaisas · 2021-02-04T16:51:43Z

/contributor add ihse

openjdk · 2021-02-04T16:52:00Z

@aghaisas
Contributor Magnus Ihse Bursie <ihse@openjdk.org> successfully added.

aghaisas · 2021-02-04T16:56:31Z

/csr

openjdk · 2021-02-04T16:57:11Z

@aghaisas has indicated that a compatibility and specification (CSR) request is needed for this pull request.
@aghaisas this pull request must refer to an issue in JBS to be able to link it to a CSR request. To refer this pull request to an issue in JBS, please use the /issue command in a comment in this pull request.

aghaisas · 2021-02-04T16:59:45Z

/contributor add aghaisas

openjdk · 2021-02-04T16:59:56Z

@aghaisas
Contributor Ajit Ghaisas <aghaisas@openjdk.org> successfully added.

openjdk · 2021-03-10T19:06:26Z

@aghaisas 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:

8260931: Implement JEP 382: New macOS Rendering Pipeline

Co-authored-by: Jayathirth D V <jdv@openjdk.org>
Co-authored-by: Alexey Ushakov <avu@openjdk.org>
Co-authored-by: Artem Bochkarev <abochkarev@openjdk.org>
Co-authored-by: Prasanta Sadhukhan <psadhukhan@openjdk.org>
Co-authored-by: Denis Konoplev <dkonoplev@openjdk.org>
Co-authored-by: Phil Race <prr@openjdk.org>
Co-authored-by: Kevin Rushforth <kcr@openjdk.org>
Co-authored-by: Magnus Ihse Bursie <ihse@openjdk.org>
Co-authored-by: Ajit Ghaisas <aghaisas@openjdk.org>
Reviewed-by: ihse, avu, kcr, gziemski, prr, kizune, jdv, psadhukhan, serb

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 35 new commits pushed to the master branch:

f7e0a09: 8263425: AArch64: two potential bugs in C1 LIRGenerator::generate_address()
554dd29: 8263564: Consolidate POSIX code for runtime exit support: os::shutdown, os::abort and os::die
da9ead5: 8263399: CDS should archive only classes allowed by module system
9c84899: 8263555: use driver-mode to run ClassFileInstaller
8e562d2: 8263477: serviceability/sa/ClhsdbDumpheap.java timed out
a7aba2b: 8263549: 8263412 can cause jtreg testlibrary split
d339320: 8263136: C4530 was reported from VS 2019 at access bridge
a528771: 8262491: AArch64: CPU description should contain compatible board list
86e4c75: 8256156: JFR: Allow 'jfr' tool to show metadata without a recording
0b68ced: 8263548: runtime/cds/appcds/SharedRegionAlignmentTest.java fails to compile after JDK-8263412
... and 25 more: https://git.openjdk.java.net/jdk/compare/273f8bdf5fe14e65e40d3d908f58dd682bb472ed...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.

aghaisas · 2021-03-11T18:07:25Z

We have addressed the review comments (except for a few minor follow-on issues)
This version of the PR is the one which we are planning to integrate into the JDK. Please review and approve.

kevinrushforth

Latest changes look good. I confirmed that this PR has all of the content from the lanai repo.

mrserb · 2021-03-12T00:36:34Z

src/java.desktop/macosx/classes/sun/java2d/metal/MTLBlitLoops.java

+            cachedSrc = srcTmp.get();
+        }
+
+        // We can convert argb_pre data from MTL surface in two places:


OK, just to confirm. I wrote that text for OGL because it was the fastest way to transfer+convert the data from the video card to the memory. And as far as I understand the metal has the same limitation? It is not possible to convert it to some non-ARGB/Pre format on the fly while transferring the pixles?

src/java.desktop/macosx/classes/sun/java2d/metal/MTLSurfaceData.java

src/java.desktop/macosx/native/libawt_lwawt/awt/AWTSurfaceLayers.m

src/java.desktop/macosx/classes/sun/java2d/metal/MTLGraphicsConfig.java

src/java.desktop/macosx/native/libawt_lwawt/java2d/metal/MTLPaints.m

src/java.desktop/macosx/native/libawt_lwawt/java2d/metal/MTLSurfaceDataBase.h

mlbridge · 2021-03-12T04:02:06Z

Mailing list message from Scott Palmer on awt-dev:

On Mar 11, 2021, at 9:53 PM, Sergey Bylokhov <serb at openjdk.java.net> wrote:

?On Fri, 12 Mar 2021 02:29:04 GMT, Jayathirth D V <jdv at openjdk.org> wrote:

src/java.desktop/macosx/classes/sun/java2d/metal/MTLSurfaceData.java line 323:

321: * more code just to support a few uncommon cases.
322: */
323: public boolean canRenderLCDText(SunGraphics2D sg2d) {

Just curious, can we render LCD on 10.14+ via metal? Does it work fine?

Yes Sergey it works fine in 10.14+ systems via metal. Most of the JCK manual tests use LCD text on UI Components and it is recently verified in 10.14+ systems for EA10.

Ok, for some reason I thought that the new macOS stopped providing LCD glyphs.

Are the glyphs different or just the way they are rasterized?

Newer versions of macOS don?t do LCD text and have gone back to plain grey-scale anti-aliasing.
Java 2D should default to NOT doing LCD anti-aliasing for text on macOS if it wants to fit in with the look of native applications.
(I?m not sure if that applies to non-retina displays.)

Scott

mlbridge · 2021-03-12T04:43:06Z

Mailing list message from Jayathirth D V on awt-dev:

On 12-Mar-2021, at 9:29 AM, Scott Palmer <swpalmer at gmail.com> wrote:

On Mar 11, 2021, at 9:53 PM, Sergey Bylokhov <serb at openjdk.java.net> wrote:

?On Fri, 12 Mar 2021 02:29:04 GMT, Jayathirth D V <jdv at openjdk.org> wrote:

src/java.desktop/macosx/classes/sun/java2d/metal/MTLSurfaceData.java line 323:

321: * more code just to support a few uncommon cases.
322: */
323: public boolean canRenderLCDText(SunGraphics2D sg2d) {

Just curious, can we render LCD on 10.14+ via metal? Does it work fine?

Yes Sergey it works fine in 10.14+ systems via metal. Most of the JCK manual tests use LCD text on UI Components and it is recently verified in 10.14+ systems for EA10.

Ok, for some reason I thought that the new macOS stopped providing LCD glyphs.

Are the glyphs different or just the way they are rasterized?

Newer versions of macOS don?t do LCD text and have gone back to plain grey-scale anti-aliasing.
Java 2D should default to NOT doing LCD anti-aliasing for text on macOS if it wants to fit in with the look of native applications.
(I?m not sure if that applies to non-retina displays.)

By default we don?t do LCD anti-aliasing for text, only when we set Text Rendering Hint to use LCD antialiasing we take sub-pixel rendering path.

Scott

mrserb · 2021-03-12T04:57:16Z

By default we don?t do LCD anti-aliasing for text, only when we set Text Rendering Hint to use LCD antialiasing we take sub-pixel rendering path.

And it actually produces LCD glyphs? not the grayscale?

mlbridge · 2021-03-12T05:12:08Z

Mailing list message from Jayathirth D V on awt-dev:

On 12-Mar-2021, at 10:30 AM, Sergey Bylokhov <serb at openjdk.java.net> wrote:

On Fri, 12 Mar 2021 00:09:54 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

Ajit Ghaisas has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains 47 additional commits since the last revision:

- Lanai PR#214 - 8263324 - avu
- Merge branch 'master' into 8260931_lanai_JEP_branch
- Lanai PR#213 - 8263325 - avu
- Lanai PR#212 - 8259825 - aghaisas
- Lanai PR#211 - 8262882 - aghaisas
- Merge branch 'master' into 8260931_lanai_JEP_branch
- Lanai PR#210 - 8263159 - jdv
- Lanai PR#209 - 8262936 - jdv
- Lanai PR#208 - 8262928 - jdv
- Lanai PR#207 - 8262750 - jdv
- ... and 37 more: https://git.openjdk.java.net/jdk/compare/9d82be31...369c3d2

Latest changes look good. I confirmed that this PR has all of the content from the lanai repo.

By default we don?t do LCD anti-aliasing for text, only when we set Text Rendering Hint to use LCD antialiasing we take sub-pixel rendering path.

And it actually produces LCD glyphs? not the grayscale?

We get glyphs which take more than a byte to represent each pixel.
Based on which we take LCD sub-pixel rendering path.

src/java.desktop/macosx/classes/sun/awt/CGraphicsConfig.java

aghaisas · 2021-03-15T06:41:02Z

/integrate

openjdk · 2021-03-15T06:42:16Z

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

0638303: 8263497: Clean up sun.security.krb5.PrincipalName::toByteArray
ba22e6f: 8263446: Avoid unary minus over unsigned type in ObjectSynchronizer::dec_in_use_list_ceiling
b371f90: 8263504: Some OutputMachOpcodes fields are uninitialized
f7e0a09: 8263425: AArch64: two potential bugs in C1 LIRGenerator::generate_address()
554dd29: 8263564: Consolidate POSIX code for runtime exit support: os::shutdown, os::abort and os::die
da9ead5: 8263399: CDS should archive only classes allowed by module system
9c84899: 8263555: use driver-mode to run ClassFileInstaller
8e562d2: 8263477: serviceability/sa/ClhsdbDumpheap.java timed out
a7aba2b: 8263549: 8263412 can cause jtreg testlibrary split
d339320: 8263136: C4530 was reported from VS 2019 at access bridge
... and 28 more: https://git.openjdk.java.net/jdk/compare/273f8bdf5fe14e65e40d3d908f58dd682bb472ed...master

Your commit was automatically rebased without conflicts.

Pushed as commit 8afec70.

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

Project Lanai Patch

0b8d96b

openjdk bot added 2d client-libs-dev@openjdk.org build build-dev@openjdk.org awt client-libs-dev@openjdk.org labels Feb 4, 2021

openjdk bot added the csr Pull request needs approved CSR before integration label Feb 4, 2021

aghaisas changed the title ~~[Draft] 8260931: Implement JEP 382: New macOS Rendering Pipeline~~ 8260931: Implement JEP 382: New macOS Rendering Pipeline Feb 4, 2021

aghaisas added 3 commits March 10, 2021 15:21

Lanai PR#211 - 8262882 - aghaisas

d27ff90

Lanai PR#212 - 8259825 - aghaisas

9a27831

Lanai PR#213 - 8263325 - avu

3980ecb

kevinrushforth approved these changes Mar 10, 2021

View reviewed changes

openjdk bot removed the csr Pull request needs approved CSR before integration label Mar 10, 2021

openjdk bot added the ready Pull request is ready to be integrated label Mar 10, 2021

avu approved these changes Mar 11, 2021

View reviewed changes

aghaisas added 2 commits March 11, 2021 22:19

Merge branch 'master' into 8260931_lanai_JEP_branch

c4309ab

Lanai PR#214 - 8263324 - avu

369c3d2

prrace approved these changes Mar 11, 2021

View reviewed changes

kevinrushforth approved these changes Mar 12, 2021

View reviewed changes

mrserb reviewed Mar 12, 2021

View reviewed changes

azuev-java approved these changes Mar 12, 2021

View reviewed changes

jayathirthrao approved these changes Mar 12, 2021

View reviewed changes

prsadhuk reviewed Mar 12, 2021

View reviewed changes

src/java.desktop/macosx/classes/sun/awt/CGraphicsConfig.java Show resolved Hide resolved

prsadhuk approved these changes Mar 12, 2021

View reviewed changes

mrserb approved these changes Mar 15, 2021

View reviewed changes

openjdk bot closed this Mar 15, 2021

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 Mar 15, 2021

jzy3d mentioned this pull request Jun 6, 2021

Test EmulGL performance on MacOS Metal + JDK17 jzy3d/jzy3d-api#186

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8260931: Implement JEP 382: New macOS Rendering Pipeline #2403

8260931: Implement JEP 382: New macOS Rendering Pipeline #2403

aghaisas commented Feb 4, 2021 •

edited by openjdk bot

Loading

bridgekeeper bot commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

openjdk bot commented Mar 10, 2021 •

edited

Loading

aghaisas commented Mar 11, 2021

kevinrushforth left a comment

mrserb Mar 12, 2021

mlbridge bot commented Mar 12, 2021

mlbridge bot commented Mar 12, 2021

mrserb commented Mar 12, 2021

mlbridge bot commented Mar 12, 2021

aghaisas commented Mar 15, 2021

openjdk bot commented Mar 15, 2021

8260931: Implement JEP 382: New macOS Rendering Pipeline #2403

8260931: Implement JEP 382: New macOS Rendering Pipeline #2403

Conversation

aghaisas commented Feb 4, 2021 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Contributors

Download

bridgekeeper bot commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

aghaisas commented Feb 4, 2021

openjdk bot commented Feb 4, 2021

openjdk bot commented Mar 10, 2021 • edited Loading

aghaisas commented Mar 11, 2021

kevinrushforth left a comment

Choose a reason for hiding this comment

mrserb Mar 12, 2021

Choose a reason for hiding this comment

mlbridge bot commented Mar 12, 2021

mlbridge bot commented Mar 12, 2021

mrserb commented Mar 12, 2021

mlbridge bot commented Mar 12, 2021

aghaisas commented Mar 15, 2021

openjdk bot commented Mar 15, 2021

aghaisas commented Feb 4, 2021 •

edited by openjdk bot

Loading

openjdk bot commented Mar 10, 2021 •

edited

Loading