Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [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.onosproject.net.pi.impl; |
| 18 | |
Andrea Campanella | 48f99fa | 2017-07-13 19:06:21 +0200 | [diff] [blame] | 19 | import com.google.common.annotations.Beta; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 20 | import com.google.common.collect.ImmutableSet; |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 21 | import com.google.common.collect.Sets; |
| 22 | import com.google.common.util.concurrent.Striped; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 23 | import org.onlab.util.ItemNotFoundException; |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 24 | import org.onlab.util.SharedExecutors; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 25 | import org.onosproject.net.DeviceId; |
| 26 | import org.onosproject.net.config.ConfigFactory; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 27 | import org.onosproject.net.config.NetworkConfigRegistry; |
| 28 | import org.onosproject.net.config.basics.BasicDeviceConfig; |
| 29 | import org.onosproject.net.config.basics.SubjectFactories; |
| 30 | import org.onosproject.net.driver.Behaviour; |
| 31 | import org.onosproject.net.driver.DefaultDriver; |
| 32 | import org.onosproject.net.driver.Driver; |
| 33 | import org.onosproject.net.driver.DriverAdminService; |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 34 | import org.onosproject.net.driver.DriverEvent; |
| 35 | import org.onosproject.net.driver.DriverListener; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 36 | import org.onosproject.net.driver.DriverProvider; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 37 | import org.onosproject.net.pi.model.PiPipeconf; |
| 38 | import org.onosproject.net.pi.model.PiPipeconfId; |
Carmelo Cascone | 39c28ca | 2017-11-15 13:03:57 -0800 | [diff] [blame] | 39 | import org.onosproject.net.pi.service.PiPipeconfConfig; |
| 40 | import org.onosproject.net.pi.service.PiPipeconfMappingStore; |
| 41 | import org.onosproject.net.pi.service.PiPipeconfService; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 42 | import org.osgi.service.component.annotations.Activate; |
| 43 | import org.osgi.service.component.annotations.Component; |
| 44 | import org.osgi.service.component.annotations.Deactivate; |
| 45 | import org.osgi.service.component.annotations.Reference; |
| 46 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 47 | import org.slf4j.Logger; |
| 48 | |
| 49 | import java.util.HashMap; |
| 50 | import java.util.Map; |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 51 | import java.util.Objects; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 52 | import java.util.Optional; |
| 53 | import java.util.Set; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 54 | import java.util.concurrent.ConcurrentHashMap; |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 55 | import java.util.concurrent.ConcurrentMap; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 56 | import java.util.concurrent.ExecutorService; |
| 57 | import java.util.concurrent.Executors; |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 58 | import java.util.concurrent.TimeUnit; |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 59 | import java.util.concurrent.locks.Lock; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 60 | |
Carmelo Cascone | 44daf56 | 2017-07-16 23:55:08 -0400 | [diff] [blame] | 61 | import static java.lang.String.format; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 62 | import static org.onlab.util.Tools.groupedThreads; |
| 63 | import static org.slf4j.LoggerFactory.getLogger; |
| 64 | |
| 65 | |
| 66 | /** |
| 67 | * Implementation of the PiPipeconfService. |
| 68 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 69 | @Component(immediate = true, service = PiPipeconfService.class) |
Andrea Campanella | 48f99fa | 2017-07-13 19:06:21 +0200 | [diff] [blame] | 70 | @Beta |
| 71 | public class PiPipeconfManager implements PiPipeconfService { |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 72 | |
| 73 | private final Logger log = getLogger(getClass()); |
| 74 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 75 | private static final String MERGED_DRIVER_SEPARATOR = ":"; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 76 | private static final String CFG_SCHEME = "piPipeconf"; |
| 77 | |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 78 | private static final int MISSING_DRIVER_WATCHDOG_INTERVAL = 5; // Seconds. |
| 79 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 80 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 81 | protected NetworkConfigRegistry cfgService; |
| 82 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 83 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 84 | protected DriverAdminService driverAdminService; |
| 85 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 86 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 87 | private PiPipeconfMappingStore pipeconfMappingStore; |
Andrea Campanella | f9c409a | 2017-07-13 14:14:41 +0200 | [diff] [blame] | 88 | |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 89 | // Registered pipeconf are replicated through the app subsystem and |
| 90 | // registered on app activated events. Hence, there should be no need of |
| 91 | // distributing this map. |
| 92 | protected ConcurrentMap<PiPipeconfId, PiPipeconf> pipeconfs = new ConcurrentHashMap<>(); |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 93 | |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 94 | private final DriverListener driverListener = new InternalDriverListener(); |
| 95 | private final Set<String> missingMergedDrivers = Sets.newCopyOnWriteArraySet(); |
| 96 | private final Striped<Lock> locks = Striped.lock(20); |
| 97 | |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 98 | protected ExecutorService executor = Executors.newFixedThreadPool( |
| 99 | 10, groupedThreads("onos/pipeconf-manager", "%d", log)); |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 100 | |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 101 | protected final ConfigFactory configFactory = |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 102 | new ConfigFactory<DeviceId, PiPipeconfConfig>( |
| 103 | SubjectFactories.DEVICE_SUBJECT_FACTORY, |
| 104 | PiPipeconfConfig.class, CFG_SCHEME) { |
| 105 | @Override |
| 106 | public PiPipeconfConfig createConfig() { |
| 107 | return new PiPipeconfConfig(); |
| 108 | } |
| 109 | }; |
| 110 | |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 111 | @Activate |
| 112 | public void activate() { |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 113 | cfgService.registerConfigFactory(configFactory); |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 114 | driverAdminService.addListener(driverListener); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 115 | checkMissingMergedDrivers(); |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 116 | if (!missingMergedDrivers.isEmpty()) { |
| 117 | // Missing drivers should be created upon detecting registration |
| 118 | // events of a new pipeconf or a base driver. If, for any reason, we |
| 119 | // miss such event, here's a watchdog task. |
| 120 | SharedExecutors.getPoolThreadExecutor() |
| 121 | .execute(this::missingDriversWatchdogTask); |
| 122 | } |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 123 | log.info("Started"); |
| 124 | } |
| 125 | |
| 126 | |
| 127 | @Deactivate |
| 128 | public void deactivate() { |
| 129 | executor.shutdown(); |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 130 | cfgService.unregisterConfigFactory(configFactory); |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 131 | driverAdminService.removeListener(driverListener); |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 132 | pipeconfs.clear(); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 133 | missingMergedDrivers.clear(); |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 134 | cfgService = null; |
| 135 | driverAdminService = null; |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 136 | log.info("Stopped"); |
| 137 | } |
| 138 | |
| 139 | @Override |
| 140 | public void register(PiPipeconf pipeconf) throws IllegalStateException { |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 141 | if (pipeconfs.containsKey(pipeconf.id())) { |
Carmelo Cascone | 44daf56 | 2017-07-16 23:55:08 -0400 | [diff] [blame] | 142 | throw new IllegalStateException(format("Pipeconf %s is already registered", pipeconf.id())); |
| 143 | } |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 144 | pipeconfs.put(pipeconf.id(), pipeconf); |
Carmelo Cascone | 44daf56 | 2017-07-16 23:55:08 -0400 | [diff] [blame] | 145 | log.info("New pipeconf registered: {}", pipeconf.id()); |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 146 | executor.execute(() -> attemptMergeAll(pipeconf.id())); |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 147 | } |
| 148 | |
| 149 | @Override |
Andrea Campanella | a9b3c9b | 2017-07-21 14:03:15 +0200 | [diff] [blame] | 150 | public void remove(PiPipeconfId pipeconfId) throws IllegalStateException { |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 151 | // TODO add mechanism to remove from device. |
| 152 | if (!pipeconfs.containsKey(pipeconfId)) { |
Andrea Campanella | a9b3c9b | 2017-07-21 14:03:15 +0200 | [diff] [blame] | 153 | throw new IllegalStateException(format("Pipeconf %s is not registered", pipeconfId)); |
| 154 | } |
Andrea Campanella | f9c409a | 2017-07-13 14:14:41 +0200 | [diff] [blame] | 155 | // TODO remove the binding from the distributed Store when the lifecycle of a pipeconf is defined. |
| 156 | // pipeconfMappingStore.removeBindings(pipeconfId); |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 157 | log.info("Removing pipeconf {}", pipeconfId); |
| 158 | pipeconfs.remove(pipeconfId); |
Andrea Campanella | a9b3c9b | 2017-07-21 14:03:15 +0200 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | @Override |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 162 | public Iterable<PiPipeconf> getPipeconfs() { |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 163 | return pipeconfs.values(); |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 164 | } |
| 165 | |
| 166 | @Override |
| 167 | public Optional<PiPipeconf> getPipeconf(PiPipeconfId id) { |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 168 | return Optional.ofNullable(pipeconfs.get(id)); |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | @Override |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame^] | 172 | public Optional<PiPipeconf> getPipeconf(DeviceId deviceId) { |
| 173 | if (pipeconfMappingStore.getPipeconfId(deviceId) == null) { |
| 174 | return Optional.empty(); |
| 175 | } else { |
| 176 | return Optional.ofNullable(pipeconfs.get( |
| 177 | pipeconfMappingStore.getPipeconfId(deviceId))); |
| 178 | } |
| 179 | } |
| 180 | |
| 181 | @Override |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 182 | public void bindToDevice(PiPipeconfId pipeconfId, DeviceId deviceId) { |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 183 | PiPipeconfId existingPipeconfId = pipeconfMappingStore.getPipeconfId(deviceId); |
| 184 | if (existingPipeconfId != null && !existingPipeconfId.equals(pipeconfId)) { |
| 185 | log.error("Cannot set binding for {} to {} as one already exists ({})", |
| 186 | deviceId, pipeconfId, existingPipeconfId); |
| 187 | return; |
| 188 | } |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 189 | pipeconfMappingStore.createOrUpdateBinding(deviceId, pipeconfId); |
| 190 | } |
| 191 | |
| 192 | @Override |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 193 | public String getMergedDriver(DeviceId deviceId, PiPipeconfId pipeconfId) { |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 194 | log.debug("Starting device driver merge of {} with {}...", deviceId, pipeconfId); |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 195 | final BasicDeviceConfig basicDeviceConfig = cfgService.getConfig( |
| 196 | deviceId, BasicDeviceConfig.class); |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 197 | if (basicDeviceConfig == null) { |
| 198 | log.warn("Unable to get basic device config for {}, " + |
Tian Jian | 855b108 | 2018-10-23 16:22:47 +0800 | [diff] [blame] | 199 | "aborting pipeconf driver merge", deviceId); |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 200 | return null; |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 201 | } |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 202 | String baseDriverName = basicDeviceConfig.driver(); |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 203 | if (baseDriverName == null) { |
| 204 | log.warn("Missing driver from basic device config for {}, " + |
| 205 | "cannot produce merged driver", deviceId); |
| 206 | return null; |
| 207 | } |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 208 | if (isMergedDriverName(baseDriverName)) { |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 209 | // The config already has driver name that is a merged one. We still |
| 210 | // need to make sure an instance of that merged driver is present in |
| 211 | // this node. |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 212 | log.debug("Base driver of {} ({}) is a merged one", |
| 213 | deviceId, baseDriverName); |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 214 | baseDriverName = getBaseDriverNameFromMerged(baseDriverName); |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 215 | } |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 216 | |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 217 | return doMergeDriver(baseDriverName, pipeconfId); |
| 218 | } |
| 219 | |
| 220 | @Override |
| 221 | public Optional<PiPipeconfId> ofDevice(DeviceId deviceId) { |
| 222 | return Optional.ofNullable(pipeconfMappingStore.getPipeconfId(deviceId)); |
| 223 | } |
| 224 | |
| 225 | private String doMergeDriver(String baseDriverName, PiPipeconfId pipeconfId) { |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 226 | final String newDriverName = mergedDriverName(baseDriverName, pipeconfId); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 227 | // Serialize per newDriverName, avoid creating duplicates. |
| 228 | locks.get(newDriverName).lock(); |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 229 | try { |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 230 | // If merged driver exists already we don't create a new one. |
| 231 | if (getDriver(newDriverName) != null) { |
| 232 | return newDriverName; |
| 233 | } |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 234 | log.info("Creating merged driver {}...", newDriverName); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 235 | final Driver mergedDriver = buildMergedDriver( |
| 236 | pipeconfId, baseDriverName, newDriverName); |
| 237 | if (mergedDriver == null) { |
| 238 | // Error logged by buildMergedDriver |
| 239 | return null; |
| 240 | } |
| 241 | registerMergedDriver(mergedDriver); |
| 242 | if (missingMergedDrivers.remove(newDriverName)) { |
| 243 | log.info("There are still {} missing merged drivers", |
| 244 | missingMergedDrivers.size()); |
| 245 | } |
| 246 | return newDriverName; |
| 247 | } finally { |
| 248 | locks.get(newDriverName).unlock(); |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 249 | } |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 250 | } |
| 251 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 252 | private String mergedDriverSuffix(PiPipeconfId pipeconfId) { |
| 253 | return MERGED_DRIVER_SEPARATOR + pipeconfId.id(); |
| 254 | } |
| 255 | |
| 256 | private String mergedDriverName(String baseDriverName, PiPipeconfId pipeconfId) { |
| 257 | return baseDriverName + mergedDriverSuffix(pipeconfId); |
| 258 | } |
| 259 | |
| 260 | private String getBaseDriverNameFromMerged(String mergedDriverName) { |
| 261 | final String[] pieces = mergedDriverName.split(MERGED_DRIVER_SEPARATOR); |
| 262 | if (pieces.length != 2) { |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 263 | return null; |
| 264 | } |
| 265 | return pieces[0]; |
| 266 | } |
| 267 | |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 268 | private PiPipeconfId getPipeconfIdFromMerged(String mergedDriverName) { |
| 269 | final String[] pieces = mergedDriverName.split(MERGED_DRIVER_SEPARATOR); |
| 270 | if (pieces.length != 2) { |
| 271 | return null; |
| 272 | } |
| 273 | return new PiPipeconfId(pieces[1]); |
| 274 | } |
| 275 | |
| 276 | private boolean isMergedDriverName(String driverName) { |
| 277 | final String[] pieces = driverName.split(MERGED_DRIVER_SEPARATOR); |
| 278 | return pieces.length == 2; |
| 279 | } |
| 280 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 281 | private Driver buildMergedDriver(PiPipeconfId pipeconfId, String baseDriverName, |
| 282 | String newDriverName) { |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 283 | final Driver baseDriver = getDriver(baseDriverName); |
| 284 | if (baseDriver == null) { |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 285 | log.error("Base driver {} not found, cannot build a merged one", |
| 286 | baseDriverName); |
| 287 | return null; |
| 288 | } |
| 289 | |
| 290 | final PiPipeconf pipeconf = pipeconfs.get(pipeconfId); |
| 291 | if (pipeconf == null) { |
| 292 | log.error("Pipeconf {} is not registered, cannot build a merged driver", |
| 293 | pipeconfId); |
| 294 | return null; |
| 295 | } |
| 296 | |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 297 | // extract the behaviours from the pipipeconf. |
| 298 | final Map<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviours = |
| 299 | new HashMap<>(); |
| 300 | pipeconf.behaviours().forEach( |
| 301 | b -> behaviours.put(b, pipeconf.implementation(b).get())); |
| 302 | final Driver piPipeconfDriver = new DefaultDriver( |
| 303 | newDriverName, baseDriver.parents(), |
| 304 | baseDriver.manufacturer(), baseDriver.hwVersion(), |
| 305 | baseDriver.swVersion(), behaviours, new HashMap<>()); |
| 306 | // take the base driver created with the behaviours of the PiPeconf and |
| 307 | // merge it with the base driver that was assigned to the device |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 308 | return piPipeconfDriver.merge(baseDriver); |
| 309 | } |
| 310 | |
| 311 | private void registerMergedDriver(Driver driver) { |
| 312 | final DriverProvider provider = new InternalDriverProvider(driver); |
| 313 | if (driverAdminService.getProviders().contains(provider)) { |
| 314 | // A provider for this driver already exist. |
| 315 | return; |
| 316 | } |
Carmelo Cascone | 96beb6f | 2018-06-27 18:07:12 +0200 | [diff] [blame] | 317 | driverAdminService.registerProvider(provider); |
| 318 | } |
| 319 | |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 320 | private Driver getDriver(String name) { |
| 321 | try { |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 322 | return driverAdminService.getDriver(name); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 323 | } catch (ItemNotFoundException e) { |
| 324 | return null; |
| 325 | } |
| 326 | } |
| 327 | |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 328 | private boolean driverExists(String name) { |
| 329 | return getDriver(name) != null; |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 330 | } |
| 331 | |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 332 | private void checkMissingMergedDriver(DeviceId deviceId) { |
| 333 | final PiPipeconfId pipeconfId = pipeconfMappingStore.getPipeconfId(deviceId); |
| 334 | final BasicDeviceConfig cfg = cfgService.getConfig(deviceId, BasicDeviceConfig.class); |
| 335 | |
| 336 | if (pipeconfId == null) { |
| 337 | // No pipeconf associated. |
| 338 | return; |
| 339 | } |
| 340 | |
| 341 | if (cfg == null || cfg.driver() == null) { |
| 342 | log.warn("Missing basic device config or driver key in netcfg for " + |
| 343 | "{}, which is odd since it has a " + |
| 344 | "pipeconf associated ({})", |
| 345 | deviceId, pipeconfId); |
| 346 | return; |
| 347 | } |
| 348 | |
| 349 | final String baseDriverName = cfg.driver(); |
| 350 | final String mergedDriverName = mergedDriverName(baseDriverName, pipeconfId); |
| 351 | |
| 352 | if (driverExists(mergedDriverName) || |
| 353 | missingMergedDrivers.contains(mergedDriverName)) { |
| 354 | // Not missing, or already aware of it missing. |
| 355 | return; |
| 356 | } |
| 357 | |
| 358 | log.info("Detected missing merged driver: {}", mergedDriverName); |
| 359 | missingMergedDrivers.add(mergedDriverName); |
| 360 | // Attempt building the driver now if all pieces are present. |
| 361 | // If not, either a driver or pipeconf event will re-trigger |
| 362 | // the process. |
| 363 | attemptDriverMerge(mergedDriverName); |
| 364 | } |
| 365 | |
| 366 | private void attemptDriverMerge(String mergedDriverName) { |
| 367 | final String baseDriverName = getBaseDriverNameFromMerged(mergedDriverName); |
| 368 | final PiPipeconfId pipeconfId = getPipeconfIdFromMerged(mergedDriverName); |
| 369 | if (driverExists(baseDriverName) && pipeconfs.containsKey(pipeconfId)) { |
| 370 | doMergeDriver(baseDriverName, pipeconfId); |
| 371 | } |
| 372 | } |
| 373 | |
| 374 | private void missingDriversWatchdogTask() { |
| 375 | while (true) { |
| 376 | // Most probably all missing drivers will be created before the |
| 377 | // watchdog interval, so wait before starting... |
| 378 | try { |
| 379 | TimeUnit.SECONDS.sleep(MISSING_DRIVER_WATCHDOG_INTERVAL); |
| 380 | } catch (InterruptedException e) { |
| 381 | log.warn("Interrupted! There are still {} missing merged drivers", |
| 382 | missingMergedDrivers.size()); |
| 383 | } |
| 384 | if (missingMergedDrivers.isEmpty()) { |
| 385 | log.info("There are no more missing merged drivers!"); |
| 386 | return; |
| 387 | } |
| 388 | log.info("Detected {} missing merged drivers, attempt merge...", |
| 389 | missingMergedDrivers.size()); |
| 390 | missingMergedDrivers.forEach(this::attemptDriverMerge); |
| 391 | } |
| 392 | } |
| 393 | |
| 394 | private void checkMissingMergedDrivers() { |
| 395 | cfgService.getSubjects(DeviceId.class, BasicDeviceConfig.class) |
| 396 | .forEach(this::checkMissingMergedDriver); |
| 397 | } |
| 398 | |
| 399 | private void attemptMergeAll(String baseDriverName) { |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 400 | missingMergedDrivers.stream() |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 401 | .filter(missingDriver -> { |
| 402 | // Filter missing merged drivers using this base driver. |
| 403 | final String xx = getBaseDriverNameFromMerged(missingDriver); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 404 | return xx != null && xx.equals(baseDriverName); |
| 405 | }) |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 406 | .forEach(this::attemptDriverMerge); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 407 | } |
| 408 | |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 409 | private void attemptMergeAll(PiPipeconfId pipeconfId) { |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 410 | missingMergedDrivers.stream() |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 411 | .filter(missingDriver -> { |
| 412 | // Filter missing merged drivers using this pipeconf. |
| 413 | final PiPipeconfId xx = getPipeconfIdFromMerged(missingDriver); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 414 | return xx != null && xx.equals(pipeconfId); |
| 415 | }) |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 416 | .forEach(this::attemptDriverMerge); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 417 | } |
| 418 | |
| 419 | private class InternalDriverListener implements DriverListener { |
| 420 | |
| 421 | @Override |
| 422 | public void event(DriverEvent event) { |
Carmelo Cascone | da0b559 | 2018-09-14 12:54:15 -0700 | [diff] [blame] | 423 | executor.execute(() -> attemptMergeAll(event.subject().name())); |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 424 | } |
| 425 | |
| 426 | @Override |
| 427 | public boolean isRelevant(DriverEvent event) { |
| 428 | return event.type() == DriverEvent.Type.DRIVER_ENHANCED; |
| 429 | } |
| 430 | } |
| 431 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 432 | /** |
| 433 | * Internal driver provider used to register merged pipeconf drivers in the |
| 434 | * core. |
| 435 | */ |
| 436 | private class InternalDriverProvider implements DriverProvider { |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 437 | |
| 438 | Driver driver; |
| 439 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 440 | InternalDriverProvider(Driver driver) { |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 441 | this.driver = driver; |
| 442 | } |
| 443 | |
| 444 | @Override |
| 445 | public Set<Driver> getDrivers() { |
| 446 | return ImmutableSet.of(driver); |
| 447 | } |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 448 | |
| 449 | @Override |
| 450 | public boolean equals(Object o) { |
| 451 | if (this == o) { |
| 452 | return true; |
| 453 | } |
| 454 | if (o == null || getClass() != o.getClass()) { |
| 455 | return false; |
| 456 | } |
| 457 | InternalDriverProvider that = (InternalDriverProvider) o; |
Carmelo Cascone | da60a61 | 2018-08-24 00:01:34 -0700 | [diff] [blame] | 458 | return Objects.equals(driver.name(), that.driver.name()); |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 459 | } |
| 460 | |
| 461 | @Override |
| 462 | public int hashCode() { |
| 463 | return Objects.hashCode(driver.name()); |
| 464 | } |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 465 | } |
Andrea Campanella | bc112a9 | 2017-06-26 19:06:43 +0200 | [diff] [blame] | 466 | } |