Skip to content

8357862: Java argument file is parsed unexpectedly with trailing comment #25589

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sormuras
Copy link
Member

@sormuras sormuras commented Jun 2, 2025

Please review this fix to correctly parse tokens in an argument file that contains trailing comments without preceding whitespace characters before the '#' comment marker, the number sign.

The specifaction of the java Command has in section java Command-Line Argument Files:

Use the number sign `#` in the argument file to identify comments.
All characters following the `#` are ignored until the end of line.

There is not requirement specified to prepend a comment in a line with at least one argument with one or more preceding whitespace characters.


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-8357862: Java argument file is parsed unexpectedly with trailing comment (Bug - P4)(⚠️ The fixVersion in this issue is [26] but the fixVersion in .jcheck/conf is 25, a new backport will be created when this pr is integrated.)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25589

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jun 2, 2025

👋 Welcome back cstein! 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
Copy link

openjdk bot commented Jun 2, 2025

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk openjdk bot added the rfr Pull request is ready for review label Jun 2, 2025
@openjdk
Copy link

openjdk bot commented Jun 2, 2025

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

  • core-libs
  • hotspot-runtime

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.

Comment on lines +267 to +276
if (pctx->parts->size == 0) {
token = clone_substring(anchor, nextc - anchor);
} else {
JLI_List_addSubstring(pctx->parts, anchor, nextc - anchor);
token = JLI_List_combine(pctx->parts);
JLI_List_free(pctx->parts);
pctx->parts = JLI_List_new(4);
}
pctx->cptr = nextc + 1;
return token;
Copy link
Member Author

@sormuras sormuras Jun 2, 2025

Choose a reason for hiding this comment

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

This code duplicates a large part of the block of the previous case. Perhaps an internal helper method could be extracted?

Copy link
Contributor

Choose a reason for hiding this comment

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

right I agree that if there is common code we should extract it in a helper method

Copy link
Member Author

Choose a reason for hiding this comment

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

Or the handling of # can be merged with the previous case ... somehow.

@mlbridge
Copy link

mlbridge bot commented Jun 2, 2025

Webrevs

@vicente-romero-oracle
Copy link
Contributor

the fact that not including a space between the comment and the previous element created havoc seems to indicate that the scanner is pretty fragile and could break again in the future. We should probably file a follow up to make this code more reliable

@sormuras
Copy link
Member Author

sormuras commented Jun 2, 2025

the fact that not including a space between the comment and the previous element created havoc seems to indicate that the scanner is pretty fragile and could break again in the future. We should probably file a follow up to make this code more reliable

Yes, seems reasonable. My initial solution was to try to make use of the shared CommandLine class, but the parsing of the launcher is too early in the game.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants