dom/mdsal-dom-inmemory-datastore/src/main/java/org/opendaylight/mdsal/dom/store/inmemory/InMemoryDOMDataTreeShard.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.mdsal.dom.store.inmemory;
  10
  11 import com.google.common.annotations.Beta;
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.util.concurrent.ListeningExecutorService;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.HashMap;
  19 import java.util.Iterator;
  20 import java.util.Map;
  21 import java.util.Map.Entry;
  22 import java.util.concurrent.ExecutorService;
  23 import javax.annotation.Nonnull;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  26 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  27 import org.opendaylight.mdsal.dom.api.DOMDataTreeShard;
  28 import org.opendaylight.mdsal.dom.spi.DOMDataTreePrefixTable;
  29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  30 import org.opendaylight.yangtools.util.concurrent.CountingRejectedExecutionHandler;
  31 import org.opendaylight.yangtools.util.concurrent.FastThreadPoolExecutor;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  33 import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeSnapshot;
  34 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  35 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
  37 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  38 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  39
  40 @Beta
  41 public class InMemoryDOMDataTreeShard implements ReadableWriteableDOMDataTreeShard, SchemaContextListener {
  42
  43     private static final int DEFAULT_SUBMIT_QUEUE_SIZE = 1000;
  44
  45     private static final class SubshardProducerSpecification {
  46         private final Collection<DOMDataTreeIdentifier> prefixes = new ArrayList<>(1);
  47         private final ChildShardContext shard;
  48
  49         SubshardProducerSpecification(final ChildShardContext subshard) {
  50             this.shard = Preconditions.checkNotNull(subshard);
  51         }
  52
  53         void addPrefix(final DOMDataTreeIdentifier prefix) {
  54             prefixes.add(prefix);
  55         }
  56
  57         DOMDataTreeShardProducer createProducer() {
  58             return shard.getShard().createProducer(prefixes);
  59         }
  60
  61         public DOMDataTreeIdentifier getPrefix() {
  62             return shard.getPrefix();
  63         }
  64     }
  65
  66     private final DOMDataTreePrefixTable<ChildShardContext> childShardsTable = DOMDataTreePrefixTable.create();
  67     private final Map<DOMDataTreeIdentifier, ChildShardContext> childShards = new HashMap<>();
  68     private final DOMDataTreeIdentifier prefix;
  69     private final DataTree dataTree;
  70     private final InMemoryDOMDataTreeShardChangePublisher shardChangePublisher;
  71     private final ListeningExecutorService executor;
  72
  73     private InMemoryDOMDataTreeShard(final DOMDataTreeIdentifier prefix, final ExecutorService dataTreeChangeExecutor,
  74                                      final int maxDataChangeListenerQueueSize, final int submitQueueSize) {
  75         this.prefix = Preconditions.checkNotNull(prefix);
  76
  77         final TreeType treeType = treeTypeFor(prefix.getDatastoreType());
  78         this.dataTree = InMemoryDataTreeFactory.getInstance().create(treeType, prefix.getRootIdentifier());
  79
  80         this.shardChangePublisher = new InMemoryDOMDataTreeShardChangePublisher(dataTreeChangeExecutor,
  81                 maxDataChangeListenerQueueSize, dataTree, prefix.getRootIdentifier(), childShards);
  82
  83         final FastThreadPoolExecutor fte = new FastThreadPoolExecutor(1, submitQueueSize, "Shard[" + prefix + "]");
  84         fte.setRejectedExecutionHandler(CountingRejectedExecutionHandler.newCallerWaitsPolicy());
  85         this.executor = MoreExecutors.listeningDecorator(fte);
  86     }
  87
  88     public static InMemoryDOMDataTreeShard create(final DOMDataTreeIdentifier id,
  89                                                   final ExecutorService dataTreeChangeExecutor,
  90                                                   final int maxDataChangeListenerQueueSize) {
  91         return new InMemoryDOMDataTreeShard(id, dataTreeChangeExecutor,
  92                 maxDataChangeListenerQueueSize, DEFAULT_SUBMIT_QUEUE_SIZE);
  93     }
  94
  95     public static InMemoryDOMDataTreeShard create(final DOMDataTreeIdentifier id,
  96                                                   final ExecutorService dataTreeChangeExecutor,
  97                                                   final int maxDataChangeListenerQueueSize,
  98                                                   final int submitQueueSize) {
  99         return new InMemoryDOMDataTreeShard(id, dataTreeChangeExecutor,
 100                 maxDataChangeListenerQueueSize, submitQueueSize);
 101     }
 102
 103     @Override
 104     public void onGlobalContextUpdated(final SchemaContext context) {
 105         dataTree.setSchemaContext(context);
 106     }
 107
 108     @Override
 109     public void onChildAttached(final DOMDataTreeIdentifier prefix, final DOMDataTreeShard child) {
 110         Preconditions.checkArgument(child != this, "Attempted to attach child %s onto self", this);
 111         reparentChildShards(prefix, child);
 112         addChildShard(prefix, child);
 113     }
 114
 115     @Override
 116     public void onChildDetached(final DOMDataTreeIdentifier prefix, final DOMDataTreeShard child) {
 117         childShards.remove(prefix);
 118         childShardsTable.remove(prefix);
 119     }
 120
 121     @Override
 122     public InMemoryDOMDataTreeShardProducer createProducer(final Collection<DOMDataTreeIdentifier> prefixes) {
 123         for (final DOMDataTreeIdentifier prodPrefix : prefixes) {
 124             Preconditions.checkArgument(prefix.contains(prodPrefix), "Prefix %s is not contained under shart root",
 125                 prodPrefix, prefix);
 126         }
 127         return new InMemoryDOMDataTreeShardProducer(this, prefixes);
 128     }
 129
 130     @Nonnull
 131     @Override
 132     public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerTreeChangeListener(
 133             @Nonnull final YangInstanceIdentifier treeId, @Nonnull final L listener) {
 134         return shardChangePublisher.registerTreeChangeListener(treeId, listener);
 135     }
 136
 137     private void addChildShard(final DOMDataTreeIdentifier prefix, final DOMDataTreeShard child) {
 138         final ChildShardContext context = createContextFor(prefix, child);
 139         childShards.put(prefix, context);
 140         childShardsTable.store(prefix, context);
 141     }
 142
 143     private void reparentChildShards(final DOMDataTreeIdentifier newChildPrefix, final DOMDataTreeShard newChild) {
 144         final Iterator<Entry<DOMDataTreeIdentifier, ChildShardContext>> actualChildren =
 145                 childShards.entrySet().iterator();
 146         final Map<DOMDataTreeIdentifier, ChildShardContext> reparented = new HashMap<>();
 147         while (actualChildren.hasNext()) {
 148             final Entry<DOMDataTreeIdentifier, ChildShardContext> actualChild = actualChildren.next();
 149             final DOMDataTreeIdentifier actualPrefix = actualChild.getKey();
 150             Preconditions.checkArgument(!newChildPrefix.equals(actualPrefix),
 151                     "Child shard with prefix %s already attached", newChildPrefix);
 152             if (newChildPrefix.contains(actualPrefix)) {
 153                 final ChildShardContext actualContext = actualChild.getValue();
 154                 actualChildren.remove();
 155                 newChild.onChildAttached(actualPrefix, actualContext.getShard());
 156                 reparented.put(actualChild.getKey(), actualContext);
 157                 childShardsTable.remove(actualPrefix);
 158             }
 159         }
 160         updateProducersAndListeners(reparented);
 161     }
 162
 163     private void updateProducersAndListeners(final Map<DOMDataTreeIdentifier, ChildShardContext> reparented) {
 164         // FIXME: remove reparenting of producers, shards have to be registered from top to bottom
 165         if (reparented.isEmpty()) {
 166             //nothing was reparented no need to update anything
 167             return;
 168         }
 169         throw new UnsupportedOperationException();
 170     }
 171
 172     private static ChildShardContext createContextFor(final DOMDataTreeIdentifier prefix,
 173             final DOMDataTreeShard child) {
 174         Preconditions.checkArgument(child instanceof WriteableDOMDataTreeShard,
 175             "Child %s is not a writable shared", child);
 176         return new ChildShardContext(prefix, (WriteableDOMDataTreeShard) child);
 177     }
 178
 179     private static TreeType treeTypeFor(final LogicalDatastoreType dsType) {
 180         switch (dsType) {
 181             case CONFIGURATION:
 182                 return TreeType.CONFIGURATION;
 183             case OPERATIONAL:
 184                 return TreeType.OPERATIONAL;
 185             default:
 186                 throw new IllegalArgumentException("Unsupported Data Store type:" + dsType);
 187         }
 188     }
 189
 190     @VisibleForTesting
 191     Map<DOMDataTreeIdentifier, DOMDataTreeShard> getChildShards() {
 192         final Map<DOMDataTreeIdentifier, DOMDataTreeShard> ret = new HashMap<>();
 193         for (final Entry<DOMDataTreeIdentifier, ChildShardContext> entry : childShards.entrySet()) {
 194             ret.put(entry.getKey(), entry.getValue().getShard());
 195         }
 196         return ret;
 197     }
 198
 199     InmemoryDOMDataTreeShardWriteTransaction createTransaction(
 200             final InmemoryDOMDataTreeShardWriteTransaction previousTx) {
 201         // FIXME: implement this
 202         throw new UnsupportedOperationException();
 203     }
 204
 205     InmemoryDOMDataTreeShardWriteTransaction createTransaction(final Collection<DOMDataTreeIdentifier> prefixes) {
 206
 207         final Map<DOMDataTreeIdentifier, SubshardProducerSpecification> affectedSubshards = new HashMap<>();
 208         for (final DOMDataTreeIdentifier producerPrefix : prefixes) {
 209             for (final ChildShardContext maybeAffected : childShards.values()) {
 210                 final DOMDataTreeIdentifier bindPath;
 211                 if (producerPrefix.contains(maybeAffected.getPrefix())) {
 212                     bindPath = maybeAffected.getPrefix();
 213                 } else if (maybeAffected.getPrefix().contains(producerPrefix)) {
 214                     // Bound path is inside subshard
 215                     bindPath = producerPrefix;
 216                 } else {
 217                     continue;
 218                 }
 219
 220                 SubshardProducerSpecification spec = affectedSubshards.get(maybeAffected.getPrefix());
 221                 if (spec == null) {
 222                     spec = new SubshardProducerSpecification(maybeAffected);
 223                     affectedSubshards.put(maybeAffected.getPrefix(), spec);
 224                 }
 225                 spec.addPrefix(bindPath);
 226             }
 227         }
 228
 229         final ShardRootModificationContext rootContext = new ShardRootModificationContext(prefix,
 230                 (CursorAwareDataTreeSnapshot) dataTree.takeSnapshot());
 231         final ShardDataModificationBuilder builder = new ShardDataModificationBuilder(rootContext);
 232         for (final SubshardProducerSpecification spec : affectedSubshards.values()) {
 233             final ForeignShardModificationContext foreignContext =
 234                     new ForeignShardModificationContext(spec.getPrefix(), spec.createProducer());
 235             builder.addSubshard(foreignContext);
 236             builder.addSubshard(spec.getPrefix(), foreignContext);
 237         }
 238
 239         return new InmemoryDOMDataTreeShardWriteTransaction(builder.build(), dataTree, shardChangePublisher, executor);
 240     }
 241 }