Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -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 | |
Ray Milkey | b65d784 | 2017-08-03 16:28:24 -0700 | [diff] [blame] | 17 | package org.onosproject.net.neighbour.impl; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 18 | |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 19 | import com.google.common.collect.HashMultimap; |
| 20 | import com.google.common.collect.ImmutableMap; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 21 | import com.google.common.collect.Multimaps; |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 22 | import com.google.common.collect.SetMultimap; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 23 | import org.onlab.packet.Ethernet; |
| 24 | import org.onlab.packet.ICMP6; |
| 25 | import org.onlab.packet.IPv6; |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 26 | import org.onlab.packet.IpAddress; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 27 | import org.onlab.packet.MacAddress; |
| 28 | import org.onlab.packet.VlanId; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 29 | import org.onlab.util.Tools; |
| 30 | import org.onosproject.cfg.ComponentConfigService; |
| 31 | import org.onosproject.core.ApplicationId; |
| 32 | import org.onosproject.core.CoreService; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 33 | import org.onosproject.net.ConnectPoint; |
| 34 | import org.onosproject.net.edge.EdgePortService; |
| 35 | import org.onosproject.net.flow.DefaultTrafficSelector; |
| 36 | import org.onosproject.net.flow.TrafficSelector; |
| 37 | import org.onosproject.net.host.HostService; |
Ray Milkey | facf286 | 2017-08-03 11:58:29 -0700 | [diff] [blame] | 38 | import org.onosproject.net.intf.Interface; |
Ray Milkey | b65d784 | 2017-08-03 16:28:24 -0700 | [diff] [blame] | 39 | import org.onosproject.net.neighbour.NeighbourHandlerRegistration; |
| 40 | import org.onosproject.net.neighbour.NeighbourMessageActions; |
| 41 | import org.onosproject.net.neighbour.NeighbourMessageContext; |
| 42 | import org.onosproject.net.neighbour.NeighbourMessageHandler; |
| 43 | import org.onosproject.net.neighbour.NeighbourResolutionService; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 44 | import org.onosproject.net.packet.InboundPacket; |
| 45 | import org.onosproject.net.packet.PacketContext; |
| 46 | import org.onosproject.net.packet.PacketProcessor; |
| 47 | import org.onosproject.net.packet.PacketService; |
| 48 | import org.osgi.service.component.ComponentContext; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 49 | import org.osgi.service.component.annotations.Activate; |
| 50 | import org.osgi.service.component.annotations.Component; |
| 51 | import org.osgi.service.component.annotations.Deactivate; |
| 52 | import org.osgi.service.component.annotations.Modified; |
| 53 | import org.osgi.service.component.annotations.Reference; |
| 54 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 55 | import org.slf4j.Logger; |
| 56 | import org.slf4j.LoggerFactory; |
| 57 | |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 58 | import java.util.Collection; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 59 | import java.util.Dictionary; |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 60 | import java.util.Iterator; |
| 61 | import java.util.Map; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 62 | import java.util.Objects; |
Pier Ventre | 0ba9852 | 2016-09-19 15:49:14 -0700 | [diff] [blame] | 63 | import java.util.stream.Collectors; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 64 | |
| 65 | import static com.google.common.base.Preconditions.checkNotNull; |
| 66 | import static org.onlab.packet.Ethernet.TYPE_ARP; |
| 67 | import static org.onlab.packet.Ethernet.TYPE_IPV6; |
| 68 | import static org.onlab.packet.ICMP6.NEIGHBOR_ADVERTISEMENT; |
| 69 | import static org.onlab.packet.ICMP6.NEIGHBOR_SOLICITATION; |
| 70 | import static org.onlab.packet.IPv6.PROTOCOL_ICMP6; |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 71 | import static org.onosproject.net.OsgiPropertyConstants.NRM_ARP_ENABLED; |
| 72 | import static org.onosproject.net.OsgiPropertyConstants.NRM_ARP_ENABLED_DEFAULT; |
| 73 | import static org.onosproject.net.OsgiPropertyConstants.NRM_NDP_ENABLED; |
| 74 | import static org.onosproject.net.OsgiPropertyConstants.NRM_NDP_ENABLED_DEFAULT; |
| 75 | import static org.onosproject.net.OsgiPropertyConstants.NRM_REQUEST_INTERCEPTS_ENABLED; |
| 76 | import static org.onosproject.net.OsgiPropertyConstants.NRM_REQUEST_INTERCEPTS_ENABLED_DEFAULT; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 77 | import static org.onosproject.net.packet.PacketPriority.CONTROL; |
| 78 | |
| 79 | /** |
| 80 | * Manages handlers for neighbour messages. |
| 81 | */ |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 82 | @Component( |
| 83 | immediate = true, |
| 84 | service = NeighbourResolutionService.class, |
| 85 | property = { |
Ray Milkey | 2d7bca1 | 2018-10-17 14:51:52 -0700 | [diff] [blame] | 86 | NRM_ARP_ENABLED + ":Boolean=" + NRM_ARP_ENABLED_DEFAULT, |
nosignal | c888801 | 2020-07-09 17:07:16 +0800 | [diff] [blame^] | 87 | NRM_NDP_ENABLED + ":Boolean=" + NRM_NDP_ENABLED_DEFAULT, |
Ray Milkey | 2d7bca1 | 2018-10-17 14:51:52 -0700 | [diff] [blame] | 88 | NRM_REQUEST_INTERCEPTS_ENABLED + ":Boolean=" + NRM_REQUEST_INTERCEPTS_ENABLED_DEFAULT |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 89 | } |
| 90 | ) |
Jonathan Hart | 1e393bb | 2016-09-14 08:51:09 -0700 | [diff] [blame] | 91 | public class NeighbourResolutionManager implements NeighbourResolutionService { |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 92 | |
| 93 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 94 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 95 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 96 | protected CoreService coreService; |
| 97 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 98 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 99 | protected HostService hostService; |
| 100 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 101 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 102 | protected EdgePortService edgeService; |
| 103 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 104 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 105 | protected PacketService packetService; |
| 106 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 107 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 108 | protected ComponentConfigService componentConfigService; |
| 109 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 110 | /** Enable Address resolution protocol. */ |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 111 | protected boolean arpEnabled = NRM_ARP_ENABLED_DEFAULT; |
Pier Luigi | 65a0ab3 | 2017-01-12 20:52:38 -0800 | [diff] [blame] | 112 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 113 | /** Enable IPv6 neighbour discovery. */ |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 114 | protected boolean ndpEnabled = NRM_NDP_ENABLED_DEFAULT; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 115 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 116 | /** Enable requesting packet intercepts. */ |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 117 | private boolean requestInterceptsEnabled = NRM_REQUEST_INTERCEPTS_ENABLED_DEFAULT; |
Pier Luigi | 65a0ab3 | 2017-01-12 20:52:38 -0800 | [diff] [blame] | 118 | |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 119 | private static final String APP_NAME = "org.onosproject.neighbour"; |
| 120 | private ApplicationId appId; |
| 121 | |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 122 | private final SetMultimap<ConnectPoint, NeighbourHandlerRegistration> packetHandlers = |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 123 | Multimaps.synchronizedSetMultimap(HashMultimap.create()); |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 124 | |
| 125 | private final InternalPacketProcessor processor = new InternalPacketProcessor(); |
Jonathan Hart | 584ea2d | 2016-10-11 10:49:16 +0200 | [diff] [blame] | 126 | private NeighbourMessageActions actions; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 127 | |
| 128 | @Activate |
| 129 | protected void activate(ComponentContext context) { |
| 130 | appId = coreService.registerApplication(APP_NAME); |
| 131 | |
| 132 | componentConfigService.registerProperties(getClass()); |
| 133 | modified(context); |
| 134 | |
Jonathan Hart | 584ea2d | 2016-10-11 10:49:16 +0200 | [diff] [blame] | 135 | actions = new DefaultNeighbourMessageActions(packetService, edgeService); |
| 136 | |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 137 | packetService.addProcessor(processor, PacketProcessor.director(1)); |
| 138 | } |
| 139 | |
| 140 | @Deactivate |
| 141 | protected void deactivate() { |
| 142 | cancelPackets(); |
| 143 | packetService.removeProcessor(processor); |
| 144 | componentConfigService.unregisterProperties(getClass(), false); |
| 145 | } |
| 146 | |
| 147 | @Modified |
| 148 | protected void modified(ComponentContext context) { |
| 149 | Dictionary<?, ?> properties = context.getProperties(); |
| 150 | Boolean flag; |
| 151 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 152 | flag = Tools.isPropertyEnabled(properties, NRM_NDP_ENABLED); |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 153 | if (flag != null) { |
| 154 | ndpEnabled = flag; |
| 155 | log.info("IPv6 neighbor discovery is {}", |
| 156 | ndpEnabled ? "enabled" : "disabled"); |
| 157 | } |
| 158 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 159 | flag = Tools.isPropertyEnabled(properties, NRM_ARP_ENABLED); |
Pier Luigi | 65a0ab3 | 2017-01-12 20:52:38 -0800 | [diff] [blame] | 160 | if (flag != null) { |
| 161 | arpEnabled = flag; |
| 162 | log.info("Address resolution protocol is {}", |
| 163 | arpEnabled ? "enabled" : "disabled"); |
| 164 | } |
| 165 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 166 | flag = Tools.isPropertyEnabled(properties, NRM_REQUEST_INTERCEPTS_ENABLED); |
Pier Luigi | 65a0ab3 | 2017-01-12 20:52:38 -0800 | [diff] [blame] | 167 | if (flag == null) { |
| 168 | log.info("Request intercepts is not configured, " + |
| 169 | "using current value of {}", requestInterceptsEnabled); |
| 170 | } else { |
| 171 | requestInterceptsEnabled = flag; |
| 172 | log.info("Configured. Request intercepts is {}", |
| 173 | requestInterceptsEnabled ? "enabled" : "disabled"); |
| 174 | } |
| 175 | |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 176 | synchronized (packetHandlers) { |
Pier Luigi | 65a0ab3 | 2017-01-12 20:52:38 -0800 | [diff] [blame] | 177 | if (!packetHandlers.isEmpty() && requestInterceptsEnabled) { |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 178 | requestPackets(); |
Pier Luigi | 65a0ab3 | 2017-01-12 20:52:38 -0800 | [diff] [blame] | 179 | } else { |
| 180 | cancelPackets(); |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 181 | } |
| 182 | } |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | private void requestPackets() { |
Pier Luigi | 65a0ab3 | 2017-01-12 20:52:38 -0800 | [diff] [blame] | 186 | if (arpEnabled) { |
| 187 | packetService.requestPackets(buildArpSelector(), CONTROL, appId); |
| 188 | } else { |
| 189 | packetService.cancelPackets(buildArpSelector(), CONTROL, appId); |
| 190 | } |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 191 | |
| 192 | if (ndpEnabled) { |
| 193 | packetService.requestPackets(buildNeighborSolicitationSelector(), |
| 194 | CONTROL, appId); |
| 195 | packetService.requestPackets(buildNeighborAdvertisementSelector(), |
| 196 | CONTROL, appId); |
| 197 | } else { |
| 198 | packetService.cancelPackets(buildNeighborSolicitationSelector(), |
| 199 | CONTROL, appId); |
| 200 | packetService.cancelPackets(buildNeighborAdvertisementSelector(), |
| 201 | CONTROL, appId); |
| 202 | } |
| 203 | } |
| 204 | |
| 205 | private void cancelPackets() { |
| 206 | packetService.cancelPackets(buildArpSelector(), CONTROL, appId); |
| 207 | packetService.cancelPackets(buildNeighborSolicitationSelector(), |
| 208 | CONTROL, appId); |
| 209 | packetService.cancelPackets(buildNeighborAdvertisementSelector(), |
| 210 | CONTROL, appId); |
| 211 | } |
| 212 | |
| 213 | private TrafficSelector buildArpSelector() { |
| 214 | return DefaultTrafficSelector.builder() |
| 215 | .matchEthType(TYPE_ARP) |
| 216 | .build(); |
| 217 | } |
| 218 | |
| 219 | private TrafficSelector buildNeighborSolicitationSelector() { |
| 220 | return DefaultTrafficSelector.builder() |
| 221 | .matchEthType(TYPE_IPV6) |
| 222 | .matchIPProtocol(PROTOCOL_ICMP6) |
| 223 | .matchIcmpv6Type(NEIGHBOR_SOLICITATION) |
| 224 | .build(); |
| 225 | } |
| 226 | |
| 227 | private TrafficSelector buildNeighborAdvertisementSelector() { |
| 228 | return DefaultTrafficSelector.builder() |
| 229 | .matchEthType(TYPE_IPV6) |
| 230 | .matchIPProtocol(PROTOCOL_ICMP6) |
| 231 | .matchIcmpv6Type(NEIGHBOR_ADVERTISEMENT) |
| 232 | .build(); |
| 233 | } |
| 234 | |
| 235 | @Override |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 236 | public void registerNeighbourHandler(ConnectPoint connectPoint, |
| 237 | NeighbourMessageHandler handler, |
| 238 | ApplicationId appId) { |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 239 | register(connectPoint, new HandlerRegistration(handler, appId)); |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 240 | } |
| 241 | |
| 242 | @Override |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 243 | public void registerNeighbourHandler(Interface intf, |
| 244 | NeighbourMessageHandler handler, |
| 245 | ApplicationId appId) { |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 246 | register(intf.connectPoint(), new HandlerRegistration(handler, intf, appId)); |
| 247 | } |
| 248 | |
| 249 | private void register(ConnectPoint connectPoint, HandlerRegistration registration) { |
| 250 | synchronized (packetHandlers) { |
Pier Ventre | 09f88b8 | 2017-01-09 23:01:05 -0800 | [diff] [blame] | 251 | if (packetHandlers.isEmpty() && requestInterceptsEnabled) { |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 252 | requestPackets(); |
| 253 | } |
| 254 | packetHandlers.put(connectPoint, registration); |
| 255 | } |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | @Override |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 259 | public void unregisterNeighbourHandler(ConnectPoint connectPoint, |
| 260 | NeighbourMessageHandler handler, |
| 261 | ApplicationId appId) { |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 262 | unregister(connectPoint, new HandlerRegistration(handler, appId)); |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 263 | } |
| 264 | |
| 265 | @Override |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 266 | public void unregisterNeighbourHandler(Interface intf, |
| 267 | NeighbourMessageHandler handler, |
| 268 | ApplicationId appId) { |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 269 | unregister(intf.connectPoint(), new HandlerRegistration(handler, intf, appId)); |
| 270 | } |
| 271 | |
| 272 | private void unregister(ConnectPoint connectPoint, HandlerRegistration registration) { |
| 273 | synchronized (packetHandlers) { |
| 274 | packetHandlers.remove(connectPoint, registration); |
| 275 | |
| 276 | if (packetHandlers.isEmpty()) { |
| 277 | cancelPackets(); |
| 278 | } |
| 279 | } |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 280 | } |
| 281 | |
| 282 | @Override |
| 283 | public void unregisterNeighbourHandlers(ApplicationId appId) { |
| 284 | synchronized (packetHandlers) { |
| 285 | Iterator<NeighbourHandlerRegistration> it = packetHandlers.values().iterator(); |
| 286 | |
| 287 | while (it.hasNext()) { |
| 288 | NeighbourHandlerRegistration registration = it.next(); |
| 289 | if (registration.appId().equals(appId)) { |
| 290 | it.remove(); |
| 291 | } |
| 292 | } |
Jonathan Hart | c004adf | 2016-09-15 16:50:04 -0700 | [diff] [blame] | 293 | |
| 294 | if (packetHandlers.isEmpty()) { |
| 295 | cancelPackets(); |
| 296 | } |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 297 | } |
| 298 | } |
| 299 | |
| 300 | @Override |
| 301 | public Map<ConnectPoint, Collection<NeighbourHandlerRegistration>> getHandlerRegistrations() { |
Ray Milkey | fb1c762 | 2018-05-18 10:16:53 -0700 | [diff] [blame] | 302 | synchronized (packetHandlers) { |
| 303 | return ImmutableMap.copyOf(Multimaps.asMap(packetHandlers)); |
| 304 | } |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 305 | } |
| 306 | |
Jonathan Hart | 584ea2d | 2016-10-11 10:49:16 +0200 | [diff] [blame] | 307 | private void handlePacket(PacketContext context) { |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 308 | InboundPacket pkt = context.inPacket(); |
| 309 | Ethernet ethPkt = pkt.parsed(); |
| 310 | |
| 311 | NeighbourMessageContext msgContext = |
| 312 | DefaultNeighbourMessageContext.createContext(ethPkt, pkt.receivedFrom(), actions); |
| 313 | |
| 314 | if (msgContext == null) { |
| 315 | return; |
| 316 | } |
| 317 | |
Pier Ventre | 0ba9852 | 2016-09-19 15:49:14 -0700 | [diff] [blame] | 318 | if (handleMessage(msgContext)) { |
| 319 | context.block(); |
| 320 | } |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 321 | |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 322 | } |
| 323 | |
Pier Ventre | 0ba9852 | 2016-09-19 15:49:14 -0700 | [diff] [blame] | 324 | private boolean handleMessage(NeighbourMessageContext context) { |
Ray Milkey | fb1c762 | 2018-05-18 10:16:53 -0700 | [diff] [blame] | 325 | Collection<NeighbourHandlerRegistration> handled; |
| 326 | synchronized (packetHandlers) { |
| 327 | handled = packetHandlers.get(context.inPort()) |
| 328 | .stream() |
| 329 | .filter(registration -> registration.intf() == null || matches(context, registration.intf())) |
| 330 | .collect(Collectors.toSet()); |
| 331 | } |
Pier Ventre | 0ba9852 | 2016-09-19 15:49:14 -0700 | [diff] [blame] | 332 | handled.forEach(registration -> registration.handler().handleMessage(context, hostService)); |
| 333 | |
| 334 | return !handled.isEmpty(); |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 335 | } |
| 336 | |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 337 | /** |
| 338 | * Checks that incoming packet matches the parameters of the interface. |
| 339 | * This means that if the interface specifies a particular parameter |
| 340 | * (VLAN, IP address, etc.) then the incoming packet should match those |
| 341 | * parameters. |
| 342 | * |
| 343 | * @param context incoming message context |
| 344 | * @param intf interface to check |
| 345 | * @return true if the incoming message matches the interface, otherwise false |
| 346 | */ |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 347 | private boolean matches(NeighbourMessageContext context, Interface intf) { |
| 348 | checkNotNull(context); |
| 349 | checkNotNull(intf); |
| 350 | |
| 351 | boolean matches = true; |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 352 | // For non-broadcast packets, if the interface has a MAC address check that |
| 353 | // the destination MAC address of the packet matches the interface MAC |
| 354 | if (!context.dstMac().isBroadcast() && |
| 355 | !intf.mac().equals(MacAddress.NONE) && |
| 356 | !intf.mac().equals(context.dstMac())) { |
| 357 | matches = false; |
| 358 | } |
| 359 | // If the interface has a VLAN, check that the packet's VLAN matches |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 360 | if (!intf.vlan().equals(VlanId.NONE) && !intf.vlan().equals(context.vlan())) { |
| 361 | matches = false; |
| 362 | } |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 363 | // If the interface has IP addresses, check that the packet's target IP |
| 364 | // address matches one of the interface IP addresses |
| 365 | if (!intf.ipAddressesList().isEmpty() && !hasIp(intf, context.target())) { |
| 366 | matches = false; |
| 367 | } |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 368 | |
| 369 | return matches; |
| 370 | } |
| 371 | |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 372 | /** |
| 373 | * Returns true if the interface has the given IP address. |
| 374 | * |
| 375 | * @param intf interface to check |
| 376 | * @param ip IP address |
| 377 | * @return true if the IP is configured on the interface, otherwise false |
| 378 | */ |
| 379 | private boolean hasIp(Interface intf, IpAddress ip) { |
| 380 | return intf.ipAddressesList().stream() |
| 381 | .anyMatch(intfAddress -> intfAddress.ipAddress().equals(ip)); |
| 382 | } |
| 383 | |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 384 | /** |
| 385 | * Stores a neighbour message handler registration. |
| 386 | */ |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 387 | private class HandlerRegistration implements NeighbourHandlerRegistration { |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 388 | private final Interface intf; |
| 389 | private final NeighbourMessageHandler handler; |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 390 | private final ApplicationId appId; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 391 | |
| 392 | /** |
| 393 | * Creates a new handler registration. |
| 394 | * |
| 395 | * @param handler neighbour message handler |
| 396 | */ |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 397 | public HandlerRegistration(NeighbourMessageHandler handler, ApplicationId appId) { |
| 398 | this(handler, null, appId); |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 399 | } |
| 400 | |
| 401 | /** |
| 402 | * Creates a new handler registration. |
| 403 | * |
| 404 | * @param handler neighbour message handler |
| 405 | * @param intf interface |
| 406 | */ |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 407 | public HandlerRegistration(NeighbourMessageHandler handler, Interface intf, ApplicationId appId) { |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 408 | this.intf = intf; |
| 409 | this.handler = handler; |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 410 | this.appId = appId; |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 411 | } |
| 412 | |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 413 | @Override |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 414 | public Interface intf() { |
| 415 | return intf; |
| 416 | } |
| 417 | |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 418 | @Override |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 419 | public NeighbourMessageHandler handler() { |
| 420 | return handler; |
| 421 | } |
| 422 | |
| 423 | @Override |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 424 | public ApplicationId appId() { |
| 425 | return appId; |
| 426 | } |
| 427 | |
| 428 | @Override |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 429 | public boolean equals(Object other) { |
| 430 | if (this == other) { |
| 431 | return true; |
| 432 | } |
| 433 | |
| 434 | if (!(other instanceof HandlerRegistration)) { |
| 435 | return false; |
| 436 | } |
| 437 | |
| 438 | HandlerRegistration that = (HandlerRegistration) other; |
| 439 | |
| 440 | return Objects.equals(intf, that.intf) && |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 441 | Objects.equals(handler, that.handler) && |
| 442 | Objects.equals(appId, that.appId); |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 443 | } |
| 444 | |
| 445 | @Override |
| 446 | public int hashCode() { |
Jonathan Hart | c4f681c | 2016-09-09 07:14:25 -0700 | [diff] [blame] | 447 | return Objects.hash(intf, handler, appId); |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 448 | } |
| 449 | } |
| 450 | |
| 451 | /** |
| 452 | * Packet processor for incoming packets. |
| 453 | */ |
| 454 | private class InternalPacketProcessor implements PacketProcessor { |
| 455 | |
| 456 | @Override |
| 457 | public void process(PacketContext context) { |
| 458 | // Stop processing if the packet has been handled, since we |
| 459 | // can't do any more to it. |
| 460 | if (context.isHandled()) { |
| 461 | return; |
| 462 | } |
| 463 | |
| 464 | InboundPacket pkt = context.inPacket(); |
| 465 | Ethernet ethPkt = pkt.parsed(); |
| 466 | if (ethPkt == null) { |
| 467 | return; |
| 468 | } |
| 469 | |
| 470 | if (ethPkt.getEtherType() == TYPE_ARP) { |
| 471 | // handle ARP packets |
| 472 | handlePacket(context); |
| 473 | } else if (ethPkt.getEtherType() == TYPE_IPV6) { |
| 474 | IPv6 ipv6 = (IPv6) ethPkt.getPayload(); |
| 475 | if (ipv6.getNextHeader() == IPv6.PROTOCOL_ICMP6) { |
| 476 | ICMP6 icmp6 = (ICMP6) ipv6.getPayload(); |
| 477 | if (icmp6.getIcmpType() == NEIGHBOR_SOLICITATION || |
| 478 | icmp6.getIcmpType() == NEIGHBOR_ADVERTISEMENT) { |
| 479 | // handle ICMPv6 solicitations and advertisements (NDP) |
| 480 | handlePacket(context); |
| 481 | } |
| 482 | } |
| 483 | } |
| 484 | } |
| 485 | } |
Jonathan Hart | 9bdaaec | 2016-08-22 13:33:45 -0700 | [diff] [blame] | 486 | } |