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