Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -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.newresource.impl; |
| 17 | |
Sho SHIMIZU | 2c7cecf | 2015-11-11 14:16:14 -0800 | [diff] [blame] | 18 | import com.google.common.collect.Lists; |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 19 | import org.onlab.packet.MplsLabel; |
| 20 | import org.onlab.packet.VlanId; |
| 21 | import org.onlab.util.ItemNotFoundException; |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 22 | import org.onosproject.net.DefaultOchSignalComparator; |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 23 | import org.onosproject.net.Device; |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 24 | import org.onosproject.net.DeviceId; |
Sho SHIMIZU | 08fdbd2 | 2015-08-19 16:59:35 -0700 | [diff] [blame] | 25 | import org.onosproject.net.Port; |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 26 | import org.onosproject.net.OchPort; |
HIGUCHI Yuta | d39e376 | 2015-12-04 09:43:16 -0800 | [diff] [blame] | 27 | import org.onosproject.net.OchSignal; |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 28 | import org.onosproject.net.PortNumber; |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 29 | import org.onosproject.net.TributarySlot; |
| 30 | import org.onosproject.net.OduSignalType; |
HIGUCHI Yuta | d39e376 | 2015-12-04 09:43:16 -0800 | [diff] [blame] | 31 | import org.onosproject.net.behaviour.LambdaQuery; |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 32 | import org.onosproject.net.behaviour.MplsQuery; |
| 33 | import org.onosproject.net.behaviour.VlanQuery; |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 34 | import org.onosproject.net.device.DeviceEvent; |
| 35 | import org.onosproject.net.device.DeviceListener; |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 36 | import org.onosproject.net.device.DeviceService; |
| 37 | import org.onosproject.net.driver.Driver; |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 38 | import org.onosproject.net.driver.DriverHandler; |
| 39 | import org.onosproject.net.driver.DriverService; |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 40 | import org.onosproject.net.newresource.ResourceAdminService; |
| 41 | import org.onosproject.net.newresource.ResourcePath; |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 42 | import org.slf4j.Logger; |
| 43 | import org.slf4j.LoggerFactory; |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 44 | |
HIGUCHI Yuta | d39e376 | 2015-12-04 09:43:16 -0800 | [diff] [blame] | 45 | import java.util.Collections; |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 46 | import java.util.List; |
HIGUCHI Yuta | d39e376 | 2015-12-04 09:43:16 -0800 | [diff] [blame] | 47 | import java.util.SortedSet; |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 48 | import java.util.concurrent.ExecutorService; |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 49 | import java.util.stream.Collectors; |
| 50 | import java.util.stream.IntStream; |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 51 | |
| 52 | import static com.google.common.base.Preconditions.checkNotNull; |
| 53 | |
| 54 | /** |
| 55 | * An implementation of DeviceListener registering devices as resources. |
| 56 | */ |
| 57 | final class ResourceDeviceListener implements DeviceListener { |
| 58 | |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 59 | private static final Logger log = LoggerFactory.getLogger(ResourceDeviceListener.class); |
| 60 | |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 61 | private static final int MAX_VLAN_ID = VlanId.MAX_VLAN; |
| 62 | private static final List<VlanId> ENTIRE_VLAN_IDS = getEntireVlans(); |
| 63 | |
HIGUCHI Yuta | 2cc93f4 | 2015-12-14 10:58:28 -0800 | [diff] [blame] | 64 | // Ref: http://www.iana.org/assignments/mpls-label-values/mpls-label-values.xhtml |
| 65 | // Smallest non-reserved MPLS label |
| 66 | private static final int MIN_UNRESERVED_LABEL = 0x10; |
| 67 | // Max non-reserved MPLS label = 239 |
| 68 | private static final int MAX_UNRESERVED_LABEL = 0xEF; |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 69 | private static final List<MplsLabel> ENTIRE_MPLS_LABELS = getEntireMplsLabels(); |
| 70 | |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 71 | private static final int TOTAL_ODU2_TRIBUTARY_SLOTS = 8; |
| 72 | private static final int TOTAL_ODU4_TRIBUTARY_SLOTS = 80; |
| 73 | private static final List<TributarySlot> ENTIRE_ODU2_TRIBUTARY_SLOTS = getEntireOdu2TributarySlots(); |
| 74 | private static final List<TributarySlot> ENTIRE_ODU4_TRIBUTARY_SLOTS = getEntireOdu4TributarySlots(); |
| 75 | |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 76 | private final ResourceAdminService adminService; |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 77 | private final DeviceService deviceService; |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 78 | private final DriverService driverService; |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 79 | private final ExecutorService executor; |
| 80 | |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 81 | |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 82 | /** |
| 83 | * Creates an instance with the specified ResourceAdminService and ExecutorService. |
| 84 | * |
| 85 | * @param adminService instance invoked to register resources |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 86 | * @param deviceService {@link DeviceService} to be used. |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 87 | * @param executor executor used for processing resource registration |
| 88 | */ |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 89 | ResourceDeviceListener(ResourceAdminService adminService, DeviceService deviceService, DriverService driverService, |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 90 | ExecutorService executor) { |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 91 | this.adminService = checkNotNull(adminService); |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 92 | this.deviceService = checkNotNull(deviceService); |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 93 | this.driverService = checkNotNull(driverService); |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 94 | this.executor = checkNotNull(executor); |
| 95 | } |
| 96 | |
| 97 | @Override |
| 98 | public void event(DeviceEvent event) { |
| 99 | Device device = event.subject(); |
| 100 | switch (event.type()) { |
| 101 | case DEVICE_ADDED: |
| 102 | registerDeviceResource(device); |
| 103 | break; |
Sho SHIMIZU | e60a5ab | 2015-08-20 11:51:49 -0700 | [diff] [blame] | 104 | case DEVICE_REMOVED: |
| 105 | unregisterDeviceResource(device); |
| 106 | break; |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 107 | case DEVICE_AVAILABILITY_CHANGED: |
| 108 | if (deviceService.isAvailable(device.id())) { |
| 109 | registerDeviceResource(device); |
| 110 | // TODO: do we need to walk the ports? |
| 111 | } else { |
| 112 | unregisterDeviceResource(device); |
| 113 | } |
| 114 | break; |
Sho SHIMIZU | 08fdbd2 | 2015-08-19 16:59:35 -0700 | [diff] [blame] | 115 | case PORT_ADDED: |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 116 | case PORT_UPDATED: |
| 117 | if (event.port().isEnabled()) { |
| 118 | registerPortResource(device, event.port()); |
| 119 | } else { |
| 120 | unregisterPortResource(device, event.port()); |
| 121 | } |
Sho SHIMIZU | c2ddedd | 2015-08-20 11:54:29 -0700 | [diff] [blame] | 122 | break; |
Sho SHIMIZU | e229284 | 2015-08-20 11:59:23 -0700 | [diff] [blame] | 123 | case PORT_REMOVED: |
| 124 | unregisterPortResource(device, event.port()); |
| 125 | break; |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 126 | default: |
| 127 | break; |
| 128 | } |
| 129 | } |
| 130 | |
| 131 | private void registerDeviceResource(Device device) { |
Sho SHIMIZU | 2c7cecf | 2015-11-11 14:16:14 -0800 | [diff] [blame] | 132 | executor.submit(() -> adminService.registerResources(ResourcePath.discrete(device.id()))); |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 133 | } |
Sho SHIMIZU | 08fdbd2 | 2015-08-19 16:59:35 -0700 | [diff] [blame] | 134 | |
Sho SHIMIZU | e60a5ab | 2015-08-20 11:51:49 -0700 | [diff] [blame] | 135 | private void unregisterDeviceResource(Device device) { |
Sho SHIMIZU | 2c7cecf | 2015-11-11 14:16:14 -0800 | [diff] [blame] | 136 | executor.submit(() -> adminService.unregisterResources(ResourcePath.discrete(device.id()))); |
Sho SHIMIZU | e60a5ab | 2015-08-20 11:51:49 -0700 | [diff] [blame] | 137 | } |
| 138 | |
Sho SHIMIZU | 08fdbd2 | 2015-08-19 16:59:35 -0700 | [diff] [blame] | 139 | private void registerPortResource(Device device, Port port) { |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 140 | ResourcePath portPath = ResourcePath.discrete(device.id(), port.number()); |
Sho SHIMIZU | 2c7cecf | 2015-11-11 14:16:14 -0800 | [diff] [blame] | 141 | executor.submit(() -> { |
| 142 | adminService.registerResources(portPath); |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 143 | |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 144 | // for VLAN IDs |
| 145 | if (isVlanEnabled(device.id(), port.number())) { |
| 146 | adminService.registerResources(Lists.transform(ENTIRE_VLAN_IDS, portPath::child)); |
| 147 | } |
| 148 | |
| 149 | // for MPLS labels |
| 150 | if (isMplsEnabled(device.id(), port.number())) { |
| 151 | adminService.registerResources(Lists.transform(ENTIRE_MPLS_LABELS, portPath::child)); |
| 152 | } |
| 153 | |
HIGUCHI Yuta | d39e376 | 2015-12-04 09:43:16 -0800 | [diff] [blame] | 154 | // for Lambdas |
| 155 | SortedSet<OchSignal> lambdas = queryLambdas(device.id(), port.number()); |
| 156 | if (!lambdas.isEmpty()) { |
| 157 | adminService.registerResources(lambdas.stream() |
| 158 | .map(portPath::child) |
| 159 | .collect(Collectors.toList())); |
| 160 | } |
| 161 | |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 162 | // for Tributary slots |
| 163 | // TODO: need to define Behaviour to make a query about OCh port |
Sho SHIMIZU | 2c7cecf | 2015-11-11 14:16:14 -0800 | [diff] [blame] | 164 | switch (port.type()) { |
| 165 | case OCH: |
| 166 | // register ODU TributarySlots against the OCH port |
| 167 | registerTributarySlotsResources(((OchPort) port).signalType(), portPath); |
| 168 | break; |
| 169 | default: |
| 170 | break; |
| 171 | } |
| 172 | }); |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | private void registerTributarySlotsResources(OduSignalType oduSignalType, ResourcePath portPath) { |
| 176 | switch (oduSignalType) { |
| 177 | case ODU2: |
Sho SHIMIZU | 2c7cecf | 2015-11-11 14:16:14 -0800 | [diff] [blame] | 178 | adminService.registerResources(Lists.transform(ENTIRE_ODU2_TRIBUTARY_SLOTS, portPath::child)); |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 179 | break; |
| 180 | case ODU4: |
Sho SHIMIZU | 2c7cecf | 2015-11-11 14:16:14 -0800 | [diff] [blame] | 181 | adminService.registerResources(Lists.transform(ENTIRE_ODU4_TRIBUTARY_SLOTS, portPath::child)); |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 182 | break; |
| 183 | default: |
| 184 | break; |
| 185 | } |
Sho SHIMIZU | 08fdbd2 | 2015-08-19 16:59:35 -0700 | [diff] [blame] | 186 | } |
Sho SHIMIZU | e229284 | 2015-08-20 11:59:23 -0700 | [diff] [blame] | 187 | |
| 188 | private void unregisterPortResource(Device device, Port port) { |
Sho SHIMIZU | 2c7cecf | 2015-11-11 14:16:14 -0800 | [diff] [blame] | 189 | ResourcePath resource = ResourcePath.discrete(device.id(), port.number()); |
| 190 | executor.submit(() -> adminService.unregisterResources(resource)); |
Sho SHIMIZU | e229284 | 2015-08-20 11:59:23 -0700 | [diff] [blame] | 191 | } |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 192 | |
HIGUCHI Yuta | d39e376 | 2015-12-04 09:43:16 -0800 | [diff] [blame] | 193 | private SortedSet<OchSignal> queryLambdas(DeviceId did, PortNumber port) { |
| 194 | try { |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 195 | // DriverHandler does not provide a way to check if a |
| 196 | // behaviour is supported. |
| 197 | Driver driver = driverService.getDriver(did); |
| 198 | if (driver == null || !driver.hasBehaviour(LambdaQuery.class)) { |
| 199 | return Collections.emptySortedSet(); |
| 200 | } |
HIGUCHI Yuta | d39e376 | 2015-12-04 09:43:16 -0800 | [diff] [blame] | 201 | DriverHandler handler = driverService.createHandler(did); |
| 202 | if (handler == null) { |
| 203 | return Collections.emptySortedSet(); |
| 204 | } |
| 205 | LambdaQuery query = handler.behaviour(LambdaQuery.class); |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 206 | if (query != null) { |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 207 | return query.queryLambdas(port).stream() |
| 208 | .flatMap(x -> OchSignal.toFlexGrid(x).stream()) |
Marc De Leenheer | cef4555 | 2015-12-14 19:59:59 -0800 | [diff] [blame] | 209 | .collect(Collectors.toCollection(DefaultOchSignalComparator::newOchSignalTreeSet)); |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 210 | } else { |
| 211 | return Collections.emptySortedSet(); |
| 212 | } |
HIGUCHI Yuta | d39e376 | 2015-12-04 09:43:16 -0800 | [diff] [blame] | 213 | } catch (ItemNotFoundException e) { |
| 214 | return Collections.emptySortedSet(); |
| 215 | } |
| 216 | } |
| 217 | |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 218 | private boolean isVlanEnabled(DeviceId device, PortNumber port) { |
| 219 | try { |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 220 | // DriverHandler does not provide a way to check if a |
| 221 | // behaviour is supported. |
| 222 | Driver driver = driverService.getDriver(device); |
| 223 | if (driver == null || !driver.hasBehaviour(VlanQuery.class)) { |
| 224 | // device does not support this |
| 225 | return false; |
| 226 | } |
| 227 | |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 228 | DriverHandler handler = driverService.createHandler(device); |
| 229 | if (handler == null) { |
| 230 | return false; |
| 231 | } |
| 232 | |
| 233 | VlanQuery query = handler.behaviour(VlanQuery.class); |
| 234 | return query != null && query.isEnabled(port); |
| 235 | } catch (ItemNotFoundException e) { |
| 236 | return false; |
| 237 | } |
| 238 | } |
| 239 | |
| 240 | private boolean isMplsEnabled(DeviceId device, PortNumber port) { |
| 241 | try { |
HIGUCHI Yuta | 11d1609 | 2015-12-04 23:35:43 -0800 | [diff] [blame] | 242 | // DriverHandler does not provide a way to check if a |
| 243 | // behaviour is supported. |
| 244 | Driver driver = driverService.getDriver(device); |
| 245 | if (driver == null || !driver.hasBehaviour(MplsQuery.class)) { |
| 246 | // device does not support this |
| 247 | return false; |
| 248 | } |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 249 | DriverHandler handler = driverService.createHandler(device); |
| 250 | if (handler == null) { |
| 251 | return false; |
| 252 | } |
| 253 | |
| 254 | MplsQuery query = handler.behaviour(MplsQuery.class); |
| 255 | return query != null && query.isEnabled(port); |
| 256 | } catch (ItemNotFoundException e) { |
| 257 | return false; |
| 258 | } |
| 259 | } |
| 260 | |
| 261 | private static List<VlanId> getEntireVlans() { |
| 262 | return IntStream.range(0, MAX_VLAN_ID) |
| 263 | .mapToObj(x -> VlanId.vlanId((short) x)) |
| 264 | .collect(Collectors.toList()); |
| 265 | } |
| 266 | |
| 267 | private static List<MplsLabel> getEntireMplsLabels() { |
HIGUCHI Yuta | 2cc93f4 | 2015-12-14 10:58:28 -0800 | [diff] [blame] | 268 | return IntStream.range(MIN_UNRESERVED_LABEL, MAX_UNRESERVED_LABEL + 1) |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 269 | .mapToObj(MplsLabel::mplsLabel) |
| 270 | .collect(Collectors.toList()); |
| 271 | } |
| 272 | |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 273 | private static List<TributarySlot> getEntireOdu2TributarySlots() { |
| 274 | return IntStream.rangeClosed(1, TOTAL_ODU2_TRIBUTARY_SLOTS) |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 275 | .mapToObj(TributarySlot::of) |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 276 | .collect(Collectors.toList()); |
| 277 | } |
| 278 | private static List<TributarySlot> getEntireOdu4TributarySlots() { |
| 279 | return IntStream.rangeClosed(1, TOTAL_ODU4_TRIBUTARY_SLOTS) |
Sho SHIMIZU | 44f3761 | 2015-11-25 16:23:22 -0800 | [diff] [blame] | 280 | .mapToObj(TributarySlot::of) |
Rimon Ashkenazy | e2410ff | 2015-11-10 14:11:08 +0200 | [diff] [blame] | 281 | .collect(Collectors.toList()); |
| 282 | } |
Sho SHIMIZU | d97a950 | 2015-08-18 10:02:30 -0700 | [diff] [blame] | 283 | } |