2 * Copyright (c) 2014 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.md.sal.common.impl.service;
10 import java.util.ArrayList;
11 import java.util.List;
13 import java.util.Map.Entry;
15 import java.util.concurrent.Callable;
16 import java.util.concurrent.ExecutorService;
18 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
19 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
20 import org.opendaylight.controller.md.sal.common.api.data.DataChangeListener;
21 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler;
22 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler.DataCommitTransaction;
23 import org.opendaylight.yangtools.concepts.Path;
24 import org.opendaylight.yangtools.yang.common.RpcResult;
25 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
26 import org.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
29 import com.google.common.base.Optional;
30 import com.google.common.base.Predicate;
31 import com.google.common.collect.ImmutableList;
32 import com.google.common.collect.ImmutableList.Builder;
33 import com.google.common.collect.ImmutableSet;
34 import com.google.common.collect.Sets;
37 public class TwoPhaseCommit<P extends Path<P>, D extends Object, DCL extends DataChangeListener<P, D>> implements
38 Callable<RpcResult<TransactionStatus>> {
39 private final static Logger log = LoggerFactory.getLogger(TwoPhaseCommit.class);
41 private final AbstractDataTransaction<P, D> transaction;
43 private final AbstractDataBroker<P, D, DCL> dataBroker;
45 public TwoPhaseCommit(final AbstractDataTransaction<P, D> transaction, final AbstractDataBroker<P, D, DCL> broker) {
46 this.transaction = transaction;
47 this.dataBroker = broker;
51 public RpcResult<TransactionStatus> call() throws Exception {
52 final Object transactionId = this.transaction.getIdentifier();
54 Set<P> changedPaths = ImmutableSet.<P> builder().addAll(transaction.getUpdatedConfigurationData().keySet())
55 .addAll(transaction.getCreatedConfigurationData().keySet())
56 .addAll(transaction.getRemovedConfigurationData())
57 .addAll(transaction.getUpdatedOperationalData().keySet())
58 .addAll(transaction.getCreatedOperationalData().keySet())
59 .addAll(transaction.getRemovedOperationalData()).build();
61 log.trace("Transaction: {} Affected Subtrees: {}", transactionId, changedPaths);
63 // The transaction has no effects, let's just shortcut it
64 if (changedPaths.isEmpty()) {
65 dataBroker.getFinishedTransactionsCount().getAndIncrement();
66 transaction.succeeded();
68 log.trace("Transaction: {} Finished successfully (no effects).", transactionId);
70 return RpcResultBuilder.<TransactionStatus> success( TransactionStatus.COMMITED ).build();
73 final ImmutableList.Builder<ListenerStateCapture<P, D, DCL>> listenersBuilder = ImmutableList.builder();
74 listenersBuilder.addAll(dataBroker.affectedListeners(changedPaths));
75 filterProbablyAffectedListeners(dataBroker.probablyAffectedListeners(changedPaths),listenersBuilder);
79 final ImmutableList<ListenerStateCapture<P, D, DCL>> listeners = listenersBuilder.build();
80 final Iterable<DataCommitHandler<P, D>> commitHandlers = dataBroker.affectedCommitHandlers(changedPaths);
81 captureInitialState(listeners);
84 log.trace("Transaction: {} Starting Request Commit.",transactionId);
85 final List<DataCommitTransaction<P, D>> handlerTransactions = new ArrayList<>();
87 for (final DataCommitHandler<P, D> handler : commitHandlers) {
88 DataCommitTransaction<P, D> requestCommit = handler.requestCommit(this.transaction);
89 if (requestCommit != null) {
90 handlerTransactions.add(requestCommit);
92 log.debug("Transaction: {}, Handler {} is not participating in transaction.", transactionId,
96 } catch (Exception e) {
97 log.error("Transaction: {} Request Commit failed", transactionId, e);
98 dataBroker.getFailedTransactionsCount().getAndIncrement();
99 this.transaction.failed();
100 return this.rollback(handlerTransactions, e);
104 log.trace("Transaction: {} Starting Finish.",transactionId);
105 final List<RpcResult<Void>> results = new ArrayList<RpcResult<Void>>();
107 for (final DataCommitTransaction<P, D> subtransaction : handlerTransactions) {
108 results.add(subtransaction.finish());
110 } catch (Exception e) {
111 log.error("Transaction: {} Finish Commit failed", transactionId, e);
112 dataBroker.getFailedTransactionsCount().getAndIncrement();
113 transaction.failed();
114 return this.rollback(handlerTransactions, e);
118 dataBroker.getFinishedTransactionsCount().getAndIncrement();
119 transaction.succeeded();
121 log.trace("Transaction: {} Finished successfully.", transactionId);
123 captureFinalState(listeners);
125 log.trace("Transaction: {} Notifying listeners.", transactionId);
127 publishDataChangeEvent(listeners);
128 return RpcResultBuilder.<TransactionStatus> success(TransactionStatus.COMMITED).build();
131 private void captureInitialState(ImmutableList<ListenerStateCapture<P, D, DCL>> listeners) {
132 for (ListenerStateCapture<P, D, DCL> state : listeners) {
133 state.setInitialConfigurationState(dataBroker.readConfigurationData(state.getPath()));
134 state.setInitialOperationalState(dataBroker.readOperationalData(state.getPath()));
139 private void captureFinalState(ImmutableList<ListenerStateCapture<P, D, DCL>> listeners) {
140 for (ListenerStateCapture<P, D, DCL> state : listeners) {
141 state.setFinalConfigurationState(dataBroker.readConfigurationData(state.getPath()));
142 state.setFinalOperationalState(dataBroker.readOperationalData(state.getPath()));
146 private void filterProbablyAffectedListeners(
147 ImmutableList<ListenerStateCapture<P, D, DCL>> probablyAffectedListeners, Builder<ListenerStateCapture<P, D, DCL>> reallyAffected) {
149 for(ListenerStateCapture<P, D, DCL> listenerSet : probablyAffectedListeners) {
150 P affectedPath = listenerSet.getPath();
151 Optional<RootedChangeSet<P,D>> configChange = resolveConfigChange(affectedPath);
152 Optional<RootedChangeSet<P, D>> operChange = resolveOperChange(affectedPath);
154 if(configChange.isPresent() || operChange.isPresent()) {
155 reallyAffected.add(listenerSet);
156 if(configChange.isPresent()) {
157 listenerSet.setNormalizedConfigurationChanges(configChange.get());
160 if(operChange.isPresent()) {
161 listenerSet.setNormalizedOperationalChanges(operChange.get());
167 private Optional<RootedChangeSet<P, D>> resolveOperChange(P affectedPath) {
168 Map<P, D> originalOper = dataBroker.deepGetBySubpath(transaction.getOriginalOperationalData(),affectedPath);
169 Map<P, D> createdOper = dataBroker.deepGetBySubpath(transaction.getCreatedOperationalData(),affectedPath);
170 Map<P, D> updatedOper = dataBroker.deepGetBySubpath(transaction.getUpdatedOperationalData(),affectedPath);
171 Set<P> removedOper = Sets.filter(transaction.getRemovedOperationalData(), dataBroker.createIsContainedPredicate(affectedPath));
172 return resolveChanges(affectedPath,originalOper,createdOper,updatedOper,removedOper);
175 private Optional<RootedChangeSet<P, D>> resolveConfigChange(P affectedPath) {
176 Map<P, D> originalConfig = dataBroker.deepGetBySubpath(transaction.getOriginalConfigurationData(),affectedPath);
177 Map<P, D> createdConfig = dataBroker.deepGetBySubpath(transaction.getCreatedConfigurationData(),affectedPath);
178 Map<P, D> updatedConfig = dataBroker.deepGetBySubpath(transaction.getUpdatedConfigurationData(),affectedPath);
179 Set<P> removedConfig = Sets.filter(transaction.getRemovedConfigurationData(), dataBroker.createIsContainedPredicate(affectedPath));
180 return resolveChanges(affectedPath,originalConfig,createdConfig,updatedConfig,removedConfig);
183 private Optional<RootedChangeSet<P,D>> resolveChanges(P affectedPath, Map<P, D> originalConfig, Map<P, D> createdConfig, Map<P, D> updatedConfig,Set<P> potentialDeletions) {
184 Predicate<P> isContained = dataBroker.createIsContainedPredicate(affectedPath);
186 if(createdConfig.isEmpty() && updatedConfig.isEmpty() && potentialDeletions.isEmpty()) {
187 return Optional.absent();
189 RootedChangeSet<P, D> changeSet = new RootedChangeSet<P,D>(affectedPath,originalConfig);
190 changeSet.addCreated(createdConfig);
192 for(Entry<P, D> entry : updatedConfig.entrySet()) {
193 if(originalConfig.containsKey(entry.getKey())) {
194 changeSet.addUpdated(entry);
196 changeSet.addCreated(entry);
200 for(Entry<P,D> entry : originalConfig.entrySet()) {
201 for(P deletion : potentialDeletions) {
202 if(isContained.apply(deletion)) {
203 changeSet.addRemoval(entry.getKey());
208 if(changeSet.isChange()) {
209 return Optional.of(changeSet);
211 return Optional.absent();
216 public void publishDataChangeEvent(final ImmutableList<ListenerStateCapture<P, D, DCL>> listeners) {
217 ExecutorService executor = this.dataBroker.getExecutor();
218 final Runnable notifyTask = new Runnable() {
221 for (final ListenerStateCapture<P, D, DCL> listenerSet : listeners) {
222 DataChangeEvent<P, D> changeEvent = listenerSet.createEvent(transaction);
223 for (final DataChangeListenerRegistration<P, D, DCL> listener : listenerSet.getListeners()) {
225 listener.getInstance().onDataChanged(changeEvent);
226 } catch (Exception e) {
227 log.error("Unhandled exception when invoking listener {}", listener, e);
233 executor.submit(notifyTask);
236 public RpcResult<TransactionStatus> rollback(final List<DataCommitTransaction<P, D>> transactions, final Exception e) {
237 for (final DataCommitTransaction<P, D> transaction : transactions) {
238 transaction.rollback();
240 return RpcResultBuilder.<TransactionStatus> failed().withResult(TransactionStatus.FAILED).build();