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.CommitLocalTransactionRequest;
18 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
19 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
20 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
21 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionSuccess;
22 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
23 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
24 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
25 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
26 import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
27 import org.opendaylight.controller.cluster.access.commands.TransactionCanCommitSuccess;
28 import org.opendaylight.controller.cluster.access.commands.TransactionCommitSuccess;
29 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
30 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
31 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
32 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
33 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
34 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitSuccess;
35 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
36 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
37 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
38 import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
39 import org.opendaylight.controller.cluster.access.concepts.RequestException;
40 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
41 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
42 import org.opendaylight.controller.cluster.access.concepts.UnsupportedRequestException;
43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
44 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
45 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
50 * Frontend read-write transaction state as observed by the shard leader.
52 * @author Robert Varga
55 final class FrontendReadWriteTransaction extends FrontendTransaction {
56 private static final Logger LOG = LoggerFactory.getLogger(FrontendReadWriteTransaction.class);
58 private ReadWriteShardDataTreeTransaction openTransaction;
59 private DataTreeModification sealedModification;
60 private ShardDataTreeCohort readyCohort;
62 private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
63 final ReadWriteShardDataTreeTransaction transaction) {
65 this.openTransaction = Preconditions.checkNotNull(transaction);
68 private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
69 final DataTreeModification mod) {
71 this.sealedModification = Preconditions.checkNotNull(mod);
74 static FrontendReadWriteTransaction createOpen(final AbstractFrontendHistory history,
75 final ReadWriteShardDataTreeTransaction transaction) {
76 return new FrontendReadWriteTransaction(history, transaction.getIdentifier(), transaction);
79 static FrontendReadWriteTransaction createReady(final AbstractFrontendHistory history,
80 final TransactionIdentifier id, final DataTreeModification mod) {
81 return new FrontendReadWriteTransaction(history, id, mod);
84 // Sequence has already been checked
86 @Nullable TransactionSuccess<?> handleRequest(final TransactionRequest<?> request, final RequestEnvelope envelope,
87 final long now) throws RequestException {
88 if (request instanceof ModifyTransactionRequest) {
89 return handleModifyTransaction((ModifyTransactionRequest) request, envelope, now);
90 } else if (request instanceof CommitLocalTransactionRequest) {
91 handleCommitLocalTransaction((CommitLocalTransactionRequest) request, envelope, now);
93 } else if (request instanceof ExistsTransactionRequest) {
94 return handleExistsTransaction((ExistsTransactionRequest) request);
95 } else if (request instanceof ReadTransactionRequest) {
96 return handleReadTransaction((ReadTransactionRequest) request);
97 } else if (request instanceof TransactionPreCommitRequest) {
98 handleTransactionPreCommit((TransactionPreCommitRequest) request, envelope, now);
100 } else if (request instanceof TransactionDoCommitRequest) {
101 handleTransactionDoCommit((TransactionDoCommitRequest) request, envelope, now);
103 } else if (request instanceof TransactionAbortRequest) {
104 handleTransactionAbort((TransactionAbortRequest) request, envelope, now);
107 LOG.warn("Rejecting unsupported request {}", request);
108 throw new UnsupportedRequestException(request);
112 private void handleTransactionPreCommit(final TransactionPreCommitRequest request,
113 final RequestEnvelope envelope, final long now) throws RequestException {
114 readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
116 public void onSuccess(final DataTreeCandidate result) {
117 recordAndSendSuccess(envelope, now, new TransactionPreCommitSuccess(readyCohort.getIdentifier(),
118 request.getSequence()));
122 public void onFailure(final Throwable failure) {
123 recordAndSendFailure(envelope, now, new RuntimeRequestException("Precommit failed", failure));
129 private void handleTransactionDoCommit(final TransactionDoCommitRequest request, final RequestEnvelope envelope,
130 final long now) throws RequestException {
131 readyCohort.commit(new FutureCallback<UnsignedLong>() {
133 public void onSuccess(final UnsignedLong result) {
134 successfulCommit(envelope, now);
138 public void onFailure(final Throwable failure) {
139 recordAndSendFailure(envelope, now, new RuntimeRequestException("Commit failed", failure));
145 private void handleTransactionAbort(final TransactionAbortRequest request,
146 final RequestEnvelope envelope, final long now) throws RequestException {
147 if (readyCohort == null) {
148 openTransaction.abort(() -> recordAndSendSuccess(envelope, now,
149 new TransactionAbortSuccess(getIdentifier(), request.getSequence())));
153 readyCohort.abort(new FutureCallback<Void>() {
155 public void onSuccess(final Void result) {
157 recordAndSendSuccess(envelope, now, new TransactionAbortSuccess(getIdentifier(),
158 request.getSequence()));
159 LOG.debug("Transaction {} aborted", getIdentifier());
163 public void onFailure(final Throwable failure) {
165 LOG.warn("Transaction {} abort failed", getIdentifier(), failure);
166 recordAndSendFailure(envelope, now, new RuntimeRequestException("Abort failed", failure));
171 private void coordinatedCommit(final RequestEnvelope envelope, final long now) {
172 readyCohort.canCommit(new FutureCallback<Void>() {
174 public void onSuccess(final Void result) {
175 recordAndSendSuccess(envelope, now, new TransactionCanCommitSuccess(readyCohort.getIdentifier(),
176 envelope.getMessage().getSequence()));
180 public void onFailure(final Throwable failure) {
181 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
187 private void directCommit(final RequestEnvelope envelope, final long now) {
188 readyCohort.canCommit(new FutureCallback<Void>() {
190 public void onSuccess(final Void result) {
191 successfulDirectCanCommit(envelope, now);
195 public void onFailure(final Throwable failure) {
196 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
202 private void successfulDirectCanCommit(final RequestEnvelope envelope, final long startTime) {
203 readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
205 public void onSuccess(final DataTreeCandidate result) {
206 successfulDirectPreCommit(envelope, startTime);
210 public void onFailure(final Throwable failure) {
211 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("PreCommit failed", failure));
217 private void successfulDirectPreCommit(final RequestEnvelope envelope, final long startTime) {
218 readyCohort.commit(new FutureCallback<UnsignedLong>() {
220 public void onSuccess(final UnsignedLong result) {
221 successfulCommit(envelope, startTime);
225 public void onFailure(final Throwable failure) {
226 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("DoCommit failed", failure));
232 private void successfulCommit(final RequestEnvelope envelope, final long startTime) {
233 recordAndSendSuccess(envelope, startTime, new TransactionCommitSuccess(readyCohort.getIdentifier(),
234 envelope.getMessage().getSequence()));
238 private void handleCommitLocalTransaction(final CommitLocalTransactionRequest request,
239 final RequestEnvelope envelope, final long now) throws RequestException {
240 if (!sealedModification.equals(request.getModification())) {
241 LOG.warn("Expecting modification {}, commit request has {}", sealedModification, request.getModification());
242 throw new UnsupportedRequestException(request);
245 final java.util.Optional<Exception> optFailure = request.getDelayedFailure();
246 if (optFailure.isPresent()) {
247 readyCohort = history().createFailedCohort(getIdentifier(), sealedModification, optFailure.get());
249 readyCohort = history().createReadyCohort(getIdentifier(), sealedModification);
252 if (request.isCoordinated()) {
253 coordinatedCommit(envelope, now);
255 directCommit(envelope, now);
259 private ExistsTransactionSuccess handleExistsTransaction(final ExistsTransactionRequest request)
260 throws RequestException {
261 final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
262 return recordSuccess(request.getSequence(), new ExistsTransactionSuccess(getIdentifier(), request.getSequence(),
266 private ReadTransactionSuccess handleReadTransaction(final ReadTransactionRequest request)
267 throws RequestException {
268 final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
269 return recordSuccess(request.getSequence(), new ReadTransactionSuccess(getIdentifier(), request.getSequence(),
273 private ModifyTransactionSuccess replyModifySuccess(final long sequence) {
274 return recordSuccess(sequence, new ModifyTransactionSuccess(getIdentifier(), sequence));
277 private @Nullable TransactionSuccess<?> handleModifyTransaction(final ModifyTransactionRequest request,
278 final RequestEnvelope envelope, final long now) throws RequestException {
280 final Collection<TransactionModification> mods = request.getModifications();
281 if (!mods.isEmpty()) {
282 final DataTreeModification modification = openTransaction.getSnapshot();
283 for (TransactionModification m : mods) {
284 if (m instanceof TransactionDelete) {
285 modification.delete(m.getPath());
286 } else if (m instanceof TransactionWrite) {
287 modification.write(m.getPath(), ((TransactionWrite) m).getData());
288 } else if (m instanceof TransactionMerge) {
289 modification.merge(m.getPath(), ((TransactionMerge) m).getData());
291 LOG.warn("{}: ignoring unhandled modification {}", history().persistenceId(), m);
296 final java.util.Optional<PersistenceProtocol> maybeProto = request.getPersistenceProtocol();
297 if (!maybeProto.isPresent()) {
298 return replyModifySuccess(request.getSequence());
301 switch (maybeProto.get()) {
303 openTransaction.abort(() -> replyModifySuccess(request.getSequence()));
304 openTransaction = null;
308 return replyModifySuccess(request.getSequence());
311 directCommit(envelope, now);
315 coordinatedCommit(envelope, now);
318 LOG.warn("{}: rejecting unsupported protocol {}", history().persistenceId(), maybeProto.get());
319 throw new UnsupportedRequestException(request);
323 private void ensureReady() {
324 // We may have a combination of READY + SIMPLE/THREE_PHASE , in which case we want to ready the transaction
326 if (readyCohort == null) {
327 readyCohort = openTransaction.ready();
328 LOG.debug("{}: transitioned {} to ready", history().persistenceId(), openTransaction.getIdentifier());
329 openTransaction = null;