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