2 * Copyright (c) 2015 - 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.vpnmanager;
10 import static java.util.Collections.emptyList;
12 import com.google.common.base.Optional;
13 import com.google.common.util.concurrent.FutureCallback;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import com.google.common.util.concurrent.MoreExecutors;
17 import java.util.ArrayList;
18 import java.util.Collections;
19 import java.util.List;
20 import javax.annotation.PostConstruct;
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.controller.md.sal.common.api.data.ReadFailedException;
26 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
27 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
28 import org.opendaylight.genius.infra.Datastore;
29 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
30 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
31 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
32 import org.opendaylight.genius.utils.SystemPropertyReader;
33 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
34 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
35 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
36 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
37 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.AddressFamily;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
47 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
52 public class VpnOpStatusListener extends AsyncDataTreeChangeListenerBase<VpnInstanceOpDataEntry, VpnOpStatusListener> {
53 private static final Logger LOG = LoggerFactory.getLogger(VpnOpStatusListener.class);
54 private final DataBroker dataBroker;
55 private final ManagedNewTransactionRunner txRunner;
56 private final IBgpManager bgpManager;
57 private final IdManagerService idManager;
58 private final IFibManager fibManager;
59 private final IMdsalApiManager mdsalManager;
60 private final VpnFootprintService vpnFootprintService;
61 private final JobCoordinator jobCoordinator;
62 private final VpnUtil vpnUtil;
65 public VpnOpStatusListener(final DataBroker dataBroker, final IBgpManager bgpManager,
66 final IdManagerService idManager, final IFibManager fibManager,
67 final IMdsalApiManager mdsalManager, final VpnFootprintService vpnFootprintService,
68 final JobCoordinator jobCoordinator, VpnUtil vpnUtil) {
69 super(VpnInstanceOpDataEntry.class, VpnOpStatusListener.class);
70 this.dataBroker = dataBroker;
71 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
72 this.bgpManager = bgpManager;
73 this.idManager = idManager;
74 this.fibManager = fibManager;
75 this.mdsalManager = mdsalManager;
76 this.vpnFootprintService = vpnFootprintService;
77 this.jobCoordinator = jobCoordinator;
78 this.vpnUtil = vpnUtil;
83 LOG.info("{} start", getClass().getSimpleName());
84 registerListener(LogicalDatastoreType.OPERATIONAL, dataBroker);
88 protected InstanceIdentifier<VpnInstanceOpDataEntry> getWildCardPath() {
89 return InstanceIdentifier.create(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class);
93 protected VpnOpStatusListener getDataTreeChangeListener() {
94 return VpnOpStatusListener.this;
98 protected void remove(InstanceIdentifier<VpnInstanceOpDataEntry> identifier, VpnInstanceOpDataEntry value) {
99 LOG.info("remove: Ignoring vpn Op {} with rd {}", value.getVpnInstanceName(), value.getVrfId());
103 @SuppressWarnings("checkstyle:IllegalCatch")
104 protected void update(InstanceIdentifier<VpnInstanceOpDataEntry> identifier,
105 VpnInstanceOpDataEntry original, VpnInstanceOpDataEntry update) {
106 LOG.info("update: Processing update for vpn {} with rd {}", update.getVpnInstanceName(), update.getVrfId());
107 if (update.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete
108 && vpnFootprintService.isVpnFootPrintCleared(update)) {
110 final String vpnName = update.getVpnInstanceName();
111 final List<String> rds = update.getRd();
112 String primaryRd = update.getVrfId();
113 final long vpnId = vpnUtil.getVpnId(vpnName);
114 jobCoordinator.enqueueJob("VPN-" + update.getVpnInstanceName(), () -> {
115 // Two transactions are used, one for operational, one for config; we only submit the config
116 // transaction if the operational transaction succeeds
117 ListenableFuture<Void> operationalFuture = txRunner.callWithNewWriteOnlyTransactionAndSubmit(
118 Datastore.OPERATIONAL, operTx -> {
119 // Clean up VPNExtraRoutes Operational DS
120 if (rds != null && VpnUtil.isBgpVpn(vpnName, primaryRd)) {
121 if (update.getType() == VpnInstanceOpDataEntry.Type.L2) {
122 rds.parallelStream().forEach(rd -> bgpManager.deleteVrf(
123 rd, false, AddressFamily.L2VPN));
125 if (update.isIpv4Configured()) {
126 rds.parallelStream().forEach(rd -> bgpManager.deleteVrf(
127 rd, false, AddressFamily.IPV4));
129 if (update.isIpv6Configured()) {
130 rds.parallelStream().forEach(rd -> bgpManager.deleteVrf(
131 rd, false, AddressFamily.IPV6));
134 InstanceIdentifier<Vpn> vpnToExtraroute =
135 VpnExtraRouteHelper.getVpnToExtrarouteVpnIdentifier(vpnName);
136 Optional<Vpn> optVpnToExtraroute = Optional.absent();
138 optVpnToExtraroute = SingleTransactionDataBroker.syncReadOptional(dataBroker,
139 LogicalDatastoreType.OPERATIONAL, vpnToExtraroute);
140 } catch (ReadFailedException e) {
141 LOG.error("update: Failed to read VpnToExtraRoute for vpn {}", vpnName);
143 if (optVpnToExtraroute.isPresent()) {
144 VpnUtil.removeVpnExtraRouteForVpn(vpnName, operTx);
146 if (VpnUtil.isL3VpnOverVxLan(update.getL3vni())) {
147 vpnUtil.removeExternalTunnelDemuxFlows(vpnName);
149 // Clean up PrefixToInterface Operational DS
150 Optional<VpnIds> optPrefixToIntf = Optional.absent();
152 optPrefixToIntf = SingleTransactionDataBroker.syncReadOptional(dataBroker,
153 LogicalDatastoreType.OPERATIONAL, VpnUtil.getPrefixToInterfaceIdentifier(vpnId));
154 } catch (ReadFailedException e) {
155 LOG.error("update: Failed to read PrefixToInterface for vpn {}", vpnName);
157 if (optPrefixToIntf.isPresent()) {
158 VpnUtil.removePrefixToInterfaceForVpnId(vpnId, operTx);
160 // Clean up L3NextHop Operational DS
161 InstanceIdentifier<VpnNexthops> vpnNextHops = InstanceIdentifier.builder(L3nexthop.class).child(
162 VpnNexthops.class, new VpnNexthopsKey(vpnId)).build();
163 Optional<VpnNexthops> optL3nexthopForVpnId = Optional.absent();
165 optL3nexthopForVpnId = SingleTransactionDataBroker.syncReadOptional(dataBroker,
166 LogicalDatastoreType.OPERATIONAL, vpnNextHops);
167 } catch (ReadFailedException e) {
168 LOG.error("update: Failed to read VpnNextHops for vpn {}", vpnName);
170 if (optL3nexthopForVpnId.isPresent()) {
171 VpnUtil.removeL3nexthopForVpnId(vpnId, operTx);
174 // Clean up VPNInstanceOpDataEntry
175 VpnUtil.removeVpnOpInstance(primaryRd, operTx);
178 Futures.addCallback(operationalFuture, new FutureCallback<Void>() {
180 public void onSuccess(Void result) {
181 Futures.addCallback(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
182 Datastore.CONFIGURATION, confTx -> {
183 // Clean up VpnInstanceToVpnId from Config DS
184 VpnUtil.removeVpnIdToVpnInstance(vpnId, confTx);
185 VpnUtil.removeVpnInstanceToVpnId(vpnName, confTx);
186 LOG.trace("Removed vpnIdentifier for rd{} vpnname {}", primaryRd, vpnName);
188 // Clean up FIB Entries Config DS
189 synchronized (vpnName.intern()) {
190 fibManager.removeVrfTable(primaryRd, confTx);
192 }), new VpnOpStatusListener.PostDeleteVpnInstanceWorker(vpnName),
193 MoreExecutors.directExecutor());
194 // Note: Release the of VpnId will happen in PostDeleteVpnInstancWorker only if
195 // operationalTxn/Config succeeds.
199 public void onFailure(Throwable throwable) {
200 LOG.error("Error deleting VPN {}", vpnName, throwable);
202 }, MoreExecutors.directExecutor());
204 LOG.info("Removed vpn data for vpnname {}", vpnName);
205 return Collections.singletonList(operationalFuture);
206 }, SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
207 } else if (update.getVpnState() == VpnInstanceOpDataEntry.VpnState.Created) {
208 final String vpnName = update.getVpnInstanceName();
209 String primaryRd = update.getVrfId();
210 if (!VpnUtil.isBgpVpn(vpnName, primaryRd)) {
213 if (original == null) {
214 LOG.error("VpnOpStatusListener.update: vpn {} with RD {}. add() handler already called",
218 if (update.getVpnTargets() == null) {
219 LOG.error("VpnOpStatusListener.update: vpn {} with RD {} vpnTargets not ready",
223 List<VpnTarget> vpnTargetList = update.getVpnTargets().getVpnTarget();
224 List<String> ertList = new ArrayList<>();
225 List<String> irtList = new ArrayList<>();
226 if (vpnTargetList != null) {
227 for (VpnTarget vpnTarget : vpnTargetList) {
228 if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.ExportExtcommunity) {
229 ertList.add(vpnTarget.getVrfRTValue());
231 if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.ImportExtcommunity) {
232 irtList.add(vpnTarget.getVrfRTValue());
234 if (vpnTarget.getVrfRTType() == VpnTarget.VrfRTType.Both) {
235 ertList.add(vpnTarget.getVrfRTValue());
236 irtList.add(vpnTarget.getVrfRTValue());
240 LOG.error("VpnOpStatusListener.update: vpn target list is empty, cannot add BGP"
241 + " VPN {} RD {}", vpnName, primaryRd);
244 jobCoordinator.enqueueJob("VPN-" + update.getVpnInstanceName(), () -> {
245 //RD update case get only updated RD list
246 List<String> rds = update.getRd() != null ? new ArrayList<>(update.getRd()) : new ArrayList<>();
247 if (original.getRd() != null && original.getRd().size() != rds.size()) {
248 rds.removeAll(original.getRd());
250 rds.parallelStream().forEach(rd -> {
252 List<String> importRTList = rd.equals(primaryRd) ? irtList : emptyList();
253 LOG.info("VpnOpStatusListener.update: updating BGPVPN for vpn {} with RD {}"
254 + " Type is {}, IPv4 is {}, IPv6 is {}, iRT {}", vpnName, primaryRd, update.getType(),
255 update.isIpv4Configured(), update.isIpv6Configured(), importRTList);
256 if (update.getType() == VpnInstanceOpDataEntry.Type.L2) {
257 bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.L2VPN);
259 if (!original.isIpv4Configured() && update.isIpv4Configured()) {
260 bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.IPV4);
261 } else if (original.isIpv4Configured() && !update.isIpv4Configured()) {
262 bgpManager.deleteVrf(rd, false, AddressFamily.IPV4);
264 if (!original.isIpv6Configured() && update.isIpv6Configured()) {
265 bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.IPV6);
266 } else if (original.isIpv6Configured() && !update.isIpv6Configured()) {
267 bgpManager.deleteVrf(rd, false, AddressFamily.IPV6);
269 /* Update vrf entry with newly added RD list. VPN does not support for
270 * deleting existing RDs
272 if (original.getRd().size() != update.getRd().size()) {
273 if (update.isIpv4Configured()) {
274 bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.IPV4);
276 if (update.isIpv6Configured()) {
277 bgpManager.addVrf(rd, importRTList, ertList, AddressFamily.IPV6);
280 } catch (RuntimeException e) {
281 LOG.error("VpnOpStatusListener.update: Exception when updating VRF to BGP for vpn {} rd {}",
291 protected void add(final InstanceIdentifier<VpnInstanceOpDataEntry> identifier,
292 final VpnInstanceOpDataEntry value) {
293 LOG.debug("add: Ignoring vpn Op {} with rd {}", value.getVpnInstanceName(), value.getVrfId());
296 private class PostDeleteVpnInstanceWorker implements FutureCallback<Void> {
297 private final Logger log = LoggerFactory.getLogger(VpnOpStatusListener.PostDeleteVpnInstanceWorker.class);
300 PostDeleteVpnInstanceWorker(String vpnName) {
301 this.vpnName = vpnName;
305 * This implies that all the future instances have returned success.
306 * Release the ID used for VPN back to IdManager
309 public void onSuccess(Void ignored) {
310 vpnUtil.releaseId(VpnConstants.VPN_IDPOOL_NAME, vpnName);
311 log.info("onSuccess: VpnId for VpnName {} is released to IdManager successfully.", vpnName);
315 * This method is used to handle failure callbacks.
318 public void onFailure(Throwable throwable) {
319 log.error("onFailure: Job for vpnInstance: {} failed with exception:",
320 vpnName , throwable);