blob: f2c2eda00b07d1238f692b17a40698cd275a60a1 [file] [log] [blame]
Hyunsun Moonb974fca2016-06-30 21:20:39 -07001/*
Jian Li8e7e6cd2018-03-30 13:33:08 +09002 * Copyright 2016-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 */
Hyunsun Moon05400872017-02-07 17:11:25 +090016package org.onosproject.openstacknetworking.impl;
Hyunsun Moonb974fca2016-06-30 21:20:39 -070017
18import com.google.common.base.Strings;
19import com.google.common.collect.Sets;
20import org.apache.felix.scr.annotations.Activate;
21import org.apache.felix.scr.annotations.Component;
22import org.apache.felix.scr.annotations.Deactivate;
23import org.apache.felix.scr.annotations.Modified;
24import org.apache.felix.scr.annotations.Property;
25import org.apache.felix.scr.annotations.Reference;
26import org.apache.felix.scr.annotations.ReferenceCardinality;
27import org.onlab.packet.ARP;
Hyunsun Moon44aac662017-02-18 02:07:01 +090028import org.onlab.packet.EthType;
Hyunsun Moonb974fca2016-06-30 21:20:39 -070029import org.onlab.packet.Ethernet;
30import org.onlab.packet.Ip4Address;
31import org.onlab.packet.IpAddress;
32import org.onlab.packet.MacAddress;
33import org.onlab.util.Tools;
Hyunsun Moon44aac662017-02-18 02:07:01 +090034import org.onosproject.cfg.ComponentConfigService;
Jian Lieae12362018-04-10 18:48:32 +090035import org.onosproject.cluster.ClusterService;
36import org.onosproject.cluster.LeadershipService;
37import org.onosproject.cluster.NodeId;
Hyunsun Moon44aac662017-02-18 02:07:01 +090038import org.onosproject.core.ApplicationId;
39import org.onosproject.core.CoreService;
Jian Lieae12362018-04-10 18:48:32 +090040import org.onosproject.mastership.MastershipService;
41import org.onosproject.net.PortNumber;
42import org.onosproject.net.device.DeviceService;
Hyunsun Moon44aac662017-02-18 02:07:01 +090043import org.onosproject.net.flow.DefaultTrafficSelector;
Hyunsun Moonb974fca2016-06-30 21:20:39 -070044import org.onosproject.net.flow.DefaultTrafficTreatment;
Hyunsun Moon44aac662017-02-18 02:07:01 +090045import org.onosproject.net.flow.TrafficSelector;
Hyunsun Moonb974fca2016-06-30 21:20:39 -070046import org.onosproject.net.flow.TrafficTreatment;
47import org.onosproject.net.packet.DefaultOutboundPacket;
48import org.onosproject.net.packet.PacketContext;
49import org.onosproject.net.packet.PacketProcessor;
50import org.onosproject.net.packet.PacketService;
Hyunsun Moon44aac662017-02-18 02:07:01 +090051import org.onosproject.openstacknetworking.api.InstancePort;
Jian Lieae12362018-04-10 18:48:32 +090052import org.onosproject.openstacknetworking.api.InstancePortEvent;
53import org.onosproject.openstacknetworking.api.InstancePortListener;
Hyunsun Moon44aac662017-02-18 02:07:01 +090054import org.onosproject.openstacknetworking.api.InstancePortService;
Jian Lieae12362018-04-10 18:48:32 +090055import org.onosproject.openstacknetworking.api.OpenstackFlowRuleService;
Hyunsun Moon44aac662017-02-18 02:07:01 +090056import org.onosproject.openstacknetworking.api.OpenstackNetworkEvent;
57import org.onosproject.openstacknetworking.api.OpenstackNetworkListener;
58import org.onosproject.openstacknetworking.api.OpenstackNetworkService;
Jian Lieae12362018-04-10 18:48:32 +090059import org.onosproject.openstacknode.api.OpenstackNode;
60import org.onosproject.openstacknode.api.OpenstackNodeEvent;
61import org.onosproject.openstacknode.api.OpenstackNodeListener;
62import org.onosproject.openstacknode.api.OpenstackNodeService;
63import org.openstack4j.model.network.Network;
64import org.openstack4j.model.network.NetworkType;
Hyunsun Moon44aac662017-02-18 02:07:01 +090065import org.openstack4j.model.network.Subnet;
Hyunsun Moonb974fca2016-06-30 21:20:39 -070066import org.osgi.service.component.ComponentContext;
67import org.slf4j.Logger;
68import org.slf4j.LoggerFactory;
Hyunsun Moon44aac662017-02-18 02:07:01 +090069
Hyunsun Moonb974fca2016-06-30 21:20:39 -070070import java.nio.ByteBuffer;
71import java.util.Dictionary;
Jian Lieae12362018-04-10 18:48:32 +090072import java.util.Objects;
Hyunsun Moonb974fca2016-06-30 21:20:39 -070073import java.util.Set;
74
75import static com.google.common.base.Preconditions.checkNotNull;
Jian Lieae12362018-04-10 18:48:32 +090076import static org.onosproject.openstacknetworking.api.Constants.ARP_BROADCAST_MODE;
77import static org.onosproject.openstacknetworking.api.Constants.ARP_PROXY_MODE;
78import static org.onosproject.openstacknetworking.api.Constants.DEFAULT_ARP_MODE_STR;
Hyunsun Moon44aac662017-02-18 02:07:01 +090079import static org.onosproject.openstacknetworking.api.Constants.DEFAULT_GATEWAY_MAC_STR;
Jian Lieae12362018-04-10 18:48:32 +090080import static org.onosproject.openstacknetworking.api.Constants.DHCP_ARP_TABLE;
Hyunsun Moon44aac662017-02-18 02:07:01 +090081import static org.onosproject.openstacknetworking.api.Constants.OPENSTACK_NETWORKING_APP_ID;
Jian Lieae12362018-04-10 18:48:32 +090082import static org.onosproject.openstacknetworking.api.Constants.PRIORITY_ARP_CONTROL_RULE;
83import static org.onosproject.openstacknetworking.api.Constants.PRIORITY_ARP_GATEWAY_RULE;
84import static org.onosproject.openstacknetworking.api.Constants.PRIORITY_ARP_REPLY_RULE;
85import static org.onosproject.openstacknetworking.api.Constants.PRIORITY_ARP_REQUEST_RULE;
86import static org.onosproject.openstacknetworking.api.Constants.PRIORITY_ARP_SUBNET_RULE;
87import static org.onosproject.openstacknetworking.util.RulePopulatorUtil.buildExtension;
88import static org.onosproject.openstacknode.api.OpenstackNode.NodeType.COMPUTE;
Hyunsun Moonb974fca2016-06-30 21:20:39 -070089
90/**
91 * Handles ARP packet from VMs.
92 */
93@Component(immediate = true)
Hyunsun Moon44aac662017-02-18 02:07:01 +090094public final class OpenstackSwitchingArpHandler {
Hyunsun Moonb974fca2016-06-30 21:20:39 -070095
96 private final Logger log = LoggerFactory.getLogger(getClass());
97
98 private static final String GATEWAY_MAC = "gatewayMac";
Jian Lieae12362018-04-10 18:48:32 +090099 private static final String ARP_MODE = "arpMode";
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700100
101 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Ray Milkey9c9cde42018-01-12 14:22:06 -0800102 CoreService coreService;
Hyunsun Moon44aac662017-02-18 02:07:01 +0900103
104 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Ray Milkey9c9cde42018-01-12 14:22:06 -0800105 PacketService packetService;
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700106
107 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Jian Lieae12362018-04-10 18:48:32 +0900108 OpenstackFlowRuleService osFlowRuleService;
109
110 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Ray Milkey9c9cde42018-01-12 14:22:06 -0800111 ComponentConfigService configService;
Hyunsun Moon44aac662017-02-18 02:07:01 +0900112
113 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Jian Lieae12362018-04-10 18:48:32 +0900114 ClusterService clusterService;
115
116 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
117 LeadershipService leadershipService;
118
119 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
120 DeviceService deviceService;
121
122 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
123 MastershipService mastershipService;
124
125 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Ray Milkey9c9cde42018-01-12 14:22:06 -0800126 InstancePortService instancePortService;
Hyunsun Moon44aac662017-02-18 02:07:01 +0900127
128 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Ray Milkey9c9cde42018-01-12 14:22:06 -0800129 OpenstackNetworkService osNetworkService;
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700130
Jian Lieae12362018-04-10 18:48:32 +0900131 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
132 protected OpenstackNodeService osNodeService;
133
Hyunsun Moonb3eb84d2016-07-27 19:10:52 -0700134 @Property(name = GATEWAY_MAC, value = DEFAULT_GATEWAY_MAC_STR,
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700135 label = "Fake MAC address for virtual network subnet gateway")
Hyunsun Moonb3eb84d2016-07-27 19:10:52 -0700136 private String gatewayMac = DEFAULT_GATEWAY_MAC_STR;
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700137
Jian Lieae12362018-04-10 18:48:32 +0900138 @Property(name = ARP_MODE, value = DEFAULT_ARP_MODE_STR,
Jian Li2a43cb32018-04-13 16:23:10 +0900139 label = "ARP processing mode, proxy (default) | broadcast ")
Jian Lieae12362018-04-10 18:48:32 +0900140 protected String arpMode = DEFAULT_ARP_MODE_STR;
141
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700142 private final InternalPacketProcessor packetProcessor = new InternalPacketProcessor();
Hyunsun Moon44aac662017-02-18 02:07:01 +0900143 private final InternalOpenstackNetworkListener osNetworkListener =
144 new InternalOpenstackNetworkListener();
Jian Lieae12362018-04-10 18:48:32 +0900145 private final InstancePortListener instancePortListener = new InternalInstancePortListener();
146 private final OpenstackNodeListener osNodeListener = new InternalNodeEventListener();
147
Hyunsun Moon44aac662017-02-18 02:07:01 +0900148 private final Set<IpAddress> gateways = Sets.newConcurrentHashSet();
149
150 private ApplicationId appId;
Jian Lieae12362018-04-10 18:48:32 +0900151 private NodeId localNodeId;
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700152
153 @Activate
Ray Milkey9c9cde42018-01-12 14:22:06 -0800154 void activate() {
Hyunsun Moon44aac662017-02-18 02:07:01 +0900155 appId = coreService.registerApplication(OPENSTACK_NETWORKING_APP_ID);
156 configService.registerProperties(getClass());
Jian Lieae12362018-04-10 18:48:32 +0900157 localNodeId = clusterService.getLocalNode().id();
Hyunsun Moon44aac662017-02-18 02:07:01 +0900158 osNetworkService.addListener(osNetworkListener);
Jian Lieae12362018-04-10 18:48:32 +0900159 osNodeService.addListener(osNodeListener);
160 leadershipService.runForLeadership(appId.name());
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700161 packetService.addProcessor(packetProcessor, PacketProcessor.director(0));
Jian Lieae12362018-04-10 18:48:32 +0900162
163 instancePortService.addListener(instancePortListener);
164
165 osNetworkService.networks().forEach(n -> {
166 if (n.getNetworkType() != NetworkType.FLAT) {
167 osNetworkService.subnets().forEach(s -> {
168 if (s.getNetworkId().equals(n.getId())) {
169 addSubnetGateway(s);
170 }
171 });
172 }
173 });
Hyunsun Moon44aac662017-02-18 02:07:01 +0900174
175 log.info("Started");
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700176 }
177
178 @Deactivate
Ray Milkey9c9cde42018-01-12 14:22:06 -0800179 void deactivate() {
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700180 packetService.removeProcessor(packetProcessor);
Hyunsun Moon44aac662017-02-18 02:07:01 +0900181 osNetworkService.removeListener(osNetworkListener);
Jian Lieae12362018-04-10 18:48:32 +0900182 osNodeService.removeListener(osNodeListener);
183 instancePortService.removeListener(instancePortListener);
184 leadershipService.withdraw(appId.name());
Hyunsun Moon44aac662017-02-18 02:07:01 +0900185 configService.unregisterProperties(getClass(), false);
186
187 log.info("Stopped");
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700188 }
189
190 @Modified
Ray Milkey9c9cde42018-01-12 14:22:06 -0800191 void modified(ComponentContext context) {
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700192 Dictionary<?, ?> properties = context.getProperties();
193 String updatedMac;
194
195 updatedMac = Tools.get(properties, GATEWAY_MAC);
196 if (!Strings.isNullOrEmpty(updatedMac) && !updatedMac.equals(gatewayMac)) {
197 gatewayMac = updatedMac;
198 }
199
Jian Lieae12362018-04-10 18:48:32 +0900200 String updateArpMode;
201
202 updateArpMode = Tools.get(properties, ARP_MODE);
203 if (!Strings.isNullOrEmpty(updateArpMode) && !updateArpMode.equals(arpMode)) {
204 arpMode = updateArpMode;
205 }
206
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700207 log.info("Modified");
208 }
209
Hyunsun Moon44aac662017-02-18 02:07:01 +0900210 private void addSubnetGateway(Subnet osSubnet) {
211 if (Strings.isNullOrEmpty(osSubnet.getGateway())) {
212 return;
213 }
214 IpAddress gatewayIp = IpAddress.valueOf(osSubnet.getGateway());
215 gateways.add(gatewayIp);
216 log.debug("Added ARP proxy entry IP:{}", gatewayIp);
217 }
218
219 private void removeSubnetGateway(Subnet osSubnet) {
220 if (Strings.isNullOrEmpty(osSubnet.getGateway())) {
221 return;
222 }
223 IpAddress gatewayIp = IpAddress.valueOf(osSubnet.getGateway());
224 gateways.remove(gatewayIp);
225 log.debug("Removed ARP proxy entry IP:{}", gatewayIp);
226 }
227
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700228 /**
229 * Processes ARP request packets.
230 * It checks if the target IP is owned by a known host first and then ask to
231 * OpenStack if it's not. This ARP proxy does not support overlapping IP.
232 *
Hyunsun Moon44aac662017-02-18 02:07:01 +0900233 * @param context packet context
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700234 * @param ethPacket ethernet packet
235 */
236 private void processPacketIn(PacketContext context, Ethernet ethPacket) {
Jian Lieae12362018-04-10 18:48:32 +0900237
238 // if the ARP mode is configured as broadcast mode, we simply ignore ARP packet_in
239 if (arpMode.equals(ARP_BROADCAST_MODE)) {
240 return;
241 }
242
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700243 ARP arpPacket = (ARP) ethPacket.getPayload();
244 if (arpPacket.getOpCode() != ARP.OP_REQUEST) {
245 return;
246 }
247
Hyunsun Moon44aac662017-02-18 02:07:01 +0900248 InstancePort srcInstPort = instancePortService.instancePort(ethPacket.getSourceMAC());
249 if (srcInstPort == null) {
250 log.trace("Failed to find source instance port(MAC:{})",
251 ethPacket.getSourceMAC());
252 return;
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700253 }
254
Hyunsun Moon44aac662017-02-18 02:07:01 +0900255 IpAddress targetIp = Ip4Address.valueOf(arpPacket.getTargetProtocolAddress());
256 MacAddress replyMac = gateways.contains(targetIp) ? MacAddress.valueOf(gatewayMac) :
257 getMacFromHostOpenstack(targetIp, srcInstPort.networkId());
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700258 if (replyMac == MacAddress.NONE) {
Hyunsun Moon44aac662017-02-18 02:07:01 +0900259 log.trace("Failed to find MAC address for {}", targetIp);
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700260 return;
261 }
262
263 Ethernet ethReply = ARP.buildArpReply(
264 targetIp.getIp4Address(),
265 replyMac,
266 ethPacket);
267
268 TrafficTreatment treatment = DefaultTrafficTreatment.builder()
269 .setOutput(context.inPacket().receivedFrom().port())
270 .build();
271
272 packetService.emit(new DefaultOutboundPacket(
273 context.inPacket().receivedFrom().deviceId(),
274 treatment,
275 ByteBuffer.wrap(ethReply.serialize())));
276 }
277
278 /**
279 * Returns MAC address of a host with a given target IP address by asking to
Hyunsun Moon44aac662017-02-18 02:07:01 +0900280 * instance port service.
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700281 *
282 * @param targetIp target ip
Hyunsun Moon44aac662017-02-18 02:07:01 +0900283 * @param osNetId openstack network id of the source instance port
284 * @return mac address, or none mac address if it fails to find the mac
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700285 */
Hyunsun Moon44aac662017-02-18 02:07:01 +0900286 private MacAddress getMacFromHostOpenstack(IpAddress targetIp, String osNetId) {
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700287 checkNotNull(targetIp);
288
Hyunsun Moon44aac662017-02-18 02:07:01 +0900289 InstancePort instPort = instancePortService.instancePort(targetIp, osNetId);
290 if (instPort != null) {
291 log.trace("Found MAC from host service for {}", targetIp);
292 return instPort.macAddress();
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700293 } else {
294 return MacAddress.NONE;
295 }
296 }
297
Jian Lieae12362018-04-10 18:48:32 +0900298 /**
299 * An internal packet processor which processes ARP request, and results in
300 * packet-out ARP reply.
301 */
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700302 private class InternalPacketProcessor implements PacketProcessor {
303
304 @Override
305 public void process(PacketContext context) {
306 if (context.isHandled()) {
307 return;
308 }
309
310 Ethernet ethPacket = context.inPacket().parsed();
311 if (ethPacket == null || ethPacket.getEtherType() != Ethernet.TYPE_ARP) {
312 return;
313 }
314 processPacketIn(context, ethPacket);
315 }
316 }
Hyunsun Moon44aac662017-02-18 02:07:01 +0900317
Jian Lieae12362018-04-10 18:48:32 +0900318 /**
319 * An internal network listener which listens to openstack network event,
320 * manages the gateway collection and installs flow rule that handles
321 * ARP request in data plane.
322 */
Hyunsun Moon44aac662017-02-18 02:07:01 +0900323 private class InternalOpenstackNetworkListener implements OpenstackNetworkListener {
324
325 @Override
326 public boolean isRelevant(OpenstackNetworkEvent event) {
327 Subnet osSubnet = event.subnet();
328 if (osSubnet == null) {
329 return false;
330 }
Jian Lieae12362018-04-10 18:48:32 +0900331
Jian Libb4f5412018-04-12 09:48:50 +0900332 Network network = osNetworkService.network(osSubnet.getNetworkId());
333
Jian Lieae12362018-04-10 18:48:32 +0900334 if (network == null) {
335 log.warn("Network is not specified.");
336 return false;
337 } else {
338 if (network.getNetworkType().equals(NetworkType.FLAT)) {
339 return false;
340 }
341 }
342
343 // do not allow to proceed without leadership
344 NodeId leader = leadershipService.getLeader(appId.name());
345 if (!Objects.equals(localNodeId, leader)) {
346 return false;
347 }
348
Hyunsun Moon44aac662017-02-18 02:07:01 +0900349 return !Strings.isNullOrEmpty(osSubnet.getGateway());
350 }
351
352 @Override
353 public void event(OpenstackNetworkEvent event) {
354 switch (event.type()) {
355 case OPENSTACK_SUBNET_CREATED:
356 case OPENSTACK_SUBNET_UPDATED:
357 addSubnetGateway(event.subnet());
Jian Lieae12362018-04-10 18:48:32 +0900358 setFakeGatewayArpRule(event.subnet(), true);
Hyunsun Moon44aac662017-02-18 02:07:01 +0900359 break;
360 case OPENSTACK_SUBNET_REMOVED:
361 removeSubnetGateway(event.subnet());
Jian Lieae12362018-04-10 18:48:32 +0900362 setFakeGatewayArpRule(event.subnet(), false);
Hyunsun Moon44aac662017-02-18 02:07:01 +0900363 break;
364 case OPENSTACK_NETWORK_CREATED:
365 case OPENSTACK_NETWORK_UPDATED:
366 case OPENSTACK_NETWORK_REMOVED:
367 case OPENSTACK_PORT_CREATED:
368 case OPENSTACK_PORT_UPDATED:
369 case OPENSTACK_PORT_REMOVED:
370 default:
371 // do nothing for the other events
372 break;
373 }
374 }
Jian Lieae12362018-04-10 18:48:32 +0900375
376 /**
377 * Installs flow rules which convert ARP request packet into ARP reply
378 * by adding a fake gateway MAC address as Source Hardware Address.
379 *
380 * @param osSubnet openstack subnet
381 * @param install flag which indicates whether to install rule or remove rule
382 */
383 private void setFakeGatewayArpRule(Subnet osSubnet, boolean install) {
384
385 if (arpMode.equals(ARP_BROADCAST_MODE)) {
386 String gateway = osSubnet.getGateway();
387
388 TrafficSelector selector = DefaultTrafficSelector.builder()
389 .matchEthType(EthType.EtherType.ARP.ethType().toShort())
390 .matchArpOp(ARP.OP_REQUEST)
391 .matchArpTpa(Ip4Address.valueOf(gateway))
392 .build();
393
394 TrafficTreatment treatment = DefaultTrafficTreatment.builder()
395 .setArpOp(ARP.OP_REPLY)
396 .setArpSha(MacAddress.valueOf(gatewayMac))
397 .setArpSpa(Ip4Address.valueOf(gateway))
398 .setOutput(PortNumber.IN_PORT)
399 .build();
400
401 osNodeService.completeNodes(COMPUTE).forEach(n ->
402 osFlowRuleService.setRule(
403 appId,
404 n.intgBridge(),
405 selector,
406 treatment,
407 PRIORITY_ARP_GATEWAY_RULE,
408 DHCP_ARP_TABLE,
409 install
410 )
411 );
412 }
413 }
414 }
415
416 /**
417 * An internal openstack node listener which is used for listening openstack
418 * node activity. As long as a node is in complete state, we will install
419 * default ARP rule to handle ARP request.
420 */
421 private class InternalNodeEventListener implements OpenstackNodeListener {
422
423 @Override
424 public boolean isRelevant(OpenstackNodeEvent event) {
425 // do not allow to proceed without leadership
426 NodeId leader = leadershipService.getLeader(appId.name());
427 return Objects.equals(localNodeId, leader);
428 }
429
430 @Override
431 public void event(OpenstackNodeEvent event) {
432 OpenstackNode osNode = event.subject();
433 switch (event.type()) {
434 case OPENSTACK_NODE_COMPLETE:
Jian Lif96685c2018-05-21 14:14:16 +0900435 if (osNode.type().equals(COMPUTE)) {
436 setDefaultArpRule(osNode, true);
437 }
Jian Lieae12362018-04-10 18:48:32 +0900438 break;
439 case OPENSTACK_NODE_INCOMPLETE:
Jian Lif96685c2018-05-21 14:14:16 +0900440 if (osNode.type().equals(COMPUTE)) {
441 setDefaultArpRule(osNode, false);
442 }
Jian Lieae12362018-04-10 18:48:32 +0900443 break;
Jian Lieae12362018-04-10 18:48:32 +0900444 default:
445 break;
446 }
447 }
448
Jian Lif96685c2018-05-21 14:14:16 +0900449 private void setDefaultArpRule(OpenstackNode osNode, boolean install) {
450 switch (arpMode) {
451 case ARP_PROXY_MODE:
452 setDefaultArpRuleForProxyMode(osNode, install);
453 break;
454 case ARP_BROADCAST_MODE:
455 setDefaultArpRuleForBroadcastMode(osNode, install);
456 break;
457 default:
458 log.warn("Invalid ARP mode {}. Please use either " +
459 "broadcast or proxy mode.", arpMode);
460 break;
Jian Lieae12362018-04-10 18:48:32 +0900461 }
462 }
Jian Lif96685c2018-05-21 14:14:16 +0900463
464 private void setDefaultArpRuleForProxyMode(OpenstackNode osNode, boolean install) {
465 TrafficSelector selector = DefaultTrafficSelector.builder()
466 .matchEthType(EthType.EtherType.ARP.ethType().toShort())
467 .build();
468
469 TrafficTreatment treatment = DefaultTrafficTreatment.builder()
470 .punt()
471 .build();
472
473 osFlowRuleService.setRule(
474 appId,
475 osNode.intgBridge(),
476 selector,
477 treatment,
478 PRIORITY_ARP_CONTROL_RULE,
479 DHCP_ARP_TABLE,
480 install
481 );
482 }
483
484 private void setDefaultArpRuleForBroadcastMode(OpenstackNode osNode, boolean install) {
485 TrafficSelector selector = DefaultTrafficSelector.builder()
486 .matchEthType(EthType.EtherType.ARP.ethType().toShort())
487 .matchArpOp(ARP.OP_REQUEST)
488 .build();
489
490 TrafficTreatment treatment = DefaultTrafficTreatment.builder()
491 .setOutput(PortNumber.FLOOD)
492 .build();
493
494 osFlowRuleService.setRule(
495 appId,
496 osNode.intgBridge(),
497 selector,
498 treatment,
499 PRIORITY_ARP_SUBNET_RULE,
500 DHCP_ARP_TABLE,
501 install
502 );
503 }
Jian Lieae12362018-04-10 18:48:32 +0900504 }
505
506 /**
507 * An internal instance port listener which listens the port events generated
508 * from VM. When ARP a host which located in a remote compute node, we specify
509 * both ARP OP mode as REQUEST and Target Protocol Address (TPA) with
510 * host IP address. When ARP a host which located in a local compute node,
511 * we specify only ARP OP mode as REQUEST.
512 */
513 private class InternalInstancePortListener implements InstancePortListener {
514
515 @Override
516 public boolean isRelevant(InstancePortEvent event) {
517
518 if (arpMode.equals(ARP_PROXY_MODE)) {
519 return false;
520 }
521
522 InstancePort instPort = event.subject();
523 return mastershipService.isLocalMaster(instPort.deviceId());
524 }
525
526 @Override
527 public void event(InstancePortEvent event) {
528 switch (event.type()) {
529 case OPENSTACK_INSTANCE_PORT_UPDATED:
530 case OPENSTACK_INSTANCE_PORT_DETECTED:
531 setArpRequestRule(event.subject(), true);
532 setArpReplyRule(event.subject(), true);
533 break;
534 case OPENSTACK_INSTANCE_PORT_VANISHED:
535 setArpRequestRule(event.subject(), false);
536 setArpReplyRule(event.subject(), false);
537 break;
538 default:
539 break;
540 }
541 }
542
543 /**
544 * Installs flow rules to match ARP request packets.
545 *
546 * @param port instance port
547 * @param install installation flag
548 */
549 private void setArpRequestRule(InstancePort port, boolean install) {
550 NetworkType type = osNetworkService.network(port.networkId()).getNetworkType();
551
552 switch (type) {
553 case VXLAN:
554 setRemoteArpRequestRuleForVxlan(port, install);
555 break;
556 case VLAN:
Jian Li59657882018-05-10 13:13:06 +0900557 // since VLAN ARP packet can be broadcasted to all hosts that connected with L2 network,
558 // there is no need to add any flow rules to handle ARP request
Jian Lieae12362018-04-10 18:48:32 +0900559 break;
560 default:
561 break;
562 }
563 }
564
565 /**
566 * Installs flow rules to match ARP reply packets.
567 *
568 * @param port instance port
569 * @param install installation flag
570 */
571 private void setArpReplyRule(InstancePort port, boolean install) {
572 NetworkType type = osNetworkService.network(port.networkId()).getNetworkType();
573
574 switch (type) {
575 case VXLAN:
Jian Li59657882018-05-10 13:13:06 +0900576 setArpReplyRuleForVxlan(port, install);
Jian Lieae12362018-04-10 18:48:32 +0900577 break;
578 case VLAN:
Jian Li59657882018-05-10 13:13:06 +0900579 setArpReplyRuleForVlan(port, install);
Jian Lieae12362018-04-10 18:48:32 +0900580 break;
581 default:
582 break;
583 }
584 }
585
586 /**
587 * Installs flow rules to match ARP request packets only for VxLAN.
588 *
589 * @param port instance port
590 * @param install installation flag
591 */
592 private void setRemoteArpRequestRuleForVxlan(InstancePort port, boolean install) {
593
594 OpenstackNode localNode = osNodeService.node(port.deviceId());
595
596 TrafficSelector selector = DefaultTrafficSelector.builder()
597 .matchEthType(EthType.EtherType.ARP.ethType().toShort())
598 .matchArpOp(ARP.OP_REQUEST)
599 .matchArpTpa(port.ipAddress().getIp4Address())
600 .build();
601
602 setRemoteArpTreatmentForVxlan(selector, port, localNode, install);
603 }
604
605 /**
606 * Installs flow rules to match ARP reply packets only for VxLAN.
607 *
608 * @param port instance port
609 * @param install installation flag
610 */
Jian Li59657882018-05-10 13:13:06 +0900611 private void setArpReplyRuleForVxlan(InstancePort port, boolean install) {
Jian Lieae12362018-04-10 18:48:32 +0900612
613 OpenstackNode localNode = osNodeService.node(port.deviceId());
614
Jian Li59657882018-05-10 13:13:06 +0900615 TrafficSelector selector = setArpReplyRuleForVnet(port, install);
616 setRemoteArpTreatmentForVxlan(selector, port, localNode, install);
617 }
618
619 /**
620 * Installs flow rules to match ARP reply packets only for VLAN.
621 *
622 * @param port instance port
623 * @param install installation flag
624 */
625 private void setArpReplyRuleForVlan(InstancePort port, boolean install) {
626
627 TrafficSelector selector = setArpReplyRuleForVnet(port, install);
628 setRemoteArpTreatmentForVlan(selector, port, install);
629 }
630
631 // a helper method
632 private TrafficSelector setArpReplyRuleForVnet(InstancePort port, boolean install) {
Jian Lieae12362018-04-10 18:48:32 +0900633 TrafficSelector selector = DefaultTrafficSelector.builder()
634 .matchEthType(EthType.EtherType.ARP.ethType().toShort())
635 .matchArpOp(ARP.OP_REPLY)
636 .matchArpTpa(port.ipAddress().getIp4Address())
637 .matchArpTha(port.macAddress())
638 .build();
639
640 TrafficTreatment treatment = DefaultTrafficTreatment.builder()
641 .setOutput(port.portNumber())
642 .build();
643
644 osFlowRuleService.setRule(
645 appId,
646 port.deviceId(),
647 selector,
648 treatment,
649 PRIORITY_ARP_REPLY_RULE,
650 DHCP_ARP_TABLE,
651 install
652 );
653
Jian Li59657882018-05-10 13:13:06 +0900654 return selector;
Jian Lieae12362018-04-10 18:48:32 +0900655 }
656
657 // a helper method
658 private void setRemoteArpTreatmentForVxlan(TrafficSelector selector,
659 InstancePort port,
660 OpenstackNode localNode,
661 boolean install) {
662 for (OpenstackNode remoteNode : osNodeService.completeNodes(COMPUTE)) {
663 if (!remoteNode.intgBridge().equals(port.deviceId())) {
664 TrafficTreatment treatmentToRemote = DefaultTrafficTreatment.builder()
665 .extension(buildExtension(
666 deviceService,
667 remoteNode.intgBridge(),
668 localNode.dataIp().getIp4Address()),
669 remoteNode.intgBridge())
670 .setOutput(remoteNode.tunnelPortNum())
671 .build();
672
673 osFlowRuleService.setRule(
674 appId,
675 remoteNode.intgBridge(),
676 selector,
677 treatmentToRemote,
678 PRIORITY_ARP_REQUEST_RULE,
679 DHCP_ARP_TABLE,
680 install
681 );
682 }
683 }
684 }
Jian Li59657882018-05-10 13:13:06 +0900685
686 // a helper method
687 private void setRemoteArpTreatmentForVlan(TrafficSelector selector,
688 InstancePort port,
689 boolean install) {
690 for (OpenstackNode remoteNode : osNodeService.completeNodes(COMPUTE)) {
691 if (!remoteNode.intgBridge().equals(port.deviceId()) && remoteNode.vlanIntf() != null) {
692 TrafficTreatment treatmentToRemote = DefaultTrafficTreatment.builder()
693 .setOutput(remoteNode.vlanPortNum())
694 .build();
695
696 osFlowRuleService.setRule(
697 appId,
698 remoteNode.intgBridge(),
699 selector,
700 treatmentToRemote,
701 PRIORITY_ARP_REQUEST_RULE,
702 DHCP_ARP_TABLE,
703 install);
704 }
705 }
706 }
Hyunsun Moon44aac662017-02-18 02:07:01 +0900707 }
Hyunsun Moonb974fca2016-06-30 21:20:39 -0700708}