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