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