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