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