2 * Copyright (c) 2015 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.bgpmanager;
10 import com.google.common.base.Optional;
12 import java.net.Inet4Address;
13 import java.net.Inet6Address;
14 import java.net.InetAddress;
15 import java.util.ArrayList;
16 import java.util.List;
17 import java.util.concurrent.BlockingQueue;
18 import java.util.concurrent.LinkedBlockingQueue;
19 import javax.annotation.PostConstruct;
20 import javax.annotation.PreDestroy;
21 import javax.inject.Inject;
22 import javax.inject.Singleton;
23 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
25 import org.opendaylight.genius.mdsalutil.MDSALUtil;
26 import org.opendaylight.genius.mdsalutil.NwConstants;
27 import org.opendaylight.genius.utils.batching.ActionableResource;
28 import org.opendaylight.genius.utils.batching.ActionableResourceImpl;
29 import org.opendaylight.genius.utils.batching.DefaultBatchHandler;
30 import org.opendaylight.genius.utils.batching.ResourceBatchingManager;
31 import org.opendaylight.netvirt.bgpmanager.thrift.gen.af_afi;
32 import org.opendaylight.netvirt.bgpmanager.thrift.gen.af_safi;
33 import org.opendaylight.netvirt.bgpmanager.thrift.gen.encap_type;
34 import org.opendaylight.netvirt.bgpmanager.thrift.gen.protocol_type;
35 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
36 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebfd.rev190219.BfdConfig;
37 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.Bgp;
38 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.BgpControlPlaneType;
39 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.EncapType;
40 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.LayerType;
41 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.DcgwTepList;
42 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.Vrfs;
43 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.VrfsKey;
44 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.dcgw.tep.list.DcgwTep;
45 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.dcgw.tep.list.DcgwTepKey;
46 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.vrfs.AddressFamiliesVrf;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpoints;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.elan.instance.ExternalTeps;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.elan.instance.ExternalTepsBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.elan.instance.ExternalTepsKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.EvpnRdToNetworks;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.evpn.rd.to.networks.EvpnRdToNetwork;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.evpn.rd.to.networks.EvpnRdToNetworkKey;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
70 import org.opendaylight.yangtools.yang.binding.DataObject;
71 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
72 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
73 import org.slf4j.Logger;
74 import org.slf4j.LoggerFactory;
77 public class BgpUtil implements AutoCloseable {
78 private static final Logger LOG = LoggerFactory.getLogger(BgpUtil.class);
79 private static final String RESOURCE_TYPE = "BGP-RESOURCES";
80 private static final int DEFAULT_BATCH_SIZE = 1000;
81 private static final int DEFAULT_BATCH_INTERVAL = 500;
82 private int enableBfdFlag = -1;
84 private final DataBroker dataBroker;
85 private final IFibManager fibManager;
88 private final BlockingQueue<ActionableResource> bgpResourcesBufferQ = new LinkedBlockingQueue<>();
91 public BgpUtil(DataBroker dataBroker, final IFibManager fibManager) {
92 this.dataBroker = dataBroker;
93 this.fibManager = fibManager;
98 ResourceBatchingManager resBatchingManager = ResourceBatchingManager.getInstance();
100 Integer batchSize = Integer.getInteger("batch.size", DEFAULT_BATCH_SIZE);
101 Integer batchInterval = Integer.getInteger("batch.wait.time", DEFAULT_BATCH_INTERVAL);
103 resBatchingManager.registerBatchableResource(RESOURCE_TYPE, bgpResourcesBufferQ,
104 new DefaultBatchHandler(dataBroker, LogicalDatastoreType.CONFIGURATION, batchSize, batchInterval));
109 public void close() {
110 ResourceBatchingManager.getInstance().deregisterBatchableResource(RESOURCE_TYPE);
114 * get a translation from prefix ipv6 to afi<br>.
115 * "ffff::1/128" sets afi as 2 because is an IPv6 value
116 * @param argPrefix ip address as ipv4 or ipv6
117 * @return afi 1 for AFI_IP 2 for AFI_IPV6
119 public static int getAFItranslatedfromPrefix(String argPrefix) {
120 int retValue = af_afi.AFI_IP.getValue();//default afiValue is 1 (= ipv4)
122 if (argPrefix.indexOf("/") == -1) {
123 prefixOnly = argPrefix;
125 prefixOnly = argPrefix.substring(0, argPrefix.indexOf("/"));
128 InetAddress address = InetAddress.getByName(prefixOnly);
129 if (address instanceof Inet6Address) {
130 retValue = af_afi.AFI_IPV6.getValue();
131 } else if (address instanceof Inet4Address) {
132 retValue = af_afi.AFI_IP.getValue();
134 } catch (java.net.UnknownHostException e) {
135 /*if exception is catched then the prefix is not an IPv6 and IPv4*/
136 LOG.error("Unrecognized ip address ipAddress: {}", argPrefix);
137 retValue = af_afi.AFI_IP.getValue();//default afiValue is 1 (= ipv4)
142 public <T extends DataObject> void update(final InstanceIdentifier<T> path, final T data) {
143 ActionableResource actResource = new ActionableResourceImpl(path.toString());
144 actResource.setAction(ActionableResource.UPDATE);
145 actResource.setInstanceIdentifier(path);
146 actResource.setInstance(data);
147 bgpResourcesBufferQ.add(actResource);
150 public <T extends DataObject> void write(final InstanceIdentifier<T> path, final T data) {
151 ActionableResource actResource = new ActionableResourceImpl(path.toString());
152 actResource.setAction(ActionableResource.CREATE);
153 actResource.setInstanceIdentifier(path);
154 actResource.setInstance(data);
155 bgpResourcesBufferQ.add(actResource);
158 public <T extends DataObject> void delete(final InstanceIdentifier<T> path) {
159 ActionableResource actResource = new ActionableResourceImpl(path.toString());
160 actResource.setAction(ActionableResource.DELETE);
161 actResource.setInstanceIdentifier(path);
162 actResource.setInstance(null);
163 bgpResourcesBufferQ.add(actResource);
166 // Convert ProtocolType to thrift protocol_type
167 public static protocol_type convertToThriftProtocolType(BgpControlPlaneType protocolType) {
168 switch (protocolType) {
170 return protocol_type.PROTOCOL_LU;
172 return protocol_type.PROTOCOL_L3VPN;
174 return protocol_type.PROTOCOL_EVPN;
176 return protocol_type.PROTOCOL_ANY;
180 // Convert EncapType to thrift encap_type
181 public static encap_type convertToThriftEncapType(EncapType encapType) {
184 return encap_type.L2TPV3_OVER_IP;
186 return encap_type.GRE;
188 return encap_type.IP_IN_IP;
190 return encap_type.VXLAN;
193 return encap_type.MPLS;
197 public VpnInstanceOpDataEntry getVpnInstanceOpData(String rd) {
198 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnInstanceOpDataIdentifier(rd);
199 Optional<VpnInstanceOpDataEntry> vpnInstanceOpData = MDSALUtil.read(dataBroker,
200 LogicalDatastoreType.OPERATIONAL, id);
201 if (vpnInstanceOpData.isPresent()) {
202 return vpnInstanceOpData.get();
207 public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
208 return InstanceIdentifier.builder(VpnInstanceOpData.class)
209 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
212 private String getElanNamefromRd(String rd) {
213 InstanceIdentifier<EvpnRdToNetwork> id = getEvpnRdToNetworkIdentifier(rd);
214 Optional<EvpnRdToNetwork> evpnRdToNetworkOpData = MDSALUtil.read(dataBroker,
215 LogicalDatastoreType.CONFIGURATION, id);
216 if (evpnRdToNetworkOpData.isPresent()) {
217 return evpnRdToNetworkOpData.get().getNetworkId();
222 private static InstanceIdentifier<EvpnRdToNetwork> getEvpnRdToNetworkIdentifier(String rd) {
223 return InstanceIdentifier.builder(EvpnRdToNetworks.class)
224 .child(EvpnRdToNetwork.class, new EvpnRdToNetworkKey(rd)).build();
227 public void addTepToElanInstance(String rd, String tepIp) {
228 if (rd == null || tepIp == null) {
229 LOG.error("addTepToElanInstance : Null parameters returning");
232 String elanName = getElanNamefromRd(rd);
233 if (elanName == null) {
234 LOG.error("Elan null while processing RT2 for RD {}", rd);
237 LOG.debug("Adding tepIp {} to elan {}", tepIp, elanName);
238 InstanceIdentifier<ExternalTeps> externalTepsId = getExternalTepsIdentifier(elanName, tepIp);
239 ExternalTepsBuilder externalTepsBuilder = new ExternalTepsBuilder();
240 ExternalTepsKey externalTepsKey = externalTepsId.firstKeyOf(ExternalTeps.class);
241 externalTepsBuilder.setTepIp(externalTepsKey.getTepIp());
242 update(externalTepsId, externalTepsBuilder.build());
245 public void deleteTepFromElanInstance(String rd, String tepIp) {
246 if (rd == null || tepIp == null) {
247 LOG.error("deleteTepFromElanInstance : Null parameters returning");
250 String elanName = getElanNamefromRd(rd);
251 if (elanName == null) {
252 LOG.error("Elan null while processing RT2 withdraw for RD {}", rd);
255 LOG.debug("Deleting tepIp {} from elan {}", tepIp, elanName);
256 InstanceIdentifier<ExternalTeps> externalTepsId = getExternalTepsIdentifier(elanName, tepIp);
257 delete(externalTepsId);
260 private static InstanceIdentifier<ExternalTeps> getExternalTepsIdentifier(String elanInstanceName, String tepIp) {
261 IpAddress tepAdress = tepIp == null ? null : new IpAddress(new Ipv4Address(tepIp));
262 return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class,
263 new ElanInstanceKey(elanInstanceName)).child(ExternalTeps.class,
264 new ExternalTepsKey(tepAdress)).build();
267 public String getVpnNameFromRd(String rd) {
268 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
269 return vpnInstanceOpData != null ? vpnInstanceOpData.getVpnInstanceName() : null;
272 /** get the vrf with the RouterDistinguisher pass in param.
273 * @param rd is the RouteDistinguisher of vrf
274 * @return the vrf of rd or null if no exist
276 public Vrfs getVrfFromRd(String rd) {
278 KeyedInstanceIdentifier<Vrfs, VrfsKey> id = InstanceIdentifier.create(Bgp.class)
279 .child(Vrfs.class, new VrfsKey(rd));
280 Optional<Vrfs> vrfsFromDs = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
281 if (vrfsFromDs.isPresent()) {
282 vrfs = vrfsFromDs.get();
287 /** get layerType used from an AddressFamiliesVrf.
288 * @param adf is the AddressFamiliesVrf from which the layer is asked.
289 * @return the layerType to reach from the argument addressFamilyVrf or null if not found
291 public static LayerType getLayerType(AddressFamiliesVrf adf) {
292 LayerType layerTypeValue = null;
293 if (adf.getSafi() == af_safi.SAFI_EVPN.getValue()) {
294 layerTypeValue = LayerType.LAYER2;
295 } else if (adf.getSafi() == af_safi.SAFI_MPLS_VPN.getValue()) {
296 layerTypeValue = LayerType.LAYER3;
298 return layerTypeValue;
301 public void removeVrfEntry(String rd, VrfEntry vrfEntry) {
302 LOG.debug("removeVrfEntry : vrf {} prefix {}", rd, vrfEntry.getDestPrefix());
303 InstanceIdentifier<VrfEntry> vrfEntryId =
304 InstanceIdentifier.builder(FibEntries.class)
305 .child(VrfTables.class, new VrfTablesKey(rd))
306 .child(VrfEntry.class, new VrfEntryKey(vrfEntry.getDestPrefix())).build();
310 public void enableBfdFlag() {
314 public void disableBfdFlag() {
318 public boolean isBfdEnabled() {
319 if (enableBfdFlag == 1) {
321 } else if (enableBfdFlag == 0) {
324 BfdConfig bfdConfig = getBfdConfig();
325 if (bfdConfig != null) {
326 return bfdConfig.isBfdEnabled();
331 public BfdConfig getBfdConfig() {
332 InstanceIdentifier<BfdConfig> id =
333 InstanceIdentifier.builder(BfdConfig.class).build();
334 Optional<BfdConfig> bfdConfigOptional = MDSALUtil.read(dataBroker,
335 LogicalDatastoreType.CONFIGURATION, id);
336 if (bfdConfigOptional.isPresent()) {
337 return bfdConfigOptional.get();
342 public DcgwTepList getDcgwTepConfig() {
343 InstanceIdentifier<DcgwTepList> id =
344 InstanceIdentifier.builder(Bgp.class).child(DcgwTepList.class).build();
345 Optional<DcgwTepList> dcgwTepListOptional = MDSALUtil.read(dataBroker,
346 LogicalDatastoreType.CONFIGURATION, id);
347 if (dcgwTepListOptional.isPresent()) {
348 return dcgwTepListOptional.get();
353 public List<String> getDcgwTepConfig(String dcgwIp) {
354 InstanceIdentifier<DcgwTep> id =
355 InstanceIdentifier.builder(Bgp.class)
356 .child(DcgwTepList.class)
357 .child(DcgwTep.class, new DcgwTepKey(dcgwIp)).build();
358 Optional<DcgwTep> tepListOptional = MDSALUtil.read(dataBroker,
359 LogicalDatastoreType.CONFIGURATION, id);
360 if (tepListOptional.isPresent()) {
361 return tepListOptional.get().getTepIps();
363 LOG.debug("No tep configured for DCGW {}", dcgwIp);
367 public static List<DPNTEPsInfo> getDpnTEPsInfos(DataBroker dataBroker) {
368 InstanceIdentifier<DpnEndpoints> iid = InstanceIdentifier.builder(DpnEndpoints.class).build();
369 Optional<DpnEndpoints> dpnEndpoints = MDSALUtil.read(LogicalDatastoreType.CONFIGURATION, iid, dataBroker);
370 if (dpnEndpoints.isPresent()) {
371 return dpnEndpoints.get().getDPNTEPsInfo();
373 return new ArrayList<>();
377 public void removeOrUpdateLBGroups(String tepIp, int addRemoveOrUpdate) {
378 getDpnTEPsInfos(dataBroker).forEach(dpnInfo -> {
379 if (NwConstants.MOD_FLOW == addRemoveOrUpdate) {
380 LOG.debug("Updating bucket in DPN {}", dpnInfo.getDPNID());
381 } else if (NwConstants.DEL_FLOW == addRemoveOrUpdate) {
382 LOG.debug("Deleting groups in DPN {}", dpnInfo.getDPNID());
384 Class<? extends TunnelTypeBase> tunType = TunnelTypeMplsOverGre.class;
385 fibManager.programDcGwLoadBalancingGroup(dpnInfo.getDPNID(),
386 tepIp, addRemoveOrUpdate, false, tunType);