YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [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 | package org.onosproject.ovsdb.providers.device; |
| 17 | |
| 18 | import static com.google.common.base.Preconditions.checkNotNull; |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 19 | import static org.onlab.util.Tools.groupedThreads; |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 20 | import static org.slf4j.LoggerFactory.getLogger; |
| 21 | |
| 22 | import java.net.URI; |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 23 | import java.util.concurrent.ExecutorService; |
| 24 | import java.util.concurrent.Executors; |
| 25 | import java.util.concurrent.TimeUnit; |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 26 | |
| 27 | import org.apache.felix.scr.annotations.Activate; |
| 28 | import org.apache.felix.scr.annotations.Component; |
| 29 | import org.apache.felix.scr.annotations.Deactivate; |
| 30 | import org.apache.felix.scr.annotations.Reference; |
| 31 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 32 | import org.apache.felix.scr.annotations.Service; |
| 33 | import org.onlab.packet.ChassisId; |
jiangrui | 8356361 | 2015-11-16 11:59:47 +0800 | [diff] [blame] | 34 | import org.onlab.packet.IpAddress; |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 35 | import org.onosproject.mastership.MastershipService; |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 36 | import org.onosproject.net.DefaultAnnotations; |
| 37 | import org.onosproject.net.Device; |
| 38 | import org.onosproject.net.DeviceId; |
| 39 | import org.onosproject.net.MastershipRole; |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 40 | import org.onosproject.net.PortNumber; |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 41 | import org.onosproject.net.SparseAnnotations; |
| 42 | import org.onosproject.net.device.DefaultDeviceDescription; |
| 43 | import org.onosproject.net.device.DeviceDescription; |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 44 | import org.onosproject.net.device.DeviceDescriptionDiscovery; |
| 45 | import org.onosproject.net.device.DeviceEvent; |
| 46 | import org.onosproject.net.device.DeviceListener; |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 47 | import org.onosproject.net.device.DeviceProvider; |
| 48 | import org.onosproject.net.device.DeviceProviderRegistry; |
| 49 | import org.onosproject.net.device.DeviceProviderService; |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 50 | import org.onosproject.net.device.DeviceService; |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 51 | import org.onosproject.net.provider.AbstractProvider; |
| 52 | import org.onosproject.net.provider.ProviderId; |
jiangrui | 8356361 | 2015-11-16 11:59:47 +0800 | [diff] [blame] | 53 | import org.onosproject.ovsdb.controller.OvsdbClientService; |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 54 | import org.onosproject.ovsdb.controller.OvsdbController; |
| 55 | import org.onosproject.ovsdb.controller.OvsdbNodeId; |
| 56 | import org.onosproject.ovsdb.controller.OvsdbNodeListener; |
| 57 | import org.slf4j.Logger; |
| 58 | |
| 59 | /** |
| 60 | * Provider which uses an ovsdb controller to detect device. |
| 61 | */ |
| 62 | @Component(immediate = true) |
| 63 | @Service |
| 64 | public class OvsdbDeviceProvider extends AbstractProvider |
| 65 | implements DeviceProvider { |
| 66 | private final Logger log = getLogger(getClass()); |
| 67 | |
| 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 69 | protected DeviceProviderRegistry providerRegistry; |
| 70 | |
| 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 72 | protected OvsdbController controller; |
| 73 | |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 74 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 75 | protected DeviceService deviceService; |
| 76 | |
| 77 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 78 | protected MastershipService mastershipService; |
| 79 | |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 80 | private DeviceProviderService providerService; |
| 81 | private OvsdbNodeListener innerNodeListener = new InnerOvsdbNodeListener(); |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 82 | private InternalDeviceListener deviceListener = new InternalDeviceListener(); |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 83 | protected static final String ISNOTNULL = "OvsdbNodeId is not null"; |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 84 | protected static final String SCHEME_NAME = "ovsdb"; |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 85 | private static final String UNKNOWN = "unknown"; |
| 86 | |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 87 | protected ExecutorService executor = |
| 88 | Executors.newFixedThreadPool(5, groupedThreads("onos/ovsdbdeviceprovider", |
| 89 | "device-installer-%d", log)); |
| 90 | |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 91 | @Activate |
| 92 | public void activate() { |
| 93 | providerService = providerRegistry.register(this); |
| 94 | controller.addNodeListener(innerNodeListener); |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 95 | deviceService.addListener(deviceListener); |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 96 | log.info("Started"); |
| 97 | } |
| 98 | |
| 99 | @Deactivate |
| 100 | public void deactivate() { |
Frank Wang | 1462982 | 2017-05-26 09:22:59 +0800 | [diff] [blame] | 101 | controller.removeNodeListener(innerNodeListener); |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 102 | providerRegistry.unregister(this); |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 103 | deviceService.removeListener(deviceListener); |
| 104 | waitForTasksToEnd(); |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 105 | providerService = null; |
| 106 | log.info("Stopped"); |
| 107 | } |
| 108 | |
| 109 | public OvsdbDeviceProvider() { |
| 110 | super(new ProviderId("ovsdb", "org.onosproject.ovsdb.provider.device")); |
| 111 | } |
| 112 | |
| 113 | @Override |
| 114 | public void triggerProbe(DeviceId deviceId) { |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 115 | log.info("Triggering probe on device {}", deviceId); |
jiangrui | 5f4d2e6 | 2015-11-16 12:52:35 +0800 | [diff] [blame] | 116 | if (!isReachable(deviceId)) { |
| 117 | log.error("Failed to probe device {}", deviceId); |
| 118 | providerService.deviceDisconnected(deviceId); |
jiangrui | 5f4d2e6 | 2015-11-16 12:52:35 +0800 | [diff] [blame] | 119 | } else { |
| 120 | log.trace("Confirmed device {} connection", deviceId); |
| 121 | } |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | @Override |
| 125 | public void roleChanged(DeviceId deviceId, MastershipRole newRole) { |
| 126 | // TODO: This will be implemented later. |
| 127 | } |
| 128 | |
| 129 | @Override |
| 130 | public boolean isReachable(DeviceId deviceId) { |
jiangrui | 8356361 | 2015-11-16 11:59:47 +0800 | [diff] [blame] | 131 | OvsdbClientService ovsdbClient = controller.getOvsdbClient(changeDeviceIdToNodeId(deviceId)); |
| 132 | return !(ovsdbClient == null || !ovsdbClient.isConnected()); |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | private class InnerOvsdbNodeListener implements OvsdbNodeListener { |
| 136 | |
| 137 | @Override |
| 138 | public void nodeAdded(OvsdbNodeId nodeId) { |
| 139 | checkNotNull(nodeId, ISNOTNULL); |
| 140 | DeviceId deviceId = DeviceId.deviceId(nodeId.toString()); |
| 141 | URI uri = URI.create(nodeId.toString()); |
| 142 | ChassisId cid = new ChassisId(); |
| 143 | String ipAddress = nodeId.getIpAddress(); |
| 144 | SparseAnnotations annotations = DefaultAnnotations.builder() |
| 145 | .set("ipaddress", ipAddress).build(); |
| 146 | DeviceDescription deviceDescription = new DefaultDeviceDescription( |
| 147 | uri, |
| 148 | Device.Type.CONTROLLER, |
| 149 | UNKNOWN, UNKNOWN, |
| 150 | UNKNOWN, UNKNOWN, |
| 151 | cid, |
| 152 | annotations); |
| 153 | providerService.deviceConnected(deviceId, deviceDescription); |
| 154 | |
| 155 | } |
| 156 | |
| 157 | @Override |
| 158 | public void nodeRemoved(OvsdbNodeId nodeId) { |
| 159 | checkNotNull(nodeId, ISNOTNULL); |
| 160 | DeviceId deviceId = DeviceId.deviceId(nodeId.toString()); |
| 161 | providerService.deviceDisconnected(deviceId); |
| 162 | |
| 163 | } |
| 164 | } |
jiangrui | 8356361 | 2015-11-16 11:59:47 +0800 | [diff] [blame] | 165 | |
| 166 | private OvsdbNodeId changeDeviceIdToNodeId(DeviceId deviceId) { |
| 167 | String[] strings = deviceId.toString().split(":"); |
| 168 | if (strings.length < 1) { |
| 169 | return null; |
| 170 | } |
| 171 | return new OvsdbNodeId(IpAddress.valueOf(strings[1]), 0); |
| 172 | } |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 173 | |
| 174 | @Override |
| 175 | public void changePortState(DeviceId deviceId, PortNumber portNumber, |
| 176 | boolean enable) { |
| 177 | // TODO if required |
| 178 | } |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 179 | |
| 180 | private void discoverPorts(DeviceId deviceId) { |
| 181 | Device device = deviceService.getDevice(deviceId); |
| 182 | if (device.is(DeviceDescriptionDiscovery.class)) { |
| 183 | DeviceDescriptionDiscovery deviceDescriptionDiscovery = device.as(DeviceDescriptionDiscovery.class); |
| 184 | providerService.updatePorts(deviceId, deviceDescriptionDiscovery.discoverPortDetails()); |
| 185 | } else { |
| 186 | log.warn("Device " + deviceId + " does not support behaviour DeviceDescriptionDiscovery"); |
| 187 | } |
| 188 | } |
| 189 | |
| 190 | private class InternalDeviceListener implements DeviceListener { |
| 191 | @Override |
| 192 | public void event(DeviceEvent event) { |
| 193 | DeviceId deviceId = event.subject().id(); |
Rafal Szalecki | d4e07f4 | 2017-10-05 16:18:39 +0200 | [diff] [blame] | 194 | |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 195 | if ((event.type() == DeviceEvent.Type.DEVICE_ADDED)) { |
| 196 | executor.execute(() -> discoverPorts(deviceId)); |
Michal Mach | 49bdb613 | 2017-06-06 16:41:16 +0200 | [diff] [blame] | 197 | } else if ((event.type() == DeviceEvent.Type.DEVICE_REMOVED)) { |
| 198 | log.debug("removing device {}", event.subject().id()); |
| 199 | OvsdbNodeId ovsdbNodeId = changeDeviceIdToNodeId(deviceId); |
| 200 | OvsdbClientService client = controller.getOvsdbClient(ovsdbNodeId); |
| 201 | if (client != null) { |
| 202 | client.disconnect(); |
| 203 | } |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 204 | } |
| 205 | } |
| 206 | |
| 207 | @Override |
| 208 | public boolean isRelevant(DeviceEvent event) { |
| 209 | DeviceId deviceId = event.subject().id(); |
| 210 | return isRelevant(deviceId) && mastershipService.isLocalMaster(deviceId); |
| 211 | } |
| 212 | |
| 213 | private boolean isRelevant(DeviceId deviceId) { |
| 214 | return deviceId.uri().getScheme().equals(SCHEME_NAME); |
| 215 | } |
| 216 | } |
| 217 | |
| 218 | private void waitForTasksToEnd() { |
| 219 | executor.shutdown(); |
| 220 | try { |
| 221 | executor.awaitTermination(5, TimeUnit.SECONDS); |
| 222 | } catch (InterruptedException e) { |
| 223 | log.error("Timeout while waiting for child threads to finish because: " + e.getMessage()); |
Ray Milkey | 5c7d488 | 2018-02-05 14:50:39 -0800 | [diff] [blame^] | 224 | Thread.currentThread().interrupt(); |
Michal Mach | 958adf6 | 2017-06-05 16:29:13 +0200 | [diff] [blame] | 225 | } |
| 226 | } |
YuanyouZhang | b5e0530 | 2015-07-21 20:14:35 +0800 | [diff] [blame] | 227 | } |