2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.mdsal.dom.store.inmemory;
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;
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;
40 public class InMemoryDOMDataTreeShard implements ReadableWriteableDOMDataTreeShard, SchemaContextListener {
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);
49 void addPrefix(final DOMDataTreeIdentifier prefix) {
53 DOMDataTreeShardProducer createProducer() {
54 return shard.getShard().createProducer(prefixes);
57 public DOMDataTreeIdentifier getPrefix() {
58 return shard.getPrefix();
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;
69 private SchemaContext schemaContext;
71 private InMemoryDOMDataTreeShard(final DOMDataTreeIdentifier prefix, final ExecutorService dataTreeChangeExecutor,
72 final int maxDataChangeListenerQueueSize, final int maxCommitQueueSize) {
73 this.prefix = Preconditions.checkNotNull(prefix);
75 final TreeType treeType = treeTypeFor(prefix.getDatastoreType());
76 this.dataTree = InMemoryDataTreeFactory.getInstance().create(treeType, prefix.getRootIdentifier());
78 this.shardChangePublisher = new InMemoryDOMDataTreeShardChangePublisher(dataTreeChangeExecutor, maxDataChangeListenerQueueSize, dataTree, prefix.getRootIdentifier(), childShards);
79 this.executor = MoreExecutors.listeningDecorator(SpecialExecutors.newBoundedSingleThreadExecutor(maxCommitQueueSize, "Shard-executor[" + prefix + "]"));
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);
88 public void onGlobalContextUpdated(final SchemaContext context) {
89 dataTree.setSchemaContext(context);
90 schemaContext = context;
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);
101 public void onChildDetached(final DOMDataTreeIdentifier prefix, final DOMDataTreeShard child) {
102 childShards.remove(prefix);
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",
111 return new InMemoryDOMDataTreeShardProducer(this, prefixes);
116 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerTreeChangeListener(@Nonnull final YangInstanceIdentifier treeId, @Nonnull final L listener) {
117 return shardChangePublisher.registerTreeChangeListener(treeId, listener);
120 private void addChildShard(final DOMDataTreeIdentifier prefix, final DOMDataTreeShard child) {
121 final ChildShardContext context = createContextFor(prefix, child);
122 childShards.put(prefix, context);
123 childShardsTable.store(prefix, context);
126 private void reparentChildShards(final DOMDataTreeIdentifier newChildPrefix, final DOMDataTreeShard newChild) {
127 final Iterator<Entry<DOMDataTreeIdentifier, ChildShardContext>> actualChildren = childShards.entrySet().iterator();
128 final Map<DOMDataTreeIdentifier, ChildShardContext> reparented = new HashMap<>();
129 while (actualChildren.hasNext()) {
130 final Entry<DOMDataTreeIdentifier, ChildShardContext> actualChild = actualChildren.next();
131 final DOMDataTreeIdentifier actualPrefix = actualChild.getKey();
132 Preconditions.checkArgument(!newChildPrefix.equals(actualPrefix),
133 "Child shard with prefix %s already attached", newChildPrefix);
134 if (newChildPrefix.contains(actualPrefix)) {
135 final ChildShardContext actualContext = actualChild.getValue();
136 actualChildren.remove();
137 newChild.onChildAttached(actualPrefix, actualContext.getShard());
138 reparented.put(actualChild.getKey(), actualContext);
139 childShardsTable.remove(actualPrefix);
142 updateProducersAndListeners(reparented);
145 private void updateProducersAndListeners(final Map<DOMDataTreeIdentifier, ChildShardContext> reparented) {
146 // FIXME: remove reparenting of producers, shards have to be registered from top to bottom
147 if (reparented.isEmpty()) {
148 //nothing was reparented no need to update anything
151 throw new UnsupportedOperationException();
154 private static ChildShardContext createContextFor(final DOMDataTreeIdentifier prefix, final DOMDataTreeShard child) {
155 Preconditions.checkArgument(child instanceof WriteableDOMDataTreeShard,
156 "Child %s is not a writable shared", child);
157 return new ChildShardContext(prefix, (WriteableDOMDataTreeShard) child);
160 private static TreeType treeTypeFor(final LogicalDatastoreType dsType) {
163 return TreeType.CONFIGURATION;
165 return TreeType.OPERATIONAL;
167 throw new IllegalArgumentException("Unsupported Data Store type:" + dsType);
172 Map<DOMDataTreeIdentifier, DOMDataTreeShard> getChildShards() {
173 final Map<DOMDataTreeIdentifier, DOMDataTreeShard> ret = new HashMap<>();
174 for (final Entry<DOMDataTreeIdentifier, ChildShardContext> entry : childShards.entrySet()) {
175 ret.put(entry.getKey(), entry.getValue().getShard());
180 InmemoryDOMDataTreeShardWriteTransaction createTransaction(final InmemoryDOMDataTreeShardWriteTransaction previousTx) {
181 // FIXME: implement this
182 throw new UnsupportedOperationException();
185 InmemoryDOMDataTreeShardWriteTransaction createTransaction(final Collection<DOMDataTreeIdentifier> prefixes) {
187 final Map<DOMDataTreeIdentifier, SubshardProducerSpecification> affectedSubshards = new HashMap<>();
188 for (final DOMDataTreeIdentifier producerPrefix : prefixes) {
189 for (final ChildShardContext maybeAffected : childShards.values()) {
190 final DOMDataTreeIdentifier bindPath;
191 if (producerPrefix.contains(maybeAffected.getPrefix())) {
192 bindPath = maybeAffected.getPrefix();
193 } else if (maybeAffected.getPrefix().contains(producerPrefix)) {
194 // Bound path is inside subshard
195 bindPath = producerPrefix;
200 SubshardProducerSpecification spec = affectedSubshards.get(maybeAffected.getPrefix());
202 spec = new SubshardProducerSpecification(maybeAffected);
203 affectedSubshards.put(maybeAffected.getPrefix(), spec);
205 spec.addPrefix(bindPath);
209 final ShardRootModificationContext rootContext = new ShardRootModificationContext(prefix,
210 (CursorAwareDataTreeSnapshot) dataTree.takeSnapshot());
211 final ShardDataModificationBuilder builder = new ShardDataModificationBuilder(rootContext);
212 for (final SubshardProducerSpecification spec : affectedSubshards.values()) {
213 final ForeignShardModificationContext foreignContext =
214 new ForeignShardModificationContext(spec.getPrefix(), spec.createProducer());
215 builder.addSubshard(foreignContext);
216 builder.addSubshard(spec.getPrefix(), foreignContext);
219 return new InmemoryDOMDataTreeShardWriteTransaction(builder.build(), dataTree, shardChangePublisher, executor);