2 * Copyright (c) 2015 Cisco Systems, Inc. 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
9 package org.opendaylight.openflowplugin.impl.device;
11 import com.google.common.annotations.VisibleForTesting;
12 import com.google.common.base.Preconditions;
13 import com.google.common.util.concurrent.CheckedFuture;
14 import com.google.common.util.concurrent.FutureCallback;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import java.util.Objects;
18 import java.util.Optional;
19 import java.util.concurrent.CancellationException;
20 import javax.annotation.Nonnull;
21 import javax.annotation.Nullable;
22 import javax.annotation.concurrent.GuardedBy;
23 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
24 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
25 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
26 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
28 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainClosedException;
30 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
31 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
32 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
33 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
34 import org.opendaylight.yangtools.yang.binding.DataObject;
35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
41 * org.opendaylight.openflowplugin.impl.device
43 * Package protected class for controlling {@link WriteTransaction} life cycle. It is
44 * a {@link TransactionChainListener} and provide package protected methods for writeToTransaction
45 * method (wrapped {@link WriteTransaction#put(LogicalDatastoreType, InstanceIdentifier, DataObject)})
46 * and submitTransaction method (wrapped {@link WriteTransaction#submit()})
48 class TransactionChainManager implements TransactionChainListener, AutoCloseable {
50 private static final Logger LOG = LoggerFactory.getLogger(TransactionChainManager.class);
51 private static final String CANNOT_WRITE_INTO_TRANSACTION = "Cannot write into transaction.";
53 private final Object txLock = new Object();
54 private final DataBroker dataBroker;
55 private final String nodeId;
56 private LifecycleService lifecycleService;
59 private WriteTransaction wTx;
61 private BindingTransactionChain txChainFactory;
63 private boolean submitIsEnabled;
65 private ListenableFuture<Void> lastSubmittedFuture;
67 private volatile boolean initCommit;
70 private TransactionChainManagerStatus transactionChainManagerStatus = TransactionChainManagerStatus.SLEEPING;
72 TransactionChainManager(@Nonnull final DataBroker dataBroker,
73 @Nonnull final DeviceInfo deviceInfo) {
74 this.dataBroker = dataBroker;
75 this.nodeId = deviceInfo.getNodeInstanceIdentifier().getKey().getId().getValue();
76 this.lastSubmittedFuture = Futures.immediateFuture(null);
80 private void createTxChain() {
81 BindingTransactionChain txChainFactoryTemp = txChainFactory;
82 txChainFactory = dataBroker.createTransactionChain(TransactionChainManager.this);
83 Optional.ofNullable(txChainFactoryTemp).ifPresent(TransactionChain::close);
86 public void setLifecycleService(final LifecycleService lifecycleService) {
87 this.lifecycleService = lifecycleService;
90 void initialSubmitWriteTransaction() {
92 submitWriteTransaction();
96 * Method change status for TxChainManager to {@link TransactionChainManagerStatus#WORKING} and it has to make
97 * registration for this class instance as {@link TransactionChainListener} to provide possibility a make DS
98 * transactions. Call this method for MASTER role only.
100 void activateTransactionManager() {
101 if (LOG.isDebugEnabled()) {
102 LOG.debug("activateTransactionManager for node {} transaction submit is set to {}", this.nodeId, submitIsEnabled);
104 synchronized (txLock) {
105 if (TransactionChainManagerStatus.SLEEPING == transactionChainManagerStatus) {
106 Preconditions.checkState(txChainFactory == null, "TxChainFactory survive last close.");
107 Preconditions.checkState(wTx == null, "We have some unexpected WriteTransaction.");
108 this.transactionChainManagerStatus = TransactionChainManagerStatus.WORKING;
109 this.submitIsEnabled = false;
110 this.initCommit = true;
117 * Method change status for TxChainManger to {@link TransactionChainManagerStatus#SLEEPING} and it unregisters
118 * this class instance as {@link TransactionChainListener} so it broke a possibility to write something to DS.
119 * Call this method for SLAVE only.
122 ListenableFuture<Void> deactivateTransactionManager() {
123 if (LOG.isDebugEnabled()) {
124 LOG.debug("deactivateTransactionManager for node {}", this.nodeId);
126 final ListenableFuture<Void> future;
127 synchronized (txLock) {
128 if (TransactionChainManagerStatus.WORKING == transactionChainManagerStatus) {
129 transactionChainManagerStatus = TransactionChainManagerStatus.SLEEPING;
130 future = txChainShuttingDown();
131 Preconditions.checkState(wTx == null, "We have some unexpected WriteTransaction.");
132 Futures.addCallback(future, new FutureCallback<Void>() {
134 public void onSuccess(final Void result) {
135 removeTxChainFactory();
139 public void onFailure(final Throwable t) {
140 removeTxChainFactory();
144 // TODO : ignoring redundant deactivate invocation
145 future = Futures.immediateCheckedFuture(null);
151 private void removeTxChainFactory() {
152 Optional.ofNullable(txChainFactory).ifPresent(TransactionChain::close);
153 txChainFactory = null;
156 boolean submitWriteTransaction() {
157 synchronized (txLock) {
158 if (!submitIsEnabled) {
159 if (LOG.isTraceEnabled()) {
160 LOG.trace("transaction not committed - submit block issued");
164 if (Objects.isNull(wTx)) {
165 if (LOG.isTraceEnabled()) {
166 LOG.trace("nothing to commit - submit returns true");
170 Preconditions.checkState(TransactionChainManagerStatus.WORKING == transactionChainManagerStatus,
171 "we have here Uncompleted Transaction for node {} and we are not MASTER", this.nodeId);
172 final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = wTx.submit();
173 lastSubmittedFuture = submitFuture;
176 Futures.addCallback(submitFuture, new FutureCallback<Void>() {
178 public void onSuccess(final Void result) {
183 public void onFailure(final Throwable t) {
184 if (t instanceof TransactionCommitFailedException) {
185 LOG.error("Transaction commit failed. ", t);
187 if (t instanceof CancellationException) {
188 LOG.warn("Submit task was canceled");
189 LOG.trace("Submit exception: ", t);
191 LOG.error("Exception during transaction submitting. ", t);
195 Optional.ofNullable(lifecycleService).ifPresent(LifecycleService::closeConnection);
203 <T extends DataObject> void addDeleteOperationTotTxChain(final LogicalDatastoreType store,
204 final InstanceIdentifier<T> path){
205 synchronized (txLock) {
208 LOG.debug("WriteTx is null for node {}. Delete {} was not realized.", this.nodeId, path);
209 throw new TransactionChainClosedException(CANNOT_WRITE_INTO_TRANSACTION);
212 wTx.delete(store, path);
216 <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
217 final InstanceIdentifier<T> path,
219 final boolean createParents){
220 synchronized (txLock) {
223 LOG.debug("WriteTx is null for node {}. Write data for {} was not realized.", this.nodeId, path);
224 throw new TransactionChainClosedException(CANNOT_WRITE_INTO_TRANSACTION);
227 wTx.put(store, path, data, createParents);
232 public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
233 final AsyncTransaction<?, ?> transaction, final Throwable cause) {
234 synchronized (txLock) {
235 if (TransactionChainManagerStatus.WORKING == transactionChainManagerStatus) {
236 LOG.warn("Transaction chain failed, recreating chain due to ", cause);
244 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
250 private void ensureTransaction() {
251 if (wTx == null && TransactionChainManagerStatus.WORKING == transactionChainManagerStatus
252 && txChainFactory != null) {
253 wTx = txChainFactory.newWriteOnlyTransaction();
258 void enableSubmit() {
259 synchronized (txLock) {
260 /* !!!IMPORTANT: never set true without txChainFactory */
261 submitIsEnabled = txChainFactory != null;
265 ListenableFuture<Void> shuttingDown() {
266 if (LOG.isDebugEnabled()) {
267 LOG.debug("TxManager is going SHUTTING_DOWN for node {}", this.nodeId);
269 synchronized (txLock) {
270 this.transactionChainManagerStatus = TransactionChainManagerStatus.SHUTTING_DOWN;
271 return txChainShuttingDown();
276 private ListenableFuture<Void> txChainShuttingDown() {
277 submitIsEnabled = false;
278 ListenableFuture<Void> future;
279 if (txChainFactory == null) {
280 // stay with actual thread
281 future = Futures.immediateCheckedFuture(null);
282 } else if (wTx == null) {
283 // hijack md-sal thread
284 future = lastSubmittedFuture;
286 if (LOG.isDebugEnabled()) {
287 LOG.debug("Submitting all transactions for Node {}", this.nodeId);
289 // hijack md-sal thread
290 future = wTx.submit();
297 public void close() {
298 if (LOG.isDebugEnabled()) {
299 LOG.debug("Setting transactionChainManagerStatus to SHUTTING_DOWN for {}", this.nodeId);
301 synchronized (txLock) {
302 removeTxChainFactory();
306 private enum TransactionChainManagerStatus {
307 /** txChainManager is sleeping - is not active (SLAVE or default init value) */
309 /** txChainManager is working - is active (MASTER) */
311 /** txChainManager is trying to be closed - device disconnecting */