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
8 package org.opendaylight.controller.cluster.datastore;
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.primitives.UnsignedLong;
13 import com.google.common.util.concurrent.FutureCallback;
14 import java.util.Collection;
15 import javax.annotation.Nullable;
16 import javax.annotation.concurrent.NotThreadSafe;
17 import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
18 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
19 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
20 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
21 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
22 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionSuccess;
23 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
24 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
25 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
26 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
27 import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
28 import org.opendaylight.controller.cluster.access.commands.TransactionCanCommitSuccess;
29 import org.opendaylight.controller.cluster.access.commands.TransactionCommitSuccess;
30 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
31 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
32 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
33 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
34 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
35 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitSuccess;
36 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
37 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
38 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
39 import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
40 import org.opendaylight.controller.cluster.access.concepts.RequestException;
41 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
42 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
43 import org.opendaylight.controller.cluster.access.concepts.UnsupportedRequestException;
44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
45 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
46 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
51 * Frontend read-write transaction state as observed by the shard leader.
53 * @author Robert Varga
56 final class FrontendReadWriteTransaction extends FrontendTransaction {
57 private static final Logger LOG = LoggerFactory.getLogger(FrontendReadWriteTransaction.class);
59 private ReadWriteShardDataTreeTransaction openTransaction;
60 private DataTreeModification sealedModification;
61 private ShardDataTreeCohort readyCohort;
63 private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
64 final ReadWriteShardDataTreeTransaction transaction) {
66 this.openTransaction = Preconditions.checkNotNull(transaction);
69 private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
70 final DataTreeModification mod) {
72 this.sealedModification = Preconditions.checkNotNull(mod);
75 static FrontendReadWriteTransaction createOpen(final AbstractFrontendHistory history,
76 final ReadWriteShardDataTreeTransaction transaction) {
77 return new FrontendReadWriteTransaction(history, transaction.getIdentifier(), transaction);
80 static FrontendReadWriteTransaction createReady(final AbstractFrontendHistory history,
81 final TransactionIdentifier id, final DataTreeModification mod) {
82 return new FrontendReadWriteTransaction(history, id, mod);
85 // Sequence has already been checked
87 @Nullable TransactionSuccess<?> doHandleRequest(final TransactionRequest<?> request, final RequestEnvelope envelope,
88 final long now) throws RequestException {
89 if (request instanceof ModifyTransactionRequest) {
90 return handleModifyTransaction((ModifyTransactionRequest) request, envelope, now);
91 } else if (request instanceof CommitLocalTransactionRequest) {
92 handleCommitLocalTransaction((CommitLocalTransactionRequest) request, envelope, now);
94 } else if (request instanceof ExistsTransactionRequest) {
95 return handleExistsTransaction((ExistsTransactionRequest) request);
96 } else if (request instanceof ReadTransactionRequest) {
97 return handleReadTransaction((ReadTransactionRequest) request);
98 } else if (request instanceof TransactionPreCommitRequest) {
99 handleTransactionPreCommit((TransactionPreCommitRequest) request, envelope, now);
101 } else if (request instanceof TransactionDoCommitRequest) {
102 handleTransactionDoCommit((TransactionDoCommitRequest) request, envelope, now);
104 } else if (request instanceof TransactionAbortRequest) {
105 handleTransactionAbort(request.getSequence(), envelope, now);
107 } else if (request instanceof AbortLocalTransactionRequest) {
108 handleLocalTransactionAbort(request.getSequence(), envelope, now);
111 LOG.warn("Rejecting unsupported request {}", request);
112 throw new UnsupportedRequestException(request);
116 private void handleTransactionPreCommit(final TransactionPreCommitRequest request,
117 final RequestEnvelope envelope, final long now) throws RequestException {
118 readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
120 public void onSuccess(final DataTreeCandidate result) {
121 recordAndSendSuccess(envelope, now, new TransactionPreCommitSuccess(readyCohort.getIdentifier(),
122 request.getSequence()));
126 public void onFailure(final Throwable failure) {
127 recordAndSendFailure(envelope, now, new RuntimeRequestException("Precommit failed", failure));
133 private void handleTransactionDoCommit(final TransactionDoCommitRequest request, final RequestEnvelope envelope,
134 final long now) throws RequestException {
135 readyCohort.commit(new FutureCallback<UnsignedLong>() {
137 public void onSuccess(final UnsignedLong result) {
138 successfulCommit(envelope, now);
142 public void onFailure(final Throwable failure) {
143 recordAndSendFailure(envelope, now, new RuntimeRequestException("Commit failed", failure));
149 private void handleLocalTransactionAbort(final long sequence, final RequestEnvelope envelope, final long now) {
150 Preconditions.checkState(readyCohort == null, "Transaction {} encountered local abort with commit underway",
152 openTransaction.abort(() -> recordAndSendSuccess(envelope, now, new TransactionAbortSuccess(getIdentifier(),
156 private void handleTransactionAbort(final long sequence, final RequestEnvelope envelope, final long now) {
157 if (readyCohort == null) {
158 openTransaction.abort(() -> recordAndSendSuccess(envelope, now, new TransactionAbortSuccess(getIdentifier(),
163 readyCohort.abort(new FutureCallback<Void>() {
165 public void onSuccess(final Void result) {
167 recordAndSendSuccess(envelope, now, new TransactionAbortSuccess(getIdentifier(), sequence));
168 LOG.debug("Transaction {} aborted", getIdentifier());
172 public void onFailure(final Throwable failure) {
174 LOG.warn("Transaction {} abort failed", getIdentifier(), failure);
175 recordAndSendFailure(envelope, now, new RuntimeRequestException("Abort failed", failure));
180 private void coordinatedCommit(final RequestEnvelope envelope, final long now) {
181 readyCohort.canCommit(new FutureCallback<Void>() {
183 public void onSuccess(final Void result) {
184 recordAndSendSuccess(envelope, now, new TransactionCanCommitSuccess(readyCohort.getIdentifier(),
185 envelope.getMessage().getSequence()));
189 public void onFailure(final Throwable failure) {
190 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
196 private void directCommit(final RequestEnvelope envelope, final long now) {
197 readyCohort.canCommit(new FutureCallback<Void>() {
199 public void onSuccess(final Void result) {
200 successfulDirectCanCommit(envelope, now);
204 public void onFailure(final Throwable failure) {
205 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
211 void successfulDirectCanCommit(final RequestEnvelope envelope, final long startTime) {
212 readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
214 public void onSuccess(final DataTreeCandidate result) {
215 successfulDirectPreCommit(envelope, startTime);
219 public void onFailure(final Throwable failure) {
220 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("PreCommit failed", failure));
226 void successfulDirectPreCommit(final RequestEnvelope envelope, final long startTime) {
227 readyCohort.commit(new FutureCallback<UnsignedLong>() {
229 public void onSuccess(final UnsignedLong result) {
230 successfulCommit(envelope, startTime);
234 public void onFailure(final Throwable failure) {
235 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("DoCommit failed", failure));
241 void successfulCommit(final RequestEnvelope envelope, final long startTime) {
242 recordAndSendSuccess(envelope, startTime, new TransactionCommitSuccess(readyCohort.getIdentifier(),
243 envelope.getMessage().getSequence()));
247 private void handleCommitLocalTransaction(final CommitLocalTransactionRequest request,
248 final RequestEnvelope envelope, final long now) throws RequestException {
249 if (!sealedModification.equals(request.getModification())) {
250 LOG.warn("Expecting modification {}, commit request has {}", sealedModification, request.getModification());
251 throw new UnsupportedRequestException(request);
254 final java.util.Optional<Exception> optFailure = request.getDelayedFailure();
255 if (optFailure.isPresent()) {
256 readyCohort = history().createFailedCohort(getIdentifier(), sealedModification, optFailure.get());
258 readyCohort = history().createReadyCohort(getIdentifier(), sealedModification);
261 if (request.isCoordinated()) {
262 coordinatedCommit(envelope, now);
264 directCommit(envelope, now);
268 private ExistsTransactionSuccess handleExistsTransaction(final ExistsTransactionRequest request)
269 throws RequestException {
270 final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
271 return recordSuccess(request.getSequence(), new ExistsTransactionSuccess(getIdentifier(), request.getSequence(),
275 private ReadTransactionSuccess handleReadTransaction(final ReadTransactionRequest request)
276 throws RequestException {
277 final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
278 return recordSuccess(request.getSequence(), new ReadTransactionSuccess(getIdentifier(), request.getSequence(),
282 private ModifyTransactionSuccess replyModifySuccess(final long sequence) {
283 return recordSuccess(sequence, new ModifyTransactionSuccess(getIdentifier(), sequence));
286 private @Nullable TransactionSuccess<?> handleModifyTransaction(final ModifyTransactionRequest request,
287 final RequestEnvelope envelope, final long now) throws RequestException {
289 final Collection<TransactionModification> mods = request.getModifications();
290 if (!mods.isEmpty()) {
291 final DataTreeModification modification = openTransaction.getSnapshot();
292 for (TransactionModification m : mods) {
293 if (m instanceof TransactionDelete) {
294 modification.delete(m.getPath());
295 } else if (m instanceof TransactionWrite) {
296 modification.write(m.getPath(), ((TransactionWrite) m).getData());
297 } else if (m instanceof TransactionMerge) {
298 modification.merge(m.getPath(), ((TransactionMerge) m).getData());
300 LOG.warn("{}: ignoring unhandled modification {}", persistenceId(), m);
305 final java.util.Optional<PersistenceProtocol> maybeProto = request.getPersistenceProtocol();
306 if (!maybeProto.isPresent()) {
307 return replyModifySuccess(request.getSequence());
310 switch (maybeProto.get()) {
312 openTransaction.abort(() -> replyModifySuccess(request.getSequence()));
313 openTransaction = null;
317 return replyModifySuccess(request.getSequence());
320 directCommit(envelope, now);
324 coordinatedCommit(envelope, now);
327 LOG.warn("{}: rejecting unsupported protocol {}", persistenceId(), maybeProto.get());
328 throw new UnsupportedRequestException(request);
332 private void ensureReady() {
333 // We may have a combination of READY + SIMPLE/THREE_PHASE , in which case we want to ready the transaction
335 if (readyCohort == null) {
336 readyCohort = openTransaction.ready();
337 LOG.debug("{}: transitioned {} to ready", persistenceId(), openTransaction.getIdentifier());
338 openTransaction = null;