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.TransactionPurgeRequest;
36 import org.opendaylight.controller.cluster.access.commands.TransactionPurgeResponse;
37 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
38 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
39 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
40 import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
41 import org.opendaylight.controller.cluster.access.concepts.RequestException;
42 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
43 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
44 import org.opendaylight.controller.cluster.access.concepts.UnsupportedRequestException;
45 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
47 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
52 * Frontend read-write transaction state as observed by the shard leader.
54 * @author Robert Varga
57 final class FrontendReadWriteTransaction extends FrontendTransaction {
58 private static final Logger LOG = LoggerFactory.getLogger(FrontendReadWriteTransaction.class);
60 private ReadWriteShardDataTreeTransaction openTransaction;
61 private DataTreeModification sealedModification;
62 private ShardDataTreeCohort readyCohort;
64 private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
65 final ReadWriteShardDataTreeTransaction transaction) {
67 this.openTransaction = Preconditions.checkNotNull(transaction);
70 private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
71 final DataTreeModification mod) {
73 this.sealedModification = Preconditions.checkNotNull(mod);
76 static FrontendReadWriteTransaction createOpen(final AbstractFrontendHistory history,
77 final ReadWriteShardDataTreeTransaction transaction) {
78 return new FrontendReadWriteTransaction(history, transaction.getIdentifier(), transaction);
81 static FrontendReadWriteTransaction createReady(final AbstractFrontendHistory history,
82 final TransactionIdentifier id, final DataTreeModification mod) {
83 return new FrontendReadWriteTransaction(history, id, mod);
86 // Sequence has already been checked
88 @Nullable TransactionSuccess<?> handleRequest(final TransactionRequest<?> request, final RequestEnvelope envelope,
89 final long now) throws RequestException {
90 if (request instanceof ModifyTransactionRequest) {
91 return handleModifyTransaction((ModifyTransactionRequest) request, envelope, now);
92 } else if (request instanceof CommitLocalTransactionRequest) {
93 handleCommitLocalTransaction((CommitLocalTransactionRequest) request, envelope, now);
95 } else if (request instanceof ExistsTransactionRequest) {
96 return handleExistsTransaction((ExistsTransactionRequest) request);
97 } else if (request instanceof ReadTransactionRequest) {
98 return handleReadTransaction((ReadTransactionRequest) request);
99 } else if (request instanceof TransactionPreCommitRequest) {
100 handleTransactionPreCommit((TransactionPreCommitRequest) request, envelope, now);
102 } else if (request instanceof TransactionDoCommitRequest) {
103 handleTransactionDoCommit((TransactionDoCommitRequest) request, envelope, now);
105 } else if (request instanceof TransactionAbortRequest) {
106 return handleTransactionAbort((TransactionAbortRequest) request, envelope, now);
107 } else if (request instanceof TransactionPurgeRequest) {
109 return new TransactionPurgeResponse(request.getTarget(), request.getSequence());
111 throw new UnsupportedRequestException(request);
115 private void handleTransactionPreCommit(final TransactionPreCommitRequest request,
116 final RequestEnvelope envelope, final long now) throws RequestException {
117 readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
119 public void onSuccess(final DataTreeCandidate result) {
120 recordAndSendSuccess(envelope, now, new TransactionPreCommitSuccess(readyCohort.getIdentifier(),
121 request.getSequence()));
125 public void onFailure(final Throwable failure) {
126 recordAndSendFailure(envelope, now, new RuntimeRequestException("Precommit failed", failure));
132 private void handleTransactionDoCommit(final TransactionDoCommitRequest request, final RequestEnvelope envelope,
133 final long now) throws RequestException {
134 readyCohort.commit(new FutureCallback<UnsignedLong>() {
136 public void onSuccess(final UnsignedLong result) {
137 successfulCommit(envelope, now);
141 public void onFailure(final Throwable failure) {
142 recordAndSendFailure(envelope, now, new RuntimeRequestException("Commit failed", failure));
148 private TransactionSuccess<?> handleTransactionAbort(final TransactionAbortRequest request,
149 final RequestEnvelope envelope, final long now) throws RequestException {
150 if (readyCohort == null) {
151 openTransaction.abort();
152 return new TransactionAbortSuccess(getIdentifier(), request.getSequence());
155 readyCohort.abort(new FutureCallback<Void>() {
157 public void onSuccess(final Void result) {
159 recordAndSendSuccess(envelope, now, new TransactionAbortSuccess(getIdentifier(),
160 request.getSequence()));
161 LOG.debug("Transaction {} aborted", getIdentifier());
165 public void onFailure(final Throwable failure) {
167 LOG.warn("Transaction {} abort failed", getIdentifier(), failure);
168 recordAndSendFailure(envelope, now, new RuntimeRequestException("Abort failed", failure));
174 private void coordinatedCommit(final RequestEnvelope envelope, final long now) {
175 readyCohort.canCommit(new FutureCallback<Void>() {
177 public void onSuccess(final Void result) {
178 recordAndSendSuccess(envelope, now, new TransactionCanCommitSuccess(readyCohort.getIdentifier(),
179 envelope.getMessage().getSequence()));
183 public void onFailure(final Throwable failure) {
184 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
190 private void directCommit(final RequestEnvelope envelope, final long now) {
191 readyCohort.canCommit(new FutureCallback<Void>() {
193 public void onSuccess(final Void result) {
194 successfulDirectCanCommit(envelope, now);
198 public void onFailure(final Throwable failure) {
199 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
205 private void successfulDirectCanCommit(final RequestEnvelope envelope, final long startTime) {
206 readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
208 public void onSuccess(final DataTreeCandidate result) {
209 successfulDirectPreCommit(envelope, startTime);
213 public void onFailure(final Throwable failure) {
214 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("PreCommit failed", failure));
220 private void successfulDirectPreCommit(final RequestEnvelope envelope, final long startTime) {
221 readyCohort.commit(new FutureCallback<UnsignedLong>() {
224 public void onSuccess(final UnsignedLong result) {
225 successfulCommit(envelope, startTime);
229 public void onFailure(final Throwable failure) {
230 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("DoCommit failed", failure));
236 private void successfulCommit(final RequestEnvelope envelope, final long startTime) {
237 recordAndSendSuccess(envelope, startTime, new TransactionCommitSuccess(readyCohort.getIdentifier(),
238 envelope.getMessage().getSequence()));
242 private void handleCommitLocalTransaction(final CommitLocalTransactionRequest request,
243 final RequestEnvelope envelope, final long now) throws RequestException {
244 if (sealedModification.equals(request.getModification())) {
245 readyCohort = history().createReadyCohort(getIdentifier(), sealedModification);
247 if (request.isCoordinated()) {
248 coordinatedCommit(envelope, now);
250 directCommit(envelope, now);
253 throw new UnsupportedRequestException(request);
257 private ExistsTransactionSuccess handleExistsTransaction(final ExistsTransactionRequest request)
258 throws RequestException {
259 final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
260 return recordSuccess(request.getSequence(), new ExistsTransactionSuccess(getIdentifier(), request.getSequence(),
264 private ReadTransactionSuccess handleReadTransaction(final ReadTransactionRequest request)
265 throws RequestException {
266 final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
267 return recordSuccess(request.getSequence(), new ReadTransactionSuccess(getIdentifier(), request.getSequence(),
271 private ModifyTransactionSuccess replyModifySuccess(final long sequence) {
272 return recordSuccess(sequence, new ModifyTransactionSuccess(getIdentifier(), sequence));
275 private @Nullable TransactionSuccess<?> handleModifyTransaction(final ModifyTransactionRequest request,
276 final RequestEnvelope envelope, final long now) throws RequestException {
278 final Collection<TransactionModification> mods = request.getModifications();
279 if (!mods.isEmpty()) {
280 final DataTreeModification modification = openTransaction.getSnapshot();
281 for (TransactionModification m : mods) {
282 if (m instanceof TransactionDelete) {
283 modification.delete(m.getPath());
284 } else if (m instanceof TransactionWrite) {
285 modification.write(m.getPath(), ((TransactionWrite) m).getData());
286 } else if (m instanceof TransactionMerge) {
287 modification.merge(m.getPath(), ((TransactionMerge) m).getData());
289 LOG.warn("{}: ignoring unhandled modification {}", history().persistenceId(), m);
294 final java.util.Optional<PersistenceProtocol> maybeProto = request.getPersistenceProtocol();
295 if (!maybeProto.isPresent()) {
296 return replyModifySuccess(request.getSequence());
299 switch (maybeProto.get()) {
301 openTransaction.abort();
302 openTransaction = null;
303 return replyModifySuccess(request.getSequence());
306 return replyModifySuccess(request.getSequence());
309 directCommit(envelope, now);
313 coordinatedCommit(envelope, now);
316 throw new UnsupportedRequestException(request);
320 private void ensureReady() {
321 // We may have a combination of READY + SIMPLE/THREE_PHASE , in which case we want to ready the transaction
323 if (readyCohort == null) {
324 readyCohort = openTransaction.ready();
325 LOG.debug("{}: transitioned {} to ready", history().persistenceId(), openTransaction.getIdentifier());
326 openTransaction = null;