8298084: Memory leak in Method::build_profiling_method_data #13

coleenp · 2022-12-09T16:16:00Z

This change fixes the MethodData leak by calling the destructor in both the release_C_heap_structures conditionally and by calling the MethodData destructor in the MetadataFactory::free_metadata method.
Thanks to @jcking for working on the patch and discussion.
Tested with tier1-4.

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-8298084: Memory leak in Method::build_profiling_method_data

Reviewers

Kim Barrett (@kimbarrett - Reviewer) ⚠️ Review applies to e195cd85
Erik Österlund (@fisk - Reviewer) ⚠️ Review applies to 11fcdba0
David Holmes (@dholmes-ora - Reviewer)
Justin King (@jcking - Author)
Tobias Hartmann (@TobiHartmann - Reviewer)

Contributors

Justin King <jcking@openjdk.org>

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk20/pull/13.diff

bridgekeeper · 2022-12-09T16:16:27Z

👋 Welcome back coleenp! 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 · 2022-12-09T16:19:53Z

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

hotspot

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 · 2022-12-09T16:23:05Z

Webrevs

openjdk · 2022-12-09T16:25:25Z

@coleenp Unknown command author - for a list of valid commands use /help.

coleenp · 2022-12-09T16:25:58Z

/help

openjdk · 2022-12-09T16:26:59Z

@coleenp Available commands:

backport - create a backport
cc - add or remove an additional classification label
clean - Mark the backport pull request as a clean backport
contributor - adds or removes additional contributors for a PR
covered - used when employer has signed the OCA
csr - require a compatibility and specification request (CSR) for this pull request
help - shows this text
integrate - performs integration of the changes in the PR
issue - edit the list of issues that this PR solves
jep - require a JDK Enhancement Proposal (JEP) for this pull request
label - add or remove an additional classification label
open - Set the pull request state to "open"
reviewer - manage additional reviewers for a PR
reviewers - set the number of additional required reviewers for this PR
signed - used after signing the OCA
solves - edit the list of issues that this PR solves
sponsor - performs integration of a PR that is authored by a non-committer
summary - updates the summary in the commit message
test - used to run tests

coleenp · 2022-12-09T16:28:19Z

/contributor add @jcking

openjdk · 2022-12-09T16:28:42Z

@coleenp
Contributor Justin King <jcking@openjdk.org> successfully added.

src/hotspot/share/memory/metadataFactory.hpp

openjdk · 2022-12-12T17:37:48Z

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

8298084: Memory leak in Method::build_profiling_method_data

Co-authored-by: Justin King <jcking@openjdk.org>
Reviewed-by: kbarrett, eosterlund, dholmes, jcking, thartmann

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

d453190: 8296955: Kitchensink.java failed with "double free or corruption (!prev): "
8962c72: 8298488: [macos13] tools/jpackage tests failing with "Exit code: 137" on macOS
0267aa5: 8297288: Example code in Scanner class
cf93933: 8298271: java/security/SignedJar/spi-calendar-provider/TestSPISigned.java failing on Windows
d624deb: 8298459: Fix msys2 linking and handling out of tree build directory for source zip creation
a894649: 8298225: [AIX] Disable PPC64LE continuations on AIX
52fffdd: 8298463: tools/javac/modules/EdgeCases.java fails on Windows after JDK-8297988
b7b996c: 8298353: C2 fails with assert(opaq->outcnt() == 1 && opaq->in(1) == limit) failed
05d67f6: 8298340: java/net/httpclient/CancelRequestTest.java fails with AssertionError: Found some subscribers for testPostInterrupt
5a92bee: 8298455: JFR: Add logging to TestClose.java
... and 1 more: https://git.openjdk.org/jdk20/compare/553ba65dc44b601e048c53cd1c48d668de9dcf1e...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.

fisk

Looks good.

coleenp · 2022-12-12T18:10:54Z

Thanks Erik and Kim. @TobiHartmann and @jcking, do you want to review?

dholmes-ora

Not sure about some of the incidental changes - see below.

Thanks.

src/hotspot/share/memory/metadataFactory.hpp

dholmes-ora · 2022-12-13T00:13:38Z

src/hotspot/share/oops/instanceKlass.cpp

+  if (release_sub_metadata) {
+    methods_do(method_release_C_heap_structures);
+  }


I don't understand this aspect of the change. It seems unrelated to the missing destructor issue and seems to cause a significant change in behaviour as we will no longer call methods_do when called from deallocate_contents with the renamed false argument.

