NETVIRT-1630 migrate to md-sal APIs
[netvirt.git] / vpnmanager / impl / src / main / java / org / opendaylight / netvirt / vpnmanager / intervpnlink / InterVpnLinkNodeAddTask.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 package org.opendaylight.netvirt.vpnmanager.intervpnlink;
9
10 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
11 import static org.opendaylight.mdsal.binding.api.WriteTransaction.CREATE_MISSING_PARENTS;
12
13 import com.google.common.util.concurrent.ListenableFuture;
14 import java.math.BigInteger;
15 import java.util.ArrayList;
16 import java.util.Collections;
17 import java.util.List;
18 import java.util.Optional;
19 import java.util.concurrent.Callable;
20 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
21 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
22 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
23 import org.opendaylight.mdsal.binding.api.DataBroker;
24 import org.opendaylight.netvirt.vpnmanager.VpnFootprintService;
25 import org.opendaylight.netvirt.vpnmanager.VpnUtil;
26 import org.opendaylight.netvirt.vpnmanager.api.intervpnlink.InterVpnLinkCache;
27 import org.opendaylight.netvirt.vpnmanager.api.intervpnlink.InterVpnLinkDataComposite;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.inter.vpn.link.state.FirstEndpointState;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.inter.vpn.link.state.FirstEndpointStateBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.inter.vpn.link.state.SecondEndpointState;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.inter.vpn.link.state.SecondEndpointStateBuilder;
34 import org.opendaylight.yangtools.yang.common.Uint32;
35 import org.opendaylight.yangtools.yang.common.Uint64;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
38
39 /**
40  * A task that, when a Node comes UP, checks if there are any InterVpnLink that
41  * hasn't been instantiated in any DPN yet. This may happen if, for example,
42  * there are no DPNs connected to controller by the time the InterVpnLink is
43  * created.
44  */
45 public class InterVpnLinkNodeAddTask implements Callable<List<? extends ListenableFuture<?>>> {
46     private static final Logger LOG = LoggerFactory.getLogger(InterVpnLinkNodeAddTask.class);
47     private static final String NBR_OF_DPNS_PROPERTY_NAME = "vpnservice.intervpnlink.number.dpns";
48
49     private final DataBroker broker;
50     private final ManagedNewTransactionRunner txRunner;
51     private final BigInteger dpnId;
52     private final IMdsalApiManager mdsalManager;
53     private final VpnFootprintService vpnFootprintService;
54     private final InterVpnLinkCache interVpnLinkCache;
55     private final VpnUtil vpnUtil;
56     private final InterVpnLinkUtil interVpnLinkUtil;
57
58     public InterVpnLinkNodeAddTask(final DataBroker broker, final IMdsalApiManager mdsalMgr,
59             final VpnFootprintService vpnFootprintService, final BigInteger dpnId,
60             final InterVpnLinkCache interVpnLinkCache, VpnUtil vpnUtil, InterVpnLinkUtil interVpnLinkUtil) {
61         this.broker = broker;
62         this.txRunner = new ManagedNewTransactionRunnerImpl(broker);
63         this.mdsalManager = mdsalMgr;
64         this.vpnFootprintService = vpnFootprintService;
65         this.dpnId = dpnId;
66         this.interVpnLinkCache = interVpnLinkCache;
67         this.interVpnLinkUtil = interVpnLinkUtil;
68         this.vpnUtil = vpnUtil;
69     }
70
71     @Override
72     public List<ListenableFuture<Void>> call() {
73         List<ListenableFuture<Void>> result = new ArrayList<>();
74         // check if there is any inter-vpn-link in with erroneous state
75         int numberOfDpns = Integer.getInteger(NBR_OF_DPNS_PROPERTY_NAME, 1);
76
77         List<Uint64> firstDpnList = Collections.singletonList(Uint64.valueOf(this.dpnId));
78         List<Uint64> secondDpnList = firstDpnList;
79         interVpnLinkCache.getAllInterVpnLinks().stream()
80             .filter(i -> i.isComplete() && !i.isActive()
81                         && shouldConfigureLinkIntoDpn(i.getInterVpnLinkState(), numberOfDpns))
82             .forEach(i -> {
83                 installLPortDispatcherTable(i.getInterVpnLinkState(), firstDpnList, secondDpnList);
84                 result.add(updateInterVpnLinkState(i.getInterVpnLinkState(), firstDpnList, secondDpnList));
85             });
86
87         return result;
88     }
89
90     private boolean shouldConfigureLinkIntoDpn(InterVpnLinkState interVpnLinkState, int numberOfDpns) {
91
92         if (interVpnLinkState.getFirstEndpointState().getDpId() == null
93                  || interVpnLinkState.getFirstEndpointState().getDpId().isEmpty()
94             || interVpnLinkState.getSecondEndpointState().getDpId() == null
95                     || interVpnLinkState.getSecondEndpointState().getDpId().isEmpty()) {
96             return true;
97         } else if (!interVpnLinkState.getFirstEndpointState().getDpId().contains(Uint64.valueOf(dpnId))
98             && !interVpnLinkState.getSecondEndpointState().getDpId().contains(Uint64.valueOf(dpnId))
99             && interVpnLinkState.getFirstEndpointState().getDpId().size() < numberOfDpns) {
100             return true;
101         } else {
102             return false;
103         }
104     }
105
106     private ListenableFuture<Void>
107         updateInterVpnLinkState(InterVpnLinkState interVpnLinkState, List<Uint64> firstDpnList,
108                                 List<Uint64> secondDpnList) {
109
110         FirstEndpointState firstEndPointState =
111             new FirstEndpointStateBuilder(interVpnLinkState.getFirstEndpointState()).setDpId(firstDpnList).build();
112         SecondEndpointState secondEndPointState =
113             new SecondEndpointStateBuilder(interVpnLinkState.getSecondEndpointState()).setDpId(secondDpnList).build();
114         InterVpnLinkState newInterVpnLinkState =
115             new InterVpnLinkStateBuilder(interVpnLinkState).setState(InterVpnLinkState.State.Active)
116                     .setFirstEndpointState(firstEndPointState).setSecondEndpointState(secondEndPointState)
117                     .build();
118         return txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, tx ->
119             tx.merge(InterVpnLinkUtil.getInterVpnLinkStateIid(interVpnLinkState.getInterVpnLinkName()),
120                     newInterVpnLinkState, CREATE_MISSING_PARENTS));
121     }
122
123     private void installLPortDispatcherTable(InterVpnLinkState interVpnLinkState, List<Uint64> firstDpnList,
124                                              List<Uint64> secondDpnList) {
125         String ivpnLinkName = interVpnLinkState.key().getInterVpnLinkName();
126         Optional<InterVpnLinkDataComposite> optVpnLink = interVpnLinkCache.getInterVpnLinkByName(ivpnLinkName);
127         if (!optVpnLink.isPresent()) {
128             LOG.warn("installLPortDispatcherTable: Could not find interVpnLink {}", ivpnLinkName);
129             return;
130         }
131
132         InterVpnLinkDataComposite vpnLink = optVpnLink.get();
133         Optional<Uint32> opt1stEndpointLportTag = vpnLink.getFirstEndpointLportTag();
134         if (!opt1stEndpointLportTag.isPresent()) {
135             LOG.warn("installLPortDispatcherTable: Could not find LPortTag for 1stEnpoint in InterVpnLink {}",
136                      ivpnLinkName);
137             return;
138         }
139
140         Optional<Uint32> opt2ndEndpointLportTag = vpnLink.getSecondEndpointLportTag();
141         if (!opt2ndEndpointLportTag.isPresent()) {
142             LOG.warn("installLPortDispatcherTable: Could not find LPortTag for 2ndEnpoint in InterVpnLink {}",
143                      ivpnLinkName);
144             return;
145         }
146
147         String firstEndpointVpnUuid = vpnLink.getFirstEndpointVpnUuid().get();
148         String secondEndpointVpnUuid = vpnLink.getSecondEndpointVpnUuid().get();
149         // Note that in the DPN of the firstEndpoint we install the lportTag of the secondEndpoint and viceversa
150         String vpn1PrimaryRd = vpnUtil.getPrimaryRd(firstEndpointVpnUuid);
151         String vpn2PrimaryRd = vpnUtil.getPrimaryRd(secondEndpointVpnUuid);
152         if (!vpnUtil.isVpnPendingDelete(vpn1PrimaryRd)
153                 && !vpnUtil.isVpnPendingDelete(vpn2PrimaryRd)) {
154             interVpnLinkUtil.installLPortDispatcherTableFlow(ivpnLinkName, firstDpnList, secondEndpointVpnUuid,
155                     opt2ndEndpointLportTag.get().toJava());
156             interVpnLinkUtil.installLPortDispatcherTableFlow(ivpnLinkName, secondDpnList, firstEndpointVpnUuid,
157                     opt1stEndpointLportTag.get().toJava());
158             // Update the VPN -> DPNs Map.
159             // Note: when a set of DPNs is calculated for Vpn1, these DPNs are added to the VpnToDpn map of Vpn2. Why?
160             // because we do the handover from Vpn1 to Vpn2 in those DPNs, so in those DPNs we must know how to reach
161             // to Vpn2 targets. If new Vpn2 targets are added later, the Fib will be maintained in these DPNs even if
162             // Vpn2 is not physically present there.
163             interVpnLinkUtil.updateVpnFootprint(secondEndpointVpnUuid, vpn1PrimaryRd, firstDpnList);
164             interVpnLinkUtil.updateVpnFootprint(firstEndpointVpnUuid, vpn2PrimaryRd, secondDpnList);
165         }
166     }
167 }