Daniel Park | 5a3e939 | 2021-03-23 08:00:00 +0900 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2021-present Open Networking Foundation |
| 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.kubevirtnetworking.impl; |
| 17 | |
| 18 | import org.onlab.packet.ARP; |
| 19 | import org.onlab.packet.EthType; |
| 20 | import org.onlab.packet.Ethernet; |
| 21 | import org.onlab.packet.Ip4Address; |
| 22 | import org.onlab.packet.IpAddress; |
| 23 | import org.onlab.packet.MacAddress; |
| 24 | import org.onlab.packet.VlanId; |
| 25 | import org.onosproject.cluster.ClusterService; |
| 26 | import org.onosproject.cluster.LeadershipService; |
| 27 | import org.onosproject.cluster.NodeId; |
| 28 | import org.onosproject.core.ApplicationId; |
| 29 | import org.onosproject.core.CoreService; |
| 30 | import org.onosproject.kubevirtnetworking.api.KubevirtFlowRuleService; |
| 31 | import org.onosproject.kubevirtnetworking.api.KubevirtNetworkAdminService; |
| 32 | import org.onosproject.kubevirtnetworking.api.KubevirtPeerRouter; |
| 33 | import org.onosproject.kubevirtnetworking.api.KubevirtRouter; |
| 34 | import org.onosproject.kubevirtnetworking.api.KubevirtRouterAdminService; |
| 35 | import org.onosproject.kubevirtnetworking.api.KubevirtRouterEvent; |
| 36 | import org.onosproject.kubevirtnetworking.api.KubevirtRouterListener; |
| 37 | import org.onosproject.kubevirtnetworking.util.KubevirtNetworkingUtil; |
| 38 | import org.onosproject.kubevirtnode.api.KubevirtNode; |
| 39 | import org.onosproject.kubevirtnode.api.KubevirtNodeService; |
| 40 | import org.onosproject.net.PortNumber; |
| 41 | import org.onosproject.net.device.DeviceService; |
| 42 | import org.onosproject.net.flow.DefaultTrafficSelector; |
| 43 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
| 44 | import org.onosproject.net.flow.TrafficSelector; |
| 45 | import org.onosproject.net.flow.TrafficTreatment; |
| 46 | import org.onosproject.net.packet.DefaultOutboundPacket; |
| 47 | import org.onosproject.net.packet.InboundPacket; |
| 48 | import org.onosproject.net.packet.PacketContext; |
| 49 | import org.onosproject.net.packet.PacketProcessor; |
| 50 | import org.onosproject.net.packet.PacketService; |
| 51 | import org.osgi.service.component.annotations.Activate; |
| 52 | import org.osgi.service.component.annotations.Component; |
| 53 | import org.osgi.service.component.annotations.Deactivate; |
| 54 | import org.osgi.service.component.annotations.Reference; |
| 55 | import org.osgi.service.component.annotations.ReferenceCardinality; |
| 56 | import org.slf4j.Logger; |
| 57 | |
| 58 | import java.nio.ByteBuffer; |
| 59 | import java.util.Objects; |
| 60 | import java.util.concurrent.ExecutorService; |
| 61 | |
| 62 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
| 63 | import static org.onlab.util.Tools.groupedThreads; |
| 64 | import static org.onosproject.kubevirtnetworking.api.Constants.DEFAULT_GATEWAY_MAC; |
| 65 | import static org.onosproject.kubevirtnetworking.api.Constants.KUBEVIRT_NETWORKING_APP_ID; |
| 66 | import static org.onosproject.kubevirtnetworking.api.Constants.PRE_FLAT_TABLE; |
| 67 | import static org.onosproject.kubevirtnetworking.api.Constants.PRIORITY_ARP_GATEWAY_RULE; |
| 68 | import static org.slf4j.LoggerFactory.getLogger; |
| 69 | |
| 70 | /** |
| 71 | * Handles arp packet. |
| 72 | */ |
| 73 | @Component(immediate = true) |
| 74 | public class KubevirtRoutingArpHandler { |
| 75 | protected final Logger log = getLogger(getClass()); |
| 76 | |
| 77 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 78 | protected CoreService coreService; |
| 79 | |
| 80 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 81 | protected ClusterService clusterService; |
| 82 | |
| 83 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 84 | protected LeadershipService leadershipService; |
| 85 | |
| 86 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 87 | protected PacketService packetService; |
| 88 | |
| 89 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 90 | protected DeviceService deviceService; |
| 91 | |
| 92 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 93 | protected KubevirtRouterAdminService kubevirtRouterService; |
| 94 | |
| 95 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 96 | protected KubevirtNetworkAdminService kubevirtNetworkService; |
| 97 | |
| 98 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 99 | protected KubevirtNodeService kubevirtNodeService; |
| 100 | |
| 101 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 102 | protected KubevirtFlowRuleService kubevirtFlowRuleService; |
| 103 | |
| 104 | private final ExecutorService eventExecutor = newSingleThreadExecutor( |
| 105 | groupedThreads(this.getClass().getSimpleName(), "event-handler")); |
| 106 | |
| 107 | private final PacketProcessor packetProcessor = new InternalPacketProcessor(); |
| 108 | |
| 109 | private final InternalRouterEventListener kubevirtRouterlistener = new InternalRouterEventListener(); |
| 110 | |
| 111 | private ApplicationId appId; |
| 112 | private NodeId localNodeId; |
| 113 | |
| 114 | |
| 115 | @Activate |
| 116 | protected void activate() { |
| 117 | appId = coreService.registerApplication(KUBEVIRT_NETWORKING_APP_ID); |
| 118 | localNodeId = clusterService.getLocalNode().id(); |
| 119 | leadershipService.runForLeadership(appId.name()); |
| 120 | |
| 121 | packetService.addProcessor(packetProcessor, PacketProcessor.director(1)); |
| 122 | kubevirtRouterService.addListener(kubevirtRouterlistener); |
| 123 | |
| 124 | log.info("Started"); |
| 125 | } |
| 126 | |
| 127 | @Deactivate |
| 128 | protected void deactivate() { |
| 129 | leadershipService.withdraw(appId.name()); |
| 130 | packetService.removeProcessor(packetProcessor); |
| 131 | kubevirtRouterService.removeListener(kubevirtRouterlistener); |
| 132 | |
| 133 | eventExecutor.shutdown(); |
| 134 | |
| 135 | log.info("Stopped"); |
| 136 | } |
| 137 | /** |
| 138 | * Triggers ARP request to retrieve the peer router mac address. |
| 139 | * |
| 140 | * @param router kubevirt router |
| 141 | * @param peerRouterIp peer router IP address |
| 142 | */ |
| 143 | private void retrievePeerRouterMac(KubevirtRouter router, IpAddress peerRouterIp) { |
| 144 | |
| 145 | log.info("Sending ARP request to the peer router {} to retrieve the MAC address.", |
| 146 | peerRouterIp.getIp4Address().toString()); |
| 147 | String routerSnatIp = router.external().keySet().stream().findAny().orElse(null); |
| 148 | |
| 149 | if (routerSnatIp == null) { |
| 150 | return; |
| 151 | } |
| 152 | |
| 153 | IpAddress sourceIp = IpAddress.valueOf(routerSnatIp); |
| 154 | |
| 155 | MacAddress sourceMac = DEFAULT_GATEWAY_MAC; |
| 156 | Ethernet ethRequest = ARP.buildArpRequest(sourceMac.toBytes(), |
| 157 | sourceIp.toOctets(), |
| 158 | peerRouterIp.toOctets(), VlanId.NO_VID); |
| 159 | |
| 160 | KubevirtNode gatewayNode = kubevirtNodeService.node(router.electedGateway()); |
| 161 | |
| 162 | if (gatewayNode == null) { |
| 163 | return; |
| 164 | } |
| 165 | |
| 166 | PortNumber externalPatchPortNum = KubevirtNetworkingUtil.externalPatchPortNum(deviceService, gatewayNode); |
| 167 | |
| 168 | if (externalPatchPortNum == null) { |
| 169 | return; |
| 170 | } |
| 171 | |
| 172 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| 173 | .setOutput(externalPatchPortNum) |
| 174 | .build(); |
| 175 | |
| 176 | packetService.emit(new DefaultOutboundPacket( |
| 177 | gatewayNode.intgBridge(), |
| 178 | treatment, |
| 179 | ByteBuffer.wrap(ethRequest.serialize()))); |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * Sets default ARP flow rule to retrieve peer router mac address. |
| 184 | * |
| 185 | * @param routerSnatIp route Snat IP |
| 186 | * @param peerRouterIp peer router IP |
| 187 | * @param gatewayNodeId gateway node |
| 188 | * @param install install if true, uninstall otherwise |
| 189 | */ |
| 190 | private void setRuleArpRequestToController(IpAddress routerSnatIp, |
| 191 | IpAddress peerRouterIp, |
| 192 | String gatewayNodeId, |
| 193 | boolean install) { |
| 194 | KubevirtNode gatewayNode = kubevirtNodeService.node(gatewayNodeId); |
| 195 | if (gatewayNode == null) { |
| 196 | return; |
| 197 | } |
| 198 | |
| 199 | if (routerSnatIp == null) { |
| 200 | return; |
| 201 | } |
| 202 | |
| 203 | TrafficSelector selector = DefaultTrafficSelector.builder() |
| 204 | .matchEthType(EthType.EtherType.ARP.ethType().toShort()) |
| 205 | .matchArpOp(ARP.OP_REPLY) |
| 206 | .matchArpSpa(peerRouterIp.getIp4Address()) |
| 207 | .matchArpTpa(routerSnatIp.getIp4Address()) |
| 208 | .build(); |
| 209 | |
| 210 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| 211 | .punt() |
| 212 | .build(); |
| 213 | |
| 214 | kubevirtFlowRuleService.setRule( |
| 215 | appId, |
| 216 | gatewayNode.intgBridge(), |
| 217 | selector, |
| 218 | treatment, |
| 219 | PRIORITY_ARP_GATEWAY_RULE, |
| 220 | PRE_FLAT_TABLE, |
| 221 | install |
| 222 | ); |
| 223 | } |
| 224 | |
| 225 | private class InternalRouterEventListener implements KubevirtRouterListener { |
| 226 | private boolean isRelevantHelper() { |
| 227 | return Objects.equals(localNodeId, leadershipService.getLeader(appId.name())); |
| 228 | } |
| 229 | |
| 230 | @Override |
| 231 | public void event(KubevirtRouterEvent event) { |
| 232 | switch (event.type()) { |
| 233 | case KUBEVIRT_GATEWAY_NODE_ATTACHED: |
| 234 | case KUBEVIRT_ROUTER_EXTERNAL_NETWORK_ATTACHED: |
| 235 | eventExecutor.execute(() -> processRouterExternalNetAttachedOrGwAttached(event.subject())); |
| 236 | break; |
| 237 | case KUBEVIRT_ROUTER_EXTERNAL_NETWORK_DETACHED: |
| 238 | eventExecutor.execute(() -> processRouterExternalNetDetached(event.subject(), |
| 239 | event.externalIp(), event.externalPeerRouterIp())); |
| 240 | break; |
| 241 | case KUBEVIRT_GATEWAY_NODE_DETACHED: |
| 242 | eventExecutor.execute(() -> processRouterGatewayNodeDetached(event.subject(), event.gateway())); |
| 243 | break; |
| 244 | default: |
| 245 | //do nothing |
| 246 | break; |
| 247 | } |
| 248 | } |
| 249 | |
| 250 | private void processRouterExternalNetAttachedOrGwAttached(KubevirtRouter router) { |
| 251 | if (!isRelevantHelper()) { |
| 252 | return; |
| 253 | } |
| 254 | KubevirtNode gatewayNode = kubevirtNodeService.node(router.electedGateway()); |
| 255 | |
| 256 | if (gatewayNode == null) { |
| 257 | return; |
| 258 | } |
| 259 | |
| 260 | String routerSnatIp = router.external().keySet().stream().findAny().orElse(null); |
| 261 | if (routerSnatIp == null) { |
| 262 | return; |
| 263 | } |
| 264 | |
| 265 | if (router.peerRouter() != null && |
| 266 | router.peerRouter().macAddress() == null && |
| 267 | router.peerRouter().ipAddress() != null) { |
| 268 | setRuleArpRequestToController(IpAddress.valueOf(routerSnatIp), |
| 269 | router.peerRouter().ipAddress(), gatewayNode.hostname(), true); |
| 270 | |
| 271 | retrievePeerRouterMac(router, router.peerRouter().ipAddress()); |
| 272 | } |
| 273 | } |
| 274 | |
| 275 | private void processRouterExternalNetDetached(KubevirtRouter router, String routerSnatIp, |
| 276 | String peerRouterIp) { |
| 277 | if (!isRelevantHelper()) { |
| 278 | return; |
| 279 | } |
| 280 | if (router.electedGateway() == null) { |
| 281 | return; |
| 282 | } |
| 283 | KubevirtNode gatewayNode = kubevirtNodeService.node(router.electedGateway()); |
| 284 | |
| 285 | if (gatewayNode == null) { |
| 286 | return; |
| 287 | } |
| 288 | |
| 289 | if (routerSnatIp == null || peerRouterIp == null) { |
| 290 | return; |
| 291 | } |
| 292 | setRuleArpRequestToController(IpAddress.valueOf(routerSnatIp), |
| 293 | IpAddress.valueOf(peerRouterIp), gatewayNode.hostname(), false); |
| 294 | } |
| 295 | |
| 296 | private void processRouterGatewayNodeDetached(KubevirtRouter router, String detachedGatewayNode) { |
| 297 | if (!isRelevantHelper()) { |
| 298 | return; |
| 299 | } |
| 300 | if (detachedGatewayNode == null) { |
| 301 | return; |
| 302 | } |
| 303 | String routerSnatIp = router.external().keySet().stream().findAny().orElse(null); |
| 304 | if (routerSnatIp == null) { |
| 305 | return; |
| 306 | } |
| 307 | |
| 308 | if (router.peerRouter() != null && router.peerRouter().ipAddress() != null) { |
| 309 | setRuleArpRequestToController(IpAddress.valueOf(routerSnatIp), |
| 310 | router.peerRouter().ipAddress(), detachedGatewayNode, false); |
| 311 | } |
| 312 | } |
| 313 | } |
| 314 | |
| 315 | private class InternalPacketProcessor implements PacketProcessor { |
| 316 | @Override |
| 317 | public void process(PacketContext context) { |
| 318 | if (context.isHandled()) { |
| 319 | return; |
| 320 | } |
| 321 | |
| 322 | InboundPacket pkt = context.inPacket(); |
| 323 | Ethernet ethernet = pkt.parsed(); |
| 324 | |
| 325 | if (ethernet != null && ethernet.getEtherType() == Ethernet.TYPE_ARP) { |
| 326 | processArpPacket(ethernet); |
| 327 | } |
| 328 | } |
| 329 | |
| 330 | private void processArpPacket(Ethernet ethernet) { |
| 331 | ARP arp = (ARP) ethernet.getPayload(); |
| 332 | |
| 333 | if (arp.getOpCode() == ARP.OP_REQUEST) { |
| 334 | return; |
| 335 | } |
| 336 | |
| 337 | IpAddress spa = Ip4Address.valueOf(arp.getSenderProtocolAddress()); |
| 338 | MacAddress sha = MacAddress.valueOf(arp.getSenderHardwareAddress()); |
| 339 | |
| 340 | IpAddress tpa = Ip4Address.valueOf(arp.getTargetProtocolAddress()); |
| 341 | |
| 342 | KubevirtRouter router = kubevirtRouterService.routers().stream() |
| 343 | .filter(r -> r.peerRouter() != null && r.peerRouter().ipAddress().equals(spa)) |
| 344 | .filter(r -> { |
| 345 | String routerSnatIp = r.external().keySet().stream().findAny().orElse(null); |
| 346 | if (routerSnatIp == null) { |
| 347 | return false; |
| 348 | } |
| 349 | return IpAddress.valueOf(routerSnatIp).equals(tpa); |
| 350 | }) |
| 351 | .findAny().orElse(null); |
| 352 | |
| 353 | if (router == null) { |
| 354 | return; |
| 355 | } |
| 356 | |
| 357 | KubevirtPeerRouter peerRouter = new KubevirtPeerRouter(spa, sha); |
| 358 | log.info("Update peer router mac adress {} to router {}", peerRouter.macAddress(), router.name()); |
| 359 | |
| 360 | kubevirtRouterService.updatePeerRouterMac(router.name(), sha); |
| 361 | } |
| 362 | } |
| 363 | } |