alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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 | package org.onosproject.net.driver.impl; |
| 17 | |
| 18 | import com.google.common.collect.ImmutableSet; |
| 19 | import com.google.common.collect.Maps; |
| 20 | import com.google.common.collect.Sets; |
| 21 | import org.apache.felix.scr.annotations.Activate; |
| 22 | import org.apache.felix.scr.annotations.Component; |
| 23 | import org.apache.felix.scr.annotations.Deactivate; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 24 | import org.apache.felix.scr.annotations.Reference; |
| 25 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Service; |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 27 | import org.onlab.util.ItemNotFoundException; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 28 | import org.onosproject.net.Device; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 29 | import org.onosproject.net.DeviceId; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 30 | import org.onosproject.net.device.DeviceService; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 31 | import org.onosproject.net.driver.Behaviour; |
| 32 | import org.onosproject.net.driver.DefaultDriverData; |
| 33 | import org.onosproject.net.driver.DefaultDriverHandler; |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 34 | import org.onosproject.net.driver.DefaultDriverProvider; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 35 | import org.onosproject.net.driver.Driver; |
| 36 | import org.onosproject.net.driver.DriverAdminService; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 37 | import org.onosproject.net.driver.DriverHandler; |
| 38 | import org.onosproject.net.driver.DriverProvider; |
| 39 | import org.slf4j.Logger; |
| 40 | import org.slf4j.LoggerFactory; |
| 41 | |
| 42 | import java.util.Map; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 43 | import java.util.Optional; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 44 | import java.util.Set; |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 45 | import java.util.stream.Collectors; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 46 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 47 | import static org.onlab.util.Tools.nullIsNotFound; |
| 48 | import static org.onosproject.net.AnnotationKeys.DRIVER; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 49 | import static org.onosproject.security.AppGuard.checkPermission; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 50 | import static org.onosproject.security.AppPermission.Type.*; |
| 51 | |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 52 | |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 53 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 54 | /** |
| 55 | * Manages inventory of device drivers. |
| 56 | */ |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 57 | @Component(immediate = true) |
| 58 | @Service |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 59 | public class DriverManager extends DefaultDriverProvider implements DriverAdminService { |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 60 | |
| 61 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 62 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 63 | private static final String NO_DRIVER = "Driver not found"; |
| 64 | private static final String NO_DEVICE = "Device not found"; |
| 65 | private static final String DEFAULT = "default"; |
| 66 | |
| 67 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 68 | protected DeviceService deviceService; |
| 69 | |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 70 | private Set<DriverProvider> providers = Sets.newConcurrentHashSet(); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 71 | private Map<String, Driver> driverByKey = Maps.newConcurrentMap(); |
| 72 | |
| 73 | @Activate |
| 74 | protected void activate() { |
| 75 | log.info("Started"); |
| 76 | } |
| 77 | |
| 78 | @Deactivate |
| 79 | protected void deactivate() { |
| 80 | log.info("Stopped"); |
| 81 | } |
| 82 | |
| 83 | |
| 84 | @Override |
| 85 | public Set<DriverProvider> getProviders() { |
| 86 | return ImmutableSet.copyOf(providers); |
| 87 | } |
| 88 | |
| 89 | @Override |
| 90 | public void registerProvider(DriverProvider provider) { |
| 91 | provider.getDrivers().forEach(driver -> { |
Thomas Vachuska | bb062ec | 2016-01-25 16:49:47 -0800 | [diff] [blame] | 92 | Driver d = addDriver(driver); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 93 | driverByKey.put(key(driver.manufacturer(), |
| 94 | driver.hwVersion(), |
Thomas Vachuska | bb062ec | 2016-01-25 16:49:47 -0800 | [diff] [blame] | 95 | driver.swVersion()), d); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 96 | }); |
| 97 | providers.add(provider); |
| 98 | } |
| 99 | |
| 100 | @Override |
| 101 | public void unregisterProvider(DriverProvider provider) { |
| 102 | provider.getDrivers().forEach(driver -> { |
Thomas Vachuska | bb062ec | 2016-01-25 16:49:47 -0800 | [diff] [blame] | 103 | removeDriver(driver); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 104 | driverByKey.remove(key(driver.manufacturer(), |
| 105 | driver.hwVersion(), |
| 106 | driver.swVersion())); |
| 107 | }); |
| 108 | providers.remove(provider); |
| 109 | } |
| 110 | |
| 111 | @Override |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 112 | public Set<Driver> getDrivers() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 113 | checkPermission(DRIVER_READ); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 114 | ImmutableSet.Builder<Driver> builder = ImmutableSet.builder(); |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 115 | drivers.values().forEach(builder::add); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 116 | return builder.build(); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | @Override |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 120 | public Set<Driver> getDrivers(Class<? extends Behaviour> withBehaviour) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 121 | checkPermission(DRIVER_READ); |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 122 | return drivers.values().stream() |
| 123 | .filter(d -> d.hasBehaviour(withBehaviour)) |
| 124 | .collect(Collectors.toSet()); |
| 125 | } |
| 126 | |
| 127 | @Override |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 128 | public Driver getDriver(String driverName) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 129 | checkPermission(DRIVER_READ); |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 130 | return nullIsNotFound(drivers.get(driverName), NO_DRIVER); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | @Override |
| 134 | public Driver getDriver(String mfr, String hw, String sw) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 135 | checkPermission(DRIVER_READ); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 136 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 137 | // First attempt a literal search. |
| 138 | Driver driver = driverByKey.get(key(mfr, hw, sw)); |
| 139 | if (driver != null) { |
| 140 | return driver; |
| 141 | } |
| 142 | |
| 143 | // Otherwise, sweep through the key space and attempt to match using |
| 144 | // regular expression matching. |
| 145 | Optional<Driver> optional = driverByKey.values().stream() |
| 146 | .filter(d -> matches(d, mfr, hw, sw)).findFirst(); |
| 147 | |
| 148 | // If no matching driver is found, return default. |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 149 | return optional.isPresent() ? optional.get() : drivers.get(DEFAULT); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 150 | } |
| 151 | |
| 152 | // Matches the given driver using ERE matching against the given criteria. |
| 153 | private boolean matches(Driver d, String mfr, String hw, String sw) { |
| 154 | // TODO: consider pre-compiling the expressions in the future |
| 155 | return mfr.matches(d.manufacturer()) && |
| 156 | hw.matches(d.hwVersion()) && |
| 157 | sw.matches(d.swVersion()); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 158 | } |
| 159 | |
| 160 | @Override |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 161 | public Driver getDriver(DeviceId deviceId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 162 | checkPermission(DRIVER_READ); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 163 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 164 | Device device = nullIsNotFound(deviceService.getDevice(deviceId), NO_DEVICE); |
| 165 | String driverName = device.annotations().value(DRIVER); |
| 166 | if (driverName != null) { |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 167 | try { |
| 168 | return getDriver(driverName); |
| 169 | } catch (ItemNotFoundException e) { |
| 170 | log.warn("Specified driver {} not found, falling back.", driverName); |
| 171 | } |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 172 | } |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 173 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 174 | return nullIsNotFound(getDriver(device.manufacturer(), |
| 175 | device.hwVersion(), device.swVersion()), |
| 176 | NO_DRIVER); |
| 177 | } |
| 178 | |
| 179 | @Override |
| 180 | public DriverHandler createHandler(DeviceId deviceId, String... credentials) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 181 | checkPermission(DRIVER_WRITE); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 182 | Driver driver = getDriver(deviceId); |
Thomas Vachuska | 80b0a80 | 2015-07-17 08:43:30 -0700 | [diff] [blame] | 183 | return new DefaultDriverHandler(new DefaultDriverData(driver, deviceId)); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 184 | } |
| 185 | |
Thomas Vachuska | 5c2f813 | 2015-04-08 23:09:08 -0700 | [diff] [blame] | 186 | // Produces a composite driver key using the specified components. |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 187 | private String key(String mfr, String hw, String sw) { |
| 188 | return String.format("%s-%s-%s", mfr, hw, sw); |
| 189 | } |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 190 | } |