8327138: Clean up status management in cdsConfig.hpp and CDS.java #18095

iklam · 2024-03-02T01:18:06Z

A few clean ups:

Rename functions like "s_loading_full_module_graph() to is_using_full_module_graph(). The meaning of "loading" is not clear: it might be interpreted as to cover only the period where the artifact is being loaded, but not the period after the artifact is completely loaded. However, the function is meant to cover both periods, so "using" is a more precise term.
The cumbersome sounding disable_loading_full_module_graph() is changed to stop_using_full_module_graph(), etc.
The status of is_using_optimized_module_handling() is moved from metaspaceShared.hpp to cdsConfig.hpp, to be consolidated with other types of CDS status.
The status of CDS was communicated to the Java class jdk.internal.misc.CDS by ad-hoc native methods. This is now changed to a single method, CDS.getCDSConfigStatus() that returns a bit field. That way we don't need to add a new native method for each type of status.
CDS.isDumpingClassList() was a misnomer. It's changed to CDS.isLoggingLambdaFormInvokers().

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-8327138: Clean up status management in cdsConfig.hpp and CDS.java (Enhancement - P4)

Reviewers

Calvin Cheung (@calvinccheung - Reviewer)
Matias Saavedra Silva (@matias9927 - Committer) ⚠️ Review applies to 78e828de

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 18095

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2024-03-02T01:18:43Z

👋 Welcome back iklam! 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 · 2024-03-02T01:19:12Z

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

core-libs
hotspot

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 · 2024-03-02T01:22:16Z

Webrevs

calvinccheung

Looks good. Just one nit below.
I assume that it has gone through some testing?

calvinccheung · 2024-03-05T20:39:10Z

src/hotspot/share/cds/cdsConfig.hpp

+  static void stop_dumping_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
+  static bool   is_dumping_full_module_graph()               { return CDS_ONLY(_is_dumping_full_module_graph) NOT_CDS(false); }
+  static void   stop_using_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN;
+  static bool     is_using_full_module_graph()                NOT_CDS_JAVA_HEAP_RETURN_(false);


Please align this with line #90.

Do you mean aligning like this:

static bool is_dumping_heap() NOT_CDS_JAVA_HEAP_RETURN_(false); static void stop_dumping_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN; static bool is_dumping_full_module_graph() { return CDS_ONLY(_is_dumping_full_module_graph) NOT_CDS(false); } static void stop_using_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN; static bool is_using_full_module_graph() NOT_CDS_JAVA_HEAP_RETURN_(false);

I think this is more messy, and you can't easily tell that these four functions are all related to the same feature (full_module_graph).

I meant the following. Just the last line #94 needs to be changed - shift one space to the left after bool.

static bool is_dumping_heap() NOT_CDS_JAVA_HEAP_RETURN_(false); static void stop_dumping_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN; static bool is_dumping_full_module_graph() { return CDS_ONLY(_is_dumping_full_module_graph) NOT_CDS(false); } static void stop_using_full_module_graph(const char* reason = nullptr) NOT_CDS_JAVA_HEAP_RETURN; static bool is_using_full_module_graph() NOT_CDS_JAVA_HEAP_RETURN_(false);

I wanted line 94 to align the "using_full_module_graph" part with the function at line 93.

In that case, it looks good.

openjdk · 2024-03-05T20:42:23Z

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

8327138: Clean up status management in cdsConfig.hpp and CDS.java

Reviewed-by: ccheung, matsaave

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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.

matias9927

Looks good, thanks! Just one comment on format below.

matias9927 · 2024-03-06T18:42:01Z

src/hotspot/share/cds/cdsConfig.hpp

