JDK-8312612: handle WideCharToMultiByte return values #15015

MBaesken · 2023-07-25T11:17:23Z

The function WideCharToMultiByte is used at a number of places of the JDK codebase for conversion purposes.
Unfortunately, the function might fail because of various reasons, so the return value must be checked to avoid undefined behavior or even crashes.
see
https://learn.microsoft.com/en-us/windows/win32/api/stringapiset/nf-stringapiset-widechartomultibyte
especially
https://learn.microsoft.com/en-us/windows/win32/api/stringapiset/nf-stringapiset-widechartomultibyte#return-value

At most places in the coding the return values are already checked, but some are missing.

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-8312612: handle WideCharToMultiByte return values (Bug - P3)

Reviewers

Christoph Langer (@RealCLanger - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15015

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2023-07-25T11:18: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-25T11:19:50Z

@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-25T11:23:50Z

Webrevs

01: Full - Incremental (3cf91afb)
00: Full (cf5e9a67)

RealCLanger

Looks good, two minor suggestions.

RealCLanger · 2023-07-28T08:23:35Z

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

+    if (nb > 0) {
+        JNU_ThrowByName(env, PRINTEREXCEPTION_STR, errStr);
+    } else {
+        JNU_ThrowByName(env, PRINTEREXCEPTION_STR, "Secondary error while OS message extraction");


better: secondary error during OS message extraction

I borrowed it from here (other error handling of WideCharToMultiByte)

jdk/src/java.base/windows/native/libjava/ProcessImpl_md.c 102 const char *errorMessage = "Secondary error while OS message extraction";

should I change both locations ?

RealCLanger · 2023-07-28T08:24:26Z

src/java.desktop/windows/native/libjsound/PLATFORM_API_WinOS_Charset_Util.cpp

+    } else {
+        delete[] lpUTF8Str;
+    }
+    return NULL;


better move return NULL into else block?

Better remove the else block :-) ?

openjdk · 2023-07-28T08:26:23Z

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

8312612: handle WideCharToMultiByte return values

Reviewed-by: clanger

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

a3d6723: 8311033: [macos] PrinterJob does not take into account Sides attribute
4ae5a3e: 8306446: java/lang/management/ThreadMXBean/Locks.java transient failures
cad6114: 8304954: SegmentedCodeCache fails when using large pages
ba645da: 8313082: Enable CreateCoredumpOnCrash for testing in makefiles
c27c877: 8302017: Allocate BadPaddingException only if it will be thrown
c55d29f: 8312626: Resolve multiple definition of 'start_timer' when statically linking JDK native libraries with user code
0ca2bfd: 8311104: dangling-gsl warning in libwixhelper.cpp
c05ba48: 8313250: Exclude java/foreign/TestByteBuffer.java on AIX
169b6e3: 8313174: Create fewer predictable port clashes in management tests
8650026: 8310033: Clarify return value of Java Time compareTo methods
... and 28 more: https://git.openjdk.org/jdk/compare/91fe03232760ae0a9b56456f2f5f5ee6e483e4ef...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.

RealCLanger

Even better.

MBaesken · 2023-07-28T11:32:25Z

Hi Christoph, thanks for the review.
The Windows aarch64 build errors seems to be unrelated (but should maybe still be addressed, but other issue).

MBaesken · 2023-07-28T13:44:08Z

/integrate

openjdk · 2023-07-28T13:45:20Z

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

34173ff: 8312574: jdk/jdk/jfr/jvm/TestChunkIntegrity.java fails with timeout
47c4b99: 8312121: Fix -Wconversion warnings in tribool.hpp
a3d6723: 8311033: [macos] PrinterJob does not take into account Sides attribute
4ae5a3e: 8306446: java/lang/management/ThreadMXBean/Locks.java transient failures
cad6114: 8304954: SegmentedCodeCache fails when using large pages
ba645da: 8313082: Enable CreateCoredumpOnCrash for testing in makefiles
c27c877: 8302017: Allocate BadPaddingException only if it will be thrown
c55d29f: 8312626: Resolve multiple definition of 'start_timer' when statically linking JDK native libraries with user code
0ca2bfd: 8311104: dangling-gsl warning in libwixhelper.cpp
c05ba48: 8313250: Exclude java/foreign/TestByteBuffer.java on AIX
... and 30 more: https://git.openjdk.org/jdk/compare/91fe03232760ae0a9b56456f2f5f5ee6e483e4ef...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-07-28T13:45:26Z

@MBaesken Pushed as commit d9559f9.

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

JDK-8312612

cf5e9a6

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

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

RealCLanger approved these changes Jul 28, 2023

View reviewed changes

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

small adjustments

3cf91af

RealCLanger approved these changes Jul 28, 2023

View reviewed changes

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

openjdk bot closed this Jul 28, 2023

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JDK-8312612: handle WideCharToMultiByte return values #15015

JDK-8312612: handle WideCharToMultiByte return values #15015

MBaesken commented Jul 25, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jul 25, 2023

openjdk bot commented Jul 25, 2023

mlbridge bot commented Jul 25, 2023 •

edited

Loading

RealCLanger left a comment

RealCLanger Jul 28, 2023

MBaesken Jul 28, 2023

RealCLanger Jul 28, 2023 •

edited

Loading

MBaesken Jul 28, 2023

openjdk bot commented Jul 28, 2023 •

edited

Loading

RealCLanger left a comment

MBaesken commented Jul 28, 2023

MBaesken commented Jul 28, 2023

openjdk bot commented Jul 28, 2023

openjdk bot commented Jul 28, 2023

JDK-8312612: handle WideCharToMultiByte return values #15015

JDK-8312612: handle WideCharToMultiByte return values #15015

Conversation

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

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Jul 25, 2023

openjdk bot commented Jul 25, 2023

mlbridge bot commented Jul 25, 2023 • edited Loading

Webrevs

RealCLanger left a comment

Choose a reason for hiding this comment

RealCLanger Jul 28, 2023

Choose a reason for hiding this comment

MBaesken Jul 28, 2023

Choose a reason for hiding this comment

RealCLanger Jul 28, 2023 • edited Loading

Choose a reason for hiding this comment

MBaesken Jul 28, 2023

Choose a reason for hiding this comment

openjdk bot commented Jul 28, 2023 • edited Loading

RealCLanger left a comment

Choose a reason for hiding this comment

MBaesken commented Jul 28, 2023

MBaesken commented Jul 28, 2023

openjdk bot commented Jul 28, 2023

openjdk bot commented Jul 28, 2023

MBaesken commented Jul 25, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Jul 25, 2023 •

edited

Loading

RealCLanger Jul 28, 2023 •

edited

Loading

openjdk bot commented Jul 28, 2023 •

edited

Loading