Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -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 | */ |
Hyunsun Moon | 0540087 | 2017-02-07 17:11:25 +0900 | [diff] [blame] | 16 | package org.onosproject.openstacknetworking.impl; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 17 | |
| 18 | import com.google.common.base.Strings; |
| 19 | import com.google.common.collect.Sets; |
| 20 | import org.apache.felix.scr.annotations.Activate; |
| 21 | import org.apache.felix.scr.annotations.Component; |
| 22 | import org.apache.felix.scr.annotations.Deactivate; |
| 23 | import org.apache.felix.scr.annotations.Modified; |
| 24 | import org.apache.felix.scr.annotations.Property; |
| 25 | import org.apache.felix.scr.annotations.Reference; |
| 26 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 27 | import org.onlab.packet.ARP; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 28 | import org.onlab.packet.EthType; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 29 | import org.onlab.packet.Ethernet; |
| 30 | import org.onlab.packet.Ip4Address; |
| 31 | import org.onlab.packet.IpAddress; |
| 32 | import org.onlab.packet.MacAddress; |
| 33 | import org.onlab.util.Tools; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 34 | import org.onosproject.cfg.ComponentConfigService; |
| 35 | import org.onosproject.core.ApplicationId; |
| 36 | import org.onosproject.core.CoreService; |
| 37 | import org.onosproject.net.flow.DefaultTrafficSelector; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 38 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 39 | import org.onosproject.net.flow.TrafficSelector; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 40 | import org.onosproject.net.flow.TrafficTreatment; |
| 41 | import org.onosproject.net.packet.DefaultOutboundPacket; |
| 42 | import org.onosproject.net.packet.PacketContext; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 43 | import org.onosproject.net.packet.PacketPriority; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 44 | import org.onosproject.net.packet.PacketProcessor; |
| 45 | import org.onosproject.net.packet.PacketService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 46 | import org.onosproject.openstacknetworking.api.InstancePort; |
| 47 | import org.onosproject.openstacknetworking.api.InstancePortService; |
| 48 | import org.onosproject.openstacknetworking.api.OpenstackNetworkEvent; |
| 49 | import org.onosproject.openstacknetworking.api.OpenstackNetworkListener; |
| 50 | import org.onosproject.openstacknetworking.api.OpenstackNetworkService; |
| 51 | import org.openstack4j.model.network.Subnet; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 52 | import org.osgi.service.component.ComponentContext; |
| 53 | import org.slf4j.Logger; |
| 54 | import org.slf4j.LoggerFactory; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 55 | |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 56 | import java.nio.ByteBuffer; |
| 57 | import java.util.Dictionary; |
| 58 | import java.util.Set; |
| 59 | |
| 60 | import static com.google.common.base.Preconditions.checkNotNull; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 61 | import static org.onosproject.openstacknetworking.api.Constants.DEFAULT_GATEWAY_MAC_STR; |
| 62 | import static org.onosproject.openstacknetworking.api.Constants.OPENSTACK_NETWORKING_APP_ID; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 63 | |
| 64 | /** |
| 65 | * Handles ARP packet from VMs. |
| 66 | */ |
| 67 | @Component(immediate = true) |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 68 | public final class OpenstackSwitchingArpHandler { |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 69 | |
| 70 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 71 | |
| 72 | private static final String GATEWAY_MAC = "gatewayMac"; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 73 | |
| 74 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 75 | CoreService coreService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 76 | |
| 77 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 78 | PacketService packetService; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 79 | |
| 80 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 81 | ComponentConfigService configService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 82 | |
| 83 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 84 | InstancePortService instancePortService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 85 | |
| 86 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 87 | OpenstackNetworkService osNetworkService; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 88 | |
Hyunsun Moon | b3eb84d | 2016-07-27 19:10:52 -0700 | [diff] [blame] | 89 | @Property(name = GATEWAY_MAC, value = DEFAULT_GATEWAY_MAC_STR, |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 90 | label = "Fake MAC address for virtual network subnet gateway") |
Hyunsun Moon | b3eb84d | 2016-07-27 19:10:52 -0700 | [diff] [blame] | 91 | private String gatewayMac = DEFAULT_GATEWAY_MAC_STR; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 92 | |
| 93 | private final InternalPacketProcessor packetProcessor = new InternalPacketProcessor(); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 94 | private final InternalOpenstackNetworkListener osNetworkListener = |
| 95 | new InternalOpenstackNetworkListener(); |
| 96 | private final Set<IpAddress> gateways = Sets.newConcurrentHashSet(); |
| 97 | |
| 98 | private ApplicationId appId; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 99 | |
| 100 | @Activate |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 101 | void activate() { |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 102 | appId = coreService.registerApplication(OPENSTACK_NETWORKING_APP_ID); |
| 103 | configService.registerProperties(getClass()); |
| 104 | osNetworkService.addListener(osNetworkListener); |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 105 | packetService.addProcessor(packetProcessor, PacketProcessor.director(0)); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 106 | osNetworkService.subnets().forEach(this::addSubnetGateway); |
| 107 | requestPacket(); |
| 108 | |
| 109 | log.info("Started"); |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | @Deactivate |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 113 | void deactivate() { |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 114 | packetService.removeProcessor(packetProcessor); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 115 | osNetworkService.removeListener(osNetworkListener); |
| 116 | configService.unregisterProperties(getClass(), false); |
| 117 | |
| 118 | log.info("Stopped"); |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | @Modified |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 122 | void modified(ComponentContext context) { |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 123 | Dictionary<?, ?> properties = context.getProperties(); |
| 124 | String updatedMac; |
| 125 | |
| 126 | updatedMac = Tools.get(properties, GATEWAY_MAC); |
| 127 | if (!Strings.isNullOrEmpty(updatedMac) && !updatedMac.equals(gatewayMac)) { |
| 128 | gatewayMac = updatedMac; |
| 129 | } |
| 130 | |
| 131 | log.info("Modified"); |
| 132 | } |
| 133 | |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 134 | private void requestPacket() { |
| 135 | TrafficSelector selector = DefaultTrafficSelector.builder() |
| 136 | .matchEthType(EthType.EtherType.ARP.ethType().toShort()) |
| 137 | .build(); |
| 138 | |
| 139 | packetService.requestPackets( |
| 140 | selector, |
| 141 | PacketPriority.CONTROL, |
| 142 | appId); |
| 143 | } |
| 144 | |
| 145 | private void addSubnetGateway(Subnet osSubnet) { |
| 146 | if (Strings.isNullOrEmpty(osSubnet.getGateway())) { |
| 147 | return; |
| 148 | } |
| 149 | IpAddress gatewayIp = IpAddress.valueOf(osSubnet.getGateway()); |
| 150 | gateways.add(gatewayIp); |
| 151 | log.debug("Added ARP proxy entry IP:{}", gatewayIp); |
| 152 | } |
| 153 | |
| 154 | private void removeSubnetGateway(Subnet osSubnet) { |
| 155 | if (Strings.isNullOrEmpty(osSubnet.getGateway())) { |
| 156 | return; |
| 157 | } |
| 158 | IpAddress gatewayIp = IpAddress.valueOf(osSubnet.getGateway()); |
| 159 | gateways.remove(gatewayIp); |
| 160 | log.debug("Removed ARP proxy entry IP:{}", gatewayIp); |
| 161 | } |
| 162 | |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 163 | /** |
| 164 | * Processes ARP request packets. |
| 165 | * It checks if the target IP is owned by a known host first and then ask to |
| 166 | * OpenStack if it's not. This ARP proxy does not support overlapping IP. |
| 167 | * |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 168 | * @param context packet context |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 169 | * @param ethPacket ethernet packet |
| 170 | */ |
| 171 | private void processPacketIn(PacketContext context, Ethernet ethPacket) { |
| 172 | ARP arpPacket = (ARP) ethPacket.getPayload(); |
| 173 | if (arpPacket.getOpCode() != ARP.OP_REQUEST) { |
| 174 | return; |
| 175 | } |
| 176 | |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 177 | InstancePort srcInstPort = instancePortService.instancePort(ethPacket.getSourceMAC()); |
| 178 | if (srcInstPort == null) { |
| 179 | log.trace("Failed to find source instance port(MAC:{})", |
| 180 | ethPacket.getSourceMAC()); |
| 181 | return; |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 182 | } |
| 183 | |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 184 | IpAddress targetIp = Ip4Address.valueOf(arpPacket.getTargetProtocolAddress()); |
| 185 | MacAddress replyMac = gateways.contains(targetIp) ? MacAddress.valueOf(gatewayMac) : |
| 186 | getMacFromHostOpenstack(targetIp, srcInstPort.networkId()); |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 187 | if (replyMac == MacAddress.NONE) { |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 188 | log.trace("Failed to find MAC address for {}", targetIp); |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 189 | return; |
| 190 | } |
| 191 | |
| 192 | Ethernet ethReply = ARP.buildArpReply( |
| 193 | targetIp.getIp4Address(), |
| 194 | replyMac, |
| 195 | ethPacket); |
| 196 | |
| 197 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| 198 | .setOutput(context.inPacket().receivedFrom().port()) |
| 199 | .build(); |
| 200 | |
| 201 | packetService.emit(new DefaultOutboundPacket( |
| 202 | context.inPacket().receivedFrom().deviceId(), |
| 203 | treatment, |
| 204 | ByteBuffer.wrap(ethReply.serialize()))); |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Returns MAC address of a host with a given target IP address by asking to |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 209 | * instance port service. |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 210 | * |
| 211 | * @param targetIp target ip |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 212 | * @param osNetId openstack network id of the source instance port |
| 213 | * @return mac address, or none mac address if it fails to find the mac |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 214 | */ |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 215 | private MacAddress getMacFromHostOpenstack(IpAddress targetIp, String osNetId) { |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 216 | checkNotNull(targetIp); |
| 217 | |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 218 | InstancePort instPort = instancePortService.instancePort(targetIp, osNetId); |
| 219 | if (instPort != null) { |
| 220 | log.trace("Found MAC from host service for {}", targetIp); |
| 221 | return instPort.macAddress(); |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 222 | } else { |
| 223 | return MacAddress.NONE; |
| 224 | } |
| 225 | } |
| 226 | |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 227 | private class InternalPacketProcessor implements PacketProcessor { |
| 228 | |
| 229 | @Override |
| 230 | public void process(PacketContext context) { |
| 231 | if (context.isHandled()) { |
| 232 | return; |
| 233 | } |
| 234 | |
| 235 | Ethernet ethPacket = context.inPacket().parsed(); |
| 236 | if (ethPacket == null || ethPacket.getEtherType() != Ethernet.TYPE_ARP) { |
| 237 | return; |
| 238 | } |
| 239 | processPacketIn(context, ethPacket); |
| 240 | } |
| 241 | } |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 242 | |
| 243 | private class InternalOpenstackNetworkListener implements OpenstackNetworkListener { |
| 244 | |
| 245 | @Override |
| 246 | public boolean isRelevant(OpenstackNetworkEvent event) { |
| 247 | Subnet osSubnet = event.subnet(); |
| 248 | if (osSubnet == null) { |
| 249 | return false; |
| 250 | } |
| 251 | return !Strings.isNullOrEmpty(osSubnet.getGateway()); |
| 252 | } |
| 253 | |
| 254 | @Override |
| 255 | public void event(OpenstackNetworkEvent event) { |
| 256 | switch (event.type()) { |
| 257 | case OPENSTACK_SUBNET_CREATED: |
| 258 | case OPENSTACK_SUBNET_UPDATED: |
| 259 | addSubnetGateway(event.subnet()); |
| 260 | break; |
| 261 | case OPENSTACK_SUBNET_REMOVED: |
| 262 | removeSubnetGateway(event.subnet()); |
| 263 | break; |
| 264 | case OPENSTACK_NETWORK_CREATED: |
| 265 | case OPENSTACK_NETWORK_UPDATED: |
| 266 | case OPENSTACK_NETWORK_REMOVED: |
| 267 | case OPENSTACK_PORT_CREATED: |
| 268 | case OPENSTACK_PORT_UPDATED: |
| 269 | case OPENSTACK_PORT_REMOVED: |
| 270 | default: |
| 271 | // do nothing for the other events |
| 272 | break; |
| 273 | } |
| 274 | } |
| 275 | } |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 276 | } |