This boolean prevents us from calling the MethodData destructor twice and releasing MethodData C heap memory twice. InstanceKlass::deallocate_contents calls release_C_heap_structures with it false, and then calls through the Metadata pointer hierarchy to MetadataFactory::free_metadata, which calls the MethodData destructor and MethodData::deallocate_contents which calls MethodData::release_C_heap_structures(). This is the delegation scheme for releasing metadata between InstanceKlass and ConstantPool.

InstanceKlass::release_C_heap_structures() is also called during class unloading and must walk the whole metadata, releasing C heap memory. It's passed true. It doesn't go through deallocate_contents because the metadata is freed together at the same time with the metaspace that contains it.

Thanks Coleen I see now how the code has been shuffled around:

Old code:

InstanceKlass::deallocate_contents -> release_C_heap_structures(/* release_sub_metadata */ false); -> methods_do(method_release_C_heap_structures); -> m->release_C_heap_structures -> method_data()->~MethodData(); -> deallocate_methods(loader_data, methods()); -> MetadataFactory::free_metadata(loader_data, method);

New code:

InstanceKlass::deallocate_contents -> release_C_heap_structures(/* release_sub_metadata */ false); -> deallocate_methods(loader_data, methods()); -> MetadataFactory::free_metadata(loader_data, method); -> method_data()->~MethodData();

Yes, plus releasing the JVMCI thing that MethodData points to also.

dholmes-ora

Thanks Coleen. A couple of further nits on comments but otherwise this seems okay.

dholmes-ora · 2022-12-13T01:15:18Z

src/hotspot/share/oops/instanceKlass.cpp

  // Can't release the constant pool here because the constant pool can be
  // deallocated separately from the InstanceKlass for default methods and
  // redefine classes.


Does this comment make sense when the parameter doesn't actually control release of the CP?

The comment means it can't release constant pool CHeap structures. It should be inclusive of MethodData also.

dholmes-ora · 2022-12-13T01:16:49Z

src/hotspot/share/oops/instanceKlass.cpp

@@ -2665,12 +2665,14 @@ static void method_release_C_heap_structures(Method* m) {
 }

 // Called also by InstanceKlass::deallocate_contents, with false for release_constant_pool.


Comment needs updating.

dholmes-ora · 2022-12-13T01:16:55Z

src/hotspot/share/oops/instanceKlass.cpp

+  if (release_sub_metadata) {
+    methods_do(method_release_C_heap_structures);
+  }


Thanks Coleen I see now how the code has been shuffled around:

Old code:

InstanceKlass::deallocate_contents -> release_C_heap_structures(/* release_sub_metadata */ false); -> methods_do(method_release_C_heap_structures); -> m->release_C_heap_structures -> method_data()->~MethodData(); -> deallocate_methods(loader_data, methods()); -> MetadataFactory::free_metadata(loader_data, method);

New code:

InstanceKlass::deallocate_contents -> release_C_heap_structures(/* release_sub_metadata */ false); -> deallocate_methods(loader_data, methods()); -> MetadataFactory::free_metadata(loader_data, method); -> method_data()->~MethodData();

jcking · 2022-12-13T03:31:32Z

src/hotspot/share/memory/metadataFactory.hpp

+      // Call the destructor. This is currently used for MethodData which has a member
+      // that needs to be destructed to release resources. Most Metadata derived classes have noop
+      // destructors and/or cleanup using deallocate_contents.
+      // T is a potentially const or volatile qualified pointer. Remove any const


We'll given the template, T by itself is no longer a pointer so its just potentially const or volatile qualified. But that is pedantic.

I just want to leave it because you're right but pointer is a readable noun here.

TobiHartmann

Looks good to me. Thanks for fixing!

coleenp · 2022-12-13T13:01:24Z

Thanks for the reviews David, Justin and Tobias.
/integrate

openjdk · 2022-12-13T13:02:33Z

Going to push as commit 04b8d0c.
Since your change was applied there have been 11 commits pushed to the master branch:

d453190: 8296955: Kitchensink.java failed with "double free or corruption (!prev): "
8962c72: 8298488: [macos13] tools/jpackage tests failing with "Exit code: 137" on macOS
0267aa5: 8297288: Example code in Scanner class
cf93933: 8298271: java/security/SignedJar/spi-calendar-provider/TestSPISigned.java failing on Windows
d624deb: 8298459: Fix msys2 linking and handling out of tree build directory for source zip creation
a894649: 8298225: [AIX] Disable PPC64LE continuations on AIX
52fffdd: 8298463: tools/javac/modules/EdgeCases.java fails on Windows after JDK-8297988
b7b996c: 8298353: C2 fails with assert(opaq->outcnt() == 1 && opaq->in(1) == limit) failed
05d67f6: 8298340: java/net/httpclient/CancelRequestTest.java fails with AssertionError: Found some subscribers for testPostInterrupt
5a92bee: 8298455: JFR: Add logging to TestClose.java
... and 1 more: https://git.openjdk.org/jdk20/compare/553ba65dc44b601e048c53cd1c48d668de9dcf1e...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-12-13T13:02:55Z

