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 throw new UnsupportedRequestException(request);
111 private void handleTransactionPreCommit(final TransactionPreCommitRequest request,
112 final RequestEnvelope envelope, final long now) throws RequestException {
113 readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
115 public void onSuccess(final DataTreeCandidate result) {
116 recordAndSendSuccess(envelope, now, new TransactionPreCommitSuccess(readyCohort.getIdentifier(),
117 request.getSequence()));
121 public void onFailure(final Throwable failure) {
122 recordAndSendFailure(envelope, now, new RuntimeRequestException("Precommit failed", failure));
128 private void handleTransactionDoCommit(final TransactionDoCommitRequest request, final RequestEnvelope envelope,
129 final long now) throws RequestException {
130 readyCohort.commit(new FutureCallback<UnsignedLong>() {
132 public void onSuccess(final UnsignedLong result) {
133 successfulCommit(envelope, now);
137 public void onFailure(final Throwable failure) {
138 recordAndSendFailure(envelope, now, new RuntimeRequestException("Commit failed", failure));
144 private void handleTransactionAbort(final TransactionAbortRequest request,
145 final RequestEnvelope envelope, final long now) throws RequestException {
146 if (readyCohort == null) {
147 openTransaction.abort(() -> recordAndSendSuccess(envelope, now,
148 new TransactionAbortSuccess(getIdentifier(), request.getSequence())));
152 readyCohort.abort(new FutureCallback<Void>() {
154 public void onSuccess(final Void result) {
156 recordAndSendSuccess(envelope, now, new TransactionAbortSuccess(getIdentifier(),
157 request.getSequence()));
158 LOG.debug("Transaction {} aborted", getIdentifier());
162 public void onFailure(final Throwable failure) {
164 LOG.warn("Transaction {} abort failed", getIdentifier(), failure);
165 recordAndSendFailure(envelope, now, new RuntimeRequestException("Abort failed", failure));
170 private void coordinatedCommit(final RequestEnvelope envelope, final long now) {
171 readyCohort.canCommit(new FutureCallback<Void>() {
173 public void onSuccess(final Void result) {
174 recordAndSendSuccess(envelope, now, new TransactionCanCommitSuccess(readyCohort.getIdentifier(),
175 envelope.getMessage().getSequence()));
179 public void onFailure(final Throwable failure) {
180 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
186 private void directCommit(final RequestEnvelope envelope, final long now) {
187 readyCohort.canCommit(new FutureCallback<Void>() {
189 public void onSuccess(final Void result) {
190 successfulDirectCanCommit(envelope, now);
194 public void onFailure(final Throwable failure) {
195 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
201 private void successfulDirectCanCommit(final RequestEnvelope envelope, final long startTime) {
202 readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
204 public void onSuccess(final DataTreeCandidate result) {
205 successfulDirectPreCommit(envelope, startTime);
209 public void onFailure(final Throwable failure) {
210 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("PreCommit failed", failure));
216 private void successfulDirectPreCommit(final RequestEnvelope envelope, final long startTime) {
217 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 readyCohort = history().createReadyCohort(getIdentifier(), sealedModification);
243 if (request.isCoordinated()) {
244 coordinatedCommit(envelope, now);
246 directCommit(envelope, now);
249 throw new UnsupportedRequestException(request);
253 private ExistsTransactionSuccess handleExistsTransaction(final ExistsTransactionRequest request)
254 throws RequestException {
255 final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
256 return recordSuccess(request.getSequence(), new ExistsTransactionSuccess(getIdentifier(), request.getSequence(),
260 private ReadTransactionSuccess handleReadTransaction(final ReadTransactionRequest request)
261 throws RequestException {
262 final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
263 return recordSuccess(request.getSequence(), new ReadTransactionSuccess(getIdentifier(), request.getSequence(),
267 private ModifyTransactionSuccess replyModifySuccess(final long sequence) {
268 return recordSuccess(sequence, new ModifyTransactionSuccess(getIdentifier(), sequence));
271 private @Nullable TransactionSuccess<?> handleModifyTransaction(final ModifyTransactionRequest request,
272 final RequestEnvelope envelope, final long now) throws RequestException {
274 final Collection<TransactionModification> mods = request.getModifications();
275 if (!mods.isEmpty()) {
276 final DataTreeModification modification = openTransaction.getSnapshot();
277 for (TransactionModification m : mods) {
278 if (m instanceof TransactionDelete) {
279 modification.delete(m.getPath());
280 } else if (m instanceof TransactionWrite) {
281 modification.write(m.getPath(), ((TransactionWrite) m).getData());
282 } else if (m instanceof TransactionMerge) {
283 modification.merge(m.getPath(), ((TransactionMerge) m).getData());
285 LOG.warn("{}: ignoring unhandled modification {}", history().persistenceId(), m);
290 final java.util.Optional<PersistenceProtocol> maybeProto = request.getPersistenceProtocol();
291 if (!maybeProto.isPresent()) {
292 return replyModifySuccess(request.getSequence());
295 switch (maybeProto.get()) {
297 openTransaction.abort(() -> replyModifySuccess(request.getSequence()));
298 openTransaction = null;
302 return replyModifySuccess(request.getSequence());
305 directCommit(envelope, now);
309 coordinatedCommit(envelope, now);
312 throw new UnsupportedRequestException(request);
316 private void ensureReady() {
317 // We may have a combination of READY + SIMPLE/THREE_PHASE , in which case we want to ready the transaction
319 if (readyCohort == null) {
320 readyCohort = openTransaction.ready();
321 LOG.debug("{}: transitioned {} to ready", history().persistenceId(), openTransaction.getIdentifier());
322 openTransaction = null;