- * Creating a transaction on the consumer side will create one instance of a transaction proxy. If during
- * the transaction reads and writes are done on data that belongs to different shards then a separate transaction will
- * be created on each of those shards by the TransactionProxy
- *
- *
- * The TransactionProxy does not make any guarantees about atomicity or order in which the transactions on the various
- * shards will be executed.
- *
+ * A transaction potentially spanning multiple backend shards.
*/
-public class TransactionProxy implements DOMStoreReadWriteTransaction {
-
- public static enum TransactionType {
- READ_ONLY,
- WRITE_ONLY,
- READ_WRITE;
-
- public static TransactionType fromInt(int type) {
- if(type == WRITE_ONLY.ordinal()) {
- return WRITE_ONLY;
- } else if(type == READ_WRITE.ordinal()) {
- return READ_WRITE;
- } else if(type == READ_ONLY.ordinal()) {
- return READ_ONLY;
- } else {
- throw new IllegalArgumentException("In TransactionType enum value" + type);
- }
- }
+public class TransactionProxy extends AbstractDOMStoreTransaction
+ implements DOMStoreReadWriteTransaction {
+ private enum TransactionState {
+ OPEN,
+ READY,
+ CLOSED,
}
- static final Mapper SAME_FAILURE_TRANSFORMER =
- new Mapper() {
- @Override
- public Throwable apply(Throwable failure) {
- return failure;
- }
- };
-
- private static final AtomicLong counter = new AtomicLong();
-
private static final Logger LOG = LoggerFactory.getLogger(TransactionProxy.class);
+ private static final DeleteOperation ROOT_DELETE_OPERATION = new DeleteOperation(YangInstanceIdentifier.empty());
- /**
- * Time interval in between transaction create retries.
- */
- private static final FiniteDuration CREATE_TX_TRY_INTERVAL =
- FiniteDuration.create(1, TimeUnit.SECONDS);
-
- /**
- * Used to enqueue the PhantomReferences for read-only TransactionProxy instances. The
- * FinalizableReferenceQueue is safe to use statically in an OSGi environment as it uses some
- * trickery to clean up its internal thread when the bundle is unloaded.
- */
- private static final FinalizableReferenceQueue phantomReferenceQueue =
- new FinalizableReferenceQueue();
-
- /**
- * This stores the TransactionProxyCleanupPhantomReference instances statically, This is
- * necessary because PhantomReferences need a hard reference so they're not garbage collected.
- * Once finalized, the TransactionProxyCleanupPhantomReference removes itself from this map
- * and thus becomes eligible for garbage collection.
- */
- private static final Map phantomReferenceCache =
- new ConcurrentHashMap<>();
-
- /**
- * A PhantomReference that closes remote transactions for a TransactionProxy when it's
- * garbage collected. This is used for read-only transactions as they're not explicitly closed
- * by clients. So the only way to detect that a transaction is no longer in use and it's safe
- * to clean up is when it's garbage collected. It's inexact as to when an instance will be GC'ed
- * but TransactionProxy instances should generally be short-lived enough to avoid being moved
- * to the old generation space and thus should be cleaned up in a timely manner as the GC
- * runs on the young generation (eden, swap1...) space much more frequently.
- */
- private static class TransactionProxyCleanupPhantomReference
- extends FinalizablePhantomReference {
-
- private final List remoteTransactionActors;
- private final AtomicBoolean remoteTransactionActorsMB;
- private final ActorContext actorContext;
- private final TransactionIdentifier identifier;
-
- protected TransactionProxyCleanupPhantomReference(TransactionProxy referent) {
- super(referent, phantomReferenceQueue);
-
- // Note we need to cache the relevant fields from the TransactionProxy as we can't
- // have a hard reference to the TransactionProxy instance itself.
-
- remoteTransactionActors = referent.remoteTransactionActors;
- remoteTransactionActorsMB = referent.remoteTransactionActorsMB;
- actorContext = referent.actorContext;
- identifier = referent.identifier;
- }
-
- @Override
- public void finalizeReferent() {
- LOG.trace("Cleaning up {} Tx actors for TransactionProxy {}",
- remoteTransactionActors.size(), identifier);
-
- phantomReferenceCache.remove(this);
-
- // Access the memory barrier volatile to ensure all previous updates to the
- // remoteTransactionActors list are visible to this thread.
-
- if(remoteTransactionActorsMB.get()) {
- for(ActorSelection actor : remoteTransactionActors) {
- LOG.trace("Sending CloseTransaction to {}", actor);
- actorContext.sendOperationAsync(actor, CloseTransaction.INSTANCE.toSerializable());
- }
- }
- }
- }
-
- /**
- * Stores the remote Tx actors for each requested data store path to be used by the
- * PhantomReference to close the remote Tx's. This is only used for read-only Tx's. The
- * remoteTransactionActorsMB volatile serves as a memory barrier to publish updates to the
- * remoteTransactionActors list so they will be visible to the thread accessing the
- * PhantomReference.
- */
- private List remoteTransactionActors;
- private volatile AtomicBoolean remoteTransactionActorsMB;
-
- /**
- * Stores the create transaction results per shard.
- */
- private final Map txFutureCallbackMap = new HashMap<>();
-
- private final TransactionType transactionType;
- private final ActorContext actorContext;
- private final TransactionIdentifier identifier;
- private final String transactionChainId;
- private final SchemaContext schemaContext;
- private boolean inReadyState;
-
- private volatile boolean initialized;
- private Semaphore operationLimiter;
- private OperationCompleter operationCompleter;
-
- public TransactionProxy(ActorContext actorContext, TransactionType transactionType) {
- this(actorContext, transactionType, "");
- }
-
- public TransactionProxy(ActorContext actorContext, TransactionType transactionType,
- String transactionChainId) {
- this.actorContext = Preconditions.checkNotNull(actorContext,
- "actorContext should not be null");
- this.transactionType = Preconditions.checkNotNull(transactionType,
- "transactionType should not be null");
- this.schemaContext = Preconditions.checkNotNull(actorContext.getSchemaContext(),
- "schemaContext should not be null");
- this.transactionChainId = transactionChainId;
-
- String memberName = actorContext.getCurrentMemberName();
- if(memberName == null){
- memberName = "UNKNOWN-MEMBER";
- }
-
- this.identifier = new TransactionIdentifier(memberName, counter.getAndIncrement());
-
- LOG.debug("Created txn {} of type {} on chain {}", identifier, transactionType, transactionChainId);
- }
+ private final Map txContextWrappers = new TreeMap<>();
+ private final AbstractTransactionContextFactory> txContextFactory;
+ private final TransactionType type;
+ private TransactionState state = TransactionState.OPEN;
@VisibleForTesting
- List> getRecordedOperationFutures() {
- List> recordedOperationFutures = Lists.newArrayList();
- for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) {
- TransactionContext transactionContext = txFutureCallback.getTransactionContext();
- if(transactionContext != null) {
- recordedOperationFutures.addAll(transactionContext.getRecordedOperationFutures());
- }
- }
+ public TransactionProxy(final AbstractTransactionContextFactory> txContextFactory, final TransactionType type) {
+ super(txContextFactory.nextIdentifier(), txContextFactory.getActorUtils().getDatastoreContext()
+ .isTransactionDebugContextEnabled());
+ this.txContextFactory = txContextFactory;
+ this.type = requireNonNull(type);
- return recordedOperationFutures;
- }
-
- @VisibleForTesting
- boolean hasTransactionContext() {
- for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) {
- TransactionContext transactionContext = txFutureCallback.getTransactionContext();
- if(transactionContext != null) {
- return true;
- }
- }
-
- return false;
+ LOG.debug("New {} Tx - {}", type, getIdentifier());
}
@Override
- public CheckedFuture>, ReadFailedException> read(final YangInstanceIdentifier path) {
-
- Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY,
- "Read operation on write-only transaction is not allowed");
-
- LOG.debug("Tx {} read {}", identifier, path);
+ public FluentFuture exists(final YangInstanceIdentifier path) {
+ return executeRead(shardNameFromIdentifier(path), new DataExists(path, DataStoreVersions.CURRENT_VERSION));
+ }
- throttleOperation();
+ private FluentFuture executeRead(final String shardName, final AbstractRead readCmd) {
+ checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
- final SettableFuture>> proxyFuture = SettableFuture.create();
+ LOG.trace("Tx {} {} {}", getIdentifier(), readCmd.getClass().getSimpleName(), readCmd.getPath());
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
+ final SettableFuture proxyFuture = SettableFuture.create();
+ AbstractTransactionContextWrapper contextWrapper = getContextWrapper(shardName);
+ contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() {
@Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.readData(path, proxyFuture);
+ public void invoke(final TransactionContext transactionContext, final Boolean havePermit) {
+ transactionContext.executeRead(readCmd, proxyFuture, havePermit);
}
});
- return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
+ return FluentFuture.from(proxyFuture);
}
@Override
- public CheckedFuture exists(final YangInstanceIdentifier path) {
-
- Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY,
- "Exists operation on write-only transaction is not allowed");
-
- LOG.debug("Tx {} exists {}", identifier, path);
-
- throttleOperation();
-
- final SettableFuture proxyFuture = SettableFuture.create();
+ public FluentFuture> read(final YangInstanceIdentifier path) {
+ checkState(type != TransactionType.WRITE_ONLY, "Reads from write-only transactions are not allowed");
+ requireNonNull(path, "path should not be null");
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.dataExists(path, proxyFuture);
- }
- });
-
- return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER);
- }
-
- private void checkModificationState() {
- Preconditions.checkState(transactionType != TransactionType.READ_ONLY,
- "Modification operation on read-only transaction is not allowed");
- Preconditions.checkState(!inReadyState,
- "Transaction is sealed - further modifications are not allowed");
+ LOG.trace("Tx {} read {}", getIdentifier(), path);
+ return path.isEmpty() ? readAllData() : singleShardRead(shardNameFromIdentifier(path), path);
}
- private void throttleOperation() {
- throttleOperation(1);
+ private FluentFuture> singleShardRead(final String shardName,
+ final YangInstanceIdentifier path) {
+ return executeRead(shardName, new ReadData(path, DataStoreVersions.CURRENT_VERSION));
}
- private void throttleOperation(int acquirePermits) {
- if(!initialized) {
- // Note : Currently mailbox-capacity comes from akka.conf and not from the config-subsystem
- operationLimiter = new Semaphore(actorContext.getTransactionOutstandingOperationLimit());
- operationCompleter = new OperationCompleter(operationLimiter);
-
- // Make sure we write this last because it's volatile and will also publish the non-volatile writes
- // above as well so they'll be visible to other threads.
- initialized = true;
- }
+ private FluentFuture> readAllData() {
+ final Set allShardNames = txContextFactory.getActorUtils().getConfiguration().getAllShardNames();
+ final Collection>> futures = new ArrayList<>(allShardNames.size());
- try {
- if(!operationLimiter.tryAcquire(acquirePermits,
- actorContext.getDatastoreContext().getOperationTimeoutInSeconds(), TimeUnit.SECONDS)){
- LOG.warn("Failed to acquire operation permit for transaction {}", getIdentifier());
- }
- } catch (InterruptedException e) {
- if(LOG.isDebugEnabled()) {
- LOG.debug("Interrupted when trying to acquire operation permit for transaction " + getIdentifier().toString(), e);
- } else {
- LOG.warn("Interrupted when trying to acquire operation permit for transaction {}", getIdentifier());
- }
+ for (String shardName : allShardNames) {
+ futures.add(singleShardRead(shardName, YangInstanceIdentifier.empty()));
}
- }
-
-
- @Override
- public void write(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
-
- checkModificationState();
- LOG.debug("Tx {} write {}", identifier, path);
+ final ListenableFuture>> listFuture = Futures.allAsList(futures);
+ final ListenableFuture> aggregateFuture;
- throttleOperation();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.writeData(path, data);
+ aggregateFuture = Futures.transform(listFuture, input -> {
+ try {
+ return NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.empty(), input,
+ txContextFactory.getActorUtils().getSchemaContext(),
+ txContextFactory.getActorUtils().getDatastoreContext().getLogicalStoreType());
+ } catch (DataValidationFailedException e) {
+ throw new IllegalArgumentException("Failed to aggregate", e);
}
- });
- }
+ }, MoreExecutors.directExecutor());
- @Override
- public void merge(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
-
- checkModificationState();
-
- LOG.debug("Tx {} merge {}", identifier, path);
-
- throttleOperation();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.mergeData(path, data);
- }
- });
+ return FluentFuture.from(aggregateFuture);
}
@Override
public void delete(final YangInstanceIdentifier path) {
+ checkModificationState("delete", path);
- checkModificationState();
-
- LOG.debug("Tx {} delete {}", identifier, path);
-
- throttleOperation();
-
- TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path);
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.deleteData(path);
- }
- });
- }
-
- @Override
- public DOMStoreThreePhaseCommitCohort ready() {
-
- checkModificationState();
-
- inReadyState = true;
-
- LOG.debug("Tx {} Readying {} transactions for commit", identifier,
- txFutureCallbackMap.size());
-
- if(txFutureCallbackMap.size() == 0) {
- onTransactionReady(Collections.>emptyList());
- TransactionRateLimitingCallback.adjustRateLimitForUnusedTransaction(actorContext);
- return NoOpDOMStoreThreePhaseCommitCohort.INSTANCE;
- }
-
- throttleOperation(txFutureCallbackMap.size());
-
- List> cohortFutures = Lists.newArrayList();
-
- for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) {
-
- LOG.debug("Tx {} Readying transaction for shard {} chain {}", identifier,
- txFutureCallback.getShardName(), transactionChainId);
-
- final TransactionContext transactionContext = txFutureCallback.getTransactionContext();
- final Future future;
- if (transactionContext != null) {
- // avoid the creation of a promise and a TransactionOperation
- future = transactionContext.readyTransaction();
- } else {
- final Promise promise = akka.dispatch.Futures.promise();
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- promise.completeWith(transactionContext.readyTransaction());
- }
- });
- future = promise.future();
- }
-
- cohortFutures.add(future);
+ if (path.isEmpty()) {
+ deleteAllData();
+ } else {
+ executeModification(new DeleteOperation(path));
}
-
- onTransactionReady(cohortFutures);
-
- return new ThreePhaseCommitCohortProxy(actorContext, cohortFutures,
- identifier.toString());
}
- /**
- * Method for derived classes to be notified when the transaction has been readied.
- *
- * @param cohortFutures the cohort Futures for each shard transaction.
- */
- protected void onTransactionReady(List> cohortFutures) {
+ private void deleteAllData() {
+ for (String shardName : getActorUtils().getConfiguration().getAllShardNames()) {
+ getContextWrapper(shardName).maybeExecuteTransactionOperation(ROOT_DELETE_OPERATION);
+ }
}
@Override
- public Object getIdentifier() {
- return this.identifier;
- }
+ public void merge(final YangInstanceIdentifier path, final NormalizedNode data) {
+ checkModificationState("merge", path);
- @Override
- public void close() {
- for (TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) {
- txFutureCallback.enqueueTransactionOperation(new TransactionOperation() {
- @Override
- public void invoke(TransactionContext transactionContext) {
- transactionContext.closeTransaction();
- }
- });
+ if (path.isEmpty()) {
+ mergeAllData(checkRootData(data));
+ } else {
+ executeModification(new MergeOperation(path, data));
}
+ }
- txFutureCallbackMap.clear();
+ private void mergeAllData(final ContainerNode rootData) {
+ // Populate requests for individual shards that are being touched
+ final Map> rootBuilders = new HashMap<>();
+ for (DataContainerChild child : rootData.body()) {
+ final String shardName = shardNameFromRootChild(child);
+ rootBuilders.computeIfAbsent(shardName,
+ unused -> Builders.containerBuilder().withNodeIdentifier(rootData.getIdentifier()))
+ .addChild(child);
+ }
- if(remoteTransactionActorsMB != null) {
- remoteTransactionActors.clear();
- remoteTransactionActorsMB.set(true);
+ // Now dispatch all merges
+ for (Entry> entry : rootBuilders.entrySet()) {
+ getContextWrapper(entry.getKey()).maybeExecuteTransactionOperation(new MergeOperation(
+ YangInstanceIdentifier.empty(), entry.getValue().build()));
}
}
- private String shardNameFromIdentifier(YangInstanceIdentifier path){
- return ShardStrategyFactory.getStrategy(path).findShard(path);
- }
+ @Override
+ public void write(final YangInstanceIdentifier path, final NormalizedNode data) {
+ checkModificationState("write", path);
- protected Future sendFindPrimaryShardAsync(String shardName) {
- return actorContext.findPrimaryShardAsync(shardName);
+ if (path.isEmpty()) {
+ writeAllData(checkRootData(data));
+ } else {
+ executeModification(new WriteOperation(path, data));
+ }
}
- private TransactionFutureCallback getOrCreateTxFutureCallback(YangInstanceIdentifier path) {
- String shardName = shardNameFromIdentifier(path);
- TransactionFutureCallback txFutureCallback = txFutureCallbackMap.get(shardName);
- if(txFutureCallback == null) {
- Future findPrimaryFuture = sendFindPrimaryShardAsync(shardName);
-
- final TransactionFutureCallback newTxFutureCallback = new TransactionFutureCallback(shardName);
-
- txFutureCallback = newTxFutureCallback;
- txFutureCallbackMap.put(shardName, txFutureCallback);
+ private void writeAllData(final ContainerNode rootData) {
+ // Open builders for all shards
+ final Map> rootBuilders = new HashMap<>();
+ for (String shardName : getActorUtils().getConfiguration().getAllShardNames()) {
+ rootBuilders.put(shardName, Builders.containerBuilder().withNodeIdentifier(rootData.getIdentifier()));
+ }
- findPrimaryFuture.onComplete(new OnComplete() {
- @Override
- public void onComplete(Throwable failure, ActorSelection primaryShard) {
- if(failure != null) {
- newTxFutureCallback.createTransactionContext(failure, null);
- } else {
- newTxFutureCallback.setPrimaryShard(primaryShard);
- }
- }
- }, actorContext.getClientDispatcher());
+ // Now distribute children as needed
+ for (DataContainerChild child : rootData.body()) {
+ final String shardName = shardNameFromRootChild(child);
+ verifyNotNull(rootBuilders.get(shardName), "Failed to find builder for %s", shardName).addChild(child);
}
- return txFutureCallback;
+ // Now dispatch all writes
+ for (Entry> entry : rootBuilders.entrySet()) {
+ getContextWrapper(entry.getKey()).maybeExecuteTransactionOperation(new WriteOperation(
+ YangInstanceIdentifier.empty(), entry.getValue().build()));
+ }
}
- public String getTransactionChainId() {
- return transactionChainId;
+ private void executeModification(final TransactionModificationOperation operation) {
+ getContextWrapper(operation.path()).maybeExecuteTransactionOperation(operation);
}
- protected ActorContext getActorContext() {
- return actorContext;
+ private static ContainerNode checkRootData(final NormalizedNode data) {
+ // Root has to be a container
+ checkArgument(data instanceof ContainerNode, "Invalid root data %s", data);
+ return (ContainerNode) data;
}
- /**
- * Interfaces for transaction operations to be invoked later.
- */
- private static interface TransactionOperation {
- void invoke(TransactionContext transactionContext);
+ private void checkModificationState(final String opName, final YangInstanceIdentifier path) {
+ checkState(type != TransactionType.READ_ONLY, "Modification operation on read-only transaction is not allowed");
+ checkState(state == TransactionState.OPEN, "Transaction is sealed - further modifications are not allowed");
+ LOG.trace("Tx {} {} {}", getIdentifier(), opName, path);
}
- /**
- * Implements a Future OnComplete callback for a CreateTransaction message. This class handles
- * retries, up to a limit, if the shard doesn't have a leader yet. This is done by scheduling a
- * retry task after a short delay.
- *