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 org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier;
28 import org.opendaylight.controller.cluster.datastore.messages.AbstractRead;
29 import org.opendaylight.controller.cluster.datastore.messages.DataExists;
30 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
31 import org.opendaylight.controller.cluster.datastore.modification.AbstractModification;
32 import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
33 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
34 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
35 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
36 import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeAggregator;
37 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
38 import org.opendaylight.controller.sal.core.spi.data.AbstractDOMStoreTransaction;
39 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
40 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
43 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46 import scala.concurrent.Future;
47 import scala.concurrent.Promise;
50 * A transaction potentially spanning multiple backend shards.
52 public class TransactionProxy extends AbstractDOMStoreTransaction<TransactionIdentifier> implements DOMStoreReadWriteTransaction {
53 private static enum TransactionState {
58 private static final Logger LOG = LoggerFactory.getLogger(TransactionProxy.class);
60 private final Map<String, TransactionContextWrapper> txContextWrappers = new HashMap<>();
61 private final AbstractTransactionContextFactory<?> txContextFactory;
62 private final TransactionType type;
63 private TransactionState state = TransactionState.OPEN;
66 public TransactionProxy(final AbstractTransactionContextFactory<?> txContextFactory, final TransactionType type) {
67 super(txContextFactory.nextIdentifier(), txContextFactory.getActorContext().getDatastoreContext()
68 .isTransactionDebugContextEnabled());
69 this.txContextFactory = txContextFactory;
70 this.type = Preconditions.checkNotNull(type);
72 LOG.debug("New {} Tx - {}", type, getIdentifier());
76 public CheckedFuture<Boolean, ReadFailedException> exists(final YangInstanceIdentifier path) {
77 return executeRead(shardNameFromIdentifier(path), new DataExists(path, DataStoreVersions.CURRENT_VERSION));
80 private <T> CheckedFuture<T, ReadFailedException> executeRead(String shardName, final AbstractRead<T> readCmd) {
81 Preconditions.checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
83 if(LOG.isDebugEnabled()) {
84 LOG.debug("Tx {} {} {}", getIdentifier(), readCmd.getClass().getSimpleName(), readCmd.getPath());
87 final SettableFuture<T> proxyFuture = SettableFuture.create();
88 TransactionContextWrapper contextWrapper = getContextWrapper(shardName);
89 contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
91 public void invoke(TransactionContext transactionContext) {
92 transactionContext.executeRead(readCmd, proxyFuture);
96 return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
100 public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(final YangInstanceIdentifier path) {
101 Preconditions.checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
103 LOG.debug("Tx {} read {}", getIdentifier(), path);
105 if (YangInstanceIdentifier.EMPTY.equals(path)) {
106 return readAllData();
108 return singleShardRead(shardNameFromIdentifier(path), path);
112 private CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> singleShardRead(
113 final String shardName, final YangInstanceIdentifier path) {
114 return executeRead(shardName, new ReadData(path, DataStoreVersions.CURRENT_VERSION));
117 private CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> readAllData() {
118 final Set<String> allShardNames = txContextFactory.getActorContext().getConfiguration().getAllShardNames();
119 final Collection<CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException>> futures = new ArrayList<>(allShardNames.size());
121 for (String shardName : allShardNames) {
122 futures.add(singleShardRead(shardName, YangInstanceIdentifier.EMPTY));
125 final ListenableFuture<List<Optional<NormalizedNode<?, ?>>>> listFuture = Futures.allAsList(futures);
126 final ListenableFuture<Optional<NormalizedNode<?, ?>>> aggregateFuture;
128 aggregateFuture = Futures.transform(listFuture, new Function<List<Optional<NormalizedNode<?, ?>>>, Optional<NormalizedNode<?, ?>>>() {
130 public Optional<NormalizedNode<?, ?>> apply(final List<Optional<NormalizedNode<?, ?>>> input) {
132 return NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.EMPTY, input, txContextFactory.getActorContext().getSchemaContext());
133 } catch (DataValidationFailedException e) {
134 throw new IllegalArgumentException("Failed to aggregate", e);
139 return MappingCheckedFuture.create(aggregateFuture, ReadFailedException.MAPPER);
143 public void delete(final YangInstanceIdentifier path) {
144 executeModification(new DeleteModification(path));
148 public void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
149 executeModification(new MergeModification(path, data));
153 public void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
154 executeModification(new WriteModification(path, data));
157 private void executeModification(final AbstractModification modification) {
158 checkModificationState();
160 if(LOG.isDebugEnabled()) {
161 LOG.debug("Tx {} executeModification {} {}", getIdentifier(), modification.getClass().getSimpleName(),
162 modification.getPath());
165 TransactionContextWrapper contextWrapper = getContextWrapper(modification.getPath());
166 contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
168 protected void invoke(TransactionContext transactionContext) {
169 transactionContext.executeModification(modification);
174 private void checkModificationState() {
175 Preconditions.checkState(type != TransactionType.READ_ONLY,
176 "Modification operation on read-only transaction is not allowed");
177 Preconditions.checkState(state == TransactionState.OPEN,
178 "Transaction is sealed - further modifications are not allowed");
181 private boolean seal(final TransactionState newState) {
182 if (state == TransactionState.OPEN) {
191 public final void close() {
192 if (!seal(TransactionState.CLOSED)) {
193 Preconditions.checkState(state == TransactionState.CLOSED, "Transaction %s is ready, it cannot be closed",
195 // Idempotent no-op as per AutoCloseable recommendation
199 for (TransactionContextWrapper contextWrapper : txContextWrappers.values()) {
200 contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
202 public void invoke(TransactionContext transactionContext) {
203 transactionContext.closeTransaction();
209 txContextWrappers.clear();
213 public final AbstractThreePhaseCommitCohort<?> ready() {
214 Preconditions.checkState(type != TransactionType.READ_ONLY, "Read-only transactions cannot be readied");
216 final boolean success = seal(TransactionState.READY);
217 Preconditions.checkState(success, "Transaction %s is %s, it cannot be readied", getIdentifier(), state);
219 LOG.debug("Tx {} Readying {} components for commit", getIdentifier(), txContextWrappers.size());
221 final AbstractThreePhaseCommitCohort<?> ret;
222 switch (txContextWrappers.size()) {
224 ret = NoOpDOMStoreThreePhaseCommitCohort.INSTANCE;
227 final Entry<String, TransactionContextWrapper> e = Iterables.getOnlyElement(txContextWrappers.entrySet());
228 ret = createSingleCommitCohort(e.getKey(), e.getValue());
231 ret = createMultiCommitCohort(txContextWrappers.entrySet());
234 txContextFactory.onTransactionReady(getIdentifier(), ret.getCohortFutures());
236 final Throwable debugContext = getDebugContext();
237 return debugContext == null ? ret : new DebugThreePhaseCommitCohort(getIdentifier(), ret, debugContext);
240 private AbstractThreePhaseCommitCohort<?> createSingleCommitCohort(final String shardName,
241 final TransactionContextWrapper contextWrapper) {
243 LOG.debug("Tx {} Readying transaction for shard {}", getIdentifier(), shardName);
245 final OperationCallback.Reference operationCallbackRef =
246 new OperationCallback.Reference(OperationCallback.NO_OP_CALLBACK);
248 final TransactionContext transactionContext = contextWrapper.getTransactionContext();
250 if (transactionContext == null) {
251 final Promise promise = akka.dispatch.Futures.promise();
252 contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
254 public void invoke(TransactionContext transactionContext) {
255 promise.completeWith(getReadyOrDirectCommitFuture(transactionContext, operationCallbackRef));
258 future = promise.future();
260 // avoid the creation of a promise and a TransactionOperation
261 future = getReadyOrDirectCommitFuture(transactionContext, operationCallbackRef);
264 return new SingleCommitCohortProxy(txContextFactory.getActorContext(), future, getIdentifier().toString(),
265 operationCallbackRef);
268 private Future<?> getReadyOrDirectCommitFuture(TransactionContext transactionContext,
269 OperationCallback.Reference operationCallbackRef) {
270 if (transactionContext.supportsDirectCommit()) {
271 TransactionRateLimitingCallback rateLimitingCallback = new TransactionRateLimitingCallback(
272 txContextFactory.getActorContext());
273 operationCallbackRef.set(rateLimitingCallback);
274 rateLimitingCallback.run();
275 return transactionContext.directCommit();
277 return transactionContext.readyTransaction();
281 private AbstractThreePhaseCommitCohort<ActorSelection> createMultiCommitCohort(
282 final Set<Entry<String, TransactionContextWrapper>> txContextWrapperEntries) {
284 final List<Future<ActorSelection>> cohortFutures = new ArrayList<>(txContextWrapperEntries.size());
285 for (Entry<String, TransactionContextWrapper> e : txContextWrapperEntries) {
286 LOG.debug("Tx {} Readying transaction for shard {}", getIdentifier(), e.getKey());
288 cohortFutures.add(e.getValue().readyTransaction());
291 return new ThreePhaseCommitCohortProxy(txContextFactory.getActorContext(), cohortFutures, getIdentifier().toString());
294 private String shardNameFromIdentifier(final YangInstanceIdentifier path) {
295 return txContextFactory.getActorContext().getShardStrategyFactory().getStrategy(path).findShard(path);
298 private TransactionContextWrapper getContextWrapper(final YangInstanceIdentifier path) {
299 return getContextWrapper(shardNameFromIdentifier(path));
302 private TransactionContextWrapper getContextWrapper(final String shardName) {
303 final TransactionContextWrapper existing = txContextWrappers.get(shardName);
304 if (existing != null) {
308 final TransactionContextWrapper fresh = txContextFactory.newTransactionContextWrapper(this, shardName);
309 txContextWrappers.put(shardName, fresh);
313 TransactionType getType() {
318 return state != TransactionState.OPEN;
321 ActorContext getActorContext() {
322 return txContextFactory.getActorContext();