arputil/arputil-impl/src/main/java/org/opendaylight/genius/arputil/internal/ArpUtilImpl.java

   1 /*
   2  * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.genius.arputil.internal;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkNotNull;
  12 import static org.opendaylight.mdsal.binding.util.Datastore.OPERATIONAL;
  13
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import com.google.common.util.concurrent.MoreExecutors;
  18 import com.google.common.util.concurrent.SettableFuture;
  19 import java.net.InetAddress;
  20 import java.net.UnknownHostException;
  21 import java.nio.charset.StandardCharsets;
  22 import java.util.HashMap;
  23 import java.util.Map;
  24 import java.util.concurrent.ConcurrentHashMap;
  25 import java.util.concurrent.ConcurrentMap;
  26 import java.util.concurrent.ExecutionException;
  27 import java.util.concurrent.ExecutorService;
  28 import java.util.concurrent.Future;
  29 import javax.inject.Inject;
  30 import javax.inject.Singleton;
  31 import org.apache.aries.blueprint.annotation.service.Reference;
  32 import org.opendaylight.genius.arputil.api.ArpConstants;
  33 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  34 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  35 import org.opendaylight.genius.mdsalutil.NWUtil;
  36 import org.opendaylight.genius.mdsalutil.packet.ARP;
  37 import org.opendaylight.genius.mdsalutil.packet.Ethernet;
  38 import org.opendaylight.infrautils.inject.AbstractLifecycle;
  39 import org.opendaylight.infrautils.metrics.Meter;
  40 import org.opendaylight.infrautils.metrics.MetricProvider;
  41 import org.opendaylight.infrautils.utils.concurrent.Executors;
  42 import org.opendaylight.mdsal.binding.api.DataBroker;
  43 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
  44 import org.opendaylight.mdsal.binding.api.NotificationService;
  45 import org.opendaylight.mdsal.binding.util.Datastore.Operational;
  46 import org.opendaylight.mdsal.binding.util.ManagedNewTransactionRunner;
  47 import org.opendaylight.mdsal.binding.util.ManagedNewTransactionRunnerImpl;
  48 import org.opendaylight.openflowplugin.libraries.liblldp.HexEncode;
  49 import org.opendaylight.openflowplugin.libraries.liblldp.Packet;
  50 import org.opendaylight.openflowplugin.libraries.liblldp.PacketException;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.ArpRequestReceivedBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.ArpResponseReceivedBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.GetMacInput;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.GetMacOutput;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.GetMacOutputBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.MacChangedBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.OdlArputilService;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.SendArpRequestInput;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.SendArpRequestInputBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.SendArpRequestOutput;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.SendArpResponseInput;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.SendArpResponseOutput;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406.interfaces.InterfaceAddress;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetEgressActionsForInterfaceInputBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetEgressActionsForInterfaceOutput;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetPortFromInterfaceInputBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetPortFromInterfaceOutput;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Metadata;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketInReason;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingListener;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingService;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.SendToController;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketInput;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketInputBuilder;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketOutput;
  95 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  96 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  97 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  98 import org.opendaylight.yangtools.yang.common.RpcResult;
  99 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 100 import org.opendaylight.yangtools.yang.common.Uint64;
 101 import org.slf4j.Logger;
 102 import org.slf4j.LoggerFactory;
 103
 104 @Singleton
 105 public class ArpUtilImpl extends AbstractLifecycle implements OdlArputilService, PacketProcessingListener {
 106     private static final Logger LOG = LoggerFactory.getLogger(ArpUtilImpl.class);
 107     private static final String MODULENAME = "odl.genius.arputil.";
 108     private static final String OPENFLOW_PFX = "openflow:";
 109
 110     private final ManagedNewTransactionRunner txRunner;
 111     private final PacketProcessingService packetProcessingService;
 112     private final NotificationPublishService notificationPublishService;
 113     private final NotificationService notificationService;
 114     private final OdlInterfaceRpcService odlInterfaceRpcService;
 115     private ListenerRegistration<ArpUtilImpl> listenerRegistration;
 116     private final ExecutorService threadPool = Executors.newFixedThreadPool(1, "ArpUtil", LOG);
 117     private final ConcurrentMap<String, String> macsDB = new ConcurrentHashMap<>();
 118     private final ConcurrentMap<String, SettableFuture<RpcResult<GetMacOutput>>> macAddrs = new ConcurrentHashMap<>();
 119
 120     private final Meter arpRespRecvd;
 121     private final Meter arpRespRecvdNotification;
 122     private final Meter arpRespRecvdNotificationRejected;
 123     private final Meter arpReqRecvd;
 124     private final Meter arpReqRecvdNotification;
 125     private final Meter arpReqRecvdNotificationRejected;
 126
 127
 128     @Inject
 129     public ArpUtilImpl(@Reference final DataBroker dataBroker,
 130                        final PacketProcessingService packetProcessingService,
 131                        @Reference final NotificationPublishService notificationPublishService,
 132                        @Reference final NotificationService notificationService,
 133                        final OdlInterfaceRpcService odlInterfaceRpcService,
 134                        @Reference  final MetricProvider metricProvider) {
 135         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
 136         this.packetProcessingService = packetProcessingService;
 137         this.notificationPublishService = notificationPublishService;
 138         this.notificationService = notificationService;
 139         this.odlInterfaceRpcService = odlInterfaceRpcService;
 140
 141         arpRespRecvd = metricProvider.newMeter(this,MODULENAME + "arpResponseReceived");
 142         arpRespRecvdNotification = metricProvider.newMeter(this,MODULENAME + "arpResponseReceivedNotification");
 143         arpRespRecvdNotificationRejected = metricProvider.newMeter(this,
 144                 MODULENAME + "arpResponseReceivedNotificationRejected");
 145         arpReqRecvd = metricProvider.newMeter(this,MODULENAME + "arpRequestReceived");
 146         arpReqRecvdNotification = metricProvider.newMeter(this,MODULENAME + "arpRequestReceivedNotification");
 147         arpReqRecvdNotificationRejected = metricProvider.newMeter(this,
 148                 MODULENAME + "arpRequestReceivedNotificationRejected");
 149     }
 150
 151     @Override
 152     public void start() {
 153         LOG.info("{} start", getClass().getSimpleName());
 154         listenerRegistration = notificationService.registerNotificationListener(this);
 155     }
 156
 157     @Override
 158     public void stop() {
 159         LOG.info("{} stop", getClass().getSimpleName());
 160
 161         if (listenerRegistration != null) {
 162             listenerRegistration.close();
 163             listenerRegistration = null;
 164         }
 165     }
 166
 167     private String getIpAddressInString(IpAddress ipAddress) throws UnknownHostException {
 168         return InetAddress.getByName(ipAddress.getIpv4Address().getValue()).getHostAddress();
 169     }
 170
 171     @Override
 172     public ListenableFuture<RpcResult<GetMacOutput>> getMac(GetMacInput input) {
 173         try {
 174             final String dstIpAddress = getIpAddressInString(input.getIpaddress());
 175             LOG.trace("getMac rpc invoked for ip {}", dstIpAddress);
 176             if (macAddrs.get(dstIpAddress) != null) {
 177                 if (LOG.isInfoEnabled()) {
 178                     LOG.info("get mac already in progress for the ip {}", dstIpAddress);
 179                 }
 180                 return macAddrs.get(dstIpAddress);
 181             }
 182             SendArpRequestInputBuilder builder = new SendArpRequestInputBuilder()
 183                     .setInterfaceAddress(input.getInterfaceAddress()).setIpaddress(input.getIpaddress());
 184             ListenableFuture<RpcResult<SendArpRequestOutput>> arpReqFt = sendArpRequest(builder.build());
 185             final SettableFuture<RpcResult<GetMacOutput>> ft = SettableFuture.create();
 186
 187             Futures.addCallback(arpReqFt, new FutureCallback<RpcResult<SendArpRequestOutput>>() {
 188                 @Override
 189                 public void onFailure(Throwable ex) {
 190                     RpcResultBuilder<GetMacOutput> resultBuilder = RpcResultBuilder.<GetMacOutput>failed()
 191                             .withError(ErrorType.APPLICATION, ex.getMessage(), ex);
 192                     ft.set(resultBuilder.build());
 193                 }
 194
 195                 @Override
 196                 public void onSuccess(RpcResult<SendArpRequestOutput> result) {
 197                     LOG.trace("Successfully sent the arp pkt out for ip {}", dstIpAddress);
 198                 }
 199             }, MoreExecutors.directExecutor());
 200
 201             macAddrs.put(dstIpAddress, ft);
 202             return ft;
 203         } catch (UnknownHostException e) {
 204             LOG.error("Failed to handle getMac request for {}", input.getIpaddress(), e);
 205             RpcResultBuilder<GetMacOutput> resultBuilder = RpcResultBuilder.<GetMacOutput>failed()
 206                     .withError(ErrorType.APPLICATION, e.getMessage(), e);
 207             return Futures.immediateFuture(resultBuilder.build());
 208         }
 209     }
 210
 211     private byte[] getIpAddressBytes(IpAddress ip) throws UnknownHostException {
 212         return InetAddress.getByName(ip.getIpv4Address().getValue()).getAddress();
 213     }
 214
 215     @Override
 216     public ListenableFuture<RpcResult<SendArpRequestOutput>> sendArpRequest(SendArpRequestInput arpReqInput) {
 217         LOG.trace("rpc sendArpRequest invoked for ip {}", arpReqInput.getIpaddress());
 218         Uint64 dpnId;
 219         byte[] payload;
 220         String interfaceName = null;
 221         byte[] srcIpBytes;
 222         byte[] dstIpBytes;
 223         byte[] srcMac;
 224
 225         RpcResultBuilder<SendArpRequestOutput> failureBuilder = RpcResultBuilder.failed();
 226         RpcResultBuilder<SendArpRequestOutput> successBuilder = RpcResultBuilder.success();
 227
 228         try {
 229             dstIpBytes = getIpAddressBytes(arpReqInput.getIpaddress());
 230         } catch (UnknownHostException e) {
 231             LOG.error("Cannot get IP address", e);
 232             failureBuilder.withError(ErrorType.APPLICATION, ArpConstants.UNKNOWN_IP_ADDRESS_SUPPLIED);
 233             return Futures.immediateFuture(failureBuilder.build());
 234         }
 235
 236         int localErrorCount = 0;
 237         for (InterfaceAddress interfaceAddress : arpReqInput.nonnullInterfaceAddress().values()) {
 238             try {
 239                 interfaceName = interfaceAddress.getInterface();
 240                 srcIpBytes = getIpAddressBytes(interfaceAddress.getIpAddress());
 241
 242                 GetPortFromInterfaceOutput portResult = getPortFromInterface(interfaceName);
 243                 checkNotNull(portResult);
 244                 dpnId = portResult.getDpid();
 245                 Long portid = portResult.getPortno().toJava();
 246                 checkArgument(null != dpnId && !Uint64.ZERO.equals(dpnId),
 247                     ArpConstants.DPN_NOT_FOUND_ERROR, interfaceName);
 248
 249                 NodeConnectorRef ref = MDSALUtil.getNodeConnRef(dpnId, portid.toString());
 250                 checkNotNull(ref, ArpConstants.NODE_CONNECTOR_NOT_FOUND_ERROR, interfaceName);
 251
 252                 LOG.trace("sendArpRequest received dpnId {} out interface {}", dpnId, interfaceName);
 253                 if (interfaceAddress.getMacaddress() == null) {
 254                     srcMac = txRunner.<Operational, ExecutionException, byte[]>
 255                         applyInterruptiblyWithNewReadOnlyTransactionAndClose(OPERATIONAL,
 256                             tx -> tx.read((InstanceIdentifier<NodeConnector>) ref.getValue()).get()
 257                                 .map(nc -> nc.augmentation(FlowCapableNodeConnector.class))
 258                                 .map(FlowCapableNodeConnector::getHardwareAddress)
 259                                 .map(MacAddress::getValue)
 260                                 .map(HexEncode::bytesFromHexString)
 261                                 .orElse(null));
 262                 } else {
 263                     String macAddr = interfaceAddress.getMacaddress().getValue();
 264                     srcMac = HexEncode.bytesFromHexString(macAddr);
 265                 }
 266                 checkNotNull(srcMac, ArpConstants.FAILED_TO_GET_SRC_MAC_FOR_INTERFACE, interfaceName, ref.getValue());
 267                 checkNotNull(srcIpBytes, ArpConstants.FAILED_TO_GET_SRC_IP_FOR_INTERFACE, interfaceName);
 268
 269                 payload = ArpPacketUtil.getPayload(ArpConstants.ARP_REQUEST_OP, srcMac, srcIpBytes,
 270                         ArpPacketUtil.ETHERNET_BROADCAST_DESTINATION, dstIpBytes);
 271
 272                 Map<ActionKey, Action> actions = getEgressAction(interfaceName);
 273                 sendPacketOutWithActions(dpnId, payload, ref, actions);
 274
 275                 LOG.trace("sent arp request for {}", arpReqInput.getIpaddress());
 276             } catch (UnknownHostException | PacketException | InterruptedException | ExecutionException e) {
 277                 LOG.trace("failed to send arp req for {} on interface {}", arpReqInput.getIpaddress(), interfaceName);
 278
 279                 failureBuilder.withError(ErrorType.APPLICATION,
 280                     ArpConstants.FAILED_TO_SEND_ARP_REQ_FOR_INTERFACE + interfaceName, e);
 281                 successBuilder.withError(ErrorType.APPLICATION,
 282                     ArpConstants.FAILED_TO_SEND_ARP_REQ_FOR_INTERFACE + interfaceName, e);
 283                 localErrorCount++;
 284             }
 285         }
 286         if (localErrorCount == arpReqInput.getInterfaceAddress().size()) {
 287             // All the requests failed
 288             return Futures.immediateFuture(failureBuilder.build());
 289         }
 290         return Futures.immediateFuture(successBuilder.build());
 291     }
 292
 293     public ListenableFuture<RpcResult<TransmitPacketOutput>> sendPacketOut(
 294             Uint64 dpnId, byte[] payload, NodeConnectorRef ref) {
 295         NodeConnectorRef nodeConnectorRef = MDSALUtil.getNodeConnRef(dpnId, "0xfffffffd");
 296         return packetProcessingService.transmitPacket(new TransmitPacketInputBuilder().setPayload(payload)
 297                 .setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class)
 298                         .child(Node.class, new NodeKey(new NodeId(OPENFLOW_PFX + dpnId))).build()))
 299                 .setIngress(nodeConnectorRef).setEgress(ref).build());
 300     }
 301
 302     private Future<RpcResult<TransmitPacketOutput>> sendPacketOutWithActions(
 303             Uint64 dpnId, byte[] payload, NodeConnectorRef ref, Map<ActionKey, Action> actions) {
 304         NodeConnectorRef nodeConnectorRef = MDSALUtil.getNodeConnRef(dpnId, "0xfffffffd");
 305         TransmitPacketInput transmitPacketInput = new TransmitPacketInputBuilder().setPayload(payload)
 306                 .setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class)
 307                         .child(Node.class, new NodeKey(new NodeId(OPENFLOW_PFX + dpnId))).build()))
 308                 .setIngress(nodeConnectorRef).setEgress(ref).setAction(actions).build();
 309         LOG.trace("PacketOut message framed for transmitting {}", transmitPacketInput);
 310         return packetProcessingService.transmitPacket(transmitPacketInput);
 311     }
 312
 313     private Map<ActionKey, Action> getEgressAction(String interfaceName) {
 314         Map<ActionKey, Action> actions = new HashMap<>();
 315         try {
 316             GetEgressActionsForInterfaceInputBuilder egressAction = new GetEgressActionsForInterfaceInputBuilder()
 317                     .setIntfName(interfaceName);
 318             OdlInterfaceRpcService intfRpc = odlInterfaceRpcService;
 319             if (intfRpc == null) {
 320                 LOG.error("Unable to obtain interfaceMgrRpc service, ignoring egress actions for interfaceName {}",
 321                         interfaceName);
 322                 return actions;
 323             }
 324             Future<RpcResult<GetEgressActionsForInterfaceOutput>> result = intfRpc
 325                     .getEgressActionsForInterface(egressAction.build());
 326             RpcResult<GetEgressActionsForInterfaceOutput> rpcResult = result.get();
 327             if (!rpcResult.isSuccessful()) {
 328                 LOG.warn("RPC Call to Get egress actions for interface {} returned with Errors {}", interfaceName,
 329                         rpcResult.getErrors());
 330             } else {
 331                 actions = rpcResult.getResult().getAction();
 332             }
 333         } catch (InterruptedException | ExecutionException e) {
 334             LOG.error("Exception when egress actions for interface {}", interfaceName, e);
 335         }
 336         return actions;
 337     }
 338
 339     @Override
 340     public ListenableFuture<RpcResult<SendArpResponseOutput>> sendArpResponse(SendArpResponseInput input) {
 341         LOG.trace("sendArpResponse rpc invoked");
 342         Uint64 dpnId;
 343         byte[] payload;
 344         byte[] srcMac;
 345
 346         try {
 347             String interfaceName = input.getInterface();
 348             GetPortFromInterfaceOutput portResult = getPortFromInterface(interfaceName);
 349             checkNotNull(portResult);
 350             dpnId = portResult.getDpid();
 351             Long portid = portResult.getPortno().toJava();
 352             NodeConnectorRef ref = MDSALUtil.getNodeConnRef(dpnId, portid.toString());
 353             checkArgument(null != dpnId && !Uint64.ZERO.equals(dpnId),
 354                 ArpConstants.DPN_NOT_FOUND_ERROR, interfaceName);
 355             checkNotNull(ref, ArpConstants.NODE_CONNECTOR_NOT_FOUND_ERROR, interfaceName);
 356
 357             LOG.trace("sendArpRequest received dpnId {} out interface {}", dpnId, interfaceName);
 358
 359             byte[] srcIpBytes = getIpAddressBytes(input.getSrcIpaddress());
 360             byte[] dstIpBytes = getIpAddressBytes(input.getDstIpaddress());
 361             if (input.getSrcMacaddress() == null) {
 362                 srcMac = portResult.getPhyAddress().getBytes(StandardCharsets.UTF_8);
 363             } else {
 364                 String macAddr = input.getSrcMacaddress().getValue();
 365                 srcMac = HexEncode.bytesFromHexString(macAddr);
 366             }
 367             byte[] dstMac = NWUtil.parseMacAddress(input.getDstMacaddress().getValue());
 368             checkNotNull(srcIpBytes, ArpConstants.FAILED_TO_GET_SRC_IP_FOR_INTERFACE, interfaceName);
 369             payload = ArpPacketUtil.getPayload(ArpConstants.ARP_RESPONSE_OP, srcMac, srcIpBytes, dstMac, dstIpBytes);
 370
 371             Map<ActionKey, Action> actions = getEgressAction(interfaceName);
 372             sendPacketOutWithActions(dpnId, payload, ref, actions);
 373             LOG.debug("Sent ARP response for IP {}, from source MAC {} to target MAC {} and target IP {} via dpnId {}",
 374                     input.getSrcIpaddress().getIpv4Address().getValue(), HexEncode.bytesToHexStringFormat(srcMac),
 375                     HexEncode.bytesToHexStringFormat(dstMac), input.getDstIpaddress().getIpv4Address().getValue(),
 376                     dpnId);
 377         } catch (UnknownHostException | PacketException | InterruptedException | ExecutionException e) {
 378             LOG.error("failed to send arp response for {}: ", input.getSrcIpaddress(), e);
 379             return RpcResultBuilder.<SendArpResponseOutput>failed()
 380                     .withError(ErrorType.APPLICATION, e.getMessage(), e).buildFuture();
 381         }
 382         RpcResultBuilder<SendArpResponseOutput> rpcResultBuilder = RpcResultBuilder.success();
 383         return Futures.immediateFuture(rpcResultBuilder.build());
 384     }
 385
 386     @Override
 387     public void onPacketReceived(PacketReceived packetReceived) {
 388         Class<? extends PacketInReason> pktInReason = packetReceived.getPacketInReason();
 389         LOG.trace("Packet Received {}", packetReceived);
 390
 391         if (pktInReason == SendToController.class) {
 392             try {
 393                 Uint64 dpnId = extractDpnId(packetReceived);
 394                 int tableId = packetReceived.getTableId().getValue().toJava();
 395
 396                 byte[] data = packetReceived.getPayload();
 397                 Ethernet ethernet = new Ethernet();
 398
 399                 ethernet.deserialize(data, 0, data.length * Byte.SIZE);
 400                 if (ethernet.getEtherType() != ArpConstants.ETH_TYPE_ARP) {
 401                     return;
 402                 }
 403
 404                 Packet pkt = ethernet.getPayload();
 405                 ARP arp = (ARP) pkt;
 406                 InetAddress srcInetAddr = InetAddress.getByAddress(arp.getSenderProtocolAddress());
 407                 InetAddress dstInetAddr = InetAddress.getByAddress(arp.getTargetProtocolAddress());
 408                 byte[] srcMac = ethernet.getSourceMACAddress();
 409                 byte[] dstMac = ethernet.getDestinationMACAddress();
 410
 411                 Metadata metadata = packetReceived.getMatch().getMetadata();
 412
 413                 String interfaceName = getInterfaceName(metadata);
 414
 415                 checkAndFireMacChangedNotification(interfaceName, srcInetAddr, srcMac);
 416                 macsDB.put(interfaceName + "-" + srcInetAddr.getHostAddress(), NWUtil.toStringMacAddress(srcMac));
 417                 if (arp.getOpCode() == ArpConstants.ARP_REQUEST_OP) {
 418                     fireArpReqRecvdNotification(interfaceName, srcInetAddr, srcMac, dstInetAddr, dpnId, tableId,
 419                             metadata.getMetadata());
 420                 } else {
 421                     fireArpRespRecvdNotification(interfaceName, srcInetAddr, srcMac, dpnId, tableId,
 422                                                  metadata.getMetadata(), dstInetAddr, dstMac);
 423                 }
 424                 if (macAddrs.get(srcInetAddr.getHostAddress()) != null) {
 425                     threadPool.execute(new MacResponderTask(arp));
 426                 }
 427             } catch (PacketException | UnknownHostException | InterruptedException | ExecutionException e) {
 428                 LOG.trace("Failed to decode packet", e);
 429             }
 430         }
 431     }
 432
 433     private GetPortFromInterfaceOutput getPortFromInterface(String interfaceName)
 434             throws InterruptedException, ExecutionException {
 435         GetPortFromInterfaceInputBuilder getPortFromInterfaceInputBuilder = new GetPortFromInterfaceInputBuilder();
 436         getPortFromInterfaceInputBuilder.setIntfName(interfaceName);
 437
 438         Future<RpcResult<GetPortFromInterfaceOutput>> portFromInterface = odlInterfaceRpcService
 439                 .getPortFromInterface(getPortFromInterfaceInputBuilder.build());
 440         GetPortFromInterfaceOutput result = portFromInterface.get().getResult();
 441         LOG.trace("getPortFromInterface rpc result is {} ", result);
 442         if (result != null) {
 443             LOG.trace("getPortFromInterface rpc result is {} {} ", result.getDpid(), result.getPortno());
 444         }
 445         return result;
 446     }
 447
 448     private String getInterfaceName(Metadata metadata)
 449             throws InterruptedException, ExecutionException {
 450         LOG.debug("metadata received is {} ", metadata);
 451
 452         GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
 453         Uint64 lportTag = MetaDataUtil.getLportFromMetadata(metadata.getMetadata());
 454
 455         ifIndexInputBuilder.setIfIndex(lportTag.intValue());
 456         GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
 457
 458         Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex = odlInterfaceRpcService
 459                 .getInterfaceFromIfIndex(input);
 460         if (interfaceFromIfIndex.get().isSuccessful()) {
 461             GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput = interfaceFromIfIndex.get().getResult();
 462             return interfaceFromIfIndexOutput.getInterfaceName();
 463         } else {
 464             LOG.error("RPC call to get interface name for if index {} failed with errors {}", lportTag,
 465                 interfaceFromIfIndex.get().getErrors());
 466             return null;
 467         }
 468     }
 469
 470     private class MacResponderTask implements Runnable {
 471         final ARP arp;
 472
 473         MacResponderTask(ARP arp) {
 474             this.arp = arp;
 475         }
 476
 477         @Override
 478         public void run() {
 479             InetAddress srcAddr;
 480             GetMacOutputBuilder outputBuilder;
 481             String srcMac;
 482             try {
 483                 srcAddr = InetAddress.getByAddress(arp.getSenderProtocolAddress());
 484                 srcMac = NWUtil.toStringMacAddress(arp.getSenderHardwareAddress());
 485                 SettableFuture<RpcResult<GetMacOutput>> future = macAddrs.remove(srcAddr.getHostAddress());
 486                 if (future == null) {
 487                     LOG.trace("There are no pending mac requests.");
 488                     return;
 489                 }
 490                 outputBuilder = new GetMacOutputBuilder().setMacaddress(new PhysAddress(srcMac));
 491                 future.set(RpcResultBuilder.success(outputBuilder.build()).build());
 492                 if (LOG.isTraceEnabled()) {
 493                     LOG.trace("sent the mac response for ip {}", srcAddr.getHostAddress());
 494                 }
 495             } catch (UnknownHostException e) {
 496                 LOG.error("failed to send mac response", e);
 497             }
 498         }
 499     }
 500
 501     private void fireArpRespRecvdNotification(String interfaceName, InetAddress srcInetAddr, byte[] srcMacAddressBytes,
 502             Uint64 dpnId, int tableId, Uint64 metadata, InetAddress dstInetAddr, byte[] dstMacAddressBytes)
 503                     throws InterruptedException {
 504         arpRespRecvd.mark();
 505
 506         IpAddress srcIp = IetfInetUtil.INSTANCE.ipAddressFor(srcInetAddr);
 507         IpAddress dstIp = IetfInetUtil.INSTANCE.ipAddressFor(dstInetAddr);
 508         String srcMacAddress = NWUtil.toStringMacAddress(srcMacAddressBytes);
 509         PhysAddress srcMac = new PhysAddress(srcMacAddress);
 510         String dstMacAddress = NWUtil.toStringMacAddress(dstMacAddressBytes);
 511         PhysAddress dstMac = new PhysAddress(dstMacAddress);
 512         ArpResponseReceivedBuilder builder = new ArpResponseReceivedBuilder();
 513         builder.setInterface(interfaceName);
 514         builder.setSrcIpaddress(srcIp);
 515         builder.setDpnId(dpnId);
 516         builder.setOfTableId((long) tableId);
 517         builder.setSrcMac(srcMac);
 518         builder.setMetadata(metadata);
 519         builder.setDstIpaddress(dstIp);
 520         builder.setDstMac(dstMac);
 521         ListenableFuture<?> offerNotification = notificationPublishService.offerNotification(builder.build());
 522         if (offerNotification != null && offerNotification.equals(NotificationPublishService.REJECTED)) {
 523             arpRespRecvdNotificationRejected.mark();
 524
 525         } else {
 526             arpRespRecvdNotification.mark();
 527         }
 528     }
 529
 530     private void fireArpReqRecvdNotification(String interfaceName, InetAddress srcInetAddr, byte[] srcMac,
 531             InetAddress dstInetAddr, Uint64 dpnId, int tableId, Uint64 metadata) throws InterruptedException {
 532         arpReqRecvd.mark();
 533         String macAddress = NWUtil.toStringMacAddress(srcMac);
 534         ArpRequestReceivedBuilder builder = new ArpRequestReceivedBuilder();
 535         builder.setInterface(interfaceName);
 536         builder.setDpnId(dpnId);
 537         builder.setOfTableId((long) tableId);
 538         builder.setSrcIpaddress(IetfInetUtil.INSTANCE.ipAddressFor(srcInetAddr));
 539         builder.setDstIpaddress(IetfInetUtil.INSTANCE.ipAddressFor(dstInetAddr));
 540         builder.setSrcMac(new PhysAddress(macAddress));
 541         builder.setMetadata(metadata);
 542         ListenableFuture<?> offerNotification = notificationPublishService.offerNotification(builder.build());
 543         if (offerNotification != null && offerNotification.equals(NotificationPublishService.REJECTED)) {
 544             arpReqRecvdNotificationRejected.mark();
 545         } else {
 546             arpReqRecvdNotification.mark();
 547         }
 548     }
 549
 550     private void checkAndFireMacChangedNotification(String interfaceName, InetAddress inetAddr, byte[] macAddressBytes)
 551             throws InterruptedException {
 552
 553         IpAddress ip = IetfInetUtil.INSTANCE.ipAddressFor(inetAddr);
 554         String macAddress = NWUtil.toStringMacAddress(macAddressBytes);
 555         PhysAddress mac = new PhysAddress(macAddress);
 556
 557         if (!macAddress.equals(macsDB.get(interfaceName + "-" + inetAddr.getHostAddress()))) {
 558             if (LOG.isTraceEnabled()) {
 559                 LOG.trace("mac address changed for {}", inetAddr);
 560             }
 561             MacChangedBuilder builder = new MacChangedBuilder();
 562             builder.setInterface(interfaceName);
 563             builder.setIpaddress(ip);
 564             builder.setMacaddress(mac);
 565             notificationPublishService.putNotification(builder.build());
 566         }
 567     }
 568
 569     private Uint64 extractDpnId(PacketReceived packetReceived) {
 570         NodeKey nodeKey = packetReceived.getIngress().getValue().firstKeyOf(Node.class);
 571         String nodeKeyString = nodeKey.getId().getValue();
 572
 573         if (!nodeKeyString.startsWith(OPENFLOW_PFX)) {
 574             LOG.warn("Could not extract DPN for packet-in, doesn't start with 'openflow:' {}", packetReceived);
 575             return null;
 576         }
 577
 578         return Uint64.valueOf(nodeKeyString.substring(OPENFLOW_PFX.length()));
 579     }
 580 }