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