From 21b36d7313ff9f02c93f85964ba682e8bc5dd148 Mon Sep 17 00:00:00 2001 From: Bjørn Christian Seime Date: Mon, 21 Sep 2020 16:11:30 +0200 Subject: Make ContainerThreadPool an interface --- .../testutil/HandlersConfigurerTestWrapper.java | 19 +-- .../container/handler/ThreadPoolProvider.java | 5 +- .../handler/threadpool/ContainerThreadPool.java | 84 +---------- .../threadpool/DefaultContainerThreadpool.java | 94 ++++++++++++ .../threadpool/ContainerThreadPoolTest.java | 165 --------------------- .../threadpool/DefaultContainerThreadPoolTest.java | 165 +++++++++++++++++++++ 6 files changed, 273 insertions(+), 259 deletions(-) create mode 100644 container-core/src/main/java/com/yahoo/container/handler/threadpool/DefaultContainerThreadpool.java delete mode 100644 container-core/src/test/java/com/yahoo/container/handler/threadpool/ContainerThreadPoolTest.java create mode 100644 container-core/src/test/java/com/yahoo/container/handler/threadpool/DefaultContainerThreadPoolTest.java (limited to 'container-core') diff --git a/container-core/src/main/java/com/yahoo/container/core/config/testutil/HandlersConfigurerTestWrapper.java b/container-core/src/main/java/com/yahoo/container/core/config/testutil/HandlersConfigurerTestWrapper.java index cb177691fa3..2ae33347408 100644 --- a/container-core/src/main/java/com/yahoo/container/core/config/testutil/HandlersConfigurerTestWrapper.java +++ b/container-core/src/main/java/com/yahoo/container/core/config/testutil/HandlersConfigurerTestWrapper.java @@ -13,8 +13,6 @@ import com.yahoo.container.core.config.HandlersConfigurerDi; import com.yahoo.container.di.CloudSubscriberFactory; import com.yahoo.container.di.ComponentDeconstructor; import com.yahoo.container.handler.threadpool.ContainerThreadPool; -import com.yahoo.container.handler.threadpool.ContainerThreadpoolConfig; -import com.yahoo.jdisc.Metric; import com.yahoo.jdisc.handler.RequestHandler; import com.yahoo.language.Linguistics; import com.yahoo.language.simple.SimpleLinguistics; @@ -22,9 +20,10 @@ import com.yahoo.language.simple.SimpleLinguistics; import java.io.File; import java.io.IOException; import java.util.LinkedHashSet; -import java.util.Map; import java.util.Random; import java.util.Set; +import java.util.concurrent.Executor; +import java.util.concurrent.Executors; /** * Class for testing HandlersConfigurer. @@ -138,16 +137,14 @@ public class HandlersConfigurerTestWrapper { protected void configure() { // Needed by e.g. SearchHandler bind(Linguistics.class).to(SimpleLinguistics.class).in(Scopes.SINGLETON); - bind(ContainerThreadPool.class).toInstance( - new ContainerThreadPool( - new ContainerThreadpoolConfig(new ContainerThreadpoolConfig.Builder()), - new Metric() { - @Override public void set(String key, Number val, Context ctx) {} - @Override public void add(String key, Number val, Context ctx) {} - @Override public Context createContext(Map properties) { return null;} - })); + bind(ContainerThreadPool.class).to(SimpleContainerThreadpool.class); } }); } + private static class SimpleContainerThreadpool implements ContainerThreadPool { + private final Executor executor = Executors.newCachedThreadPool(); + @Override public Executor executor() { return executor; } + } + } diff --git a/container-core/src/main/java/com/yahoo/container/handler/ThreadPoolProvider.java b/container-core/src/main/java/com/yahoo/container/handler/ThreadPoolProvider.java index dc594903f21..ae313b1b04c 100644 --- a/container-core/src/main/java/com/yahoo/container/handler/ThreadPoolProvider.java +++ b/container-core/src/main/java/com/yahoo/container/handler/ThreadPoolProvider.java @@ -6,6 +6,7 @@ import com.yahoo.component.AbstractComponent; import com.yahoo.container.di.componentgraph.Provider; import com.yahoo.container.handler.threadpool.ContainerThreadPool; import com.yahoo.container.handler.threadpool.ContainerThreadpoolConfig; +import com.yahoo.container.handler.threadpool.DefaultContainerThreadpool; import com.yahoo.container.protect.ProcessTerminator; import com.yahoo.jdisc.Metric; @@ -25,11 +26,11 @@ public class ThreadPoolProvider extends AbstractComponent implements Provider createQ(int queueSize, int maxThreads) { - return (queueSize == 0) - ? new SynchronousQueue<>(false) - : (queueSize < 0) - ? new ArrayBlockingQueue<>(maxThreads*4) - : new ArrayBlockingQueue<>(queueSize); - } +public interface ContainerThreadPool extends AutoCloseable { - private static int computeMaximumThreadPoolSize(int maxNumThreads) { - return (maxNumThreads <= 0) - ? Runtime.getRuntime().availableProcessors() * 4 - : maxNumThreads; - } + Executor executor(); - private static int computeCoreThreadPoolSize(int corePoolSize, int maxNumThreads) { - return Math.min( - corePoolSize <= 0 ? Runtime.getRuntime().availableProcessors() * 2 : corePoolSize, - maxNumThreads); - } + default void close() {} } diff --git a/container-core/src/main/java/com/yahoo/container/handler/threadpool/DefaultContainerThreadpool.java b/container-core/src/main/java/com/yahoo/container/handler/threadpool/DefaultContainerThreadpool.java new file mode 100644 index 00000000000..4d8c245a25a --- /dev/null +++ b/container-core/src/main/java/com/yahoo/container/handler/threadpool/DefaultContainerThreadpool.java @@ -0,0 +1,94 @@ +// Copyright Verizon Media. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.container.handler.threadpool; + +import com.google.inject.Inject; +import com.yahoo.component.AbstractComponent; +import com.yahoo.concurrent.ThreadFactoryFactory; +import com.yahoo.container.protect.ProcessTerminator; +import com.yahoo.jdisc.Metric; + +import java.util.concurrent.ArrayBlockingQueue; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.Executor; +import java.util.concurrent.SynchronousQueue; +import java.util.concurrent.TimeUnit; + +/** + * Default implementation of {@link DefaultContainerThreadpool}. + * + * @author Steinar Knutsen + * @author baldersheim + * @author bratseth + * @author bjorncs + */ +public class DefaultContainerThreadpool extends AbstractComponent implements AutoCloseable, ContainerThreadPool { + + private final ExecutorServiceWrapper threadpool; + + @Inject + public DefaultContainerThreadpool(ContainerThreadpoolConfig config, Metric metric) { + this(config, metric, new ProcessTerminator()); + } + + public DefaultContainerThreadpool(ContainerThreadpoolConfig config, Metric metric, ProcessTerminator processTerminator) { + ThreadPoolMetric threadPoolMetric = new ThreadPoolMetric(metric, config.name()); + int maxNumThreads = computeMaximumThreadPoolSize(config.maxThreads()); + int coreNumThreads = computeCoreThreadPoolSize(config.minThreads(), maxNumThreads); + WorkerCompletionTimingThreadPoolExecutor executor = + new WorkerCompletionTimingThreadPoolExecutor(coreNumThreads, maxNumThreads, + (int)config.keepAliveTime() * 1000, TimeUnit.MILLISECONDS, + createQ(config.queueSize(), maxNumThreads), + ThreadFactoryFactory.getThreadFactory(config.name()), + threadPoolMetric); + // Prestart needed, if not all threads will be created by the fist N tasks and hence they might also + // get the dreaded thread locals initialized even if they will never run. + // That counters what we we want to achieve with the Q that will prefer thread locality. + executor.prestartAllCoreThreads(); + threadpool = new ExecutorServiceWrapper(executor, threadPoolMetric, processTerminator, + config.maxThreadExecutionTimeSeconds() * 1000L); + } + + @Override public Executor executor() { return threadpool; } + @Override public void close() { closeInternal(); } + @Override public void deconstruct() { closeInternal(); super.deconstruct(); } + + /** + * Shutdown the thread pool, give a grace period of 1 second before forcibly + * shutting down all worker threads. + */ + private void closeInternal() { + boolean terminated; + + threadpool.shutdown(); + try { + terminated = threadpool.awaitTermination(1, TimeUnit.SECONDS); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + return; + } + if (!terminated) { + threadpool.shutdownNow(); + } + } + + private static BlockingQueue createQ(int queueSize, int maxThreads) { + return (queueSize == 0) + ? new SynchronousQueue<>(false) + : (queueSize < 0) + ? new ArrayBlockingQueue<>(maxThreads*4) + : new ArrayBlockingQueue<>(queueSize); + } + + private static int computeMaximumThreadPoolSize(int maxNumThreads) { + return (maxNumThreads <= 0) + ? Runtime.getRuntime().availableProcessors() * 4 + : maxNumThreads; + } + + private static int computeCoreThreadPoolSize(int corePoolSize, int maxNumThreads) { + return Math.min( + corePoolSize <= 0 ? Runtime.getRuntime().availableProcessors() * 2 : corePoolSize, + maxNumThreads); + } + +} diff --git a/container-core/src/test/java/com/yahoo/container/handler/threadpool/ContainerThreadPoolTest.java b/container-core/src/test/java/com/yahoo/container/handler/threadpool/ContainerThreadPoolTest.java deleted file mode 100644 index 02e791099ed..00000000000 --- a/container-core/src/test/java/com/yahoo/container/handler/threadpool/ContainerThreadPoolTest.java +++ /dev/null @@ -1,165 +0,0 @@ -// Copyright Verizon Media. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -package com.yahoo.container.handler.threadpool; - -import com.yahoo.collections.Tuple2; -import com.yahoo.concurrent.Receiver; -import com.yahoo.container.protect.ProcessTerminator; -import com.yahoo.jdisc.Metric; -import org.junit.Ignore; -import org.junit.Test; -import org.mockito.Mockito; - -import java.util.concurrent.Executor; -import java.util.concurrent.RejectedExecutionException; -import java.util.concurrent.ThreadPoolExecutor; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.fail; - -/** - * @author Steinar Knutsen - * @author bjorncs - */ -public class ContainerThreadPoolTest { - @Test - public final void testThreadPool() throws InterruptedException { - ContainerThreadpoolConfig config = new ContainerThreadpoolConfig(new ContainerThreadpoolConfig.Builder().maxThreads(1)); - ContainerThreadPool threadPool = new ContainerThreadPool(config, Mockito.mock(Metric.class)); - Executor exec = threadPool.executor(); - Tuple2 reply; - FlipIt command = new FlipIt(); - for (boolean done = false; !done;) { - try { - exec.execute(command); - done = true; - } catch (RejectedExecutionException e) { - // just try again - } - } - reply = command.didItRun.get(5 * 60 * 1000); - if (reply.first != Receiver.MessageState.VALID) { - fail("Executor task probably timed out, five minutes should be enough to flip a boolean."); - } - if (reply.second != Boolean.TRUE) { - fail("Executor task seemed to run, but did not get correct value."); - } - threadPool.close(); - command = new FlipIt(); - try { - exec.execute(command); - } catch (final RejectedExecutionException e) { - // this is what should happen - return; - } - fail("Pool did not reject tasks after shutdown."); - } - - private ThreadPoolExecutor createPool(int maxThreads, int queueSize) { - ContainerThreadpoolConfig config = new ContainerThreadpoolConfig(new ContainerThreadpoolConfig.Builder().maxThreads(maxThreads).queueSize(queueSize)); - ContainerThreadPool threadPool = new ContainerThreadPool(config, Mockito.mock(Metric.class)); - ExecutorServiceWrapper wrapper = (ExecutorServiceWrapper) threadPool.executor(); - WorkerCompletionTimingThreadPoolExecutor executor = (WorkerCompletionTimingThreadPoolExecutor)wrapper.delegate(); - return executor; - } - - @Test - public void testThatThreadPoolSizeFollowsConfig() { - ThreadPoolExecutor executor = createPool(3, 9); - assertEquals(3, executor.getMaximumPoolSize()); - assertEquals(9, executor.getQueue().remainingCapacity()); - } - @Test - public void testThatThreadPoolSizeAutoDetected() { - ThreadPoolExecutor executor = createPool(0, 0); - assertEquals(Runtime.getRuntime().availableProcessors()*4, executor.getMaximumPoolSize()); - assertEquals(0, executor.getQueue().remainingCapacity()); - } - @Test - public void testThatQueueSizeAutoDetected() { - ThreadPoolExecutor executor = createPool(3, -1); - assertEquals(3, executor.getMaximumPoolSize()); - assertEquals(executor.getMaximumPoolSize()*4, executor.getQueue().remainingCapacity()); - } - @Test - public void testThatThreadPoolSizeAndQueueSizeAutoDetected() { - ThreadPoolExecutor executor = createPool(0, -1); - assertEquals(Runtime.getRuntime().availableProcessors()*4, executor.getMaximumPoolSize()); - assertEquals(executor.getMaximumPoolSize()*4, executor.getQueue().remainingCapacity()); - } - - private class FlipIt implements Runnable { - public final Receiver didItRun = new Receiver<>(); - - @Override - public void run() { - didItRun.put(Boolean.TRUE); - } - } - - @Test - @Ignore // Ignored because it depends on the system time and so is unstable on factory - public void testThreadPoolTerminationOnBreakdown() throws InterruptedException { - ContainerThreadpoolConfig config = new ContainerThreadpoolConfig( - new ContainerThreadpoolConfig.Builder() - .maxThreads(2) - .maxThreadExecutionTimeSeconds(1)); - MockProcessTerminator terminator = new MockProcessTerminator(); - ContainerThreadPool threadPool = new ContainerThreadPool(config, Mockito.mock(Metric.class), terminator); - - // No dying when threads hang shorter than max thread execution time - threadPool.executor().execute(new Hang(500)); - threadPool.executor().execute(new Hang(500)); - assertEquals(0, terminator.dieRequests); - assertRejected(threadPool, new Hang(500)); // no more threads - assertEquals(0, terminator.dieRequests); // ... but not for long enough yet - try { Thread.sleep(1500); } catch (InterruptedException e) {} - threadPool.executor().execute(new Hang(1)); - assertEquals(0, terminator.dieRequests); - try { Thread.sleep(50); } catch (InterruptedException e) {} // Make sure both threads are available - - // Dying when hanging both thread pool threads for longer than max thread execution time - threadPool.executor().execute(new Hang(2000)); - threadPool.executor().execute(new Hang(2000)); - assertEquals(0, terminator.dieRequests); - assertRejected(threadPool, new Hang(2000)); // no more threads - assertEquals(0, terminator.dieRequests); // ... but not for long enough yet - try { Thread.sleep(1500); } catch (InterruptedException e) {} - assertRejected(threadPool, new Hang(2000)); // no more threads - assertEquals(1, terminator.dieRequests); // ... for longer than maxThreadExecutionTime - } - - private void assertRejected(ContainerThreadPool threadPool, Runnable task) { - try { - threadPool.executor().execute(task); - fail("Expected execution rejected"); - } catch (final RejectedExecutionException expected) { - } - } - - private class Hang implements Runnable { - - private final long hangMillis; - - public Hang(int hangMillis) { - this.hangMillis = hangMillis; - } - - @Override - public void run() { - try { Thread.sleep(hangMillis); } catch (InterruptedException e) {} - } - - } - - private static class MockProcessTerminator extends ProcessTerminator { - - public volatile int dieRequests = 0; - - @Override - public void logAndDie(String message, boolean dumpThreads) { - dieRequests++; - } - - } - -} \ No newline at end of file diff --git a/container-core/src/test/java/com/yahoo/container/handler/threadpool/DefaultContainerThreadPoolTest.java b/container-core/src/test/java/com/yahoo/container/handler/threadpool/DefaultContainerThreadPoolTest.java new file mode 100644 index 00000000000..8b1ed12c796 --- /dev/null +++ b/container-core/src/test/java/com/yahoo/container/handler/threadpool/DefaultContainerThreadPoolTest.java @@ -0,0 +1,165 @@ +// Copyright Verizon Media. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.container.handler.threadpool; + +import com.yahoo.collections.Tuple2; +import com.yahoo.concurrent.Receiver; +import com.yahoo.container.protect.ProcessTerminator; +import com.yahoo.jdisc.Metric; +import org.junit.Ignore; +import org.junit.Test; +import org.mockito.Mockito; + +import java.util.concurrent.Executor; +import java.util.concurrent.RejectedExecutionException; +import java.util.concurrent.ThreadPoolExecutor; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.fail; + +/** + * @author Steinar Knutsen + * @author bjorncs + */ +public class DefaultContainerThreadPoolTest { + @Test + public final void testThreadPool() throws InterruptedException { + ContainerThreadpoolConfig config = new ContainerThreadpoolConfig(new ContainerThreadpoolConfig.Builder().maxThreads(1)); + ContainerThreadPool threadPool = new DefaultContainerThreadpool(config, Mockito.mock(Metric.class)); + Executor exec = threadPool.executor(); + Tuple2 reply; + FlipIt command = new FlipIt(); + for (boolean done = false; !done;) { + try { + exec.execute(command); + done = true; + } catch (RejectedExecutionException e) { + // just try again + } + } + reply = command.didItRun.get(5 * 60 * 1000); + if (reply.first != Receiver.MessageState.VALID) { + fail("Executor task probably timed out, five minutes should be enough to flip a boolean."); + } + if (reply.second != Boolean.TRUE) { + fail("Executor task seemed to run, but did not get correct value."); + } + threadPool.close(); + command = new FlipIt(); + try { + exec.execute(command); + } catch (final RejectedExecutionException e) { + // this is what should happen + return; + } + fail("Pool did not reject tasks after shutdown."); + } + + private ThreadPoolExecutor createPool(int maxThreads, int queueSize) { + ContainerThreadpoolConfig config = new ContainerThreadpoolConfig(new ContainerThreadpoolConfig.Builder().maxThreads(maxThreads).queueSize(queueSize)); + ContainerThreadPool threadPool = new DefaultContainerThreadpool(config, Mockito.mock(Metric.class)); + ExecutorServiceWrapper wrapper = (ExecutorServiceWrapper) threadPool.executor(); + WorkerCompletionTimingThreadPoolExecutor executor = (WorkerCompletionTimingThreadPoolExecutor)wrapper.delegate(); + return executor; + } + + @Test + public void testThatThreadPoolSizeFollowsConfig() { + ThreadPoolExecutor executor = createPool(3, 9); + assertEquals(3, executor.getMaximumPoolSize()); + assertEquals(9, executor.getQueue().remainingCapacity()); + } + @Test + public void testThatThreadPoolSizeAutoDetected() { + ThreadPoolExecutor executor = createPool(0, 0); + assertEquals(Runtime.getRuntime().availableProcessors()*4, executor.getMaximumPoolSize()); + assertEquals(0, executor.getQueue().remainingCapacity()); + } + @Test + public void testThatQueueSizeAutoDetected() { + ThreadPoolExecutor executor = createPool(3, -1); + assertEquals(3, executor.getMaximumPoolSize()); + assertEquals(executor.getMaximumPoolSize()*4, executor.getQueue().remainingCapacity()); + } + @Test + public void testThatThreadPoolSizeAndQueueSizeAutoDetected() { + ThreadPoolExecutor executor = createPool(0, -1); + assertEquals(Runtime.getRuntime().availableProcessors()*4, executor.getMaximumPoolSize()); + assertEquals(executor.getMaximumPoolSize()*4, executor.getQueue().remainingCapacity()); + } + + private class FlipIt implements Runnable { + public final Receiver didItRun = new Receiver<>(); + + @Override + public void run() { + didItRun.put(Boolean.TRUE); + } + } + + @Test + @Ignore // Ignored because it depends on the system time and so is unstable on factory + public void testThreadPoolTerminationOnBreakdown() throws InterruptedException { + ContainerThreadpoolConfig config = new ContainerThreadpoolConfig( + new ContainerThreadpoolConfig.Builder() + .maxThreads(2) + .maxThreadExecutionTimeSeconds(1)); + MockProcessTerminator terminator = new MockProcessTerminator(); + ContainerThreadPool threadPool = new DefaultContainerThreadpool(config, Mockito.mock(Metric.class), terminator); + + // No dying when threads hang shorter than max thread execution time + threadPool.executor().execute(new Hang(500)); + threadPool.executor().execute(new Hang(500)); + assertEquals(0, terminator.dieRequests); + assertRejected(threadPool, new Hang(500)); // no more threads + assertEquals(0, terminator.dieRequests); // ... but not for long enough yet + try { Thread.sleep(1500); } catch (InterruptedException e) {} + threadPool.executor().execute(new Hang(1)); + assertEquals(0, terminator.dieRequests); + try { Thread.sleep(50); } catch (InterruptedException e) {} // Make sure both threads are available + + // Dying when hanging both thread pool threads for longer than max thread execution time + threadPool.executor().execute(new Hang(2000)); + threadPool.executor().execute(new Hang(2000)); + assertEquals(0, terminator.dieRequests); + assertRejected(threadPool, new Hang(2000)); // no more threads + assertEquals(0, terminator.dieRequests); // ... but not for long enough yet + try { Thread.sleep(1500); } catch (InterruptedException e) {} + assertRejected(threadPool, new Hang(2000)); // no more threads + assertEquals(1, terminator.dieRequests); // ... for longer than maxThreadExecutionTime + } + + private void assertRejected(ContainerThreadPool threadPool, Runnable task) { + try { + threadPool.executor().execute(task); + fail("Expected execution rejected"); + } catch (final RejectedExecutionException expected) { + } + } + + private class Hang implements Runnable { + + private final long hangMillis; + + public Hang(int hangMillis) { + this.hangMillis = hangMillis; + } + + @Override + public void run() { + try { Thread.sleep(hangMillis); } catch (InterruptedException e) {} + } + + } + + private static class MockProcessTerminator extends ProcessTerminator { + + public volatile int dieRequests = 0; + + @Override + public void logAndDie(String message, boolean dumpThreads) { + dieRequests++; + } + + } + +} \ No newline at end of file -- cgit v1.2.3