8322215: [win] OS events that close the stage can cause Glass to reference freed memory

[beldenfox]

When a Stage is closed while processing an OS message the glass peer object is deleted immediately even if it's still executing member functions. As glass unwinds the stack and executes cleanup code it's referencing freed memory.

There are cases where glass generates JavaFX events back-to-back. For example, when handling the Delete key glass sends a PRESSED and TYPED event in the same routine. If the Stage is closed during the PRESSED event the code that sends the TYPED event is running inside an object that has already been deleted.

When the Stage is closed glass calls the OS routine ::DestroyWindow on the HWND causing a WM_NCDESTROY message to be sent. Currently the BaseWnd object is deleted when processing this message. This PR defers the destruction until all messages have been processed. This is the same approach used in the Linux code.

---

Progress

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

Issue

• JDK-8322215: [win] OS events that close the stage can cause Glass to reference freed memory (Bug - P3)

Reviewers

• Michael Strauß (@mstr2 - Committer)
• Kevin Rushforth (@kevinrushforth - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1309

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/1309.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back mfox! 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.

[mlbridge]

Webrevs

• 01: Full - Incremental (eaae9963)
• 00: Full (0eb0f985)

[kevinrushforth]

/reviewers 2

[openjdk]

@kevinrushforth
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 1 Reviewer, 1 Author).

[mstr2]

Looks good! I've left a comment inline.

[mstr2]

Minor: the naming scheme in this class would be m_messageCount.

[kevinrushforth]

The code changes look good.

I tested it, and confirm that with a debug build the test crashes without the fix and passes with the fix.

[openjdk]

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

8322215: [win] OS events that close the stage can cause Glass to reference freed memory

Reviewed-by: mstrauss, kcr

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

• 3cf9390: 8323879: constructor Path(Path) which takes another Path object fail to draw on canvas html
• 872dbc8: 8323543: NPE when table items are set to null
• e2bc52d: Merge
• ce3eace: Merge
• 1744050: Merge
• fcde661: Merge
• 95f4cd3: Merge
• 7791ab8: Merge
• 9af0643: Merge
• 9a4c24e: Merge
• ... and 16 more: https://git.openjdk.org/jfx/compare/8872f7afab5eca725b29d9e5b005084c22b27b9c...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.

[beldenfox]

/integrate

[openjdk]

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

• 3cf9390: 8323879: constructor Path(Path) which takes another Path object fail to draw on canvas html
• 872dbc8: 8323543: NPE when table items are set to null
• e2bc52d: Merge
• ce3eace: Merge
• 1744050: Merge
• fcde661: Merge
• 95f4cd3: Merge
• 7791ab8: Merge
• 9af0643: Merge
• 9a4c24e: Merge
• ... and 16 more: https://git.openjdk.org/jfx/compare/8872f7afab5eca725b29d9e5b005084c22b27b9c...master

Your commit was automatically rebased without conflicts.

[openjdk]

@beldenfox Pushed as commit c1c52e5.

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

[beldenfox]

/backport jfx jfx22

[openjdk]

@beldenfox the backport was successfully created on the branch backport-beldenfox-c1c52e5a in my personal fork of openjdk/jfx. To create a pull request with this backport targeting openjdk/jfx:jfx22, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit c1c52e5a from the openjdk/jfx repository.

The commit being backported was authored by Martin Fox on 22 Jan 2024 and was reviewed by Michael Strauß and Kevin Rushforth.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jfx:

$ git fetch https://github.com/openjdk-bots/jfx.git backport-beldenfox-c1c52e5a:backport-beldenfox-c1c52e5a
$ git checkout backport-beldenfox-c1c52e5a
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jfx.git backport-beldenfox-c1c52e5a

⚠️ @beldenfox You are not yet a collaborator in my fork openjdk-bots/jfx. An invite will be sent out and you need to accept it before you can proceed.