Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 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 | */ |
tom | be98831 | 2014-09-19 18:38:47 -0700 | [diff] [blame] | 16 | package org.onlab.onos.net.link.impl; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 17 | |
alshabib | df652ad | 2014-09-09 11:53:19 -0700 | [diff] [blame] | 18 | import static com.google.common.base.Preconditions.checkNotNull; |
| 19 | import static org.slf4j.LoggerFactory.getLogger; |
| 20 | |
| 21 | import java.util.Set; |
| 22 | |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Activate; |
| 24 | import org.apache.felix.scr.annotations.Component; |
| 25 | import org.apache.felix.scr.annotations.Deactivate; |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Reference; |
| 27 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 28 | import org.apache.felix.scr.annotations.Service; |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 29 | import org.onlab.onos.event.AbstractListenerRegistry; |
| 30 | import org.onlab.onos.event.EventDeliveryService; |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 31 | import org.onlab.onos.net.ConnectPoint; |
| 32 | import org.onlab.onos.net.DeviceId; |
| 33 | import org.onlab.onos.net.Link; |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 34 | import org.onlab.onos.net.MastershipRole; |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 35 | import org.onlab.onos.net.device.DeviceEvent; |
| 36 | import org.onlab.onos.net.device.DeviceListener; |
| 37 | import org.onlab.onos.net.device.DeviceService; |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 38 | import org.onlab.onos.net.link.LinkAdminService; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 39 | import org.onlab.onos.net.link.LinkDescription; |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 40 | import org.onlab.onos.net.link.LinkEvent; |
| 41 | import org.onlab.onos.net.link.LinkListener; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 42 | import org.onlab.onos.net.link.LinkProvider; |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 43 | import org.onlab.onos.net.link.LinkProviderRegistry; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 44 | import org.onlab.onos.net.link.LinkProviderService; |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 45 | import org.onlab.onos.net.link.LinkService; |
tom | 35c0dc3 | 2014-09-19 10:00:58 -0700 | [diff] [blame] | 46 | import org.onlab.onos.net.link.LinkStore; |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 47 | import org.onlab.onos.net.link.LinkStoreDelegate; |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 48 | import org.onlab.onos.net.provider.AbstractProviderRegistry; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 49 | import org.onlab.onos.net.provider.AbstractProviderService; |
| 50 | import org.slf4j.Logger; |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 51 | |
alshabib | df652ad | 2014-09-09 11:53:19 -0700 | [diff] [blame] | 52 | import com.google.common.collect.Sets; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * Provides basic implementation of the link SB & NB APIs. |
| 56 | */ |
| 57 | @Component(immediate = true) |
| 58 | @Service |
tom | 35c0dc3 | 2014-09-19 10:00:58 -0700 | [diff] [blame] | 59 | public class LinkManager |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 60 | extends AbstractProviderRegistry<LinkProvider, LinkProviderService> |
| 61 | implements LinkService, LinkAdminService, LinkProviderRegistry { |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 62 | |
| 63 | private static final String DEVICE_ID_NULL = "Device ID cannot be null"; |
| 64 | private static final String LINK_DESC_NULL = "Link description cannot be null"; |
| 65 | private static final String CONNECT_POINT_NULL = "Connection point cannot be null"; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 66 | |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 67 | private final Logger log = getLogger(getClass()); |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 68 | |
tom | b86066b | 2014-09-15 09:52:24 -0700 | [diff] [blame] | 69 | protected final AbstractListenerRegistry<LinkEvent, LinkListener> |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 70 | listenerRegistry = new AbstractListenerRegistry<>(); |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 71 | |
alshabib | b5522ff | 2014-09-29 19:20:00 -0700 | [diff] [blame] | 72 | private final LinkStoreDelegate delegate = new InternalStoreDelegate(); |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 73 | |
| 74 | private final DeviceListener deviceListener = new InternalDeviceListener(); |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 75 | |
| 76 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | 35c0dc3 | 2014-09-19 10:00:58 -0700 | [diff] [blame] | 77 | protected LinkStore store; |
| 78 | |
| 79 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 80 | protected DeviceService deviceService; |
tom | 4c6606f | 2014-09-07 11:11:21 -0700 | [diff] [blame] | 81 | |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 82 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | 0d39526 | 2014-09-07 16:53:40 -0700 | [diff] [blame] | 83 | protected EventDeliveryService eventDispatcher; |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 84 | |
| 85 | @Activate |
| 86 | public void activate() { |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 87 | store.setDelegate(delegate); |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 88 | eventDispatcher.addSink(LinkEvent.class, listenerRegistry); |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 89 | deviceService.addListener(deviceListener); |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 90 | log.info("Started"); |
| 91 | } |
| 92 | |
| 93 | @Deactivate |
| 94 | public void deactivate() { |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 95 | store.unsetDelegate(delegate); |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 96 | eventDispatcher.removeSink(LinkEvent.class); |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 97 | deviceService.removeListener(deviceListener); |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 98 | log.info("Stopped"); |
| 99 | } |
| 100 | |
| 101 | @Override |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 102 | public int getLinkCount() { |
| 103 | return store.getLinkCount(); |
| 104 | } |
| 105 | |
| 106 | @Override |
| 107 | public Iterable<Link> getLinks() { |
| 108 | return store.getLinks(); |
| 109 | } |
| 110 | |
| 111 | @Override |
| 112 | public Set<Link> getDeviceLinks(DeviceId deviceId) { |
| 113 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 114 | return Sets.union(store.getDeviceEgressLinks(deviceId), |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 115 | store.getDeviceIngressLinks(deviceId)); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 116 | } |
| 117 | |
| 118 | @Override |
| 119 | public Set<Link> getDeviceEgressLinks(DeviceId deviceId) { |
| 120 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 121 | return store.getDeviceEgressLinks(deviceId); |
| 122 | } |
| 123 | |
| 124 | @Override |
tom | d176fc4 | 2014-09-08 00:12:30 -0700 | [diff] [blame] | 125 | public Set<Link> getDeviceIngressLinks(DeviceId deviceId) { |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 126 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 127 | return store.getDeviceIngressLinks(deviceId); |
| 128 | } |
| 129 | |
| 130 | @Override |
| 131 | public Set<Link> getLinks(ConnectPoint connectPoint) { |
| 132 | checkNotNull(connectPoint, CONNECT_POINT_NULL); |
| 133 | return Sets.union(store.getEgressLinks(connectPoint), |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 134 | store.getIngressLinks(connectPoint)); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | @Override |
| 138 | public Set<Link> getEgressLinks(ConnectPoint connectPoint) { |
| 139 | checkNotNull(connectPoint, CONNECT_POINT_NULL); |
| 140 | return store.getEgressLinks(connectPoint); |
| 141 | } |
| 142 | |
| 143 | @Override |
tom | d176fc4 | 2014-09-08 00:12:30 -0700 | [diff] [blame] | 144 | public Set<Link> getIngressLinks(ConnectPoint connectPoint) { |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 145 | checkNotNull(connectPoint, CONNECT_POINT_NULL); |
| 146 | return store.getIngressLinks(connectPoint); |
| 147 | } |
| 148 | |
| 149 | @Override |
tom | d176fc4 | 2014-09-08 00:12:30 -0700 | [diff] [blame] | 150 | public Link getLink(ConnectPoint src, ConnectPoint dst) { |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 151 | checkNotNull(src, CONNECT_POINT_NULL); |
| 152 | checkNotNull(dst, CONNECT_POINT_NULL); |
tom | d176fc4 | 2014-09-08 00:12:30 -0700 | [diff] [blame] | 153 | return store.getLink(src, dst); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | @Override |
| 157 | public void removeLinks(ConnectPoint connectPoint) { |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 158 | if (deviceService.getRole(connectPoint.deviceId()) != MastershipRole.MASTER) { |
| 159 | return; |
| 160 | } |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 161 | removeLinks(getLinks(connectPoint)); |
| 162 | } |
| 163 | |
| 164 | @Override |
| 165 | public void removeLinks(DeviceId deviceId) { |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 166 | if (deviceService.getRole(deviceId) != MastershipRole.MASTER) { |
| 167 | return; |
| 168 | } |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 169 | removeLinks(getDeviceLinks(deviceId)); |
| 170 | } |
| 171 | |
| 172 | @Override |
| 173 | public void addListener(LinkListener listener) { |
| 174 | listenerRegistry.addListener(listener); |
| 175 | } |
| 176 | |
| 177 | @Override |
| 178 | public void removeListener(LinkListener listener) { |
| 179 | listenerRegistry.removeListener(listener); |
| 180 | } |
| 181 | |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 182 | // Auxiliary interceptor for device remove events to prune links that |
| 183 | // are associated with the removed device or its port. |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 184 | private class InternalDeviceListener implements DeviceListener { |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 185 | @Override |
| 186 | public void event(DeviceEvent event) { |
| 187 | if (event.type() == DeviceEvent.Type.DEVICE_REMOVED) { |
| 188 | removeLinks(event.subject().id()); |
| 189 | } else if (event.type() == DeviceEvent.Type.PORT_REMOVED) { |
| 190 | removeLinks(new ConnectPoint(event.subject().id(), |
| 191 | event.port().number())); |
| 192 | } |
| 193 | } |
| 194 | } |
| 195 | |
tom | 7869ad9 | 2014-09-09 14:32:08 -0700 | [diff] [blame] | 196 | @Override |
| 197 | protected LinkProviderService createProviderService(LinkProvider provider) { |
| 198 | return new InternalLinkProviderService(provider); |
| 199 | } |
| 200 | |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 201 | // Personalized link provider service issued to the supplied provider. |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 202 | private class InternalLinkProviderService |
| 203 | extends AbstractProviderService<LinkProvider> |
| 204 | implements LinkProviderService { |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 205 | |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 206 | InternalLinkProviderService(LinkProvider provider) { |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 207 | super(provider); |
| 208 | } |
| 209 | |
| 210 | @Override |
| 211 | public void linkDetected(LinkDescription linkDescription) { |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 212 | checkNotNull(linkDescription, LINK_DESC_NULL); |
| 213 | checkValidity(); |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 214 | |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 215 | LinkEvent event = store.createOrUpdateLink(provider().id(), |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 216 | linkDescription); |
| 217 | if (event != null) { |
Thomas Vachuska | 0e752bd | 2014-10-22 22:33:41 -0700 | [diff] [blame] | 218 | log.info("Link {} detected", linkDescription); |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 219 | post(event); |
| 220 | } |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 221 | } |
| 222 | |
| 223 | @Override |
| 224 | public void linkVanished(LinkDescription linkDescription) { |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 225 | checkNotNull(linkDescription, LINK_DESC_NULL); |
| 226 | checkValidity(); |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 227 | |
| 228 | ConnectPoint src = linkDescription.src(); |
| 229 | ConnectPoint dst = linkDescription.dst(); |
alshabib | dfc7afb | 2014-10-21 20:13:27 -0700 | [diff] [blame] | 230 | |
| 231 | LinkEvent event = store.removeLink(src, dst); |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 232 | if (event != null) { |
| 233 | log.info("Link {} vanished", linkDescription); |
| 234 | post(event); |
| 235 | } |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 236 | } |
| 237 | |
| 238 | @Override |
| 239 | public void linksVanished(ConnectPoint connectPoint) { |
| 240 | checkNotNull(connectPoint, "Connect point cannot be null"); |
| 241 | checkValidity(); |
alshabib | 12288c8 | 2014-10-23 10:24:23 -0700 | [diff] [blame] | 242 | |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 243 | log.info("Links for connection point {} vanished", connectPoint); |
Yuta HIGUCHI | e794cbe | 2014-10-17 13:21:23 -0700 | [diff] [blame] | 244 | // FIXME: This will remove links registered by other providers |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 245 | removeLinks(getLinks(connectPoint)); |
| 246 | } |
| 247 | |
| 248 | @Override |
| 249 | public void linksVanished(DeviceId deviceId) { |
| 250 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 251 | checkValidity(); |
alshabib | 12288c8 | 2014-10-23 10:24:23 -0700 | [diff] [blame] | 252 | |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 253 | log.info("Links for device {} vanished", deviceId); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 254 | removeLinks(getDeviceLinks(deviceId)); |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 255 | } |
| 256 | } |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 257 | |
| 258 | // Removes all links in the specified set and emits appropriate events. |
| 259 | private void removeLinks(Set<Link> links) { |
| 260 | for (Link link : links) { |
| 261 | LinkEvent event = store.removeLink(link.src(), link.dst()); |
| 262 | post(event); |
| 263 | } |
| 264 | } |
| 265 | |
| 266 | // Posts the specified event to the local event dispatcher. |
| 267 | private void post(LinkEvent event) { |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 268 | if (event != null) { |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 269 | eventDispatcher.post(event); |
| 270 | } |
| 271 | } |
| 272 | |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 273 | // Store delegate to re-post events emitted from the store. |
| 274 | private class InternalStoreDelegate implements LinkStoreDelegate { |
| 275 | @Override |
| 276 | public void notify(LinkEvent event) { |
| 277 | post(event); |
| 278 | } |
| 279 | } |
tom | db0d03f | 2014-08-27 16:34:15 -0700 | [diff] [blame] | 280 | } |