9b485df13a95a0b4a9e038c607a016a058a543f8
[controller.git] / opendaylight / md-sal / sal-dom-broker / src / main / java / org / opendaylight / controller / md / sal / dom / broker / impl / ShardedDOMDataTreeProducer.java
1 /*
2  * Copyright (c) 2015 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 package org.opendaylight.controller.md.sal.dom.broker.impl;
9
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.BiMap;
12 import com.google.common.collect.ImmutableBiMap;
13 import com.google.common.collect.ImmutableBiMap.Builder;
14 import com.google.common.collect.ImmutableMap;
15 import com.google.common.collect.ImmutableSet;
16 import java.util.Collection;
17 import java.util.Collections;
18 import java.util.HashMap;
19 import java.util.LinkedList;
20 import java.util.Map;
21 import java.util.Map.Entry;
22 import java.util.Queue;
23 import java.util.Set;
24 import javax.annotation.concurrent.GuardedBy;
25 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
26 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeProducer;
27 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeProducerBusyException;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeProducerException;
29 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeShard;
30 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
31 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
32 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
33 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36
37 final class ShardedDOMDataTreeProducer implements DOMDataTreeProducer {
38     private static final Logger LOG = LoggerFactory.getLogger(ShardedDOMDataTreeProducer.class);
39     private final BiMap<DOMDataTreeShard, DOMStoreTransactionChain> shardToChain;
40     private final Map<DOMDataTreeIdentifier, DOMDataTreeShard> idToShard;
41     private final ShardedDOMDataTree dataTree;
42
43     @GuardedBy("this")
44     private Map<DOMDataTreeIdentifier, DOMDataTreeProducer> children = Collections.emptyMap();
45     @GuardedBy("this")
46     private DOMDataWriteTransaction openTx;
47     @GuardedBy("this")
48     private boolean closed;
49
50     ShardedDOMDataTreeProducer(final ShardedDOMDataTree dataTree, final Map<DOMDataTreeIdentifier, DOMDataTreeShard> shardMap, final Set<DOMDataTreeShard> shards) {
51         this.dataTree = Preconditions.checkNotNull(dataTree);
52
53         // Create shard -> chain map
54         final Builder<DOMDataTreeShard, DOMStoreTransactionChain> cb = ImmutableBiMap.builder();
55         final Queue<Exception> es = new LinkedList<>();
56
57         for (final DOMDataTreeShard s : shards) {
58             if (s instanceof DOMStore) {
59                 try {
60                     final DOMStoreTransactionChain c = ((DOMStore)s).createTransactionChain();
61                     LOG.trace("Using DOMStore chain {} to access shard {}", c, s);
62                     cb.put(s, c);
63                 } catch (final Exception e) {
64                     LOG.error("Failed to instantiate chain for shard {}", s, e);
65                     es.add(e);
66                 }
67             } else {
68                 LOG.error("Unhandled shard instance type {}", s.getClass());
69             }
70         }
71         this.shardToChain = cb.build();
72
73         // An error was encountered, close chains and report the error
74         if (shardToChain.size() != shards.size()) {
75             for (final DOMStoreTransactionChain c : shardToChain.values()) {
76                 try {
77                     c.close();
78                 } catch (final Exception e) {
79                     LOG.warn("Exception raised while closing chain {}", c, e);
80                 }
81             }
82
83             final IllegalStateException e = new IllegalStateException("Failed to completely allocate contexts", es.poll());
84             while (!es.isEmpty()) {
85                 e.addSuppressed(es.poll());
86             }
87
88             throw e;
89         }
90
91         idToShard = ImmutableMap.copyOf(shardMap);
92     }
93
94     @Override
95     public synchronized DOMDataWriteTransaction createTransaction(final boolean isolated) {
96         Preconditions.checkState(!closed, "Producer is already closed");
97         Preconditions.checkState(openTx == null, "Transaction %s is still open", openTx);
98
99         // Allocate backing transactions
100         final Map<DOMDataTreeShard, DOMStoreWriteTransaction> shardToTx = new HashMap<>();
101         for (final Entry<DOMDataTreeShard, DOMStoreTransactionChain> e : shardToChain.entrySet()) {
102             shardToTx.put(e.getKey(), e.getValue().newWriteOnlyTransaction());
103         }
104
105         // Create the ID->transaction map
106         final ImmutableMap.Builder<DOMDataTreeIdentifier, DOMStoreWriteTransaction> b = ImmutableMap.builder();
107         for (final Entry<DOMDataTreeIdentifier, DOMDataTreeShard> e : idToShard.entrySet()) {
108             b.put(e.getKey(), shardToTx.get(e.getValue()));
109         }
110
111         final ShardedDOMDataWriteTransaction ret = new ShardedDOMDataWriteTransaction(this, b.build());
112         openTx = ret;
113         return ret;
114     }
115
116     @GuardedBy("this")
117     private boolean haveSubtree(final DOMDataTreeIdentifier subtree) {
118         for (final DOMDataTreeIdentifier i : idToShard.keySet()) {
119             if (i.contains(subtree)) {
120                 return true;
121             }
122         }
123
124         return false;
125     }
126
127     @GuardedBy("this")
128     private DOMDataTreeProducer lookupChild(final DOMDataTreeIdentifier s) {
129         for (final Entry<DOMDataTreeIdentifier, DOMDataTreeProducer> e : children.entrySet()) {
130             if (e.getKey().contains(s)) {
131                 return e.getValue();
132             }
133         }
134
135         return null;
136     }
137
138     @Override
139     public synchronized DOMDataTreeProducer createProducer(final Collection<DOMDataTreeIdentifier> subtrees) {
140         Preconditions.checkState(!closed, "Producer is already closed");
141         Preconditions.checkState(openTx == null, "Transaction %s is still open", openTx);
142
143         for (final DOMDataTreeIdentifier s : subtrees) {
144             // Check if the subtree was visible at any time
145             if (!haveSubtree(s)) {
146                 throw new IllegalArgumentException(String.format("Subtree %s was never available in producer %s", s, this));
147             }
148
149             // Check if the subtree has not been delegated to a child
150             final DOMDataTreeProducer child = lookupChild(s);
151             Preconditions.checkArgument(child == null, "Subtree %s is delegated to child producer %s", s, child);
152
153             // Check if part of the requested subtree is not delegated to a child.
154             for (final DOMDataTreeIdentifier c : children.keySet()) {
155                 if (s.contains(c)) {
156                     throw new IllegalArgumentException(String.format("Subtree %s cannot be delegated as it is superset of already-delegated %s", s, c));
157                 }
158             }
159         }
160
161         final DOMDataTreeProducer ret = dataTree.createProducer(this, subtrees);
162         final ImmutableMap.Builder<DOMDataTreeIdentifier, DOMDataTreeProducer> cb = ImmutableMap.builder();
163         cb.putAll(children);
164         for (final DOMDataTreeIdentifier s : subtrees) {
165             cb.put(s, ret);
166         }
167
168         children = cb.build();
169         return ret;
170     }
171
172     @Override
173     public synchronized void close() throws DOMDataTreeProducerException {
174         if (!closed) {
175             if (openTx != null) {
176                 throw new DOMDataTreeProducerBusyException(String.format("Transaction %s is still open", openTx));
177             }
178
179             closed = true;
180             dataTree.destroyProducer(this);
181         }
182     }
183
184     static DOMDataTreeProducer create(final ShardedDOMDataTree dataTree, final Map<DOMDataTreeIdentifier, DOMDataTreeShard> shardMap) {
185         /*
186          * FIXME: we do not allow multiple multiple shards in a producer because we do not implement the
187          *        synchronization primitives yet
188          */
189         final Set<DOMDataTreeShard> shards = ImmutableSet.copyOf(shardMap.values());
190         if (shards.size() > 1) {
191             throw new UnsupportedOperationException("Cross-shard producers are not supported yet");
192         }
193
194         return new ShardedDOMDataTreeProducer(dataTree, shardMap, shards);
195     }
196
197     Set<DOMDataTreeIdentifier> getSubtrees() {
198         return idToShard.keySet();
199     }
200
201     synchronized void cancelTransaction(final ShardedDOMDataWriteTransaction transaction) {
202         if (!openTx.equals(transaction)) {
203             LOG.warn("Transaction {} is not open in producer {}", transaction, this);
204             return;
205         }
206
207         LOG.debug("Transaction {} cancelled", transaction);
208         openTx = null;
209     }
210 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.