Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [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 | |
Jonathan Hart | f4bd048 | 2017-01-27 15:11:18 -0800 | [diff] [blame] | 17 | package org.onosproject.routing; |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 18 | |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 19 | import com.google.common.collect.Sets; |
Ray Milkey | facf286 | 2017-08-03 11:58:29 -0700 | [diff] [blame] | 20 | import org.onosproject.net.intf.Interface; |
| 21 | import org.onosproject.net.intf.InterfaceEvent; |
| 22 | import org.onosproject.net.intf.InterfaceListener; |
| 23 | import org.onosproject.net.intf.InterfaceService; |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 24 | import org.onosproject.net.DeviceId; |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 25 | import org.onosproject.net.device.DeviceService; |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 26 | import org.slf4j.Logger; |
| 27 | import org.slf4j.LoggerFactory; |
| 28 | |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 29 | import java.util.HashSet; |
| 30 | import java.util.Set; |
| 31 | import java.util.function.Consumer; |
| 32 | import java.util.stream.Stream; |
| 33 | |
| 34 | import static com.google.common.base.Preconditions.checkNotNull; |
| 35 | |
| 36 | /** |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 37 | * Manages the configuration and provisioning of a single-device router. |
| 38 | * It maintains which interfaces are part of the router when the configuration |
| 39 | * changes, and handles the provisioning/unprovisioning of interfaces when they |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 40 | * are added/removed. |
| 41 | */ |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 42 | public class Router { |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 43 | |
| 44 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 45 | |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 46 | private final Consumer<InterfaceProvisionRequest> provisioner; |
| 47 | private final Consumer<InterfaceProvisionRequest> unprovisioner; |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 48 | |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 49 | private RouterInfo info; |
| 50 | |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 51 | private Set<Interface> provisioned = new HashSet<>(); |
| 52 | |
| 53 | private InterfaceService interfaceService; |
| 54 | private InterfaceListener listener = new InternalInterfaceListener(); |
| 55 | |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 56 | private DeviceService deviceService; |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 57 | |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 58 | private AsyncDeviceFetcher asyncDeviceFetcher; |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 59 | |
| 60 | /** |
| 61 | * Creates a new router interface manager. |
| 62 | * |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 63 | * @param info router configuration information |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 64 | * @param interfaceService interface service |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 65 | * @param deviceService device service |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 66 | * @param provisioner consumer that will provision new interfaces |
| 67 | * @param unprovisioner consumer that will unprovision old interfaces |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 68 | * @param forceUnprovision force unprovision when the device goes offline |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 69 | */ |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 70 | public Router(RouterInfo info, |
| 71 | InterfaceService interfaceService, |
| 72 | DeviceService deviceService, |
| 73 | Consumer<InterfaceProvisionRequest> provisioner, |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 74 | Consumer<InterfaceProvisionRequest> unprovisioner, |
| 75 | boolean forceUnprovision) { |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 76 | this.info = checkNotNull(info); |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 77 | this.provisioner = checkNotNull(provisioner); |
| 78 | this.unprovisioner = checkNotNull(unprovisioner); |
| 79 | this.interfaceService = checkNotNull(interfaceService); |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 80 | this.deviceService = checkNotNull(deviceService); |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 81 | |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 82 | this.asyncDeviceFetcher = AsyncDeviceFetcher.create(deviceService); |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 83 | if (forceUnprovision) { |
| 84 | asyncDeviceFetcher.registerCallback(info.deviceId(), this::provision, this::forceUnprovision); |
| 85 | } else { |
| 86 | asyncDeviceFetcher.registerCallback(info.deviceId(), this::provision, null); |
| 87 | } |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 88 | |
| 89 | interfaceService.addListener(listener); |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Cleans up the router and unprovisions all interfaces. |
| 94 | */ |
| 95 | public void cleanup() { |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 96 | asyncDeviceFetcher.shutdown(); |
| 97 | |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 98 | interfaceService.removeListener(listener); |
Jonathan Hart | 60e7f51 | 2017-02-10 10:24:24 -0800 | [diff] [blame] | 99 | asyncDeviceFetcher.shutdown(); |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 100 | |
| 101 | unprovision(); |
| 102 | } |
| 103 | |
| 104 | /** |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 105 | * Retrieves the router configuration information. |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 106 | * |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 107 | * @return router configuration information |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 108 | */ |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 109 | public RouterInfo info() { |
| 110 | return info; |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | /** |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 114 | * Changes the router configuration. |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 115 | * |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 116 | * @param newConfig new configuration |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 117 | * @param forceUnprovision true if we want to force unprovision the device when it goes offline |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 118 | */ |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 119 | public void changeConfiguration(RouterInfo newConfig, boolean forceUnprovision) { |
| 120 | if (forceUnprovision) { |
| 121 | asyncDeviceFetcher.registerCallback(info.deviceId(), this::provision, this::forceUnprovision); |
| 122 | } else { |
| 123 | asyncDeviceFetcher.registerCallback(info.deviceId(), this::provision, null); |
| 124 | } |
| 125 | |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 126 | Set<String> oldConfiguredInterfaces = info.interfaces(); |
| 127 | info = newConfig; |
| 128 | Set<String> newConfiguredInterfaces = info.interfaces(); |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 129 | |
| 130 | if (newConfiguredInterfaces.isEmpty() && !oldConfiguredInterfaces.isEmpty()) { |
| 131 | // Reverted to using all interfaces. Provision interfaces that |
| 132 | // weren't previously in the configured list |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 133 | getInterfacesForDevice(info.deviceId()) |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 134 | .filter(intf -> !oldConfiguredInterfaces.contains(intf.name())) |
| 135 | .forEach(this::provision); |
| 136 | } else if (!newConfiguredInterfaces.isEmpty() && oldConfiguredInterfaces.isEmpty()) { |
| 137 | // Began using an interface list. Unprovision interfaces that |
| 138 | // are not in the new interface list. |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 139 | getInterfacesForDevice(info.deviceId()) |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 140 | .filter(intf -> !newConfiguredInterfaces.contains(intf.name())) |
| 141 | .forEach(this::unprovision); |
| 142 | } else { |
| 143 | // The existing interface list was changed. |
| 144 | Set<String> toUnprovision = Sets.difference(oldConfiguredInterfaces, newConfiguredInterfaces); |
| 145 | Set<String> toProvision = Sets.difference(newConfiguredInterfaces, oldConfiguredInterfaces); |
| 146 | |
| 147 | toUnprovision.forEach(name -> |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 148 | getInterfacesForDevice(info.deviceId()) |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 149 | .filter(intf -> intf.name().equals(name)) |
| 150 | .findFirst() |
| 151 | .ifPresent(this::unprovision) |
| 152 | ); |
| 153 | |
| 154 | toProvision.forEach(name -> |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 155 | getInterfacesForDevice(info.deviceId()) |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 156 | .filter(intf -> intf.name().equals(name)) |
| 157 | .findFirst() |
| 158 | .ifPresent(this::provision) |
| 159 | ); |
| 160 | } |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | private void provision() { |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 164 | getInterfacesForDevice(info.deviceId()) |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 165 | .forEach(this::provision); |
| 166 | } |
| 167 | |
| 168 | private void unprovision() { |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 169 | getInterfacesForDevice(info.deviceId()) |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 170 | .forEach(this::unprovision); |
| 171 | } |
| 172 | |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 173 | private void forceUnprovision() { |
| 174 | getInterfacesForDevice(info.deviceId()) |
| 175 | .forEach(this::forceUnprovision); |
| 176 | } |
| 177 | |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 178 | private void provision(Interface intf) { |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 179 | if (!provisioned.contains(intf) && deviceAvailable(intf) && shouldProvision(intf)) { |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 180 | log.info("Provisioning interface {}", intf); |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 181 | provisioner.accept(InterfaceProvisionRequest.of(info, intf)); |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 182 | provisioned.add(intf); |
| 183 | } |
| 184 | } |
| 185 | |
| 186 | private void unprovision(Interface intf) { |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 187 | if (provisioned.contains(intf) && deviceAvailable(intf) && shouldProvision(intf)) { |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 188 | log.info("Unprovisioning interface {}", intf); |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 189 | unprovisioner.accept(InterfaceProvisionRequest.of(info, intf)); |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 190 | provisioned.remove(intf); |
| 191 | } |
| 192 | } |
| 193 | |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 194 | private void forceUnprovision(Interface intf) { |
| 195 | // Skip availability check when force unprovisioning an interface |
| 196 | if (provisioned.contains(intf) && shouldProvision(intf)) { |
| 197 | log.info("Unprovisioning interface {}", intf); |
| 198 | unprovisioner.accept(InterfaceProvisionRequest.of(info, intf)); |
| 199 | provisioned.remove(intf); |
| 200 | } |
| 201 | } |
| 202 | |
| 203 | private boolean deviceAvailable(Interface intf) { |
| 204 | return deviceService.isAvailable(intf.connectPoint().deviceId()); |
| 205 | } |
| 206 | |
Jonathan Hart | 249b4cf | 2017-02-03 18:02:58 -0800 | [diff] [blame] | 207 | private boolean shouldProvision(Interface intf) { |
Charles Chan | c6d227e | 2017-02-28 15:15:17 -0800 | [diff] [blame] | 208 | return info.interfaces().isEmpty() || info.interfaces().contains(intf.name()); |
Jonathan Hart | f8cd052 | 2016-10-25 07:09:55 -0700 | [diff] [blame] | 209 | } |
| 210 | |
| 211 | private Stream<Interface> getInterfacesForDevice(DeviceId deviceId) { |
| 212 | return interfaceService.getInterfaces().stream() |
| 213 | .filter(intf -> intf.connectPoint().deviceId().equals(deviceId)); |
| 214 | } |
| 215 | |
| 216 | private class InternalInterfaceListener implements InterfaceListener { |
| 217 | @Override |
| 218 | public void event(InterfaceEvent event) { |
| 219 | Interface intf = event.subject(); |
| 220 | switch (event.type()) { |
| 221 | case INTERFACE_ADDED: |
| 222 | provision(intf); |
| 223 | break; |
| 224 | case INTERFACE_UPDATED: |
| 225 | // TODO |
| 226 | break; |
| 227 | case INTERFACE_REMOVED: |
| 228 | unprovision(intf); |
| 229 | break; |
| 230 | default: |
| 231 | break; |
| 232 | } |
| 233 | } |
| 234 | } |
| 235 | } |