remove finalizer and use LazyCleaner implementation from pgjdbc #1625
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| /* changes were made to move it into the software.amazon.jdbc.util package | ||
| * | ||
| * Copyright 2022 Juan Lopes | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package software.amazon.jdbc.util; | ||
|
|
||
| import java.lang.ref.PhantomReference; | ||
| import java.lang.ref.ReferenceQueue; | ||
| import java.time.Duration; | ||
| import java.util.concurrent.ThreadFactory; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import org.checkerframework.checker.nullness.qual.Nullable; | ||
|
|
||
| public class LazyCleaner { | ||
| private static final Logger LOGGER = Logger.getLogger(LazyCleaner.class.getName()); | ||
| private static final LazyCleaner instance = | ||
| new LazyCleaner( | ||
| Duration.ofMillis(Long.getLong("aws.jdbc.cleanup.thread.ttl", 30000)), | ||
| "AWS-JDBC-Cleaner" | ||
| ); | ||
|
|
||
| public interface Cleanable<T extends Throwable> { | ||
| void clean() throws T; | ||
| } | ||
|
|
||
| public interface CleaningAction<T extends Throwable> { | ||
| void onClean(boolean leak) throws T; | ||
| } | ||
|
|
||
| private final ReferenceQueue<Object> queue = new ReferenceQueue<>(); | ||
| private final long threadTtl; | ||
| private final ThreadFactory threadFactory; | ||
| private boolean threadRunning; | ||
| private int watchedCount; | ||
| private @Nullable Node<?> first; | ||
|
|
||
| public static LazyCleaner getInstance() { | ||
| return instance; | ||
| } | ||
|
|
||
| public LazyCleaner(Duration threadTtl, final String threadName) { | ||
| this(threadTtl, runnable -> { | ||
| Thread thread = new Thread(runnable, threadName); | ||
| thread.setDaemon(true); | ||
| return thread; | ||
| }); | ||
| } | ||
|
|
||
| private LazyCleaner(Duration threadTtl, ThreadFactory threadFactory) { | ||
| this.threadTtl = threadTtl.toMillis(); | ||
| this.threadFactory = threadFactory; | ||
| } | ||
|
|
||
| public <T extends Throwable> Cleanable<T> register(Object obj, CleaningAction<T> action) { | ||
| return add(new Node<T>(obj, action)); | ||
| } | ||
|
|
||
| public synchronized int getWatchedCount() { | ||
| return watchedCount; | ||
| } | ||
|
|
||
| public synchronized boolean isThreadRunning() { | ||
| return threadRunning; | ||
| } | ||
|
|
||
| private synchronized boolean checkEmpty() { | ||
| if (first == null) { | ||
| threadRunning = false; | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private synchronized <T extends Throwable> Node<T> add(Node<T> node) { | ||
| if (first != null) { | ||
| node.next = first; | ||
| first.prev = node; | ||
| } | ||
| first = node; | ||
| watchedCount++; | ||
|
|
||
| if (!threadRunning) { | ||
| threadRunning = startThread(); | ||
| } | ||
| return node; | ||
| } | ||
|
|
||
| private boolean startThread() { | ||
| Thread thread = threadFactory.newThread(new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| while (true) { | ||
| try { | ||
| Thread.currentThread().setContextClassLoader(null); | ||
| Thread.currentThread().setUncaughtExceptionHandler(null); | ||
| Node<?> ref = (Node<?>) queue.remove(threadTtl); | ||
| if (ref == null) { | ||
| if (checkEmpty()) { | ||
| break; | ||
| } | ||
| continue; | ||
| } | ||
| try { | ||
| ref.onClean(true); | ||
| } catch (Throwable e) { | ||
| if (e instanceof InterruptedException) { | ||
| LOGGER.log(Level.WARNING, "Unexpected interrupt while executing onClean", e); | ||
| throw e; | ||
| } | ||
| LOGGER.log(Level.WARNING, "Unexpected exception while executing onClean", e); | ||
| } | ||
| } catch (InterruptedException e) { | ||
| if (LazyCleaner.this.checkEmpty()) { | ||
| LOGGER.log( | ||
| Level.FINE, | ||
| "Cleanup queue is empty, and got interrupt, will terminate the cleanup thread" | ||
| ); | ||
| break; | ||
| } | ||
| LOGGER.log(Level.FINE, "Ignoring interrupt since the cleanup queue is non-empty"); | ||
| } catch (Throwable e) { | ||
| LOGGER.log(Level.WARNING, "Unexpected exception in cleaner thread main loop", e); | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| if (thread != null) { | ||
| thread.start(); | ||
| return true; | ||
| } | ||
| LOGGER.log(Level.WARNING, "Unable to create cleanup thread"); | ||
| return false; | ||
| } | ||
|
|
||
| private synchronized boolean remove(Node<?> node) { | ||
| if (node.next == node) { | ||
| return false; | ||
| } | ||
|
|
||
| if (first == node) { | ||
| first = node.next; | ||
| } | ||
| if (node.next != null) { | ||
| node.next.prev = node.prev; | ||
| } | ||
| if (node.prev != null) { | ||
| node.prev.next = node.next; | ||
| } | ||
|
|
||
| node.next = node; | ||
| node.prev = node; | ||
|
|
||
| watchedCount--; | ||
| return true; | ||
| } | ||
|
|
||
| private class Node<T extends Throwable> extends PhantomReference<Object> implements Cleanable<T>, | ||
| CleaningAction<T> { | ||
| private final @Nullable CleaningAction<T> action; | ||
| private @Nullable Node<?> prev; | ||
| private @Nullable Node<?> next; | ||
|
|
||
| Node(Object referent, CleaningAction<T> action) { | ||
| super(referent, queue); | ||
| this.action = action; | ||
| } | ||
|
|
||
| @Override | ||
| public void clean() throws T { | ||
| onClean(false); | ||
| } | ||
|
|
||
| @Override | ||
| public void onClean(boolean leak) throws T { | ||
| if (!remove(this)) { | ||
| return; | ||
| } | ||
| if (action != null) { | ||
| action.onClean(leak); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the thread be a daemon thread?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually we do not use a daemon thread in pgjdbc