dhcpservice/impl/src/main/java/org/opendaylight/netvirt/dhcpservice/DhcpServiceUtils.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.netvirt.dhcpservice;
  10
  11
  12 import java.math.BigInteger;
  13 import java.net.InetAddress;
  14 import java.net.UnknownHostException;
  15 import java.util.ArrayList;
  16 import java.util.Arrays;
  17 import java.util.Collections;
  18 import java.util.HashMap;
  19 import java.util.LinkedList;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.Objects;
  23 import java.util.Optional;
  24 import java.util.concurrent.CopyOnWriteArrayList;
  25 import java.util.concurrent.ExecutionException;
  26 import java.util.function.BiConsumer;
  27 import java.util.function.Consumer;
  28 import java.util.stream.Collectors;
  29 import java.util.stream.LongStream;
  30 import org.eclipse.jdt.annotation.NonNull;
  31 import org.eclipse.jdt.annotation.Nullable;
  32 import org.opendaylight.genius.datastoreutils.ExpectedDataObjectNotFoundException;
  33 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  34 import org.opendaylight.genius.infra.Datastore.Configuration;
  35 import org.opendaylight.genius.infra.Datastore.Operational;
  36 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
  37 import org.opendaylight.genius.infra.TypedWriteTransaction;
  38 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
  39 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  40 import org.opendaylight.genius.mdsalutil.ActionInfo;
  41 import org.opendaylight.genius.mdsalutil.FlowEntity;
  42 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  43 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  44 import org.opendaylight.genius.mdsalutil.MatchInfo;
  45 import org.opendaylight.genius.mdsalutil.NWUtil;
  46 import org.opendaylight.genius.mdsalutil.NwConstants;
  47 import org.opendaylight.genius.mdsalutil.actions.ActionDrop;
  48 import org.opendaylight.genius.mdsalutil.actions.ActionPuntToController;
  49 import org.opendaylight.genius.mdsalutil.instructions.InstructionApplyActions;
  50 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  51 import org.opendaylight.genius.mdsalutil.matches.MatchArpOp;
  52 import org.opendaylight.genius.mdsalutil.matches.MatchArpTpa;
  53 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetSource;
  54 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetType;
  55 import org.opendaylight.genius.mdsalutil.matches.MatchIpProtocol;
  56 import org.opendaylight.genius.mdsalutil.matches.MatchTunnelId;
  57 import org.opendaylight.genius.mdsalutil.matches.MatchUdpDestinationPort;
  58 import org.opendaylight.genius.mdsalutil.matches.MatchUdpSourcePort;
  59 import org.opendaylight.genius.utils.ServiceIndex;
  60 import org.opendaylight.mdsal.binding.api.DataBroker;
  61 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  62 import org.opendaylight.netvirt.dhcpservice.api.DhcpMConstants;
  63 import org.opendaylight.netvirt.elanmanager.api.ElanHelper;
  64 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceBindings;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeIngress;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceTypeFlowBased;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflow;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflowBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfo;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoKey;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesKey;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dhcpservice.api.rev150710.InterfaceNameMacAddresses;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dhcpservice.api.rev150710.SubnetDhcpPortData;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dhcpservice.api.rev150710._interface.name.mac.addresses.InterfaceNameMacAddress;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dhcpservice.api.rev150710._interface.name.mac.addresses.InterfaceNameMacAddressBuilder;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dhcpservice.api.rev150710._interface.name.mac.addresses.InterfaceNameMacAddressKey;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dhcpservice.api.rev150710.subnet.dhcp.port.data.SubnetToDhcpPort;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dhcpservice.api.rev150710.subnet.dhcp.port.data.SubnetToDhcpPortBuilder;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dhcpservice.api.rev150710.subnet.dhcp.port.data.SubnetToDhcpPortKey;
 114 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 115 import org.opendaylight.yangtools.yang.common.Uint64;
 116 import org.slf4j.Logger;
 117 import org.slf4j.LoggerFactory;
 118
 119 public final class DhcpServiceUtils {
 120     private static final Logger LOG = LoggerFactory.getLogger(DhcpServiceUtils.class);
 121
 122     private static List<Uint64> connectedDpnIds = new CopyOnWriteArrayList<>();
 123
 124     private DhcpServiceUtils() {
 125
 126     }
 127
 128     public static void setupDhcpFlowEntry(@Nullable Uint64 dpId, short tableId, @Nullable String vmMacAddress,
 129                                           int addOrRemove,
 130                                           IMdsalApiManager mdsalUtil, DhcpServiceCounters dhcpServiceCounters,
 131                                           TypedReadWriteTransaction<Configuration> tx)
 132             throws ExecutionException, InterruptedException {
 133         if (dpId == null || dpId.equals(DhcpMConstants.INVALID_DPID) || vmMacAddress == null) {
 134             return;
 135         }
 136         List<MatchInfo> matches = getDhcpMatch(vmMacAddress);
 137         List<InstructionInfo> instructions = new ArrayList<>();
 138         List<ActionInfo> actionsInfos = new ArrayList<>();
 139
 140         // Punt to controller
 141         actionsInfos.add(new ActionPuntToController());
 142         instructions.add(new InstructionApplyActions(actionsInfos));
 143         if (addOrRemove == NwConstants.DEL_FLOW) {
 144             LOG.trace("Removing DHCP Flow DpId {}, vmMacAddress {}", dpId, vmMacAddress);
 145             dhcpServiceCounters.removeDhcpFlow();
 146             mdsalUtil.removeFlow(tx, dpId, getDhcpFlowRef(dpId, tableId, vmMacAddress), tableId);
 147         } else {
 148             FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, tableId,
 149                     getDhcpFlowRef(dpId, tableId, vmMacAddress), DhcpMConstants.DEFAULT_DHCP_FLOW_PRIORITY,
 150                     "DHCP", 0, 0, DhcpMConstants.COOKIE_DHCP_BASE, matches, instructions);
 151             LOG.trace("Installing DHCP Flow DpId {}, vmMacAddress {}", dpId, vmMacAddress);
 152             dhcpServiceCounters.installDhcpFlow();
 153             mdsalUtil.addFlow(tx, flowEntity);
 154         }
 155     }
 156
 157     private static String getDhcpFlowRef(Uint64 dpId, long tableId, String vmMacAddress) {
 158         return new StringBuilder().append(DhcpMConstants.FLOWID_PREFIX)
 159                 .append(dpId.toString()).append(NwConstants.FLOWID_SEPARATOR)
 160                 .append(tableId).append(NwConstants.FLOWID_SEPARATOR)
 161                 .append(vmMacAddress).toString();
 162     }
 163
 164     private static String getDhcpArpFlowRef(Uint64 dpId, long tableId, long lportTag, String ipAddress) {
 165         return new StringBuilder().append(DhcpMConstants.FLOWID_PREFIX)
 166                 .append(dpId.toString()).append(NwConstants.FLOWID_SEPARATOR)
 167                 .append(tableId).append(NwConstants.FLOWID_SEPARATOR)
 168                 .append(lportTag).append(NwConstants.FLOWID_SEPARATOR)
 169                 .append(ipAddress).toString();
 170     }
 171
 172     public static void setupDhcpDropAction(Uint64 dpId, short tableId, String vmMacAddress, int addOrRemove,
 173                                            IMdsalApiManager mdsalUtil, DhcpServiceCounters dhcpServiceCounters,
 174                                            TypedReadWriteTransaction<Configuration> tx)
 175             throws ExecutionException, InterruptedException {
 176         if (dpId == null || dpId.equals(DhcpMConstants.INVALID_DPID) || vmMacAddress == null) {
 177             return;
 178         }
 179         List<MatchInfo> matches = getDhcpMatch(vmMacAddress);
 180
 181         List<ActionInfo> actionsInfos = new ArrayList<>();
 182         List<InstructionInfo> instructions = new ArrayList<>();
 183         instructions.add(new InstructionApplyActions(actionsInfos));
 184         // Drop Action
 185         actionsInfos.add(new ActionDrop());
 186         if (addOrRemove == NwConstants.DEL_FLOW) {
 187             LOG.trace("Removing DHCP Drop Flow DpId {}, vmMacAddress {}", dpId, vmMacAddress);
 188             dhcpServiceCounters.removeDhcpDropFlow();
 189             mdsalUtil.removeFlow(tx, dpId, getDhcpFlowRef(dpId, tableId, vmMacAddress), tableId);
 190         } else {
 191             FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, tableId,
 192                     getDhcpFlowRef(dpId, tableId, vmMacAddress), DhcpMConstants.DEFAULT_DHCP_FLOW_PRIORITY,
 193                     "DHCP", 0, 0, DhcpMConstants.COOKIE_DHCP_BASE, matches, instructions);
 194             LOG.trace("Installing DHCP Drop Flow DpId {}, vmMacAddress {}", dpId, vmMacAddress);
 195             dhcpServiceCounters.installDhcpDropFlow();
 196             mdsalUtil.addFlow(tx, flowEntity);
 197         }
 198     }
 199
 200     public static void setupDhcpArpRequest(Uint64 dpId, short tableId, Uint64 vni, String dhcpIpAddress,
 201                                            int lportTag, @Nullable Long elanTag, boolean add,
 202                                            IMdsalApiManager mdsalUtil, TypedReadWriteTransaction<Configuration> tx)
 203             throws ExecutionException, InterruptedException {
 204         List<MatchInfo> matches = getDhcpArpMatch(vni, dhcpIpAddress);
 205         if (add) {
 206             Flow flow = MDSALUtil.buildFlowNew(tableId, getDhcpArpFlowRef(dpId, tableId, lportTag, dhcpIpAddress),
 207                     DhcpMConstants.DEFAULT_DHCP_ARP_FLOW_PRIORITY, "DHCPArp", 0, 0,
 208                     generateDhcpArpCookie(lportTag, dhcpIpAddress), matches, null);
 209             LOG.trace("Removing DHCP ARP Flow DpId {}, DHCP Port IpAddress {}", dpId, dhcpIpAddress);
 210             mdsalUtil.removeFlow(tx, dpId, flow);
 211         } else {
 212             Flow flow = MDSALUtil.buildFlowNew(tableId, getDhcpArpFlowRef(dpId, tableId, lportTag, dhcpIpAddress),
 213                     DhcpMConstants.DEFAULT_DHCP_ARP_FLOW_PRIORITY, "DHCPArp", 0, 0,
 214                     generateDhcpArpCookie(lportTag, dhcpIpAddress), matches,
 215                     getDhcpArpInstructions(elanTag, lportTag));
 216             LOG.trace("Adding DHCP ARP Flow DpId {}, DHCPPort IpAddress {}", dpId, dhcpIpAddress);
 217             mdsalUtil.addFlow(tx, dpId, flow);
 218         }
 219     }
 220
 221     public static List<MatchInfo> getDhcpMatch() {
 222         List<MatchInfo> matches = new ArrayList<>();
 223         matches.add(MatchEthernetType.IPV4);
 224         matches.add(MatchIpProtocol.UDP);
 225         matches.add(new MatchUdpSourcePort(DhcpMConstants.DHCP_CLIENT_PORT));
 226         matches.add(new MatchUdpDestinationPort(DhcpMConstants.DHCP_SERVER_PORT));
 227         return matches;
 228     }
 229
 230     public static List<MatchInfo> getDhcpMatch(String vmMacAddress) {
 231         List<MatchInfo> matches = getDhcpMatch();
 232         matches.add(new MatchEthernetSource(new MacAddress(vmMacAddress)));
 233         return matches;
 234     }
 235
 236     private static List<MatchInfo> getDhcpArpMatch(Uint64 vni, String ipAddress) {
 237         return Arrays.asList(MatchEthernetType.ARP, MatchArpOp.REQUEST, new MatchTunnelId(vni),
 238                 new MatchArpTpa(ipAddress, "32"));
 239     }
 240
 241     private static Map<InstructionKey, Instruction> getDhcpArpInstructions(Long elanTag, int lportTag) {
 242         Map<InstructionKey, Instruction> mkInstructions = new HashMap<InstructionKey, Instruction>();
 243         int instructionKey = 0;
 244         mkInstructions.put(new InstructionKey(++instructionKey), MDSALUtil.buildAndGetWriteMetadaInstruction(
 245                 ElanHelper.getElanMetadataLabel(elanTag, lportTag), ElanHelper.getElanMetadataMask(),
 246                 instructionKey));
 247         mkInstructions.put(new InstructionKey(++instructionKey), MDSALUtil
 248                 .buildAndGetGotoTableInstruction(NwConstants.ARP_RESPONDER_TABLE, instructionKey));
 249         return mkInstructions;
 250     }
 251
 252     private static Uint64 generateDhcpArpCookie(int lportTag, String ipAddress) {
 253         try {
 254             return Uint64.valueOf(NwConstants.TUNNEL_TABLE_COOKIE.toJava().add(BigInteger.valueOf(255))
 255                     .add(BigInteger.valueOf(NWUtil.convertInetAddressToLong(InetAddress.getByName(ipAddress))))
 256                     .add(BigInteger.valueOf(lportTag)));
 257         } catch (UnknownHostException e) {
 258             return Uint64.valueOf(NwConstants.TUNNEL_TABLE_COOKIE.toJava().add(BigInteger.valueOf(lportTag)));
 259         }
 260     }
 261
 262     public static List<Uint64> getListOfDpns(DataBroker broker) {
 263         if (!connectedDpnIds.isEmpty()) {
 264             return connectedDpnIds;
 265         }
 266         try {
 267             return extractDpnsFromNodes(MDSALUtil.read(broker, LogicalDatastoreType.OPERATIONAL,
 268                     InstanceIdentifier.builder(Nodes.class).build()));
 269         } catch (ExecutionException | InterruptedException e) {
 270             LOG.error("getListOfDpns: Exception while reading getListOfDpns DS", e);
 271             return Collections.emptyList();
 272         }
 273     }
 274
 275     @NonNull
 276     private static List<Uint64> extractDpnsFromNodes(Optional<Nodes> optionalNodes) {
 277         return optionalNodes.map(
 278             nodes -> nodes.nonnullNode().values().stream().map(Node::getId).filter(Objects::nonNull).map(
 279                     MDSALUtil::getDpnIdFromNodeName).collect(
 280                     Collectors.toList())).orElse(Collections.emptyList());
 281     }
 282
 283     @NonNull
 284     public static List<Uint64> getDpnsForElan(String elanInstanceName, DataBroker broker) {
 285         List<Uint64> elanDpns = new LinkedList<>();
 286         InstanceIdentifier<ElanDpnInterfacesList> elanDpnInstanceIdentifier =
 287                 InstanceIdentifier.builder(ElanDpnInterfaces.class)
 288                         .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)).build();
 289         Optional<ElanDpnInterfacesList> elanDpnOptional;
 290         try {
 291             elanDpnOptional = SingleTransactionDataBroker.syncReadOptional(broker, LogicalDatastoreType.OPERATIONAL,
 292                     elanDpnInstanceIdentifier);
 293         } catch (ExecutionException | InterruptedException e) {
 294             LOG.error("getDpnsForElan: Exception while reading ElanDpnInterfacesList DS for the elanInstanceName {}",
 295                     elanInstanceName, e);
 296             return Collections.emptyList();
 297         }
 298         if (elanDpnOptional.isPresent()) {
 299             Map<DpnInterfacesKey, DpnInterfaces> dpnInterfacesMap = elanDpnOptional.get().nonnullDpnInterfaces();
 300             for (DpnInterfaces dpnInterfaces : dpnInterfacesMap.values()) {
 301                 elanDpns.add(dpnInterfaces.getDpId());
 302             }
 303         }
 304         return elanDpns;
 305     }
 306
 307     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state
 308             .@Nullable Interface getInterfaceFromOperationalDS(String interfaceName, DataBroker dataBroker) {
 309         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 310                 .state.InterfaceKey interfaceKey =
 311                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 312                         .state.InterfaceKey(interfaceName);
 313         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508
 314                 .interfaces.state.Interface> interfaceId = InstanceIdentifier.builder(InterfacesState.class)
 315                 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508
 316                         .interfaces.state.Interface.class, interfaceKey).build();
 317         return MDSALUtil.read(LogicalDatastoreType.OPERATIONAL, interfaceId, dataBroker).orElse(null);
 318     }
 319
 320
 321     @Nullable
 322     public static String getSegmentationId(Uuid networkId, DataBroker broker) {
 323         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class)
 324                 .child(Networks.class).child(Network.class, new NetworkKey(networkId));
 325         Optional<Network> optionalNetwork;
 326         try {
 327             optionalNetwork = MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, inst);
 328         } catch (ExecutionException | InterruptedException e) {
 329             LOG.error("getSegmentationId: Exception while reading Network DS for the Network {}",
 330                     networkId.getValue(), e);
 331             return null;
 332         }
 333         if (!optionalNetwork.isPresent()) {
 334             return null;
 335         }
 336         Network network = optionalNetwork.get();
 337         String segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, NetworkTypeVxlan.class);
 338         return segmentationId;
 339     }
 340
 341     public static String getJobKey(String interfaceName) {
 342         return new StringBuilder().append(DhcpMConstants.DHCP_JOB_KEY_PREFIX).append(interfaceName).toString();
 343     }
 344
 345     public static void bindDhcpService(String interfaceName, short tableId, TypedWriteTransaction<Configuration> tx) {
 346         int instructionKey = 0;
 347         List<Instruction> instructions = new ArrayList<>();
 348         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(tableId, ++instructionKey));
 349         short serviceIndex = ServiceIndex.getIndex(NwConstants.DHCP_SERVICE_NAME, NwConstants.DHCP_SERVICE_INDEX);
 350         BoundServices
 351                 serviceInfo =
 352                 getBoundServices(String.format("%s.%s", "dhcp", interfaceName),
 353                         serviceIndex, DhcpMConstants.DEFAULT_FLOW_PRIORITY,
 354                         DhcpMConstants.COOKIE_VM_INGRESS_TABLE, instructions);
 355         tx.mergeParentStructurePut(buildServiceId(interfaceName, serviceIndex), serviceInfo);
 356     }
 357
 358     public static void unbindDhcpService(String interfaceName, TypedWriteTransaction<Configuration> tx) {
 359         short serviceIndex = ServiceIndex.getIndex(NwConstants.DHCP_SERVICE_NAME, NwConstants.DHCP_SERVICE_INDEX);
 360         tx.delete(buildServiceId(interfaceName, serviceIndex));
 361     }
 362
 363     private static InstanceIdentifier<BoundServices> buildServiceId(String interfaceName,
 364                                                              short dhcpServicePriority) {
 365         return InstanceIdentifier.builder(ServiceBindings.class)
 366                 .child(ServicesInfo.class, new ServicesInfoKey(interfaceName, ServiceModeIngress.class))
 367                 .child(BoundServices.class, new BoundServicesKey(dhcpServicePriority)).build();
 368     }
 369
 370     public static BoundServices getBoundServices(String serviceName, short servicePriority, int flowPriority,
 371                                           Uint64 cookie, List<Instruction> instructions) {
 372         StypeOpenflowBuilder augBuilder = new StypeOpenflowBuilder().setFlowCookie(cookie)
 373                 .setFlowPriority(flowPriority).setInstruction(instructions);
 374         return new BoundServicesBuilder().withKey(new BoundServicesKey(servicePriority))
 375                 .setServiceName(serviceName).setServicePriority(servicePriority)
 376                 .setServiceType(ServiceTypeFlowBased.class)
 377                 .addAugmentation(StypeOpenflow.class, augBuilder.build()).build();
 378     }
 379
 380     @SuppressWarnings("checkstyle:IllegalCatch")
 381     protected static void createSubnetDhcpPortData(Port port,
 382             BiConsumer<InstanceIdentifier<SubnetToDhcpPort>, SubnetToDhcpPort> consumer) {
 383         java.util.Optional<String> ip4Address = getIpV4Address(port);
 384         java.util.Optional<String> subnetId = getNeutronSubnetId(port);
 385         if (!(ip4Address.isPresent() && subnetId.isPresent())) {
 386             return;
 387         }
 388         LOG.trace("Adding SubnetPortData entry for subnet {}", subnetId.get());
 389         InstanceIdentifier<SubnetToDhcpPort> identifier = buildSubnetToDhcpPort(subnetId.get());
 390         SubnetToDhcpPort subnetToDhcpPort = getSubnetToDhcpPort(port, subnetId.get(), ip4Address.get());
 391         try {
 392             LOG.trace("Adding to SubnetToDhcpPort subnet {}  mac {}.", subnetId.get(),
 393                     port.getMacAddress().getValue());
 394             consumer.accept(identifier, subnetToDhcpPort);
 395         } catch (Exception e) {
 396             LOG.error("Failure while creating SubnetToDhcpPort map for network {}.", port.getNetworkId(), e);
 397         }
 398     }
 399
 400     @SuppressWarnings("checkstyle:IllegalCatch")
 401     protected static void removeSubnetDhcpPortData(Port port, Consumer<InstanceIdentifier<SubnetToDhcpPort>> consumer) {
 402         String subnetId = port.getDeviceId().substring("OpenDaylight".length() + 1);
 403         LOG.trace("Removing NetworkPortData entry for Subnet {}", subnetId);
 404         InstanceIdentifier<SubnetToDhcpPort> identifier = buildSubnetToDhcpPort(subnetId);
 405         try {
 406             consumer.accept(identifier);
 407             LOG.trace("Deleted SubnetDhcpPort for Subnet {}", subnetId);
 408         } catch (Exception e) {
 409             LOG.error("Failure while removing SubnetToDhcpPort for subnet {}.", subnetId, e);
 410         }
 411
 412     }
 413
 414     static InstanceIdentifier<SubnetToDhcpPort> buildSubnetToDhcpPort(String subnetId) {
 415         return InstanceIdentifier.builder(SubnetDhcpPortData.class)
 416                 .child(SubnetToDhcpPort.class, new SubnetToDhcpPortKey(subnetId)).build();
 417     }
 418
 419     public static java.util.Optional<SubnetToDhcpPort> getSubnetDhcpPortData(DataBroker broker, String subnetId) {
 420         InstanceIdentifier<SubnetToDhcpPort> id = buildSubnetToDhcpPort(subnetId);
 421         try {
 422             return java.util.Optional
 423                     .ofNullable(SingleTransactionDataBroker.syncRead(broker, LogicalDatastoreType.CONFIGURATION, id));
 424         } catch (ExpectedDataObjectNotFoundException e) {
 425             LOG.warn("Failed to read SubnetToDhcpPort for DS due to error {}", e.getMessage());
 426         }
 427         return java.util.Optional.empty();
 428     }
 429
 430     static IpAddress convertLongToIp(long ip) {
 431         String[] array = LongStream.of(24, 16, 8, 0) //
 432                 .map(x -> ip >> x & 0xFF).boxed() //
 433                 .map(String::valueOf) //
 434                 .toArray(String[]::new);
 435         return IpAddressBuilder.getDefaultInstance(String.join(".", array));
 436     }
 437
 438     static long convertIpToLong(IpAddress ipa) {
 439         String[] splitIp = ipa.stringValue().split("\\.");
 440         long result = 0;
 441         for (String part : splitIp) {
 442             result <<= 8;
 443             result |= Integer.parseInt(part);
 444         }
 445         return result;
 446     }
 447
 448
 449     static SubnetToDhcpPort getSubnetToDhcpPort(Port port, String subnetId, String ipAddress) {
 450         return new SubnetToDhcpPortBuilder()
 451                 .withKey(new SubnetToDhcpPortKey(subnetId))
 452                 .setSubnetId(subnetId).setPortName(port.getUuid().getValue())
 453                 .setPortMacaddress(port.getMacAddress().getValue()).setPortFixedip(ipAddress).build();
 454     }
 455
 456     static InterfaceInfo getInterfaceInfo(IInterfaceManager interfaceManager, String interfaceName) {
 457         return interfaceManager.getInterfaceInfoFromOperationalDataStore(interfaceName);
 458     }
 459
 460     public static java.util.Optional<String> getIpV4Address(Port port) {
 461         if (port.getFixedIps() == null) {
 462             return java.util.Optional.empty();
 463         }
 464         return port.getFixedIps().values().stream().filter(DhcpServiceUtils::isIpV4AddressAvailable)
 465                 .map(v -> v.getIpAddress().getIpv4Address().getValue()).findFirst();
 466     }
 467
 468     public static java.util.Optional<String> getNeutronSubnetId(Port port) {
 469         if (port.getFixedIps() == null) {
 470             return java.util.Optional.empty();
 471         }
 472         return port.getFixedIps().values().stream().filter(DhcpServiceUtils::isIpV4AddressAvailable)
 473                 .map(v -> v.getSubnetId().getValue()).findFirst();
 474     }
 475
 476     public static boolean isIpV4AddressAvailable(FixedIps fixedIp) {
 477         return fixedIp != null && fixedIp.getIpAddress() != null && fixedIp.getIpAddress().getIpv4Address() != null;
 478     }
 479
 480     @Nullable
 481     public static String getAndUpdateVmMacAddress(TypedReadWriteTransaction<Operational> tx, String interfaceName,
 482             DhcpManager dhcpManager) throws ExecutionException, InterruptedException {
 483         InstanceIdentifier<InterfaceNameMacAddress> instanceIdentifier =
 484                 InstanceIdentifier.builder(InterfaceNameMacAddresses.class)
 485                         .child(InterfaceNameMacAddress.class, new InterfaceNameMacAddressKey(interfaceName)).build();
 486         Optional<InterfaceNameMacAddress> existingEntry = tx.read(instanceIdentifier).get();
 487         if (!existingEntry.isPresent()) {
 488             LOG.trace("Entry for interface {} missing in InterfaceNameVmMacAddress map", interfaceName);
 489             String vmMacAddress = getNeutronMacAddress(interfaceName, dhcpManager);
 490             if (vmMacAddress == null || vmMacAddress.isEmpty()) {
 491                 return null;
 492             }
 493             LOG.trace("Updating InterfaceNameVmMacAddress map with {}, {}", interfaceName,vmMacAddress);
 494             InterfaceNameMacAddress interfaceNameMacAddress =
 495                     new InterfaceNameMacAddressBuilder()
 496                             .withKey(new InterfaceNameMacAddressKey(interfaceName))
 497                             .setInterfaceName(interfaceName).setMacAddress(vmMacAddress).build();
 498             tx.mergeParentStructureMerge(instanceIdentifier, interfaceNameMacAddress);
 499             return vmMacAddress;
 500         }
 501         return existingEntry.get().getMacAddress();
 502     }
 503
 504     @Nullable
 505     private static String getNeutronMacAddress(String interfaceName, DhcpManager dhcpManager) {
 506         Port port = dhcpManager.getNeutronPort(interfaceName);
 507         if (port != null) {
 508             LOG.trace("Port found in neutron. Interface Name {}, port {}", interfaceName, port);
 509             return port.getMacAddress().getValue();
 510         }
 511         return null;
 512     }
 513
 514     @NonNull
 515     public static List<Uuid> getSubnetIdsFromNetworkId(DataBroker broker, Uuid networkId) {
 516         InstanceIdentifier id = buildNetworkMapIdentifier(networkId);
 517         Optional<NetworkMap> optionalNetworkMap;
 518         try {
 519             optionalNetworkMap = SingleTransactionDataBroker.syncReadOptional(broker,
 520                     LogicalDatastoreType.CONFIGURATION, id);
 521         } catch (ExecutionException | InterruptedException e) {
 522             LOG.error("getSubnetIdsFromNetworkId: Exception while reading NetworkMap DS for the network {}",
 523                     networkId.getValue(), e);
 524             return Collections.emptyList();
 525         }
 526         if (optionalNetworkMap.isPresent()) {
 527             @Nullable List<Uuid> subnetIdList = optionalNetworkMap.get().getSubnetIdList();
 528             if (subnetIdList != null) {
 529                 return subnetIdList;
 530             }
 531         }
 532         return Collections.emptyList();
 533     }
 534
 535     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
 536         return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class,
 537             new NetworkMapKey(networkId)).build();
 538     }
 539
 540     public static boolean isIpv4Subnet(DataBroker broker, Uuid subnetUuid) {
 541         final SubnetKey subnetkey = new SubnetKey(subnetUuid);
 542         final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
 543                 .child(Subnets.class).child(Subnet.class, subnetkey);
 544         final Optional<Subnet> subnet;
 545         try {
 546             subnet = SingleTransactionDataBroker.syncReadOptional(broker, LogicalDatastoreType.CONFIGURATION,
 547                     subnetidentifier);
 548         } catch (ExecutionException | InterruptedException e) {
 549             LOG.error("isIpv4Subnet: Exception while reading Subnet DS for the Subnet {}",
 550                     subnetUuid.getValue(), e);
 551             return false;
 552         }
 553         if (subnet.isPresent()) {
 554             Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
 555             return IpVersionV4.class.equals(ipVersionBase);
 556         }
 557         return false;
 558     }
 559
 560     public static void addToDpnIdCache(Uint64 dpnId) {
 561         if (!connectedDpnIds.contains(dpnId)) {
 562             connectedDpnIds.add(dpnId);
 563         }
 564     }
 565
 566     public static void removeFromDpnIdCache(Uint64 dpnId) {
 567         connectedDpnIds.remove(dpnId);
 568     }
 569
 570     public static Uint64 getDpnIdFromNodeConnectorId(NodeConnectorId nodeConnectorId) {
 571         Long dpIdLong = MDSALUtil.getDpnIdFromPortName(nodeConnectorId);
 572         return dpIdLong < 0 ? Uint64.ZERO : Uint64.valueOf(dpIdLong);
 573     }
 574 }
 575