dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/ShardedDOMDataTreeWriteTransaction.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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 package org.opendaylight.mdsal.dom.broker;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.ImmutableMap;
  12 import com.google.common.collect.Maps;
  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 com.google.common.util.concurrent.SettableFuture;
  18 import java.util.Collection;
  19 import java.util.Deque;
  20 import java.util.LinkedList;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Map.Entry;
  24 import java.util.Set;
  25 import java.util.concurrent.atomic.AtomicLong;
  26 import java.util.function.BiConsumer;
  27 import java.util.function.Consumer;
  28 import java.util.stream.Collectors;
  29 import javax.annotation.Nonnull;
  30 import javax.annotation.concurrent.GuardedBy;
  31 import javax.annotation.concurrent.NotThreadSafe;
  32 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  33 import org.opendaylight.mdsal.dom.api.DOMDataTreeCursorAwareTransaction;
  34 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  35 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor;
  36 import org.opendaylight.mdsal.dom.store.inmemory.DOMDataTreeShardProducer;
  37 import org.opendaylight.mdsal.dom.store.inmemory.DOMDataTreeShardWriteTransaction;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 @NotThreadSafe
  45 final class ShardedDOMDataTreeWriteTransaction implements DOMDataTreeCursorAwareTransaction {
  46     private static final Logger LOG = LoggerFactory.getLogger(ShardedDOMDataTreeWriteTransaction.class);
  47     private static final TransactionCommitFailedExceptionMapper SUBMIT_FAILED_MAPPER =
  48             TransactionCommitFailedExceptionMapper.create("submit");
  49     private static final AtomicLong COUNTER = new AtomicLong();
  50
  51     private final Map<DOMDataTreeIdentifier, DOMDataTreeShardWriteTransaction> idToTransaction;
  52     private final Collection<YangInstanceIdentifier> childBoundaries;
  53     private final ShardedDOMDataTreeProducer producer;
  54     private final String identifier;
  55
  56     private final SettableFuture<Void> future = SettableFuture.create();
  57     private final CheckedFuture<Void, TransactionCommitFailedException> submitFuture =
  58             Futures.makeChecked(future, SUBMIT_FAILED_MAPPER);
  59
  60     @GuardedBy("this")
  61     private boolean closed =  false;
  62
  63     @GuardedBy("this")
  64     private DOMDataTreeWriteCursor openCursor;
  65
  66     ShardedDOMDataTreeWriteTransaction(final ShardedDOMDataTreeProducer producer,
  67                                        final Map<DOMDataTreeIdentifier, DOMDataTreeShardProducer> idToProducer,
  68                                        final Set<YangInstanceIdentifier> childRoots) {
  69         this.producer = Preconditions.checkNotNull(producer);
  70         this.identifier = "SHARDED-DOM-" + COUNTER.getAndIncrement();
  71         idToTransaction = ImmutableMap.copyOf(Maps.transformValues(idToProducer,
  72             DOMDataTreeShardProducer::createTransaction));
  73         childBoundaries = Preconditions.checkNotNull(childRoots);
  74         LOG.debug("Created new transaction {}", identifier);
  75     }
  76
  77     private DOMDataTreeShardWriteTransaction lookup(final DOMDataTreeIdentifier prefix) {
  78         for (final Entry<DOMDataTreeIdentifier, DOMDataTreeShardWriteTransaction> e : idToTransaction.entrySet()) {
  79             if (e.getKey().contains(prefix)) {
  80                 Preconditions.checkArgument(!producer.isDelegatedToChild(prefix),
  81                     "Path %s is delegated to child producer.", prefix);
  82                 return e.getValue();
  83             }
  84         }
  85
  86         return null;
  87     }
  88
  89     @Override
  90     public String getIdentifier() {
  91         return identifier;
  92     }
  93
  94     @Override
  95     public synchronized boolean cancel() {
  96         if (closed) {
  97             return false;
  98         }
  99
 100         LOG.debug("Cancelling transaction {}", identifier);
 101         if (openCursor != null) {
 102             openCursor.close();
 103         }
 104         for (final DOMDataTreeShardWriteTransaction tx : idToTransaction.values()) {
 105             tx.close();
 106         }
 107
 108         closed = true;
 109         producer.cancelTransaction(this);
 110         return true;
 111     }
 112
 113     @Override
 114     public synchronized DOMDataTreeWriteCursor createCursor(final DOMDataTreeIdentifier prefix) {
 115         Preconditions.checkState(!closed, "Transaction is closed already");
 116         Preconditions.checkState(openCursor == null, "There is still a cursor open");
 117
 118         final DOMDataTreeShardWriteTransaction lookup = lookup(prefix);
 119         Preconditions.checkArgument(lookup != null, "Path %s is not accessible from transaction %s", prefix, this);
 120
 121         openCursor = new DelegatingCursor(lookup.createCursor(prefix), prefix);
 122         return openCursor;
 123     }
 124
 125     @Override
 126     public synchronized CheckedFuture<Void, TransactionCommitFailedException> submit() {
 127         Preconditions.checkState(!closed, "Transaction %s is already closed", identifier);
 128         Preconditions.checkState(openCursor == null, "Cannot submit transaction while there is a cursor open");
 129
 130         producer.transactionSubmitted(this);
 131         return submitFuture;
 132     }
 133
 134     void doSubmit(final Consumer<ShardedDOMDataTreeWriteTransaction> success,
 135             final BiConsumer<ShardedDOMDataTreeWriteTransaction, Throwable> failure) {
 136
 137         final ListenableFuture<List<Void>> listListenableFuture = Futures.allAsList(
 138             idToTransaction.values().stream().map(tx -> {
 139                 LOG.debug("Readying tx {}", identifier);
 140                 tx.ready();
 141                 return tx.submit();
 142             }).collect(Collectors.toList()));
 143
 144         Futures.addCallback(listListenableFuture, new FutureCallback<List<Void>>() {
 145             @Override
 146             public void onSuccess(final List<Void> result) {
 147                 success.accept(ShardedDOMDataTreeWriteTransaction.this);
 148             }
 149
 150             @Override
 151             public void onFailure(final Throwable exp) {
 152                 failure.accept(ShardedDOMDataTreeWriteTransaction.this, exp);
 153             }
 154         });
 155     }
 156
 157     void onTransactionSuccess(final Void result) {
 158         future.set(result);
 159     }
 160
 161     void onTransactionFailure(final Throwable throwable) {
 162         future.setException(throwable);
 163     }
 164
 165     synchronized void cursorClosed() {
 166         openCursor = null;
 167     }
 168
 169     private class DelegatingCursor implements DOMDataTreeWriteCursor {
 170
 171         private final DOMDataTreeWriteCursor delegate;
 172         private final DOMDataTreeIdentifier rootPosition;
 173         private final Deque<PathArgument> path = new LinkedList<>();
 174
 175         DelegatingCursor(final DOMDataTreeWriteCursor delegate, final DOMDataTreeIdentifier rootPosition) {
 176             this.delegate = Preconditions.checkNotNull(delegate);
 177             this.rootPosition = Preconditions.checkNotNull(rootPosition);
 178             path.addAll(rootPosition.getRootIdentifier().getPathArguments());
 179         }
 180
 181         @Override
 182         public void enter(@Nonnull final PathArgument child) {
 183             checkAvailable(child);
 184             path.push(child);
 185             delegate.enter(child);
 186         }
 187
 188         @Override
 189         public void enter(@Nonnull final PathArgument... path) {
 190             for (final PathArgument pathArgument : path) {
 191                 enter(pathArgument);
 192             }
 193         }
 194
 195         @Override
 196         public void enter(@Nonnull final Iterable<PathArgument> path) {
 197             for (final PathArgument pathArgument : path) {
 198                 enter(pathArgument);
 199             }
 200         }
 201
 202         @Override
 203         public void exit() {
 204             path.pop();
 205             delegate.exit();
 206         }
 207
 208         @Override
 209         public void exit(final int depth) {
 210             for (int i = 0; i < depth; i++) {
 211                 path.pop();
 212             }
 213             delegate.exit(depth);
 214         }
 215
 216         @Override
 217         public void close() {
 218             int depthEntered = path.size() - rootPosition.getRootIdentifier().getPathArguments().size();
 219             if (depthEntered > 0) {
 220                 // clean up existing modification cursor in case this tx will be reused for batching
 221                 delegate.exit(depthEntered);
 222             }
 223
 224             delegate.close();
 225             cursorClosed();
 226         }
 227
 228         @Override
 229         public void delete(final PathArgument child) {
 230             checkAvailable(child);
 231             delegate.delete(child);
 232         }
 233
 234         @Override
 235         public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
 236             checkAvailable(child);
 237             delegate.merge(child, data);
 238         }
 239
 240         @Override
 241         public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
 242             checkAvailable(child);
 243             delegate.write(child, data);
 244         }
 245
 246         void checkAvailable(final PathArgument child) {
 247             path.add(child);
 248             final YangInstanceIdentifier yid = YangInstanceIdentifier.create(path);
 249             childBoundaries.forEach(id -> {
 250                 if (id.contains(yid)) {
 251                     path.removeLast();
 252                     throw new IllegalArgumentException("Path {" + yid + "} is not available to this cursor"
 253                             + " since it's already claimed by a child producer");
 254                 }
 255             });
 256             path.removeLast();
 257         }
 258     }
 259 }