opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/legacy/sharded/adapter/ShardedDOMDataBrokerDelegatingReadWriteTransaction.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.controller.md.sal.dom.broker.impl.legacy.sharded.adapter;
  10
  11 import static com.google.common.base.Preconditions.checkNotNull;
  12 import static com.google.common.base.Preconditions.checkState;
  13
  14 import com.google.common.base.Function;
  15 import com.google.common.base.Optional;
  16 import com.google.common.collect.ImmutableMap;
  17 import com.google.common.collect.Lists;
  18 import com.google.common.collect.Maps;
  19 import com.google.common.util.concurrent.CheckedFuture;
  20 import com.google.common.util.concurrent.FluentFuture;
  21 import com.google.common.util.concurrent.FutureCallback;
  22 import com.google.common.util.concurrent.Futures;
  23 import com.google.common.util.concurrent.ListenableFuture;
  24 import com.google.common.util.concurrent.MoreExecutors;
  25 import com.google.common.util.concurrent.SettableFuture;
  26 import java.util.Map;
  27 import java.util.Queue;
  28 import javax.annotation.Nonnull;
  29 import javax.annotation.concurrent.NotThreadSafe;
  30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  31 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  32 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  33 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  34 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  35 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  36 import org.opendaylight.mdsal.common.api.CommitInfo;
  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.DataTree;
  40 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
  41 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  42 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  45
  46 /**
  47  * Read/write transaction that delegates write and initial read to
  48  * {@link org.opendaylight.mdsal.dom.broker.ShardedDOMWriteTransactionAdapter}
  49  * and {@link org.opendaylight.mdsal.dom.broker.ShardedDOMReadTransactionAdapter}
  50  * respectively. These two in turn rely on shard aware implementation of
  51  * {@link org.opendaylight.mdsal.dom.api.DOMDataTreeService}.
  52  *
  53  * <p>
  54  * Since reading data distributed on different subshards is not guaranteed to
  55  * return all relevant data, best effort is to try to operate only on single
  56  * subtree in conceptual data tree. We define this subtree by first write
  57  * operation performed on transaction. All next read and write operations
  58  * should be performed just in this initial subtree.
  59  */
  60 // FIXME explicitly enforce just one subtree requirement
  61 @NotThreadSafe
  62 class ShardedDOMDataBrokerDelegatingReadWriteTransaction implements DOMDataReadWriteTransaction {
  63     private final DOMDataReadOnlyTransaction readTxDelegate;
  64     private final DOMDataWriteTransaction writeTxDelegate;
  65     private final Object txIdentifier;
  66     private final ImmutableMap<LogicalDatastoreType, Queue<Modification>> modificationHistoryMap;
  67     private final ImmutableMap<LogicalDatastoreType, DataTreeSnapshot> snapshotMap;
  68     private final Map<LogicalDatastoreType, ListenableFuture<Optional<NormalizedNode<?, ?>>>> initialReadMap;
  69     private YangInstanceIdentifier root = null;
  70
  71     ShardedDOMDataBrokerDelegatingReadWriteTransaction(final Object readWriteTxId, final SchemaContext ctx,
  72                                                               final DOMDataReadOnlyTransaction readTxDelegate,
  73                                                               final DOMDataWriteTransaction writeTxDelegate) {
  74         this.readTxDelegate = checkNotNull(readTxDelegate);
  75         this.writeTxDelegate = checkNotNull(writeTxDelegate);
  76         this.txIdentifier = checkNotNull(readWriteTxId);
  77         this.initialReadMap = Maps.newEnumMap(LogicalDatastoreType.class);
  78
  79         final InMemoryDataTreeFactory treeFactory = new InMemoryDataTreeFactory();
  80         final ImmutableMap.Builder<LogicalDatastoreType, DataTreeSnapshot> snapshotMapBuilder = ImmutableMap.builder();
  81         final ImmutableMap.Builder<LogicalDatastoreType, Queue<Modification>> modificationHistoryMapBuilder
  82                 = ImmutableMap.builder();
  83         for (final LogicalDatastoreType store : LogicalDatastoreType.values()) {
  84             final DataTree tree = treeFactory.create(treeConfigForStore(store));
  85             tree.setSchemaContext(ctx);
  86             snapshotMapBuilder.put(store, tree.takeSnapshot());
  87
  88             modificationHistoryMapBuilder.put(store, Lists.newLinkedList());
  89         }
  90
  91         modificationHistoryMap = modificationHistoryMapBuilder.build();
  92         snapshotMap = snapshotMapBuilder.build();
  93     }
  94
  95     @Override
  96     public boolean cancel() {
  97         readTxDelegate.close();
  98         return writeTxDelegate.cancel();
  99     }
 100
 101     @Override
 102     public void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
 103         if (root == null) {
 104             initialRead(path);
 105         }
 106
 107         modificationHistoryMap.get(store).add(new Modification(Modification.Operation.DELETE, path, null));
 108         writeTxDelegate.delete(store, path);
 109     }
 110
 111     @Override
 112     public CheckedFuture<Void, TransactionCommitFailedException> submit() {
 113         return writeTxDelegate.submit();
 114     }
 115
 116     @Override
 117     public FluentFuture<? extends CommitInfo> commit() {
 118         return writeTxDelegate.commit();
 119     }
 120
 121     @Override
 122     public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(final LogicalDatastoreType store,
 123                                                                                    final YangInstanceIdentifier path) {
 124         checkState(root != null,
 125                    "A modify operation (put, merge or delete) must be performed prior to a read operation");
 126         final SettableFuture<Optional<NormalizedNode<?, ?>>> readResult = SettableFuture.create();
 127         final Queue<Modification> currentHistory = Lists.newLinkedList(modificationHistoryMap.get(store));
 128         Futures.addCallback(initialReadMap.get(store), new FutureCallback<Optional<NormalizedNode<?, ?>>>() {
 129             @Override
 130             public void onSuccess(@Nonnull final Optional<NormalizedNode<?, ?>> result) {
 131                 final DataTreeModification mod = snapshotMap.get(store).newModification();
 132                 if (result.isPresent()) {
 133                     mod.write(path, result.get());
 134                 }
 135                 applyModificationHistoryToSnapshot(mod, currentHistory);
 136                 readResult.set(Optional.fromJavaUtil(mod.readNode(path)));
 137             }
 138
 139             @Override
 140             public void onFailure(final Throwable throwable) {
 141                 readResult.setException(throwable);
 142             }
 143         }, MoreExecutors.directExecutor());
 144
 145         return Futures.makeChecked(readResult, ReadFailedException.MAPPER);
 146     }
 147
 148     @Override
 149     public CheckedFuture<Boolean, ReadFailedException> exists(final LogicalDatastoreType store,
 150                                                               final YangInstanceIdentifier path) {
 151         checkState(root != null,
 152                    "A modify operation (put, merge or delete) must be performed prior to an exists operation");
 153         return Futures.makeChecked(Futures.transform(read(store, path),
 154                                                      (Function<Optional<NormalizedNode<?, ?>>, Boolean>)
 155                                                              Optional::isPresent),
 156                                    ReadFailedException.MAPPER);
 157     }
 158
 159     @Override
 160     public void put(final LogicalDatastoreType store, final YangInstanceIdentifier path,
 161                     final NormalizedNode<?, ?> data) {
 162         if (root == null) {
 163             initialRead(path);
 164         }
 165
 166         modificationHistoryMap.get(store).add(new Modification(Modification.Operation.WRITE, path, data));
 167         writeTxDelegate.put(store, path, data);
 168     }
 169
 170     @Override
 171     public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path,
 172                       final NormalizedNode<?, ?> data) {
 173         if (root == null) {
 174             initialRead(path);
 175         }
 176
 177         modificationHistoryMap.get(store).add(new Modification(Modification.Operation.MERGE, path, data));
 178         writeTxDelegate.merge(store, path, data);
 179     }
 180
 181     @Override
 182     public Object getIdentifier() {
 183         return txIdentifier;
 184     }
 185
 186     private void initialRead(final YangInstanceIdentifier path) {
 187         root = path;
 188
 189         for (final LogicalDatastoreType store : LogicalDatastoreType.values()) {
 190             initialReadMap.put(store, readTxDelegate.read(store, path));
 191         }
 192     }
 193
 194     private static DataTreeConfiguration treeConfigForStore(final LogicalDatastoreType store) {
 195         return store == LogicalDatastoreType.CONFIGURATION ? DataTreeConfiguration.DEFAULT_CONFIGURATION
 196                 : DataTreeConfiguration.DEFAULT_OPERATIONAL;
 197     }
 198
 199     private static void applyModificationHistoryToSnapshot(final DataTreeModification dataTreeModification,
 200                                                     final Queue<Modification> modificationHistory) {
 201         while (!modificationHistory.isEmpty()) {
 202             final Modification modification = modificationHistory.poll();
 203             switch (modification.getOperation()) {
 204                 case WRITE:
 205                     dataTreeModification.write(modification.getPath(), modification.getData());
 206                     break;
 207                 case MERGE:
 208                     dataTreeModification.merge(modification.getPath(), modification.getData());
 209                     break;
 210                 case DELETE:
 211                     dataTreeModification.delete(modification.getPath());
 212                     break;
 213                 default:
 214                     // NOOP
 215             }
 216         }
 217     }
 218
 219     static class Modification {
 220
 221         enum Operation {
 222             WRITE, MERGE, DELETE
 223         }
 224
 225         private final NormalizedNode<?, ?> data;
 226         private final YangInstanceIdentifier path;
 227         private final Operation operation;
 228
 229         Modification(final Operation operation, final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
 230             this.data = data;
 231             this.path = checkNotNull(path);
 232             this.operation = checkNotNull(operation);
 233         }
 234
 235         Operation getOperation() {
 236             return operation;
 237         }
 238
 239         YangInstanceIdentifier getPath() {
 240             return path;
 241         }
 242
 243         NormalizedNode<?, ?> getData() {
 244             return data;
 245         }
 246     }
 247 }