@@ -61,6 +69,7 @@ class CDSConfig : public AllStatic {
  static bool      is_dumping_dynamic_archive()              { return CDS_ONLY(_is_dumping_dynamic_archive) NOT_CDS(false); }
  static void  enable_dumping_dynamic_archive()              { CDS_ONLY(_is_dumping_dynamic_archive = true); }
  static void disable_dumping_dynamic_archive()              { CDS_ONLY(_is_dumping_dynamic_archive = false); }
+  static bool      is_using_archive()                        NOT_CDS_RETURN_(false);


Could you fix the alignment of the method names here?

Since several people are confused by the alignment style (align same words to the right), I fixed the grouping of the functions so that the text is aligned to the left, as in most header files.

Please take a look at ae0e0ac -- it's best viewed on GutHub with white spaces hidden.

dholmes-ora

Some drive-by nits. (But copyright needs fixing.)

dholmes-ora · 2024-03-07T06:50:04Z

src/hotspot/share/cds/cdsConfig.cpp

- * Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.


Incorrect copyright update - should be "2023, 2024,"

dholmes-ora · 2024-03-07T06:52:07Z

src/hotspot/share/cds/cdsConfig.cpp

+  return (is_dumping_archive()               ? IS_DUMPING_ARCHIVE : 0) |
+         (is_dumping_static_archive()        ? IS_DUMPING_STATIC_ARCHIVE : 0) |
+         (is_logging_lambda_form_invokers()  ? IS_LOGGING_LAMBDA_FORM_INVOKERS : 0) |
+         (is_using_archive()                 ? IS_USING_ARCHIVE : 0);


You can remove one space before the ? in each line

dholmes-ora · 2024-03-07T06:53:14Z

src/hotspot/share/cds/cdsConfig.hpp

+  static const int IS_DUMPING_ARCHIVE                     = 1 << 0;
+  static const int IS_DUMPING_STATIC_ARCHIVE              = 1 << 1;
+  static const int IS_LOGGING_LAMBDA_FORM_INVOKERS        = 1 << 2;
+  static const int IS_USING_ARCHIVE                       = 1 << 3;


why is the = sign so far away?

iklam · 2024-03-09T03:48:17Z

Thanks @calvinccheung @matias9927 @dholmes-ora for the review.
/integrate

openjdk · 2024-03-09T03:48:39Z

Going to push as commit 761ed25.
Since your change was applied there has been 1 commit pushed to the master branch:

53628f2: 8327492: Remove applet usage and update DisposeInActionEventTest.html

Your commit was automatically rebased without conflicts.

openjdk · 2024-03-09T03:48:45Z

@iklam Pushed as commit 761ed25.

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

8327138: Clean up status management in cdsConfig.hpp and CDS.java

78e828d

openjdk bot added the rfr Pull request is ready for review label Mar 2, 2024

openjdk bot added hotspot hotspot-dev@openjdk.org core-libs core-libs-dev@openjdk.org labels Mar 2, 2024

calvinccheung approved these changes Mar 5, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Mar 5, 2024

matias9927 approved these changes Mar 6, 2024

View reviewed changes

iklam added 2 commits March 6, 2024 14:16

fixed alignments

ae0e0ac

more alignment

5a28f86

dholmes-ora reviewed Mar 7, 2024

View reviewed changes

@dholmes-ora comments -- white spaces and copyright

c8f08f7

calvinccheung approved these changes Mar 7, 2024

View reviewed changes

Merge branch 'master' into 8327138-clean-up-cdsConfig-and-CDS-java

25c19bb

openjdk bot added the integrated Pull request has been integrated label Mar 9, 2024

openjdk bot closed this Mar 9, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8327138: Clean up status management in cdsConfig.hpp and CDS.java #18095

8327138: Clean up status management in cdsConfig.hpp and CDS.java #18095

iklam commented Mar 2, 2024 •

edited by openjdk bot

Loading

bridgekeeper bot commented Mar 2, 2024

openjdk bot commented Mar 2, 2024

mlbridge bot commented Mar 2, 2024 •

edited

Loading

calvinccheung left a comment

calvinccheung Mar 5, 2024

iklam Mar 5, 2024

calvinccheung Mar 5, 2024

iklam Mar 6, 2024

calvinccheung Mar 6, 2024

openjdk bot commented Mar 5, 2024 •

edited

Loading

matias9927 left a comment

matias9927 Mar 6, 2024

iklam Mar 6, 2024

dholmes-ora left a comment

dholmes-ora Mar 7, 2024

iklam Mar 7, 2024

dholmes-ora Mar 7, 2024

iklam Mar 7, 2024

dholmes-ora Mar 7, 2024

iklam Mar 7, 2024

iklam commented Mar 9, 2024

openjdk bot commented Mar 9, 2024

openjdk bot commented Mar 9, 2024

		* Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
		* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.

8327138: Clean up status management in cdsConfig.hpp and CDS.java #18095

8327138: Clean up status management in cdsConfig.hpp and CDS.java #18095

Conversation

iklam commented Mar 2, 2024 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Mar 2, 2024

openjdk bot commented Mar 2, 2024

mlbridge bot commented Mar 2, 2024 • edited Loading

Webrevs

calvinccheung left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openjdk bot commented Mar 5, 2024 • edited Loading

matias9927 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dholmes-ora left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iklam commented Mar 9, 2024

openjdk bot commented Mar 9, 2024

openjdk bot commented Mar 9, 2024

iklam commented Mar 2, 2024 •

edited by openjdk bot

Loading

mlbridge bot commented Mar 2, 2024 •

edited

Loading

openjdk bot commented Mar 5, 2024 •

edited

Loading