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