Datastore-constrained txes: elanmanager
[netvirt.git] / elanmanager / impl / src / main / java / org / opendaylight / netvirt / elan / internal / ElanInstanceManager.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.elan.internal;
10
11 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
12 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
13
14 import com.google.common.base.Optional;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.List;
19 import javax.annotation.PostConstruct;
20 import javax.inject.Inject;
21 import javax.inject.Singleton;
22
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.datastoreutils.AsyncDataTreeChangeListenerBase;
26 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
27 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
28 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
29 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
30 import org.opendaylight.genius.mdsalutil.MDSALUtil;
31 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
32 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
33 import org.opendaylight.netvirt.elan.cache.ElanInterfaceCache;
34 import org.opendaylight.netvirt.elan.utils.ElanConstants;
35 import org.opendaylight.netvirt.elan.utils.ElanUtils;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.Elan;
45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
48
49 @Singleton
50 public class ElanInstanceManager extends AsyncDataTreeChangeListenerBase<ElanInstance, ElanInstanceManager> {
51
52     private static final Logger LOG = LoggerFactory.getLogger(ElanInstanceManager.class);
53
54     private final DataBroker broker;
55     private final ManagedNewTransactionRunner txRunner;
56     private final IdManagerService idManager;
57     private final IInterfaceManager interfaceManager;
58     private final ElanInterfaceManager elanInterfaceManager;
59     private final JobCoordinator jobCoordinator;
60     private final ElanInterfaceCache elanInterfaceCache;
61
62     @Inject
63     public ElanInstanceManager(final DataBroker dataBroker, final IdManagerService managerService,
64                                final ElanInterfaceManager elanInterfaceManager,
65                                final IInterfaceManager interfaceManager, final JobCoordinator jobCoordinator,
66                                final ElanInterfaceCache elanInterfaceCache) {
67         super(ElanInstance.class, ElanInstanceManager.class);
68         this.broker = dataBroker;
69         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
70         this.idManager = managerService;
71         this.elanInterfaceManager = elanInterfaceManager;
72         this.interfaceManager = interfaceManager;
73         this.jobCoordinator = jobCoordinator;
74         this.elanInterfaceCache = elanInterfaceCache;
75     }
76
77     @Override
78     @PostConstruct
79     public void init() {
80         registerListener(LogicalDatastoreType.CONFIGURATION, broker);
81     }
82
83     @Override
84     protected void remove(InstanceIdentifier<ElanInstance> identifier, ElanInstance deletedElan) {
85         LOG.trace("Remove ElanInstance - Key: {}, value: {}", identifier, deletedElan);
86         String elanName = deletedElan.getElanInstanceName();
87         // check the elan Instance present in the Operational DataStore
88         Elan existingElan = ElanUtils.getElanByName(broker, elanName);
89         long elanTag = deletedElan.getElanTag();
90         // Cleaning up the existing Elan Instance
91         if (existingElan != null) {
92             List<String> elanInterfaces = existingElan.getElanInterfaces();
93             if (elanInterfaces != null && !elanInterfaces.isEmpty()) {
94                 List<ListenableFuture<Void>> futureList = new ArrayList<>();
95                 elanInterfaces.forEach(elanInterfaceName -> {
96                     jobCoordinator.enqueueJob(ElanUtils.getElanInterfaceJobKey(elanInterfaceName), () -> {
97                         InstanceIdentifier<ElanInterface> elanInterfaceId = ElanUtils
98                                 .getElanInterfaceConfigurationDataPathId(elanInterfaceName);
99                         InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(elanInterfaceName);
100                         futureList.addAll(elanInterfaceManager.removeElanInterface(deletedElan, elanInterfaceName,
101                                 interfaceInfo));
102                         ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
103                                 elanInterfaceId);
104                         return futureList;
105                     },ElanConstants.JOB_MAX_RETRIES);
106                 });
107             }
108             ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
109                     ElanUtils.getElanInstanceOperationalDataPath(elanName));
110             Optional<ElanDpnInterfacesList> elanDpnInterfaceList = MDSALUtil.read(broker,
111                     LogicalDatastoreType.OPERATIONAL,
112                     ElanUtils.getElanDpnOperationDataPath(elanName));
113             if (elanDpnInterfaceList.isPresent()) {
114                 ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
115                         getElanDpnOperationDataPath(elanName));
116             }
117             ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
118                     ElanUtils.getElanInfoEntriesOperationalDataPath(elanTag));
119         }
120         elanInterfaceCache.getInterfaceNames(elanName).forEach(
121             elanInterfaceName -> jobCoordinator.enqueueJob(ElanUtils.getElanInterfaceJobKey(elanInterfaceName),
122                 () -> Collections.singletonList(txRunner.callWithNewReadWriteTransactionAndSubmit(CONFIGURATION, tx -> {
123                     LOG.info("Deleting the elanInterface present under ConfigDS:{}", elanInterfaceName);
124                     tx.delete(ElanUtils.getElanInterfaceConfigurationDataPathId(elanInterfaceName));
125                     elanInterfaceManager.unbindService(elanInterfaceName, tx);
126                     LOG.info("unbind the Interface:{} service bounded to Elan:{}", elanInterfaceName, elanName);
127                 })), ElanConstants.JOB_MAX_RETRIES));
128         // Release tag
129         ElanUtils.releaseId(idManager, ElanConstants.ELAN_ID_POOL_NAME, elanName);
130         if (deletedElan.augmentation(EtreeInstance.class) != null) {
131             removeEtreeInstance(deletedElan);
132         }
133     }
134
135     private void removeEtreeInstance(ElanInstance deletedElan) {
136         // Release leaves tag
137         ElanUtils.releaseId(idManager, ElanConstants.ELAN_ID_POOL_NAME,
138                 deletedElan.getElanInstanceName() + ElanConstants.LEAVES_POSTFIX);
139
140         ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
141                 ElanUtils.getElanInfoEntriesOperationalDataPath(
142                         deletedElan.augmentation(EtreeInstance.class).getEtreeLeafTagVal().getValue()));
143     }
144
145     @Override
146     protected void update(InstanceIdentifier<ElanInstance> identifier, ElanInstance original, ElanInstance update) {
147         Long existingElanTag = original.getElanTag();
148         String elanName = update.getElanInstanceName();
149         if (existingElanTag == null || !existingElanTag.equals(update.getElanTag())) {
150             if (update.getElanTag() == null  || update.getElanTag() == 0L) {
151                 // update the elan-Instance with new properties
152                 ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL,
153                     operTx -> ListenableFutures.addErrorLogging(
154                         txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION,
155                             confTx -> ElanUtils.updateOperationalDataStore(idManager, update, new ArrayList<>(), confTx,
156                                 operTx)), LOG, "Error updating ELAN tag in ELAN instance")), LOG,
157                     "Error updating ELAN tag in ELAN instance");
158             } else {
159                 jobCoordinator.enqueueJob(elanName, () -> elanInterfaceManager.handleunprocessedElanInterfaces(update),
160                     ElanConstants.JOB_MAX_RETRIES);
161             }
162         }
163     }
164
165     @Override
166     protected void add(InstanceIdentifier<ElanInstance> identifier, ElanInstance elanInstanceAdded) {
167         ListenableFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(OPERATIONAL, operTx -> {
168             String elanInstanceName  = elanInstanceAdded.getElanInstanceName();
169             Elan elanInfo = ElanUtils.getElanByName(operTx, elanInstanceName);
170             if (elanInfo == null) {
171                 ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION,
172                     confTx -> ElanUtils.updateOperationalDataStore(idManager, elanInstanceAdded, new ArrayList<>(),
173                         confTx, operTx)), LOG, "Error adding an ELAN instance");
174             }
175         }), LOG, "Error adding an ELAN instance");
176     }
177
178     private static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationDataPath(String elanInstanceName) {
179         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
180                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)).build();
181     }
182
183     @Override
184     protected InstanceIdentifier<ElanInstance> getWildCardPath() {
185         return InstanceIdentifier.create(ElanInstances.class).child(ElanInstance.class);
186     }
187
188     @Override
189     protected ElanInstanceManager getDataTreeChangeListener() {
190         return this;
191     }
192 }