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