Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onlab.util; |
| 18 | |
Murat Parlakisik | dc17f7b | 2016-01-26 12:08:35 -0800 | [diff] [blame] | 19 | import org.onlab.metrics.MetricsService; |
| 20 | |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 21 | import java.util.Timer; |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 22 | import java.util.concurrent.ExecutorService; |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 23 | |
Thomas Vachuska | b0317c6 | 2015-04-08 23:58:58 -0700 | [diff] [blame] | 24 | import static com.google.common.base.Preconditions.checkArgument; |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 25 | import static java.util.concurrent.Executors.newFixedThreadPool; |
| 26 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 27 | import static org.onlab.util.Tools.groupedThreads; |
| 28 | |
| 29 | /** |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 30 | * Utility for managing a set of shared execution resources, such as a timer, |
| 31 | * single thread executor and thread pool executor for use by various parts of |
| 32 | * the platform or by applications. |
| 33 | * <p> |
| 34 | * Whenever possible, use of these shared resources is encouraged over creating |
| 35 | * separate ones. |
| 36 | * </p> |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 37 | */ |
| 38 | public final class SharedExecutors { |
| 39 | |
Thomas Vachuska | b0317c6 | 2015-04-08 23:58:58 -0700 | [diff] [blame] | 40 | public static final int DEFAULT_POOL_SIZE = 30; |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 41 | |
Ray Milkey | 9bf3b2a8 | 2019-03-14 13:47:31 -0700 | [diff] [blame^] | 42 | private static SharedExecutorService singleThreadExecutor; |
| 43 | private static SharedExecutorService poolThreadExecutor; |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 44 | |
Ray Milkey | 9bf3b2a8 | 2019-03-14 13:47:31 -0700 | [diff] [blame^] | 45 | private static SharedTimer sharedTimer; |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 46 | |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 47 | // Ban public construction |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 48 | private SharedExecutors() { |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 49 | } |
| 50 | |
| 51 | /** |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 52 | * Returns the shared single thread executor. |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 53 | * |
| 54 | * @return shared single thread executor |
| 55 | */ |
| 56 | public static ExecutorService getSingleThreadExecutor() { |
Ray Milkey | 9bf3b2a8 | 2019-03-14 13:47:31 -0700 | [diff] [blame^] | 57 | setup(); |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 58 | return singleThreadExecutor; |
| 59 | } |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 60 | |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 61 | /** |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 62 | * Returns the shared thread pool executor. |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 63 | * |
| 64 | * @return shared executor pool |
| 65 | */ |
| 66 | public static ExecutorService getPoolThreadExecutor() { |
Ray Milkey | 9bf3b2a8 | 2019-03-14 13:47:31 -0700 | [diff] [blame^] | 67 | setup(); |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 68 | return poolThreadExecutor; |
| 69 | } |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 70 | |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 71 | /** |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 72 | * Returns the shared timer. |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 73 | * |
| 74 | * @return shared timer |
| 75 | */ |
Thomas Vachuska | 945e7b0 | 2015-03-18 14:23:53 -0700 | [diff] [blame] | 76 | public static Timer getTimer() { |
Ray Milkey | 9bf3b2a8 | 2019-03-14 13:47:31 -0700 | [diff] [blame^] | 77 | setup(); |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 78 | return sharedTimer; |
| 79 | } |
| 80 | |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 81 | /** |
| 82 | * Sets the shared thread pool size. |
Thomas Vachuska | b0317c6 | 2015-04-08 23:58:58 -0700 | [diff] [blame] | 83 | * |
| 84 | * @param poolSize new pool size |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 85 | */ |
| 86 | public static void setPoolSize(int poolSize) { |
Thomas Vachuska | b0317c6 | 2015-04-08 23:58:58 -0700 | [diff] [blame] | 87 | checkArgument(poolSize > 0, "Shared pool size size must be greater than 0"); |
| 88 | poolThreadExecutor.setBackingExecutor( |
| 89 | newFixedThreadPool(poolSize, groupedThreads("onos/shared", |
| 90 | "onos-pool-executor-%d"))); |
| 91 | } |
| 92 | |
Thomas Vachuska | 0666f15 | 2016-08-05 12:03:54 -0700 | [diff] [blame] | 93 | /** |
| 94 | * Enables or disables calculation of the pool performance metrics. If |
| 95 | * the metrics service is not null metric collection will be enabled; |
| 96 | * otherwise it will be disabled. |
| 97 | * |
| 98 | * @param metricsService optional metric service |
| 99 | */ |
| 100 | public static void setMetricsService(MetricsService metricsService) { |
| 101 | poolThreadExecutor.setMetricsService(metricsService); |
Murat Parlakisik | dc17f7b | 2016-01-26 12:08:35 -0800 | [diff] [blame] | 102 | } |
| 103 | |
Thomas Vachuska | b0317c6 | 2015-04-08 23:58:58 -0700 | [diff] [blame] | 104 | /** |
| 105 | * Shuts down all shared timers and executors and therefore should be |
| 106 | * called only by the framework. |
| 107 | */ |
| 108 | public static void shutdown() { |
| 109 | sharedTimer.shutdown(); |
| 110 | singleThreadExecutor.backingExecutor().shutdown(); |
| 111 | poolThreadExecutor.backingExecutor().shutdown(); |
Ray Milkey | 9bf3b2a8 | 2019-03-14 13:47:31 -0700 | [diff] [blame^] | 112 | sharedTimer = null; |
| 113 | singleThreadExecutor = null; |
| 114 | poolThreadExecutor = null; |
| 115 | } |
| 116 | |
| 117 | private static synchronized void setup() { |
| 118 | if (sharedTimer == null) { |
| 119 | sharedTimer = new SharedTimer(); |
| 120 | |
| 121 | singleThreadExecutor = |
| 122 | new SharedExecutorService( |
| 123 | newSingleThreadExecutor(groupedThreads("onos/shared", |
| 124 | "onos-single-executor"))); |
| 125 | |
| 126 | poolThreadExecutor = |
| 127 | new SharedExecutorService( |
| 128 | newFixedThreadPool(DEFAULT_POOL_SIZE, |
| 129 | groupedThreads("onos/shared", |
| 130 | "onos-pool-executor-%d"))); |
| 131 | } |
Thomas Vachuska | b0317c6 | 2015-04-08 23:58:58 -0700 | [diff] [blame] | 132 | } |
| 133 | |
| 134 | // Timer extension which does not allow outside cancel method. |
| 135 | private static class SharedTimer extends Timer { |
| 136 | |
| 137 | public SharedTimer() { |
| 138 | super("onos-shared-timer"); |
| 139 | } |
| 140 | |
| 141 | @Override |
| 142 | public void cancel() { |
| 143 | throw new UnsupportedOperationException("Cancel of shared timer is not allowed"); |
| 144 | } |
| 145 | |
| 146 | private void shutdown() { |
| 147 | super.cancel(); |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 148 | } |
| 149 | } |
Thomas Vachuska | b0317c6 | 2015-04-08 23:58:58 -0700 | [diff] [blame] | 150 | |
Murat Parlakisik | af1042d | 2015-03-14 01:08:29 -0700 | [diff] [blame] | 151 | } |