JDK-8313164: src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp GetRGBPixels adjust releasing of resources #15038

MBaesken · 2023-07-26T10:43:20Z

In src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp GetRGBPixels we release some resources at the end of the function by calling DeleteObject/DeleteDC. This is recommended by the MS API docs.
However this should be done as well in some early leaving with throw that can occur in this function.

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-8313164: src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp GetRGBPixels adjust releasing of resources (Bug - P3)

Reviewers

Thomas Stuefe (@tstuefe - Reviewer) ⚠️ Review applies to 9403dc41

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15038

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2023-07-26T10:44:40Z

👋 Welcome back mbaesken! 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 · 2023-07-26T10:46:22Z

@MBaesken 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.

mlbridge · 2023-07-26T10:50:04Z

Webrevs

01: Full - Incremental (95283db0)
00: Full (9403dc41)

MBaesken · 2023-07-26T11:09:37Z

One additional idea - in case of failing IS_SAFE* checks (leading to the throw astd::bad_alloc) , should we add some tracing to make clear what went wrong ? We have
J2dTraceLn1 / J2dTraceLn for this; unfortunately it seems to be only active for DEBUG-builds .

tstuefe

Okay. Did you find this with SonarCloud?

Since this is c++, it may be simpler to use RAII for this. Up to you though, the patch is also fine in its current form.

openjdk · 2023-07-26T11:32:37Z

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

8313164: src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp GetRGBPixels adjust releasing of resources

Reviewed-by: stuefe

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

a9d21c6: 8313081: MonitoringSupport_lock should be unconditionally initialized after 8304074
4c2e54f: 8309088: security/infra/java/security/cert/CertPathValidator/certification/AmazonCA.java fails
830413f: 8313087: DerValue::toString should output a hex view of the values in byte array
7412193: 4800398: (ch spec) Clarify Channels.newChannel(InputStream) spec
e7726fb: 8313155: Problem list some JUnit-based tests in test/jdk/java/lang/invoke
02a0473: 8312445: Array types in annotation elements show square brackets twice
c22cadf: 8312526: Test dk/jfr/event/oldobject/TestHeapDeep.java failed: Could not find ChainNode
cc2a75e: 8312619: Strange error message when switching over long
1f81e5b: 8312229: Crash involving yield, switch and anonymous classes

Please see this link for an up-to-date comparison between the source branch of this pull request and 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.

MBaesken · 2023-07-26T12:53:45Z

Hi Thomas , I just found those while looking at some other resource alloc/freeing, no Sonatype or similar was used.

Regarding RAII , not sure if something like this is used in the awt native code (or are there some good examples in awt native code?) . So I better keep it as it is, to be consistent with the codebase around it.

MBaesken · 2023-07-27T07:05:59Z

/integrate

openjdk · 2023-07-27T07:06:35Z

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

36d578c: 8311653: Modify -XshowSettings launcher behavior
a9d21c6: 8313081: MonitoringSupport_lock should be unconditionally initialized after 8304074
4c2e54f: 8309088: security/infra/java/security/cert/CertPathValidator/certification/AmazonCA.java fails
830413f: 8313087: DerValue::toString should output a hex view of the values in byte array
7412193: 4800398: (ch spec) Clarify Channels.newChannel(InputStream) spec
e7726fb: 8313155: Problem list some JUnit-based tests in test/jdk/java/lang/invoke
02a0473: 8312445: Array types in annotation elements show square brackets twice
c22cadf: 8312526: Test dk/jfr/event/oldobject/TestHeapDeep.java failed: Could not find ChainNode
cc2a75e: 8312619: Strange error message when switching over long
1f81e5b: 8312229: Crash involving yield, switch and anonymous classes

Your commit was automatically rebased without conflicts.

openjdk · 2023-07-27T07:06:46Z

@MBaesken Pushed as commit b7545a6.

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

aivanov-jdk · 2023-07-27T19:57:01Z

src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp

+    if (!IS_SAFE_SIZE_MUL(BYTES_PER_PIXEL, numPixels)) {
+        ::DeleteObject(hbitmap);
+        ::DeleteDC(hdcMem);
+        ::DeleteDC(hdcScreen);
+        throw std::bad_alloc();
+    }


I wonder if we can catch std::bad_alloc to release the resources and to re-throw the exception.

Since a C++ exception is thrown, using try-catch for clean-up seems reasonable, this would avoid duplicating the clean-up code in three places or so.

Hi Alexey, probably we could do this. Do you think it is worth the effort (we would have a big try catch block instead, but would centralize the ::Delete* calls) ?

Since you've already integrated, it's not worth redoing in my opinion.

Error handling in C and C++ code is always prone to repetitive sequence of calls; in this particular case exceptions are already used, and it looks that handling that exception could have had a benefit of reducing code duplication.

JDK-8313164

9403dc4

openjdk bot added the rfr Pull request is ready for review label Jul 26, 2023

openjdk bot added the client client-libs-dev@openjdk.org label Jul 26, 2023

tstuefe approved these changes Jul 26, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jul 26, 2023

adjust checks and calculation of numPixels

95283db

openjdk bot added the integrated Pull request has been integrated label Jul 27, 2023

openjdk bot closed this Jul 27, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jul 27, 2023

aivanov-jdk reviewed Jul 27, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JDK-8313164: src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp GetRGBPixels adjust releasing of resources #15038

JDK-8313164: src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp GetRGBPixels adjust releasing of resources #15038

MBaesken commented Jul 26, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jul 26, 2023

openjdk bot commented Jul 26, 2023

mlbridge bot commented Jul 26, 2023 •

edited

Loading

MBaesken commented Jul 26, 2023

tstuefe left a comment

openjdk bot commented Jul 26, 2023 •

edited

Loading

MBaesken commented Jul 26, 2023

MBaesken commented Jul 27, 2023

openjdk bot commented Jul 27, 2023

openjdk bot commented Jul 27, 2023

aivanov-jdk Jul 27, 2023 •

edited

Loading

MBaesken Jul 28, 2023

aivanov-jdk Jul 28, 2023

JDK-8313164: src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp GetRGBPixels adjust releasing of resources #15038

JDK-8313164: src/java.desktop/windows/native/libawt/windows/awt_Robot.cpp GetRGBPixels adjust releasing of resources #15038

Conversation

MBaesken commented Jul 26, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Jul 26, 2023

openjdk bot commented Jul 26, 2023

mlbridge bot commented Jul 26, 2023 • edited Loading

Webrevs

MBaesken commented Jul 26, 2023

tstuefe left a comment

Choose a reason for hiding this comment

openjdk bot commented Jul 26, 2023 • edited Loading

MBaesken commented Jul 26, 2023

MBaesken commented Jul 27, 2023

openjdk bot commented Jul 27, 2023

openjdk bot commented Jul 27, 2023

aivanov-jdk Jul 27, 2023 • edited Loading

Choose a reason for hiding this comment

MBaesken Jul 28, 2023

Choose a reason for hiding this comment

aivanov-jdk Jul 28, 2023

Choose a reason for hiding this comment

MBaesken commented Jul 26, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Jul 26, 2023 •

edited

Loading

openjdk bot commented Jul 26, 2023 •

edited

Loading

aivanov-jdk Jul 27, 2023 •

edited

Loading