Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 Open Networking Laboratory |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.core.impl; |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 17 | |
| 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 20 | import org.apache.felix.scr.annotations.Deactivate; |
| 21 | import org.apache.felix.scr.annotations.Modified; |
| 22 | import org.apache.felix.scr.annotations.Property; |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 25 | import org.apache.felix.scr.annotations.Service; |
Murat Parlakisik | dc17f7b | 2016-01-26 12:08:35 -0800 | [diff] [blame] | 26 | import org.onlab.metrics.MetricsService; |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 27 | import org.onlab.util.SharedExecutors; |
Thomas Vachuska | c65dd71 | 2015-11-04 17:19:10 -0800 | [diff] [blame] | 28 | import org.onosproject.app.ApplicationService; |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 29 | import org.onosproject.cfg.ComponentConfigService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 30 | import org.onosproject.core.ApplicationId; |
| 31 | import org.onosproject.core.ApplicationIdStore; |
| 32 | import org.onosproject.core.CoreService; |
| 33 | import org.onosproject.core.IdBlockStore; |
| 34 | import org.onosproject.core.IdGenerator; |
| 35 | import org.onosproject.core.Version; |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 36 | import org.onosproject.event.EventDeliveryService; |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 37 | import org.osgi.service.component.ComponentContext; |
Thomas Vachuska | 8dc1a69 | 2015-03-31 01:01:37 -0700 | [diff] [blame] | 38 | import org.slf4j.Logger; |
| 39 | import org.slf4j.LoggerFactory; |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 40 | |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 41 | import java.io.File; |
HIGUCHI Yuta | 3b3bd1e | 2015-09-22 16:39:33 -0700 | [diff] [blame] | 42 | import java.io.IOException; |
| 43 | import java.nio.file.Files; |
| 44 | import java.nio.file.Path; |
| 45 | import java.nio.file.Paths; |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 46 | import java.util.Dictionary; |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 47 | import java.util.List; |
| 48 | import java.util.Set; |
| 49 | |
| 50 | import static com.google.common.base.Preconditions.checkNotNull; |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 51 | import static com.google.common.base.Strings.isNullOrEmpty; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 52 | import static org.onosproject.security.AppGuard.checkPermission; |
Thomas Vachuska | c65dd71 | 2015-11-04 17:19:10 -0800 | [diff] [blame] | 53 | import static org.onosproject.security.AppPermission.Type.APP_READ; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 54 | |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 55 | |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 56 | |
| 57 | /** |
| 58 | * Core service implementation. |
| 59 | */ |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 60 | @Component(immediate = true) |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 61 | @Service |
| 62 | public class CoreManager implements CoreService { |
| 63 | |
Thomas Vachuska | 8dc1a69 | 2015-03-31 01:01:37 -0700 | [diff] [blame] | 64 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 65 | |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 66 | private static final File VERSION_FILE = new File("../VERSION"); |
Thomas Vachuska | 5d8994f | 2016-03-03 17:13:26 -0800 | [diff] [blame] | 67 | private static Version version = Version.version("1.5.0-SNAPSHOT"); |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 68 | |
| 69 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 70 | protected ApplicationIdStore applicationIdStore; |
| 71 | |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 72 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 73 | protected IdBlockStore idBlockStore; |
| 74 | |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 75 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Thomas Vachuska | c65dd71 | 2015-11-04 17:19:10 -0800 | [diff] [blame] | 76 | protected ApplicationService appService; |
| 77 | |
| 78 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 79 | protected ComponentConfigService cfgService; |
| 80 | |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 81 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 82 | protected EventDeliveryService eventDeliveryService; |
| 83 | |
Murat Parlakisik | dc17f7b | 2016-01-26 12:08:35 -0800 | [diff] [blame] | 84 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 85 | protected MetricsService metricsService; |
| 86 | |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 87 | private static final int DEFAULT_POOL_SIZE = 30; |
| 88 | @Property(name = "sharedThreadPoolSize", intValue = DEFAULT_POOL_SIZE, |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 89 | label = "Configure shared pool maximum size ") |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 90 | private int sharedThreadPoolSize = DEFAULT_POOL_SIZE; |
| 91 | |
| 92 | private static final int DEFAULT_EVENT_TIME = 2000; |
| 93 | @Property(name = "maxEventTimeLimit", intValue = DEFAULT_EVENT_TIME, |
| 94 | label = "Maximum number of millis an event sink has to process an event") |
| 95 | private int maxEventTimeLimit = DEFAULT_EVENT_TIME; |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 96 | |
Murat Parlakisik | dc17f7b | 2016-01-26 12:08:35 -0800 | [diff] [blame] | 97 | private static final boolean DEFAULT_PERFORMANCE_CHECK = false; |
| 98 | @Property(name = "sharedThreadPerformanceCheck", boolValue = DEFAULT_PERFORMANCE_CHECK, |
| 99 | label = "Enable queue performance check on shared pool") |
| 100 | private boolean calculatePoolPerformance = DEFAULT_PERFORMANCE_CHECK; |
| 101 | |
| 102 | |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 103 | @Activate |
| 104 | public void activate() { |
Thomas Vachuska | 6cba495 | 2015-04-22 12:38:22 -0700 | [diff] [blame] | 105 | registerApplication(CORE_APP_NAME); |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 106 | cfgService.registerProperties(getClass()); |
HIGUCHI Yuta | 3b3bd1e | 2015-09-22 16:39:33 -0700 | [diff] [blame] | 107 | try { |
| 108 | Path path = Paths.get(VERSION_FILE.getPath()); |
| 109 | List<String> versionLines = Files.readAllLines(path); |
| 110 | if (versionLines != null && !versionLines.isEmpty()) { |
| 111 | version = Version.version(versionLines.get(0)); |
| 112 | } |
| 113 | } catch (IOException e) { |
| 114 | // version file not found, using default |
| 115 | log.trace("Version file not found", e); |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 116 | } |
| 117 | } |
| 118 | |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 119 | @Deactivate |
| 120 | public void deactivate() { |
| 121 | cfgService.unregisterProperties(getClass(), false); |
Thomas Vachuska | b0317c6 | 2015-04-08 23:58:58 -0700 | [diff] [blame] | 122 | SharedExecutors.shutdown(); |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 123 | } |
| 124 | |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 125 | @Override |
| 126 | public Version version() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 127 | checkPermission(APP_READ); |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 128 | return version; |
| 129 | } |
| 130 | |
| 131 | @Override |
| 132 | public Set<ApplicationId> getAppIds() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 133 | checkPermission(APP_READ); |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 134 | return applicationIdStore.getAppIds(); |
| 135 | } |
| 136 | |
| 137 | @Override |
| 138 | public ApplicationId getAppId(Short id) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 139 | checkPermission(APP_READ); |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 140 | return applicationIdStore.getAppId(id); |
| 141 | } |
| 142 | |
| 143 | @Override |
Ray Milkey | 0247986 | 2015-02-17 17:02:19 -0800 | [diff] [blame] | 144 | public ApplicationId getAppId(String name) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 145 | checkPermission(APP_READ); |
Ray Milkey | 0247986 | 2015-02-17 17:02:19 -0800 | [diff] [blame] | 146 | return applicationIdStore.getAppId(name); |
| 147 | } |
| 148 | |
| 149 | |
| 150 | @Override |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 151 | public ApplicationId registerApplication(String name) { |
| 152 | checkNotNull(name, "Application ID cannot be null"); |
| 153 | return applicationIdStore.registerApplication(name); |
| 154 | } |
| 155 | |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 156 | @Override |
Thomas Vachuska | c65dd71 | 2015-11-04 17:19:10 -0800 | [diff] [blame] | 157 | public ApplicationId registerApplication(String name, Runnable preDeactivate) { |
| 158 | ApplicationId id = registerApplication(name); |
| 159 | appService.registerDeactivateHook(id, preDeactivate); |
| 160 | return id; |
| 161 | } |
| 162 | |
| 163 | @Override |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 164 | public IdGenerator getIdGenerator(String topic) { |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 165 | IdBlockAllocator allocator = new StoreBasedIdBlockAllocator(topic, idBlockStore); |
| 166 | return new BlockAllocatorBasedIdGenerator(allocator); |
| 167 | } |
| 168 | |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 169 | |
| 170 | @Modified |
| 171 | public void modified(ComponentContext context) { |
| 172 | Dictionary<?, ?> properties = context.getProperties(); |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 173 | Integer poolSize = getIntegerProperty(properties, "sharedThreadPoolSize"); |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 174 | |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 175 | if (poolSize != null && poolSize > 1) { |
| 176 | sharedThreadPoolSize = poolSize; |
| 177 | SharedExecutors.setPoolSize(sharedThreadPoolSize); |
| 178 | } else if (poolSize != null) { |
| 179 | log.warn("sharedThreadPoolSize must be greater than 1"); |
| 180 | } |
| 181 | |
| 182 | Integer timeLimit = getIntegerProperty(properties, "maxEventTimeLimit"); |
| 183 | if (timeLimit != null && timeLimit > 1) { |
| 184 | maxEventTimeLimit = timeLimit; |
| 185 | eventDeliveryService.setDispatchTimeLimit(maxEventTimeLimit); |
| 186 | } else if (timeLimit != null) { |
| 187 | log.warn("maxEventTimeLimit must be greater than 1"); |
| 188 | } |
| 189 | |
Murat Parlakisik | dc17f7b | 2016-01-26 12:08:35 -0800 | [diff] [blame] | 190 | Boolean performanceCheck = isPropertyEnabled(properties, "sharedThreadPerformanceCheck"); |
| 191 | if (performanceCheck != null) { |
| 192 | calculatePoolPerformance = performanceCheck; |
| 193 | SharedExecutors.setCalculatePoolPerformance(calculatePoolPerformance, metricsService); |
| 194 | } |
| 195 | |
| 196 | log.info("Settings: sharedThreadPoolSize={}, maxEventTimeLimit={}, calculatePoolPerformance={}", |
| 197 | sharedThreadPoolSize, maxEventTimeLimit, calculatePoolPerformance); |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 198 | } |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 199 | |
| 200 | |
| 201 | /** |
| 202 | * Get Integer property from the propertyName |
| 203 | * Return null if propertyName is not found. |
| 204 | * |
Thomas Vachuska | 36002e6 | 2015-05-19 16:12:29 -0700 | [diff] [blame] | 205 | * @param properties properties to be looked up |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 206 | * @param propertyName the name of the property to look up |
| 207 | * @return value when the propertyName is defined or return null |
| 208 | */ |
| 209 | private static Integer getIntegerProperty(Dictionary<?, ?> properties, |
| 210 | String propertyName) { |
Thomas Vachuska | c65dd71 | 2015-11-04 17:19:10 -0800 | [diff] [blame] | 211 | Integer value; |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 212 | try { |
| 213 | String s = (String) properties.get(propertyName); |
Thomas Vachuska | c65dd71 | 2015-11-04 17:19:10 -0800 | [diff] [blame] | 214 | value = isNullOrEmpty(s) ? null : Integer.parseInt(s.trim()); |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 215 | } catch (NumberFormatException | ClassCastException e) { |
| 216 | value = null; |
| 217 | } |
| 218 | return value; |
| 219 | } |
| 220 | |
Murat Parlakisik | dc17f7b | 2016-01-26 12:08:35 -0800 | [diff] [blame] | 221 | /** |
| 222 | * Check property name is defined and set to true. |
| 223 | * |
| 224 | * @param properties properties to be looked up |
| 225 | * @param propertyName the name of the property to look up |
| 226 | * @return value when the propertyName is defined or return null |
| 227 | */ |
| 228 | private static Boolean isPropertyEnabled(Dictionary<?, ?> properties, |
| 229 | String propertyName) { |
| 230 | Boolean value = null; |
| 231 | try { |
| 232 | String s = (String) properties.get(propertyName); |
| 233 | value = isNullOrEmpty(s) ? null : s.trim().equals("true"); |
| 234 | } catch (ClassCastException e) { |
| 235 | // No propertyName defined. |
| 236 | value = null; |
| 237 | } |
| 238 | return value; |
| 239 | } |
| 240 | |
| 241 | |
Murat Parlakisik | 553db17 | 2015-04-08 03:29:04 -0700 | [diff] [blame] | 242 | |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 243 | } |