Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 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.provider.general.device.impl; |
| 18 | |
| 19 | import com.google.common.annotations.Beta; |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 20 | import com.google.common.collect.Maps; |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 21 | import com.google.common.util.concurrent.Striped; |
| 22 | import gnmi.Gnmi.Notification; |
| 23 | import gnmi.Gnmi.Path; |
| 24 | import gnmi.Gnmi.PathElem; |
| 25 | import gnmi.Gnmi.SubscribeRequest; |
| 26 | import gnmi.Gnmi.Subscription; |
| 27 | import gnmi.Gnmi.SubscriptionList; |
| 28 | import gnmi.Gnmi.SubscriptionMode; |
| 29 | import gnmi.Gnmi.Update; |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 30 | import org.onosproject.gnmi.api.GnmiController; |
| 31 | import org.onosproject.gnmi.api.GnmiEvent; |
| 32 | import org.onosproject.gnmi.api.GnmiEventListener; |
| 33 | import org.onosproject.gnmi.api.GnmiUpdate; |
| 34 | import org.onosproject.gnmi.api.GnmiUtils; |
| 35 | import org.onosproject.mastership.MastershipEvent; |
| 36 | import org.onosproject.mastership.MastershipListener; |
| 37 | import org.onosproject.mastership.MastershipService; |
Yi Tseng | 59d5f3e | 2018-11-27 23:09:41 -0800 | [diff] [blame] | 38 | import org.onosproject.net.DefaultAnnotations; |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 39 | import org.onosproject.net.DeviceId; |
| 40 | import org.onosproject.net.Port; |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 41 | import org.onosproject.net.PortNumber; |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 42 | import org.onosproject.net.device.DefaultPortDescription; |
| 43 | import org.onosproject.net.device.DeviceEvent; |
| 44 | import org.onosproject.net.device.DeviceListener; |
| 45 | import org.onosproject.net.device.DeviceProviderService; |
| 46 | import org.onosproject.net.device.DeviceService; |
| 47 | import org.onosproject.net.device.PortDescription; |
| 48 | import org.slf4j.Logger; |
| 49 | import org.slf4j.LoggerFactory; |
| 50 | |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 51 | import java.util.List; |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 52 | import java.util.Map; |
| 53 | import java.util.Objects; |
| 54 | import java.util.Set; |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 55 | import java.util.concurrent.ExecutorService; |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 56 | import java.util.concurrent.locks.Lock; |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 57 | import java.util.stream.Collectors; |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 58 | |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 59 | import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
| 60 | import static org.onlab.util.Tools.groupedThreads; |
| 61 | |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 62 | /** |
| 63 | * Entity that manages gNMI subscription for devices using OpenConfig models and |
| 64 | * that reports relevant events to the core. |
| 65 | */ |
| 66 | @Beta |
| 67 | class GnmiDeviceStateSubscriber { |
| 68 | |
pierventre | 50696a7 | 2021-06-01 12:26:36 +0200 | [diff] [blame] | 69 | private static final String LAST_CHANGE = "last-change"; |
Yi Tseng | 59d5f3e | 2018-11-27 23:09:41 -0800 | [diff] [blame] | 70 | |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 71 | private static Logger log = LoggerFactory.getLogger(GnmiDeviceStateSubscriber.class); |
| 72 | |
| 73 | private final GnmiController gnmiController; |
| 74 | private final DeviceService deviceService; |
| 75 | private final DeviceProviderService providerService; |
| 76 | private final MastershipService mastershipService; |
| 77 | |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 78 | private final InternalGnmiEventListener gnmiEventListener = new InternalGnmiEventListener(); |
| 79 | private final InternalDeviceListener deviceEventListener = new InternalDeviceListener(); |
| 80 | private final InternalMastershipListener mastershipListener = new InternalMastershipListener(); |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 81 | private final Map<DeviceId, Set<PortNumber>> deviceSubscribed = Maps.newHashMap(); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 82 | |
| 83 | private final Striped<Lock> deviceLocks = Striped.lock(30); |
| 84 | |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 85 | private ExecutorService eventExecutor; |
| 86 | |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 87 | GnmiDeviceStateSubscriber(GnmiController gnmiController, DeviceService deviceService, |
| 88 | MastershipService mastershipService, |
| 89 | DeviceProviderService providerService) { |
| 90 | this.gnmiController = gnmiController; |
| 91 | this.deviceService = deviceService; |
| 92 | this.mastershipService = mastershipService; |
| 93 | this.providerService = providerService; |
| 94 | } |
| 95 | |
| 96 | public void activate() { |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 97 | eventExecutor = newSingleThreadScheduledExecutor(groupedThreads( |
| 98 | "onos/gnmi", "events-%d", log)); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 99 | deviceService.addListener(deviceEventListener); |
| 100 | mastershipService.addListener(mastershipListener); |
| 101 | gnmiController.addListener(gnmiEventListener); |
| 102 | // Subscribe to existing devices. |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 103 | deviceService.getDevices().forEach(d -> checkSubscription(d.id())); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | public void deactivate() { |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 107 | deviceSubscribed.keySet().forEach(this::unsubscribeIfNeeded); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 108 | deviceService.removeListener(deviceEventListener); |
| 109 | mastershipService.removeListener(mastershipListener); |
| 110 | gnmiController.removeListener(gnmiEventListener); |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 111 | eventExecutor.shutdownNow(); |
| 112 | eventExecutor = null; |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 113 | } |
| 114 | |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 115 | private void checkSubscription(DeviceId deviceId) { |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 116 | if (gnmiController.get(deviceId) == null) { |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 117 | // Ignore devices for which a gNMI client does not exist. |
| 118 | return; |
| 119 | } |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 120 | deviceLocks.get(deviceId).lock(); |
| 121 | try { |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 122 | if (shouldHaveSubscription(deviceId)) { |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 123 | subscribeIfNeeded(deviceId); |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 124 | } else { |
| 125 | unsubscribeIfNeeded(deviceId); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 126 | } |
| 127 | } finally { |
| 128 | deviceLocks.get(deviceId).unlock(); |
| 129 | } |
| 130 | } |
| 131 | |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 132 | private boolean shouldHaveSubscription(DeviceId deviceId) { |
| 133 | return deviceService.getDevice(deviceId) != null |
| 134 | && deviceService.isAvailable(deviceId) |
| 135 | && mastershipService.isLocalMaster(deviceId) |
| 136 | && !deviceService.getPorts(deviceId).isEmpty(); |
| 137 | } |
| 138 | |
pierventre | 50696a7 | 2021-06-01 12:26:36 +0200 | [diff] [blame] | 139 | private Path interfaceStatePath(String interfaceName) { |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 140 | return Path.newBuilder() |
| 141 | .addElem(PathElem.newBuilder().setName("interfaces").build()) |
| 142 | .addElem(PathElem.newBuilder() |
| 143 | .setName("interface").putKey("name", interfaceName).build()) |
| 144 | .addElem(PathElem.newBuilder().setName("state").build()) |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 145 | .build(); |
| 146 | } |
| 147 | |
| 148 | private void unsubscribeIfNeeded(DeviceId deviceId) { |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 149 | gnmiController.get(deviceId).unsubscribe(); |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 150 | if (deviceSubscribed.remove(deviceId) != null) { |
| 151 | log.info("Cancelled gNMI subscription for {}", deviceId); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 152 | } |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | private void subscribeIfNeeded(DeviceId deviceId) { |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 156 | |
| 157 | Set<PortNumber> ports = deviceService.getPorts(deviceId).stream() |
| 158 | .map(Port::number) |
| 159 | .collect(Collectors.toSet()); |
| 160 | |
| 161 | if (Objects.equals(ports, deviceSubscribed.get(deviceId))) { |
| 162 | // Already subscribed for the same ports. |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 163 | return; |
| 164 | } |
| 165 | |
Carmelo Cascone | 67a317d | 2019-03-18 17:08:22 -0700 | [diff] [blame] | 166 | // Subscribe for the new set of ports. |
| 167 | deviceSubscribed.put(deviceId, ports); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 168 | |
Carmelo Cascone | 67a317d | 2019-03-18 17:08:22 -0700 | [diff] [blame] | 169 | // Send subscription request. |
| 170 | final SubscriptionList subscriptionList = SubscriptionList.newBuilder() |
| 171 | .setMode(SubscriptionList.Mode.STREAM) |
| 172 | .setUpdatesOnly(true) |
| 173 | .addAllSubscription(ports.stream().map( |
| 174 | port -> Subscription.newBuilder() |
pierventre | 50696a7 | 2021-06-01 12:26:36 +0200 | [diff] [blame] | 175 | .setPath(interfaceStatePath(port.name())) |
Carmelo Cascone | 67a317d | 2019-03-18 17:08:22 -0700 | [diff] [blame] | 176 | .setMode(SubscriptionMode.ON_CHANGE) |
| 177 | .build()).collect(Collectors.toList())) |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 178 | .build(); |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 179 | gnmiController.get(deviceId).subscribe( |
Carmelo Cascone | 67a317d | 2019-03-18 17:08:22 -0700 | [diff] [blame] | 180 | SubscribeRequest.newBuilder() |
| 181 | .setSubscribe(subscriptionList) |
| 182 | .build()); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 183 | |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 184 | log.info("Started gNMI subscription for {} ports on {}", ports.size(), deviceId); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | private void handleGnmiUpdate(GnmiUpdate eventSubject) { |
| 188 | Notification notification = eventSubject.update(); |
| 189 | if (notification == null) { |
| 190 | log.warn("Cannot handle gNMI event without update data, abort"); |
| 191 | log.debug("gNMI update:\n{}", eventSubject); |
| 192 | return; |
| 193 | } |
| 194 | |
pierventre | 50696a7 | 2021-06-01 12:26:36 +0200 | [diff] [blame] | 195 | long lastChange = 0; |
| 196 | Update statusUpdate = null; |
| 197 | Path path; |
| 198 | PathElem lastElem; |
| 199 | // The assumption is that the notification contains all the updates: |
| 200 | // last-change, oper-status, counters, and so on. Otherwise, we need |
| 201 | // to put in place the aggregation logic in ONOS |
| 202 | for (Update update : notification.getUpdateList()) { |
| 203 | path = update.getPath(); |
| 204 | lastElem = path.getElem(path.getElemCount() - 1); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 205 | |
| 206 | // Use last element to identify which state updated |
| 207 | if ("oper-status".equals(lastElem.getName())) { |
pierventre | 50696a7 | 2021-06-01 12:26:36 +0200 | [diff] [blame] | 208 | statusUpdate = update; |
| 209 | } else if ("last-change".equals(lastElem.getName())) { |
| 210 | lastChange = update.getVal().getUintVal(); |
| 211 | } else if (log.isDebugEnabled()) { |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 212 | log.debug("Unrecognized update {}", GnmiUtils.pathToString(path)); |
| 213 | } |
pierventre | 50696a7 | 2021-06-01 12:26:36 +0200 | [diff] [blame] | 214 | } |
| 215 | |
| 216 | // Last-change could be not supported by the device |
| 217 | // Cannot proceed without the status update. |
| 218 | if (statusUpdate != null) { |
| 219 | handleOperStatusUpdate(eventSubject.deviceId(), statusUpdate, lastChange); |
| 220 | } |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 221 | } |
| 222 | |
Yi Tseng | 59d5f3e | 2018-11-27 23:09:41 -0800 | [diff] [blame] | 223 | private void handleOperStatusUpdate(DeviceId deviceId, Update update, long timestamp) { |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 224 | Path path = update.getPath(); |
| 225 | // first element should be "interface" |
| 226 | String interfaceName = path.getElem(1).getKeyOrDefault("name", null); |
| 227 | if (interfaceName == null) { |
| 228 | log.error("No interface present in gNMI update, abort"); |
| 229 | log.debug("gNMI update:\n{}", update); |
| 230 | return; |
| 231 | } |
| 232 | |
| 233 | List<Port> portsFromDevice = deviceService.getPorts(deviceId); |
| 234 | portsFromDevice.forEach(port -> { |
| 235 | if (!port.number().name().equals(interfaceName)) { |
| 236 | return; |
| 237 | } |
| 238 | |
Yi Tseng | 59d5f3e | 2018-11-27 23:09:41 -0800 | [diff] [blame] | 239 | DefaultAnnotations portAnnotations = DefaultAnnotations.builder() |
| 240 | .putAll(port.annotations()) |
| 241 | .set(LAST_CHANGE, String.valueOf(timestamp)) |
| 242 | .build(); |
| 243 | |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 244 | // Port/Interface name is identical in OpenConfig model, but not in ONOS |
| 245 | // This might cause some problem if we use one name to different port |
| 246 | PortDescription portDescription = DefaultPortDescription.builder() |
| 247 | .portSpeed(port.portSpeed()) |
| 248 | .withPortNumber(port.number()) |
| 249 | .isEnabled(update.getVal().getStringVal().equals("UP")) |
| 250 | .type(port.type()) |
Yi Tseng | 59d5f3e | 2018-11-27 23:09:41 -0800 | [diff] [blame] | 251 | .annotations(portAnnotations) |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 252 | .build(); |
| 253 | providerService.portStatusChanged(deviceId, portDescription); |
| 254 | }); |
| 255 | } |
| 256 | |
| 257 | class InternalGnmiEventListener implements GnmiEventListener { |
| 258 | |
| 259 | @Override |
| 260 | public void event(GnmiEvent event) { |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 261 | eventExecutor.execute(() -> { |
| 262 | if (!deviceSubscribed.containsKey(event.subject().deviceId())) { |
| 263 | log.warn("Received gNMI event from {}, but we did'nt expect to " + |
| 264 | "be subscribed to it! Discarding event...", |
| 265 | event.subject().deviceId()); |
| 266 | return; |
| 267 | } |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 268 | |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 269 | log.debug("Received gNMI event {}", event.toString()); |
| 270 | if (event.type() == GnmiEvent.Type.UPDATE) { |
| 271 | handleGnmiUpdate((GnmiUpdate) event.subject()); |
| 272 | } else { |
| 273 | log.debug("Unsupported gNMI event type: {}", event.type()); |
| 274 | } |
| 275 | }); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 276 | } |
| 277 | } |
| 278 | |
| 279 | class InternalMastershipListener implements MastershipListener { |
| 280 | |
| 281 | @Override |
| 282 | public void event(MastershipEvent event) { |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 283 | eventExecutor.execute(() -> checkSubscription(event.subject())); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 284 | } |
| 285 | } |
| 286 | |
| 287 | class InternalDeviceListener implements DeviceListener { |
| 288 | |
| 289 | @Override |
| 290 | public void event(DeviceEvent event) { |
pierventre | 52ef933 | 2021-07-09 22:42:17 +0200 | [diff] [blame] | 291 | eventExecutor.execute(() -> { |
| 292 | switch (event.type()) { |
| 293 | case DEVICE_ADDED: |
| 294 | case DEVICE_AVAILABILITY_CHANGED: |
| 295 | case DEVICE_UPDATED: |
| 296 | case DEVICE_REMOVED: |
| 297 | case PORT_ADDED: |
| 298 | case PORT_REMOVED: |
| 299 | checkSubscription(event.subject().id()); |
| 300 | break; |
| 301 | default: |
| 302 | break; |
| 303 | } |
| 304 | }); |
Yi Tseng | e616d75 | 2018-11-27 10:53:27 -0800 | [diff] [blame] | 305 | } |
| 306 | } |
| 307 | } |