8374718: Generation of CompilerProperties can fail in subtle ways

[mcimadamore]

This PR introduced a new diagnostic info line to allow warning keys to be associated with a lint category. For instance:

# lint: identity
compiler.warn.attempt.to.synchronize.on.instance.of.value.based.class=\
    attempt to synchronize on an instance of a value-based class

Is parsed at build time, and result in the following field to be added to the CompilerProperties class:

        /**
         * "attempt.to.synchronize.on.instance.of.value.based.class"
         */
        public static final LintWarning AttemptToSynchronizeOnInstanceOfValueBasedClass = new LintWarning(EnumSet.noneOf(DiagnosticFlag.class), LintCategory.get("identity").get(), "compiler", "attempt.to.synchronize.on.instance.of.value.based.class");

Note that the lint category undergoes a dynamic lookup:

LintCategory.get("identity").get()

This means that if there's a typo in the compiler.properties file, the lookup will fail and the JDK build will fail in a very obscure way (see JBS for reference). To avoid this problem, this PR removes the dynamic lookup from the generated file -- that is, the code in CompilerProperties will be:

        /**
         * "attempt.to.synchronize.on.instance.of.value.based.class"
         */
        public static final LintWarning AttemptToSynchronizeOnInstanceOfValueBasedClass = new LintWarning(EnumSet.noneOf(DiagnosticFlag.class), LintCategory.IDENTITY, "compiler", "attempt.to.synchronize.on.instance.of.value.based.class");

That is, the lint category string in compiler.properties is turned into a field name, first by capitalizing all the chars, then by replacing - with _. This ensures that if a lint category is mispelled in compiler.prooprties, the resulting generated code will fail to compile.

The small price we have to pay for this is that we need to make sure that the naming of the lint category enum fields are consistent -- to this end the lint field RAW had to be renamed to RAWTYPES. But that was the only exception to the unwritten rule. I have also added a comment to capture this rule.

---

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-8374718: Generation of CompilerProperties can fail in subtle ways (Bug - P4)

Reviewers

• Jan Lahoda (@lahodaj - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 29090

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back mcimadamore! 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]

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

8374718: Generation of CompilerProperties can fail in subtle ways

Reviewed-by: jlahoda

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

• da14813: 8373453: C2 SuperWord: must handle load slices that have loads with different memory inputs
• 929864b: 8362087: Test containers/docker/ShareTmpDir.java intermittent fails
• d7a3df6: 8374436: compiler/igvn/IntegerDivValueTests.java failed with division by zero
• ... and 317 more: https://git.openjdk.org/jdk/compare/16699a394d4d6c2b8a21e7de3c3d344c5a3309b4...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.

[openjdk]

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

• build
• compiler

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]

Webrevs

• 00: Full (1f146f28)

[lahodaj]

Looks good to me, thanks!

[mcimadamore]

/integrate

[openjdk]

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

• 067fd3c: 8374768: S390X builds are failing after JDK-8372754
• 08ff16f: 8374576: Disable MemoryEaterMT for VirtualThread
• a71326a: 8374528: C2 SuperWord: TestAliasingFuzzer.java strengthen no-multiversioning IR rule
• ... and 330 more: https://git.openjdk.org/jdk/compare/16699a394d4d6c2b8a21e7de3c3d344c5a3309b4...master

Your commit was automatically rebased without conflicts.

[openjdk]

@mcimadamore Pushed as commit 904ba5f.

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