8362123: ClassLoader Leak via Executors.newSingleThreadExecutor(...)#26296
8362123: ClassLoader Leak via Executors.newSingleThreadExecutor(...)#26296chrisdennis wants to merge 1 commit intoopenjdk:masterfrom
Conversation
|
Hi @chrisdennis, welcome to this OpenJDK project and thanks for contributing! We do not recognize you as Contributor and need to ensure you have signed the Oracle Contributor Agreement (OCA). If you have not signed the OCA, please follow the instructions. Please fill in your GitHub username in the "Username" field of the application. Once you have signed the OCA, please let us know by writing If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please use "Add GitHub user chrisdennis" as summary for the issue. If you are contributing this work on behalf of your employer and your employer has signed the OCA, please let us know by writing |
|
@chrisdennis 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: 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 169 new commits pushed to the
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 (@viktorklang-ora, @AlanBateman) but any other Committer may sponsor as well. ➡️ To flag this PR as ready for integration with the above commit message, type |
|
@chrisdennis The following label will be automatically applied to this pull request:
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. |
|
/covered Covered under my employment by IBM. I've set the author email on my commits to my IBM address, and I can be reached there for validation reasons if necessary. My Github user is also a member of the IBM Github organization. |
|
Thank you! Please allow for a few business days to verify that your employer has signed the OCA. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated! |
|
@robilad : Apologies for the direct invoke, but I've seen you facilitate this process before, so hope this is still the right way to bump things: I've waited a "few business days" but have seen no movement on the OCA verification, and have noticed no verification email inbound to me (chris.w.dennis@ibm.com). |
|
@chrisdennis This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply issue a |
|
/keepalive - awaiting action from IBM to get OCA paperwork processed. |
|
@chrisdennis The pull request is being re-evaluated and the inactivity timeout has been reset. |
bridgekeeper
bot
removed
oca
|
@chrisdennis Looks like your OCA approval was resolved, so I'll have a look at your Pull-Request now. |
| ClassLoader classLoader = Utils.getTestClassPathURLClassLoader(ClassLoader.getPlatformClassLoader()); | ||
|
|
||
| ReferenceQueue<?> queue = new ReferenceQueue<>(); | ||
| Reference<?> reference = new PhantomReference(classLoader, queue); | ||
|
|
||
| classLoader.loadClass("AutoShutdown$IsolatedClass").getDeclaredMethod("shutdown", Consumer.class).invoke(null, shutdown); | ||
| classLoader = null; | ||
|
|
||
| assertTrue(ForceGC.wait(() -> queue.poll() != null)); | ||
| Reference.reachabilityFence(reference); |
There was a problem hiding this comment.
reachabilityFence should be placed in a finally-block as per: https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/ref/Reference.html#reachabilityFence(java.lang.Object)
| ClassLoader classLoader = Utils.getTestClassPathURLClassLoader(ClassLoader.getPlatformClassLoader()); | |
| ReferenceQueue<?> queue = new ReferenceQueue<>(); | |
| Reference<?> reference = new PhantomReference(classLoader, queue); | |
| classLoader.loadClass("AutoShutdown$IsolatedClass").getDeclaredMethod("shutdown", Consumer.class).invoke(null, shutdown); | |
| classLoader = null; | |
| assertTrue(ForceGC.wait(() -> queue.poll() != null)); | |
| Reference.reachabilityFence(reference); | |
| try { | |
| ClassLoader classLoader = Utils.getTestClassPathURLClassLoader(ClassLoader.getPlatformClassLoader()); | |
| ReferenceQueue<?> queue = new ReferenceQueue<>(); | |
| Reference<?> reference = new PhantomReference(classLoader, queue); | |
| classLoader.loadClass("AutoShutdown$IsolatedClass").getDeclaredMethod("shutdown", Consumer.class).invoke(null, shutdown); | |
| classLoader = null; | |
| assertTrue(ForceGC.wait(() -> queue.poll() != null)); | |
| } finally { | |
| Reference.reachabilityFence(reference); | |
| } |
| ReferenceQueue<?> queue = new ReferenceQueue<>(); | ||
| Reference<?> reference = new PhantomReference(classLoader, queue); | ||
|
|
||
| classLoader.loadClass("AutoShutdown$IsolatedClass").getDeclaredMethod("shutdown", Consumer.class).invoke(null, shutdown); |
There was a problem hiding this comment.
Can we split up and assert that the defining loader of IsolatedClass is "classLoader"? It's important to be confident of that when looking at this test.
| ReferenceQueue<?> queue = new ReferenceQueue<>(); | ||
| Reference<?> reference = new PhantomReference(classLoader, queue); | ||
|
|
||
| classLoader.loadClass("AutoShutdown$IsolatedClass").getDeclaredMethod("shutdown", Consumer.class).invoke(null, shutdown); |
There was a problem hiding this comment.
Something like this:
| classLoader.loadClass("AutoShutdown$IsolatedClass").getDeclaredMethod("shutdown", Consumer.class).invoke(null, shutdown); | |
| classLoader.loadClass("AutoShutdown$IsolatedClass") | |
| .getDeclaredMethod("shutdown", Consumer.class) | |
| .invoke(null, shutdown); |
|
|
||
| public static class IsolatedClass { | ||
|
|
||
| private static final ExecutorService executor = Executors.newSingleThreadExecutor(new IsolatedThreadFactory()); |
There was a problem hiding this comment.
| private static final ExecutorService executor = Executors.newSingleThreadExecutor(new IsolatedThreadFactory()); | |
| private static final ExecutorService executor = | |
| Executors.newSingleThreadExecutor(new IsolatedThreadFactory()); |
| @ParameterizedTest | ||
| @MethodSource("shutdownMethods") | ||
| void testShutdownUnlinksCleaner(Consumer<ExecutorService> shutdown) throws Exception { | ||
| ClassLoader classLoader = Utils.getTestClassPathURLClassLoader(ClassLoader.getPlatformClassLoader()); |
There was a problem hiding this comment.
| ClassLoader classLoader = Utils.getTestClassPathURLClassLoader(ClassLoader.getPlatformClassLoader()); | |
| ClassLoader classLoader = | |
| Utils.getTestClassPathURLClassLoader(ClassLoader.getPlatformClassLoader()); |
| } | ||
|
|
||
| private static Stream<Arguments> shutdownMethods() { | ||
| return Stream.<Consumer<ExecutorService>>of(e -> e.shutdown(), e -> e.shutdownNow()).map(Arguments::of); |
There was a problem hiding this comment.
| return Stream.<Consumer<ExecutorService>>of(e -> e.shutdown(), e -> e.shutdownNow()).map(Arguments::of); | |
| return Stream.<Consumer<ExecutorService>>of( | |
| e -> e.shutdown(), | |
| e -> e.shutdownNow() | |
| ).map(Arguments::of); |
Executors shutdown via `shutdownNow()` should have their cleanables cleaned to prevent a classloader leak. This can happen if a classloader exists that both references the wrapped executor and is referenced by the delegate executor.
chrisdennis
force-pushed
the
JDK-8362123
branch
from
ea197f4 to
eaec0b5
Compare
|
@viktorklang-ora @AlanBateman I believe I've covered all the requested changes. |
|
@chrisdennis Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information. |
|
Apologies for the force push, force of habit from my normal work. |
viktorklang-ora
left a comment
viktorklang-ora
left a comment
There was a problem hiding this comment.
Looks good, thanks for addressing this!
|
Apologies gentlemen, but do I need to do something to move this on? If I understand correctly it's just a |
|
Yes, you need to use "/integrate", and then one of us will sponsor. |
|
/integrate |
|
@chrisdennis |
|
/sponsor |
|
Going to push as commit d5a2079.
Your commit was automatically rebased without conflicts. |
openjdk
bot
removed
ready
|
@AlanBateman @chrisdennis Pushed as commit d5a2079. 💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored. |
|
/backport jdk25u |
|
@chrisdennis To use the |
3 participants
Executors shutdown via
shutdownNow()should have their cleanables cleaned to prevent a classloader leak. This can happen if a classloader exists that both references the wrapped executor and is referenced by the delegate executor.To quote @Martin-Buchholz:
Progress
Issue
Reviewers
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/26296/head:pull/26296$ git checkout pull/26296Update a local copy of the PR:
$ git checkout pull/26296$ git pull https://git.openjdk.org/jdk.git pull/26296/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 26296View PR using the GUI difftool:
$ git pr show -t 26296Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/26296.diff
Using Webrev
Link to Webrev Comment