8257872: UL: -Xlog does not check number of options #1685

jyukutyo · 2020-12-08T03:02:03Z

In Unified Logging options can be specified up to four (-Xlog[:[selections][:[output][:[decorators][:output-options]]]]).
But it’s possible to specify options with more colons like java -Xlog:::::.
It’s better to show a message when more options are specified than maximum number.

By this PR a warning message is outputted when options are specified more than the max number.

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8257872: UL: -Xlog does not check number of options

Reviewers

David Holmes (@dholmes-ora - Reviewer)
Ioi Lam (@iklam - Reviewer)
Yasumasa Suenaga (@YaSuenag - Reviewer)

Download

$ git fetch https://git.openjdk.java.net/jdk pull/1685/head:pull/1685
$ git checkout pull/1685

bridgekeeper · 2020-12-08T03:03:01Z

👋 Welcome back ksakata! 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 · 2020-12-08T03:03:44Z

@jyukutyo The following label will be automatically applied to this pull request:

hotspot-runtime

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 · 2020-12-08T04:52:17Z

Webrevs

01: Full - Incremental (ed882ea)
00: Full (e5ab283)

dholmes-ora · 2020-12-08T06:13:18Z

src/hotspot/share/logging/logConfiguration.cpp

      break;
    }
  }

+  if (str != NULL) {
+    log_warning(logging)("Options are specified more than the max number in -Xlog.");


Might I suggest:
log_warning(logging)("Ignoring excess -Xlog options: \"%s\"", str);

Thank you for your suggestion. This message is clear for everyone. I changed the warning message.

iklam · 2020-12-09T00:59:56Z

Should this be a warning or an error? The behavior seems inconsistent:

$ java -Xlog:gc=error:::foo -version
[0.000s][warning][logging] Output options for existing outputs are ignored.
java version "16-internal" 2021-03-16
Java(TM) SE Runtime Environment (build 16-internal+0-adhoc.iklam.open)
Java HotSpot(TM) 64-Bit Server VM (build 16-internal+0-adhoc.iklam.open, mixed mode, sharing)

$ java -Xlog:gc=error::foo -version
[0.000s][error][logging] Invalid decorator 'foo'.
Invalid -Xlog option '-Xlog:gc=error::foo', see error log for details.
Error: Could not create the Java Virtual Machine.
Error: A fatal exception has occurred. Program will exit.

jyukutyo · 2020-12-09T03:04:32Z

In this PR I chose a warning level to ignore the invalid option and run a application. It isn't serious thing and some people might run with invalid option already.

The fourth option is for output-option and can be described relatively free. So I suspect that it is ignored even when it is invalid.

dholmes-ora · 2020-12-10T01:41:05Z

I think a warning is okay in this context.

openjdk · 2020-12-10T01:41:41Z

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

8257872: UL: -Xlog does not check number of options

Reviewed-by: dholmes, iklam, ysuenaga

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

6847bbb: 8255918: XMLStreamFilterImpl constructor consumes XMLStreamException
d2f9e31: 8257638: Update usage of "type" terminology in javax.lang.model
f631a99: 8256888: Client manual test problem list update
eb1c8a1: 8257924: Use full path when running external executable from jpackage
1ce2a36: 8257539: tools/jpackage/windows/WinL10nTest.java unpack.bat failed with Exit code: 1618
53e537c: 8255387: Japanese characters were printed upside down on AIX
0a3e446: 8257993: vmTestbase/nsk/jvmti/RedefineClasses/StressRedefine/TestDescription.java crash intermittently
46c9a86: 8245956: JavaCompiler still uses File API instead of Path API in a specific case
baf4c1a: 8257917: [JVMCI] crash when materializing boxed values under -Xcomp
fd5f6e2: 8257986: [JVMCI] ProblemList 2 reprofile JVMCI tests
... and 79 more: https://git.openjdk.java.net/jdk/compare/d3ac1bf16c2e6ffc1f5b1759631750cb7eac2e17...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@dholmes-ora, @iklam, @YaSuenag) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

iklam

Agree that warning is OK.

jyukutyo · 2020-12-10T02:01:17Z

/integrate

openjdk · 2020-12-10T02:01:42Z

@jyukutyo
Your change (at version ed882ea) is now ready to be sponsored by a Committer.

YaSuenag

Looks good! I will sponsor you.

YaSuenag · 2020-12-10T04:04:46Z

/sponsor

openjdk · 2020-12-10T04:05:39Z

@YaSuenag @jyukutyo Since your change was applied there have been 89 commits pushed to the master branch:

6847bbb: 8255918: XMLStreamFilterImpl constructor consumes XMLStreamException
d2f9e31: 8257638: Update usage of "type" terminology in javax.lang.model
f631a99: 8256888: Client manual test problem list update
eb1c8a1: 8257924: Use full path when running external executable from jpackage
1ce2a36: 8257539: tools/jpackage/windows/WinL10nTest.java unpack.bat failed with Exit code: 1618
53e537c: 8255387: Japanese characters were printed upside down on AIX
0a3e446: 8257993: vmTestbase/nsk/jvmti/RedefineClasses/StressRedefine/TestDescription.java crash intermittently
46c9a86: 8245956: JavaCompiler still uses File API instead of Path API in a specific case
baf4c1a: 8257917: [JVMCI] crash when materializing boxed values under -Xcomp
fd5f6e2: 8257986: [JVMCI] ProblemList 2 reprofile JVMCI tests
... and 79 more: https://git.openjdk.java.net/jdk/compare/d3ac1bf16c2e6ffc1f5b1759631750cb7eac2e17...master

Your commit was automatically rebased without conflicts.

Pushed as commit 34650f5.

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

Check the number of options in -Xlog

e5ab283

openjdk bot added the hotspot-runtime hotspot-runtime-dev@openjdk.org label Dec 8, 2020

jyukutyo marked this pull request as ready for review December 8, 2020 04:48

openjdk bot added the rfr Pull request is ready for review label Dec 8, 2020

dholmes-ora reviewed Dec 8, 2020

View reviewed changes

Change the warning message

ed882ea

dholmes-ora approved these changes Dec 10, 2020

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Dec 10, 2020

iklam approved these changes Dec 10, 2020

View reviewed changes

openjdk bot added the sponsor Pull request is ready to be sponsored label Dec 10, 2020

YaSuenag approved these changes Dec 10, 2020

View reviewed changes

openjdk bot closed this Dec 10, 2020

openjdk bot added integrated Pull request has been integrated and removed sponsor Pull request is ready to be sponsored ready Pull request is ready to be integrated rfr Pull request is ready for review labels Dec 10, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8257872: UL: -Xlog does not check number of options #1685

8257872: UL: -Xlog does not check number of options #1685

jyukutyo commented Dec 8, 2020 •

edited by openjdk bot

Loading

bridgekeeper bot commented Dec 8, 2020

openjdk bot commented Dec 8, 2020

mlbridge bot commented Dec 8, 2020 •

edited

Loading

dholmes-ora Dec 8, 2020

jyukutyo Dec 9, 2020

iklam commented Dec 9, 2020

jyukutyo commented Dec 9, 2020

dholmes-ora commented Dec 10, 2020

openjdk bot commented Dec 10, 2020 •

edited

Loading

iklam left a comment

jyukutyo commented Dec 10, 2020

openjdk bot commented Dec 10, 2020

YaSuenag left a comment

YaSuenag commented Dec 10, 2020

openjdk bot commented Dec 10, 2020

8257872: UL: -Xlog does not check number of options #1685

8257872: UL: -Xlog does not check number of options #1685

Conversation

jyukutyo commented Dec 8, 2020 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Download

bridgekeeper bot commented Dec 8, 2020

openjdk bot commented Dec 8, 2020

mlbridge bot commented Dec 8, 2020 • edited Loading

Webrevs

dholmes-ora Dec 8, 2020

Choose a reason for hiding this comment

jyukutyo Dec 9, 2020

Choose a reason for hiding this comment

iklam commented Dec 9, 2020

jyukutyo commented Dec 9, 2020

dholmes-ora commented Dec 10, 2020

openjdk bot commented Dec 10, 2020 • edited Loading

iklam left a comment

Choose a reason for hiding this comment

jyukutyo commented Dec 10, 2020

openjdk bot commented Dec 10, 2020

YaSuenag left a comment

Choose a reason for hiding this comment

YaSuenag commented Dec 10, 2020

openjdk bot commented Dec 10, 2020

jyukutyo commented Dec 8, 2020 •

edited by openjdk bot

Loading

mlbridge bot commented Dec 8, 2020 •

edited

Loading

openjdk bot commented Dec 10, 2020 •

edited

Loading