@coleenp Pushed as commit 04b8d0c.

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

8298084: Memory leak in Method::build_profiling_method_data

0bc9aba

openjdk bot added the rfr Pull request is ready for review label Dec 9, 2022

openjdk bot added the hotspot hotspot-dev@openjdk.org label Dec 9, 2022

kimbarrett suggested changes Dec 11, 2022

View reviewed changes

src/hotspot/share/memory/metadataFactory.hpp Outdated Show resolved Hide resolved

Fix metaprogramming

e195cd8

kimbarrett approved these changes Dec 12, 2022

View reviewed changes

src/hotspot/share/memory/metadataFactory.hpp Outdated Show resolved Hide resolved

openjdk bot added the ready Pull request is ready to be integrated label Dec 12, 2022

Even more metaprogramming improvements

11fcdba

fisk approved these changes Dec 12, 2022

View reviewed changes

dholmes-ora reviewed Dec 13, 2022

View reviewed changes

dholmes-ora approved these changes Dec 13, 2022

View reviewed changes

coleenp added 3 commits December 13, 2022 01:21

Update comment

6deb5f4

More comment updates.

9cccf6c

Even more comment updates. Removed word salad.

95ecbc3

jcking reviewed Dec 13, 2022

View reviewed changes

jcking approved these changes Dec 13, 2022

View reviewed changes

dholmes-ora approved these changes Dec 13, 2022

View reviewed changes

TobiHartmann approved these changes Dec 13, 2022

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Dec 13, 2022

openjdk bot closed this Dec 13, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Dec 13, 2022

coleenp deleted the method-data branch December 13, 2022 13:05

8298084: Memory leak in Method::build_profiling_method_data #13

8298084: Memory leak in Method::build_profiling_method_data #13

coleenp commented Dec 9, 2022 •

edited by openjdk bot

bridgekeeper bot commented Dec 9, 2022

openjdk bot commented Dec 9, 2022

mlbridge bot commented Dec 9, 2022 •

edited

openjdk bot commented Dec 9, 2022

coleenp commented Dec 9, 2022

openjdk bot commented Dec 9, 2022

coleenp commented Dec 9, 2022

openjdk bot commented Dec 9, 2022

openjdk bot commented Dec 12, 2022 •

edited

fisk left a comment

coleenp commented Dec 12, 2022

dholmes-ora left a comment

dholmes-ora Dec 13, 2022

coleenp Dec 13, 2022

dholmes-ora Dec 13, 2022

coleenp Dec 13, 2022

dholmes-ora left a comment

dholmes-ora Dec 13, 2022

coleenp Dec 13, 2022 •

edited

dholmes-ora Dec 13, 2022

dholmes-ora Dec 13, 2022

jcking Dec 13, 2022

coleenp Dec 13, 2022

TobiHartmann left a comment

coleenp commented Dec 13, 2022

openjdk bot commented Dec 13, 2022

openjdk bot commented Dec 13, 2022

		@@ -2665,12 +2665,14 @@ static void method_release_C_heap_structures(Method* m) {
		}

		// Called also by InstanceKlass::deallocate_contents, with false for release_constant_pool.

8298084: Memory leak in Method::build_profiling_method_data #13

8298084: Memory leak in Method::build_profiling_method_data #13

Conversation

coleenp commented Dec 9, 2022 • edited by openjdk bot

Progress

Issue

Reviewers

Contributors

Reviewing

bridgekeeper bot commented Dec 9, 2022

openjdk bot commented Dec 9, 2022

mlbridge bot commented Dec 9, 2022 • edited

Webrevs

openjdk bot commented Dec 9, 2022

coleenp commented Dec 9, 2022

openjdk bot commented Dec 9, 2022

coleenp commented Dec 9, 2022

openjdk bot commented Dec 9, 2022

openjdk bot commented Dec 12, 2022 • edited

fisk left a comment

Choose a reason for hiding this comment

coleenp commented Dec 12, 2022

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

dholmes-ora left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coleenp Dec 13, 2022 • edited

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

TobiHartmann left a comment

Choose a reason for hiding this comment

coleenp commented Dec 13, 2022

openjdk bot commented Dec 13, 2022

openjdk bot commented Dec 13, 2022

coleenp commented Dec 9, 2022 •

edited by openjdk bot

mlbridge bot commented Dec 9, 2022 •

edited

openjdk bot commented Dec 12, 2022 •

edited

coleenp Dec 13, 2022 •

edited