2 * Copyright (c) 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
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
8 package org.opendaylight.netvirt.natservice.internal;
10 import java.util.ArrayList;
11 import java.util.Collections;
12 import java.util.List;
13 import java.util.concurrent.ExecutionException;
14 import org.eclipse.jdt.annotation.Nullable;
15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
18 import org.opendaylight.genius.infra.Datastore.Configuration;
19 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
20 import org.opendaylight.genius.infra.TypedWriteTransaction;
21 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
22 import org.opendaylight.genius.mdsalutil.MDSALUtil;
23 import org.opendaylight.genius.mdsalutil.MatchInfo;
24 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
25 import org.opendaylight.genius.mdsalutil.NwConstants;
26 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
27 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
28 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetSource;
29 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
30 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
31 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
32 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
44 import org.opendaylight.yangtools.yang.common.Uint32;
45 import org.opendaylight.yangtools.yang.common.Uint64;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
49 public final class NatEvpnUtil {
51 private static final Logger LOG = LoggerFactory.getLogger(NatEvpnUtil.class);
53 private NatEvpnUtil() {
57 public static void releaseLPortTagForRouter(DataBroker dataBroker, IdManagerService idManager, String routerName) {
59 String rd = NatUtil.getVpnRd(dataBroker, routerName);
60 Uint32 l3Vni = NatEvpnUtil.getL3Vni(dataBroker, rd);
61 if (!NatEvpnUtil.isL3VpnOverVxLan(l3Vni)) {
62 LOG.info("releaseLPortTagForRouter : Router:{} is not part of L3VPNOverVxlan", routerName);
65 if (NatUtil.releaseId(idManager, IfmConstants.IFM_IDPOOL_NAME, routerName) == NatConstants.INVALID_ID) {
66 LOG.error("releaseLPortTagForRouter: Unable to release VNI for router {}", routerName);
70 public static Uint64 getTunnelIdForRouter(IdManagerService idManager, DataBroker dataBroker, String routerName,
72 /* Only if the router is part of an L3VPN-Over-VXLAN, Router_lPort_Tag which will be carved out per router
73 from 'interfaces' POOL and used as tunnel_id. Otherwise we will continue to use router-id as the tunnel-id
74 in the following Flows.
76 1) PSNAT_TABLE (on Non-NAPT) -> Send to Remote Group
77 2) INTERNAL_TUNNEL_TABLE (on NAPT) -> Send to OUTBOUND_NAPT_TABLE */
78 String rd = NatUtil.getVpnRd(dataBroker, routerName);
79 Uint32 l3Vni = getL3Vni(dataBroker, rd);
80 if (isL3VpnOverVxLan(l3Vni)) {
81 Uint32 routerLportTag = NatUtil.getUniqueId(idManager, IfmConstants.IFM_IDPOOL_NAME, routerName);
82 if (routerLportTag != NatConstants.INVALID_ID) {
83 LOG.trace("getTunnelIdForRouter : Successfully allocated Router_lPort_Tag = {} from ID Manager for "
84 + "Router ID = {}", routerLportTag, routerId);
85 return Uint64.valueOf(routerLportTag.longValue());
87 LOG.warn("getTunnelIdForRouter : Failed to allocate Router_lPort_Tag from ID Manager for Router ID:{} "
88 + "Continue to use router-id as tunnel-id", routerId);
89 return Uint64.valueOf(routerId.longValue());
92 return Uint64.valueOf(routerId.longValue());
95 static Uint32 getL3Vni(DataBroker broker, String rd) {
96 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpData(broker, rd);
97 if (vpnInstanceOpDataEntry != null && vpnInstanceOpDataEntry.getL3vni() != null) {
98 return vpnInstanceOpDataEntry.getL3vni();
100 return NatConstants.DEFAULT_L3VNI_VALUE;
103 private static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
104 InstanceIdentifier<VpnInstanceOpDataEntry> id = NatUtil.getVpnInstanceOpDataIdentifier(rd);
105 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(broker,
106 LogicalDatastoreType.OPERATIONAL, id).orNull();
109 private static boolean isL3VpnOverVxLan(Uint32 l3Vni) {
110 return l3Vni != null && l3Vni.longValue() != 0;
113 static ProviderTypes getExtNwProvTypeFromRouterName(DataBroker dataBroker, String routerName,
114 Uuid externalNetworkId) {
115 ProviderTypes extNwProviderType = null;
116 if (externalNetworkId == null) {
117 LOG.error("getExtNwProvTypeFromRouterName : external network UUID is not available for router {}",
119 return extNwProviderType;
121 extNwProviderType = NatUtil.getProviderTypefromNetworkId(dataBroker, externalNetworkId);
122 if (extNwProviderType == null) {
123 LOG.error("getExtNwProvTypeFromRouterName : Could not retrieve provider type for external network {}",
125 return extNwProviderType;
127 return extNwProviderType;
130 @SuppressWarnings("checkstyle:IllegalCatch")
131 public static void addRoutesForVxLanProvType(DataBroker broker,
132 IBgpManager bgpManager,
133 IFibManager fibManager,
139 @Nullable String interfaceName,
141 TypedWriteTransaction<Configuration> writeTx,
142 RouteOrigin origin, Uint64 dpId,
145 LOG.info("addRoutesForVxLanProvType : Adding Fib entry rd {} prefix {} nextHop {} l3Vni {}",
146 rd, prefix, nextHopIp, l3Vni);
147 if (nextHopIp == null) {
148 LOG.error("addRoutesForVxLanProvType : addPrefix failed since nextHopIp cannot be null for prefix {}",
152 NatUtil.addPrefixToInterface(broker, NatUtil.getVpnId(broker, vpnName), interfaceName, prefix,
153 networkId.getValue(), dpId, Prefixes.PrefixCue.Nat);
155 fibManager.addOrUpdateFibEntry(rd, null /*macAddress*/, prefix,
156 Collections.singletonList(nextHopIp), VrfEntry.EncapType.Vxlan, NatConstants.DEFAULT_LABEL_VALUE,
157 l3Vni, gwMacAddress, null /* parent-vpn-rd */, origin, writeTx);
158 /* Publish to Bgp only if its an INTERNET VPN */
159 if (rd != null && !rd.equalsIgnoreCase(vpnName)) {
160 bgpManager.advertisePrefix(rd, null /*macAddress*/, prefix, Collections.singletonList(nextHopIp),
161 VrfEntry.EncapType.Vxlan, NatConstants.DEFAULT_LABEL_VALUE, l3Vni, Uint32.ZERO /*l2vni*/,
164 LOG.info("addRoutesForVxLanProvType : Added Fib entry rd {} prefix {} nextHop {} l3Vni {}", rd, prefix,
166 } catch (Exception e) {
167 LOG.error("addRoutesForVxLanProvType : Failed while adding routes for prefix {}", prefix, e);
171 static void makeL3GwMacTableEntry(final Uint64 dpnId, final Uint32 vpnId, String macAddress,
172 List<Instruction> customInstructions, IMdsalApiManager mdsalManager,
173 TypedWriteTransaction<Configuration> confTx) {
175 List<MatchInfo> matchInfo = new ArrayList<>();
176 matchInfo.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId.longValue()),
177 MetaDataUtil.METADATA_MASK_VRFID));
178 matchInfo.add(new MatchEthernetDestination(new MacAddress(macAddress)));
179 LOG.debug("makeL3GwMacTableEntry : Create flow table {} -> table {} for External Vpn Id = {} "
180 + "and MacAddress = {} on DpnId = {}",
181 NwConstants.L3_GW_MAC_TABLE, NwConstants.INBOUND_NAPT_TABLE, vpnId, macAddress, dpnId);
182 // Install the flow entry in L3_GW_MAC_TABLE
183 String flowRef = NatUtil.getFlowRef(dpnId, NwConstants.L3_GW_MAC_TABLE, vpnId, macAddress);
184 Flow l3GwMacTableFlowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_GW_MAC_TABLE,
185 flowRef, 21, flowRef, 0, 0,
186 NwConstants.COOKIE_L3_GW_MAC_TABLE, matchInfo, customInstructions);
188 mdsalManager.addFlow(confTx, dpnId, l3GwMacTableFlowEntity);
189 LOG.debug("makeL3GwMacTableEntry : Successfully created flow entity {} on DPN = {}",
190 l3GwMacTableFlowEntity, dpnId);
193 static void removeL3GwMacTableEntry(final Uint64 dpnId, final Uint32 vpnId, final String macAddress,
194 IMdsalApiManager mdsalManager, TypedReadWriteTransaction<Configuration> confTx)
195 throws ExecutionException, InterruptedException {
196 List<MatchInfo> matchInfo = new ArrayList<>();
197 matchInfo.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId.longValue()),
198 MetaDataUtil.METADATA_MASK_VRFID));
199 matchInfo.add(new MatchEthernetSource(new MacAddress(macAddress)));
200 LOG.debug("removeL3GwMacTableEntry : Remove flow table {} -> table {} for External Vpn Id = {} "
201 + "and MacAddress = {} on DpnId = {}",
202 NwConstants.L3_GW_MAC_TABLE, NwConstants.INBOUND_NAPT_TABLE, vpnId, macAddress, dpnId);
203 // Remove the flow entry in L3_GW_MAC_TABLE
204 String flowRef = NatUtil.getFlowRef(dpnId, NwConstants.L3_GW_MAC_TABLE, vpnId, macAddress);
205 Flow l3GwMacTableFlowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_GW_MAC_TABLE,
206 flowRef, 21, flowRef, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, matchInfo, null);
208 mdsalManager.removeFlow(confTx, dpnId, l3GwMacTableFlowEntity);
209 LOG.debug("removeL3GwMacTableEntry : Successfully removed flow entity {} on DPN = {}",
210 l3GwMacTableFlowEntity, dpnId);
213 public static String getFlowRef(Uint64 dpnId, short tableId, Uint32 l3Vni, String flowName) {
214 return flowName + NwConstants.FLOWID_SEPARATOR + dpnId + NwConstants.FLOWID_SEPARATOR + tableId + NwConstants
215 .FLOWID_SEPARATOR + l3Vni;
219 public static Uuid getFloatingIpInterfaceIdFromFloatingIpId(DataBroker broker, Uuid floatingIpId) {
220 InstanceIdentifier<FloatingIpIdToPortMapping> id =
221 NatUtil.buildfloatingIpIdToPortMappingIdentifier(floatingIpId);
222 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(broker,
223 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
224 FloatingIpIdToPortMapping::getFloatingIpPortId).orElse(null);