Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8304825: MacOS metal pipeline - window isn't painted if created during display sleep #13375

Closed
wants to merge 1 commit into from

Conversation

aghaisas
Copy link
Contributor

@aghaisas aghaisas commented Apr 6, 2023

Root cause : The CVDisplayLink used in MTLLayer stops invoking callbacks on screen sleep and wakeup event. It is found that stop and restart of CVDisplayLink on these events also does not help.

Fix : Recreate the CVDisplayLink on screen sleep and wakeup event.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8304825: MacOS metal pipeline - window isn't painted if created during display sleep

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/13375/head:pull/13375
$ git checkout pull/13375

Update a local copy of the PR:
$ git checkout pull/13375
$ git pull https://git.openjdk.org/jdk.git pull/13375/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13375

View PR using the GUI difftool:
$ git pr show -t 13375

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/13375.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Apr 6, 2023

👋 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 openjdk bot added the rfr Pull request is ready for review label Apr 6, 2023
@openjdk
Copy link

openjdk bot commented Apr 6, 2023

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

  • client

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

@openjdk openjdk bot added the client client-libs-dev@openjdk.org label Apr 6, 2023
@mlbridge
Copy link

mlbridge bot commented Apr 6, 2023

Webrevs

J2dTraceLn(J2D_TRACE_VERBOSE, "MTLLayer.onScreenSleep --- received screen sleep notification.");

[self stopDisplayLink];
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming this is something we should have done already to save wasted work ?
i.e if the screen is asleep, we don't need to be connected to it and updating windows ?
But I see the same stopDisplayLink call in the wakeup code ... any issues with the extra call there ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming this is something we should have done already to save wasted work ?
i.e if the screen is asleep, we don't need to be connected to it and updating windows ?

We start the DisplayLink from Metal RenderQueue whenever there is something to be painted from back buffer to the window buffer. Once the window buffer is painted in a DisplayLink callback, we stop the DisplayLink.
We were not stopping the DisplayLink on screen sleep event. This is what this PR adds.

But I see the same stopDisplayLink call in the wakeup code ... any issues with the extra call there ?

I have added that call as a sanity before releasing the Displaylink. It will be a no-op if DisplayLink is not running.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

Copy link
Member

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. I tested this on an M1 MacBook. The test program attached to the bug fails without your fix and passes with your fix.

Copy link
Contributor

@avu avu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for me

@openjdk
Copy link

openjdk bot commented Apr 7, 2023

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

8304825: MacOS metal pipeline - window isn't painted if created during display sleep

Reviewed-by: kcr, avu, prr

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

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.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Apr 7, 2023
@aghaisas
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Apr 10, 2023

Going to push as commit 969a6b9.
Since your change was applied there have been 132 commits pushed to the master branch:

  • 9727685: 8305310: Calculate PublicKey from PrivateKey
  • 50d7335: 8305696: (zipfs) Avoid redundant LinkedHashMap.containsKey call ZipFileSystem.makeParentDirs
  • ec9d816: 6441827: Documentation mentions nonexistent NullReferenceException
  • 9e20382: 8305721: add make compile-commands artifacts to .gitignore
  • f45b01f: 8305766: ProblemList runtime/CompressedOops/CompressedClassPointers.java
  • a8871f5: 8305407: ExternalSpecsWriter should ignore white-space differences in spec titles
  • 6b2a86a: 8300257: C2: vectorization fails on some simple Memory Segment loops
  • dc81603: 8305666: Add system property for fair AWT lock
  • c67bbce: 8305711: Arm: C2 always enters slowpath for monitorexit
  • ce6e746: 8305118: Add RISC-V related content to building.md
  • ... and 122 more: https://git.openjdk.org/jdk/compare/e3855d005408945ea00e3bc38a0f10bef45cd627...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Apr 10, 2023
@openjdk openjdk bot closed this Apr 10, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Apr 10, 2023
@openjdk
Copy link

openjdk bot commented Apr 10, 2023

@aghaisas Pushed as commit 969a6b9.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client client-libs-dev@openjdk.org integrated Pull request has been integrated
4 participants