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