JDK-8318671: Potential uninitialized uintx value after JDK-8317683 by tstuefe · Pull Request #16335 · openjdk/jdk

tstuefe · 2023-10-24T07:08:07Z

When using 'MemStat' CompileCommand, we accidentally register the command if an invalid suboption had been specified. Fixed, added regression test (verified).

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-8318671: Potential uninitialized uintx value after JDK-8317683 (Bug - P4)

Reviewers

Tobias Hartmann (@TobiHartmann - Reviewer) ⚠️ Review applies to 287d8106
Aleksey Shipilev (@shipilev - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16335

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2023-10-24T07:08:56Z

👋 Welcome back stuefe! 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-10-24T07:10:07Z

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

hotspot-compiler
serviceability

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.

mlbridge · 2023-10-24T09:01:01Z

Webrevs

dholmes-ora · 2023-10-24T10:26:32Z

src/hotspot/share/compiler/compilerOracle.cpp

      jio_snprintf(errorbuf, buf_size, "MemStat: invalid value expected 'collect' or 'print' (omitting value means 'collect')");
+      return handled_err;


If "omitting value means 'collect'" then why do we not simply set value = (uintx)MemStatAction::collect ? Otherwise what is that message supposed to mean?

Ternary return values are unpleasant.

If "omitting value means 'collect'" then why do we not simply set value = (uintx)MemStatAction::collect ? Otherwise what is that message supposed to mean?

We only enter this function if a value for this command had been given (-XX:CompileCommand=<command>,<method>[,<value>]). The default case is handled somewhere else (CompilerOracle::parse_from_line).

Ternary return values are unpleasant.

As, on a general base? You don't like the number three :-) ?

Here, we have to distinguish between:

not handled, its not a command option that accepts enum strings

handled, with two variants: handled, had an error, and handled, had no error. Only in the latter case we want to register the command.

Okay I'll butt out. The comment doesn't make sense to me.

@dholmes-ora Sorry if I came across as flippant; that was not my intention. If you can stomach it, I rewrote the patch to be hopefully easier to read. Thanks.

No I didn't take it that way at all. The new patch does seem easier to read, but I will still defer to compiler folk to review this.

…d-uintx-value-after-JDK-8317683

tstuefe · 2023-10-26T08:54:42Z

test/hotspot/jtreg/serviceability/dcmd/compiler/CompilerMemoryStatisticTest.java

- *          java.management
- * @run main/othervm -XX:CompileCommand=memstat,*.*,collect CompilerMemoryStatisticTest
- */
-


Reviewer hint: Removed because its redundant with the syntax check introduced in MemStatTest.java

jdksjolen

Hi,

This looks good to me, I've got a couple of comments (one is just a nit). I'll leave it to the compiler folks for approval.

src/hotspot/share/compiler/compilerOracle.cpp

test/hotspot/jtreg/compiler/compilercontrol/commands/MemStatTest.java

TobiHartmann

Looks reasonable to me.

openjdk · 2023-10-31T08:56:13Z

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

8318671: Potential uninitialized uintx value after JDK-8317683

Reviewed-by: thartmann, shade

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

bad6999: 8313672: C2: PhaseCCP does not correctly track analysis dependencies involving shift, convert, and mask
fbe1937: 8319955: Improve dependencies removal during class unloading
4c1540b: 8287284: C2: loop optimization performs split_thru_phi infinitely many times
70f0c01: 8320054: Remove unused _count from NMT walker classes
e7486e8: 8315986: [macos14] javax/swing/JMenuItem/4654927/bug4654927.java: component must be showing on the screen to determine its location
a6343c0: 8319999: Refactor MetaspaceShared::use_full_module_graph()
d9a89c5: 8319572: Test jdk/incubator/vector/LoadJsvmlTest.java ignores VM flags
1e76ba0: 8319439: Move BufferNode from PtrQueue files to new files
d5abe49: 8319628: DateFormat does not mention IllegalArgumentException for invalid style args
d725b73: 8301310: The SendRawSysexMessage test may cause a JVM crash
... and 27 more: https://git.openjdk.org/jdk/compare/03db82818b905f21cb5ad1d56a687e238b4a6e33...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.

TobiHartmann · 2023-11-13T11:51:30Z

I think this is ready for integration given that both @dholmes-ora and @jdksjolen are okay with it.

…value-after-JDK-8317683

tstuefe · 2023-11-13T13:30:18Z

I think this is ready for integration given that both @dholmes-ora and @jdksjolen are okay with it.

Well, they did not approve yet; @jdksjolen or @dholmes-ora, if you are happy with this, could you hit the big green button please?

dholmes-ora · 2023-11-14T05:04:44Z

@TobiHartmann both @jdksjolen and myself indicated we would defer to the compiler team to review/approve this. I only had some drive-by comments.

tstuefe · 2023-11-14T08:10:53Z

@shipilev maybe, as bug owner?

shipilev · 2023-11-14T14:51:47Z

src/hotspot/share/compiler/compilerOracle.cpp

      total_bytes_read += bytes_read;
      line += bytes_read;
      register_command(matcher, option, value);
-      return;


Why this return removed? All other cases in this file have the return after register_command, which I assume the style here: once any command is properly matched, return.

shipilev · 2023-11-14T15:03:42Z

src/hotspot/share/compiler/compilerOracle.cpp

-static bool parseEnumValueAsUintx(enum CompileCommand option, const char* line, uintx& value, int& bytes_read, char* errorbuf, const int buf_size) {
+// Parse an uintx-based option value. Also takes care of parsing enum values for options that are enums.
+// Returns true if ok, false if the value could not be parsed.
+static bool parseUintxValue(enum CompileCommand option, const char* line, uintx& value, int& bytes_read) {


It is honestly weird to see parse***Uintx***Value dealing with enums, and be specialized for MemStat. Can you reflow this to match how MemLimit does it?

jdk/src/hotspot/share/compiler/compilerOracle.cpp

Line 702 in 7bb1999

bool success = (option == CompileCommand::MemLimit) && parseMemLimit(line, value, bytes_read, errorbuf, buf_size);

Okay, rewritten in the style of #16631. Retested too. Let's get this out of the door, please.

shipilev

All right, new version looks significantly better, thanks!

tstuefe · 2023-11-15T09:54:53Z

MacOS error unrelated.

/integrate

openjdk · 2023-11-15T09:55:54Z

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

fac6b51: 8319781: RISC-V: Refactor UseRVV related checks
bad6999: 8313672: C2: PhaseCCP does not correctly track analysis dependencies involving shift, convert, and mask
fbe1937: 8319955: Improve dependencies removal during class unloading
4c1540b: 8287284: C2: loop optimization performs split_thru_phi infinitely many times
70f0c01: 8320054: Remove unused _count from NMT walker classes
e7486e8: 8315986: [macos14] javax/swing/JMenuItem/4654927/bug4654927.java: component must be showing on the screen to determine its location
a6343c0: 8319999: Refactor MetaspaceShared::use_full_module_graph()
d9a89c5: 8319572: Test jdk/incubator/vector/LoadJsvmlTest.java ignores VM flags
1e76ba0: 8319439: Move BufferNode from PtrQueue files to new files
d5abe49: 8319628: DateFormat does not mention IllegalArgumentException for invalid style args
... and 28 more: https://git.openjdk.org/jdk/compare/03db82818b905f21cb5ad1d56a687e238b4a6e33...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-11-15T09:56:04Z

@tstuefe Pushed as commit 2e34a2e.

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

JDK-8318671-Potential-uninitialized-uintx-value-after-JDK-8317683

bdcd4e6

openjdk bot added serviceability serviceability-dev@openjdk.org hotspot-compiler hotspot-compiler-dev@openjdk.org labels Oct 24, 2023

tstuefe marked this pull request as ready for review October 24, 2023 08:56

openjdk bot added the rfr Pull request is ready for review label Oct 24, 2023

dholmes-ora reviewed Oct 24, 2023

View reviewed changes

tstuefe added 2 commits October 25, 2023 21:25

Merge branch 'openjdk:master' into JDK-8318671-Potential-uninitialize…

3e56329

…d-uintx-value-after-JDK-8317683

Make patch more palatable

24ec153

openjdk bot removed the rfr Pull request is ready for review label Oct 26, 2023

tstuefe commented Oct 26, 2023

View reviewed changes

remove tab

1564cf4

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

Fix Windows build

287d810

jdksjolen reviewed Oct 30, 2023

View reviewed changes

src/hotspot/share/compiler/compilerOracle.cpp Outdated Show resolved Hide resolved

test/hotspot/jtreg/compiler/compilercontrol/commands/MemStatTest.java Show resolved Hide resolved

TobiHartmann approved these changes Oct 31, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Oct 31, 2023

Merge branch 'master' into JDK-8318671-Potential-uninitialized-uintx-…

7abf7cc

…value-after-JDK-8317683

openjdk bot mentioned this pull request Nov 13, 2023

JDK-8319301: Static analysis warnings after JDK-8318016 #16631

Closed

3 tasks

shipilev reviewed Nov 14, 2023

View reviewed changes

feedback shade

591ce6e

shipilev approved these changes Nov 15, 2023

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Nov 15, 2023

openjdk bot closed this Nov 15, 2023

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

		jio_snprintf(errorbuf, buf_size, "MemStat: invalid value expected 'collect' or 'print' (omitting value means 'collect')");
		return handled_err;

Conversation

tstuefe commented Oct 24, 2023 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Oct 24, 2023

Uh oh!

openjdk bot commented Oct 24, 2023

Uh oh!

mlbridge bot commented Oct 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jdksjolen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

TobiHartmann left a comment

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Oct 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TobiHartmann commented Nov 13, 2023

Uh oh!

tstuefe commented Nov 13, 2023

Uh oh!

dholmes-ora commented Nov 14, 2023

Uh oh!

tstuefe commented Nov 14, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shipilev left a comment

Choose a reason for hiding this comment

Uh oh!

tstuefe commented Nov 15, 2023

Uh oh!

openjdk bot commented Nov 15, 2023

Uh oh!

openjdk bot commented Nov 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

tstuefe commented Oct 24, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Oct 24, 2023 •

edited

Loading

openjdk bot commented Oct 31, 2023 •

edited

Loading