-
Notifications
You must be signed in to change notification settings - Fork 439
RATIS-1603. TimeoutScheduler can have a huge amount of threads and cause OOM. #666
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
50 changes: 50 additions & 0 deletions
50
ratis-common/src/main/java/org/apache/ratis/util/TimeoutExecutor.java
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,50 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 org.apache.ratis.util; | ||
|
|
||
| import org.apache.ratis.util.function.CheckedRunnable; | ||
| import org.slf4j.Logger; | ||
|
|
||
| import java.util.function.Consumer; | ||
| import java.util.function.Supplier; | ||
|
|
||
| /** Execute timeout tasks. */ | ||
| public interface TimeoutExecutor { | ||
| int MAXIMUM_POOL_SIZE = 8; | ||
| static TimeoutExecutor getInstance() { | ||
| return TimeoutTimer.getInstance(); | ||
| } | ||
|
|
||
| /** @return the number of scheduled but not completed timeout tasks. */ | ||
| int getTaskCount(); | ||
|
|
||
| /** | ||
| * Schedule a timeout task. | ||
| * | ||
| * @param timeout the timeout value. | ||
| * @param task the task to run when timeout. | ||
| * @param errorHandler to handle the error, if there is any. | ||
| */ | ||
| <THROWABLE extends Throwable> void onTimeout( | ||
| TimeDuration timeout, CheckedRunnable<THROWABLE> task, Consumer<THROWABLE> errorHandler); | ||
|
|
||
| /** When timeout, run the task. Log the error, if there is any. */ | ||
| default void onTimeout(TimeDuration timeout, CheckedRunnable<?> task, Logger log, Supplier<String> errorMessage) { | ||
| onTimeout(timeout, task, t -> log.error(errorMessage.get(), t)); | ||
| } | ||
| } |
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
109 changes: 109 additions & 0 deletions
109
ratis-common/src/main/java/org/apache/ratis/util/TimeoutTimer.java
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,109 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 org.apache.ratis.util; | ||
|
|
||
| import org.apache.ratis.util.function.CheckedRunnable; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Timer; | ||
| import java.util.TimerTask; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
| import java.util.function.Consumer; | ||
| import java.util.function.Supplier; | ||
|
|
||
| public final class TimeoutTimer implements TimeoutExecutor { | ||
| public static final Logger LOG = LoggerFactory.getLogger(TimeoutTimer.class); | ||
|
|
||
| private static final Supplier<TimeoutTimer> INSTANCE = JavaUtils.memoize(() -> new TimeoutTimer(MAXIMUM_POOL_SIZE)); | ||
|
|
||
| public static TimeoutTimer getInstance() { | ||
| return INSTANCE.get(); | ||
| } | ||
|
|
||
| static class Task extends TimerTask { | ||
| private final int id; | ||
| private final Runnable runnable; | ||
|
|
||
| Task(int id, Runnable runnable) { | ||
| this.id = id; | ||
| this.runnable = LogUtils.newRunnable(LOG, runnable, this::toString); | ||
| } | ||
|
|
||
| @Override | ||
| public void run() { | ||
| LOG.debug("run {}", this); | ||
| runnable.run(); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "task #" + id; | ||
| } | ||
| } | ||
|
|
||
| /** The number of scheduled tasks. */ | ||
| private final AtomicInteger numTasks = new AtomicInteger(); | ||
| /** A unique ID for each task. */ | ||
| private final AtomicInteger taskId = new AtomicInteger(); | ||
|
|
||
| private final List<MemoizedSupplier<Timer>> timers; | ||
|
|
||
| private TimeoutTimer(int numTimers) { | ||
| final List<MemoizedSupplier<Timer>> list = new ArrayList<>(numTimers); | ||
| for(int i = 0; i < numTimers; i++) { | ||
| final String name = "timer" + i; | ||
| list.add(JavaUtils.memoize(() -> new Timer(name, true))); | ||
| } | ||
| this.timers = Collections.unmodifiableList(list); | ||
| } | ||
|
|
||
| @Override | ||
| public int getTaskCount() { | ||
| return numTasks.get(); | ||
| } | ||
|
|
||
| private Timer getTimer(int tid) { | ||
| return timers.get(Math.toIntExact(Integer.toUnsignedLong(tid) % timers.size())).get(); | ||
| } | ||
|
|
||
| private void schedule(TimeDuration timeout, Runnable toSchedule) { | ||
| final int tid = taskId.incrementAndGet(); | ||
| final int n = numTasks.incrementAndGet(); | ||
| LOG.debug("schedule a task #{} with timeout {}, numTasks={}", tid, timeout, n); | ||
| getTimer(n).schedule(new Task(tid, toSchedule), timeout.toLong(TimeUnit.MILLISECONDS)); | ||
| } | ||
|
|
||
| @Override | ||
| public <THROWABLE extends Throwable> void onTimeout( | ||
| TimeDuration timeout, CheckedRunnable<THROWABLE> task, Consumer<THROWABLE> errorHandler) { | ||
| schedule(timeout, () -> { | ||
| try { | ||
| task.run(); | ||
| } catch(Throwable t) { | ||
| errorHandler.accept(JavaUtils.cast(t)); | ||
| } finally { | ||
| numTasks.decrementAndGet(); | ||
| } | ||
| }); | ||
| } | ||
| } |
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
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
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
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.
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 we remove this class, it will cause thread overflow and should not be called again
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.
Let's keep it for a while. Not sure if we may find some problem in the new TimeoutTimer in the future. It may be useful then.