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