2 * Copyright (c) 2014 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
8 package org.opendaylight.controller.cluster.datastore;
10 import akka.actor.ActorSelection;
11 import com.google.common.annotations.VisibleForTesting;
12 import com.google.common.base.Function;
13 import com.google.common.base.Optional;
14 import com.google.common.base.Preconditions;
15 import com.google.common.collect.Iterables;
16 import com.google.common.util.concurrent.CheckedFuture;
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import com.google.common.util.concurrent.SettableFuture;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.HashMap;
23 import java.util.List;
25 import java.util.Map.Entry;
27 import java.util.concurrent.Semaphore;
28 import java.util.concurrent.TimeUnit;
29 import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier;
30 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
31 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
32 import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeAggregator;
33 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
34 import org.opendaylight.controller.sal.core.spi.data.AbstractDOMStoreTransaction;
35 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
36 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42 import scala.concurrent.Future;
43 import scala.concurrent.Promise;
46 * A transaction potentially spanning multiple backend shards.
48 public class TransactionProxy extends AbstractDOMStoreTransaction<TransactionIdentifier> implements DOMStoreReadWriteTransaction {
49 private static enum TransactionState {
54 private static final Logger LOG = LoggerFactory.getLogger(TransactionProxy.class);
56 private final Map<String, TransactionContextWrapper> txContextAdapters = new HashMap<>();
57 private final AbstractTransactionContextFactory<?> txContextFactory;
58 private final TransactionType type;
59 private TransactionState state = TransactionState.OPEN;
60 private volatile OperationCompleter operationCompleter;
61 private volatile Semaphore operationLimiter;
64 public TransactionProxy(final AbstractTransactionContextFactory<?> txContextFactory, final TransactionType type) {
65 super(txContextFactory.nextIdentifier(), false);
66 this.txContextFactory = txContextFactory;
67 this.type = Preconditions.checkNotNull(type);
69 LOG.debug("New {} Tx - {}", type, getIdentifier());
73 public CheckedFuture<Boolean, ReadFailedException> exists(final YangInstanceIdentifier path) {
74 Preconditions.checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
76 LOG.debug("Tx {} exists {}", getIdentifier(), path);
80 final SettableFuture<Boolean> proxyFuture = SettableFuture.create();
81 TransactionContextWrapper contextAdapter = getContextAdapter(path);
82 contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
84 public void invoke(TransactionContext transactionContext) {
85 transactionContext.dataExists(path, proxyFuture);
89 return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
93 public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(final YangInstanceIdentifier path) {
94 Preconditions.checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
96 LOG.debug("Tx {} read {}", getIdentifier(), path);
98 if (YangInstanceIdentifier.EMPTY.equals(path)) {
103 return singleShardRead(shardNameFromIdentifier(path), path);
107 private CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> singleShardRead(
108 final String shardName, final YangInstanceIdentifier path) {
109 final SettableFuture<Optional<NormalizedNode<?, ?>>> proxyFuture = SettableFuture.create();
110 TransactionContextWrapper contextAdapter = getContextAdapter(shardName);
111 contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
113 public void invoke(TransactionContext transactionContext) {
114 transactionContext.readData(path, proxyFuture);
118 return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
121 private CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> readAllData() {
122 final Set<String> allShardNames = txContextFactory.getActorContext().getConfiguration().getAllShardNames();
123 final Collection<CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException>> futures = new ArrayList<>(allShardNames.size());
125 for (String shardName : allShardNames) {
126 futures.add(singleShardRead(shardName, YangInstanceIdentifier.EMPTY));
129 final ListenableFuture<List<Optional<NormalizedNode<?, ?>>>> listFuture = Futures.allAsList(futures);
130 final ListenableFuture<Optional<NormalizedNode<?, ?>>> aggregateFuture;
132 aggregateFuture = Futures.transform(listFuture, new Function<List<Optional<NormalizedNode<?, ?>>>, Optional<NormalizedNode<?, ?>>>() {
134 public Optional<NormalizedNode<?, ?>> apply(final List<Optional<NormalizedNode<?, ?>>> input) {
136 return NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.EMPTY, input, txContextFactory.getActorContext().getSchemaContext());
137 } catch (DataValidationFailedException e) {
138 throw new IllegalArgumentException("Failed to aggregate", e);
143 return MappingCheckedFuture.create(aggregateFuture, ReadFailedException.MAPPER);
147 public void delete(final YangInstanceIdentifier path) {
148 checkModificationState();
150 LOG.debug("Tx {} delete {}", getIdentifier(), path);
154 TransactionContextWrapper contextAdapter = getContextAdapter(path);
155 contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
157 public void invoke(TransactionContext transactionContext) {
158 transactionContext.deleteData(path);
164 public void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
165 checkModificationState();
167 LOG.debug("Tx {} merge {}", getIdentifier(), path);
171 TransactionContextWrapper contextAdapter = getContextAdapter(path);
172 contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
174 public void invoke(TransactionContext transactionContext) {
175 transactionContext.mergeData(path, data);
181 public void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
182 checkModificationState();
184 LOG.debug("Tx {} write {}", getIdentifier(), path);
188 TransactionContextWrapper contextAdapter = getContextAdapter(path);
189 contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
191 public void invoke(TransactionContext transactionContext) {
192 transactionContext.writeData(path, data);
197 private void checkModificationState() {
198 Preconditions.checkState(type != TransactionType.READ_ONLY,
199 "Modification operation on read-only transaction is not allowed");
200 Preconditions.checkState(state == TransactionState.OPEN,
201 "Transaction is sealed - further modifications are not allowed");
204 private boolean seal(final TransactionState newState) {
205 if (state == TransactionState.OPEN) {
214 public final void close() {
215 if (!seal(TransactionState.CLOSED)) {
216 Preconditions.checkState(state == TransactionState.CLOSED, "Transaction %s is ready, it cannot be closed",
218 // Idempotent no-op as per AutoCloseable recommendation
222 for (TransactionContextWrapper contextAdapter : txContextAdapters.values()) {
223 contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
225 public void invoke(TransactionContext transactionContext) {
226 transactionContext.closeTransaction();
232 txContextAdapters.clear();
236 public final AbstractThreePhaseCommitCohort<?> ready() {
237 Preconditions.checkState(type != TransactionType.READ_ONLY, "Read-only transactions cannot be readied");
239 final boolean success = seal(TransactionState.READY);
240 Preconditions.checkState(success, "Transaction %s is %s, it cannot be readied", getIdentifier(), state);
242 LOG.debug("Tx {} Readying {} components for commit", getIdentifier(), txContextAdapters.size());
244 final AbstractThreePhaseCommitCohort<?> ret;
245 switch (txContextAdapters.size()) {
247 TransactionRateLimitingCallback.adjustRateLimitForUnusedTransaction(txContextFactory.getActorContext());
248 ret = NoOpDOMStoreThreePhaseCommitCohort.INSTANCE;
251 final Entry<String, TransactionContextWrapper> e = Iterables.getOnlyElement(txContextAdapters.entrySet());
252 ret = createSingleCommitCohort(e.getKey(), e.getValue());
255 ret = createMultiCommitCohort(txContextAdapters.entrySet());
258 txContextFactory.onTransactionReady(getIdentifier(), ret.getCohortFutures());
262 private AbstractThreePhaseCommitCohort<?> createSingleCommitCohort(final String shardName,
263 final TransactionContextWrapper contextAdapter) {
266 LOG.debug("Tx {} Readying transaction for shard {}", getIdentifier(), shardName);
268 final OperationCallback.Reference operationCallbackRef =
269 new OperationCallback.Reference(OperationCallback.NO_OP_CALLBACK);
271 final TransactionContext transactionContext = contextAdapter.getTransactionContext();
273 if (transactionContext == null) {
274 final Promise promise = akka.dispatch.Futures.promise();
275 contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
277 public void invoke(TransactionContext transactionContext) {
278 promise.completeWith(getReadyOrDirectCommitFuture(transactionContext, operationCallbackRef));
281 future = promise.future();
283 // avoid the creation of a promise and a TransactionOperation
284 future = getReadyOrDirectCommitFuture(transactionContext, operationCallbackRef);
287 return new SingleCommitCohortProxy(txContextFactory.getActorContext(), future, getIdentifier().toString(),
288 operationCallbackRef);
291 private Future<?> getReadyOrDirectCommitFuture(TransactionContext transactionContext,
292 OperationCallback.Reference operationCallbackRef) {
293 if (transactionContext.supportsDirectCommit()) {
294 TransactionRateLimitingCallback rateLimitingCallback = new TransactionRateLimitingCallback(
295 txContextFactory.getActorContext());
296 operationCallbackRef.set(rateLimitingCallback);
297 rateLimitingCallback.run();
298 return transactionContext.directCommit();
300 return transactionContext.readyTransaction();
304 private AbstractThreePhaseCommitCohort<ActorSelection> createMultiCommitCohort(
305 final Set<Entry<String, TransactionContextWrapper>> txContextAdapterEntries) {
308 final List<Future<ActorSelection>> cohortFutures = new ArrayList<>(txContextAdapterEntries.size());
309 for (Entry<String, TransactionContextWrapper> e : txContextAdapterEntries) {
310 LOG.debug("Tx {} Readying transaction for shard {}", getIdentifier(), e.getKey());
312 TransactionContextWrapper contextAdapter = e.getValue();
313 final TransactionContext transactionContext = contextAdapter.getTransactionContext();
314 Future<ActorSelection> future;
315 if (transactionContext != null) {
316 // avoid the creation of a promise and a TransactionOperation
317 future = transactionContext.readyTransaction();
319 final Promise<ActorSelection> promise = akka.dispatch.Futures.promise();
320 contextAdapter.maybeExecuteTransactionOperation(new TransactionOperation() {
322 public void invoke(TransactionContext transactionContext) {
323 promise.completeWith(transactionContext.readyTransaction());
327 future = promise.future();
330 cohortFutures.add(future);
333 return new ThreePhaseCommitCohortProxy(txContextFactory.getActorContext(), cohortFutures, getIdentifier().toString());
336 private static String shardNameFromIdentifier(final YangInstanceIdentifier path) {
337 return ShardStrategyFactory.getStrategy(path).findShard(path);
340 private TransactionContextWrapper getContextAdapter(final YangInstanceIdentifier path) {
341 return getContextAdapter(shardNameFromIdentifier(path));
344 private TransactionContextWrapper getContextAdapter(final String shardName) {
345 final TransactionContextWrapper existing = txContextAdapters.get(shardName);
346 if (existing != null) {
350 final TransactionContextWrapper fresh = txContextFactory.newTransactionAdapter(this, shardName);
351 txContextAdapters.put(shardName, fresh);
355 TransactionType getType() {
360 return state != TransactionState.OPEN;
363 ActorContext getActorContext() {
364 return txContextFactory.getActorContext();
367 OperationCompleter getCompleter() {
368 OperationCompleter ret = operationCompleter;
370 final Semaphore s = getLimiter();
371 ret = new OperationCompleter(s);
372 operationCompleter = ret;
378 Semaphore getLimiter() {
379 Semaphore ret = operationLimiter;
381 // Note : Currently mailbox-capacity comes from akka.conf and not from the config-subsystem
382 ret = new Semaphore(getActorContext().getTransactionOutstandingOperationLimit());
383 operationLimiter = ret;
388 void throttleOperation() {
389 throttleOperation(1);
392 private void throttleOperation(int acquirePermits) {
394 if (!getLimiter().tryAcquire(acquirePermits,
395 getActorContext().getDatastoreContext().getOperationTimeoutInSeconds(), TimeUnit.SECONDS)){
396 LOG.warn("Failed to acquire operation permit for transaction {}", getIdentifier());
398 } catch (InterruptedException e) {
399 if (LOG.isDebugEnabled()) {
400 LOG.debug("Interrupted when trying to acquire operation permit for transaction {}", getIdentifier(), e);
402 LOG.warn("Interrupted when trying to acquire operation permit for transaction {}", getIdentifier());