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.Collections;
12 import java.util.List;
14 import java.util.Map.Entry;
16 import java.util.concurrent.Callable;
17 import java.util.concurrent.ExecutorService;
19 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
20 import org.opendaylight.controller.md.sal.common.api.data.DataChangeEvent;
21 import org.opendaylight.controller.md.sal.common.api.data.DataChangeListener;
22 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler;
23 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler.DataCommitTransaction;
24 import org.opendaylight.controller.sal.common.util.Rpcs;
25 import org.opendaylight.yangtools.concepts.Path;
26 import org.opendaylight.yangtools.yang.common.RpcError;
27 import org.opendaylight.yangtools.yang.common.RpcResult;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
31 import com.google.common.base.Optional;
32 import com.google.common.base.Predicate;
33 import com.google.common.collect.ImmutableList;
34 import com.google.common.collect.ImmutableList.Builder;
35 import com.google.common.collect.ImmutableSet;
36 import com.google.common.collect.Sets;
38 public class TwoPhaseCommit<P extends Path<P>, D extends Object, DCL extends DataChangeListener<P, D>> implements
39 Callable<RpcResult<TransactionStatus>> {
40 private final static Logger log = LoggerFactory.getLogger(TwoPhaseCommit.class);
42 private final AbstractDataTransaction<P, D> transaction;
44 private final AbstractDataBroker<P, D, DCL> dataBroker;
46 public TwoPhaseCommit(final AbstractDataTransaction<P, D> transaction, final AbstractDataBroker<P, D, DCL> broker) {
47 this.transaction = transaction;
48 this.dataBroker = broker;
52 public RpcResult<TransactionStatus> call() throws Exception {
53 final Object transactionId = this.transaction.getIdentifier();
55 Set<P> changedPaths = ImmutableSet.<P> builder().addAll(transaction.getUpdatedConfigurationData().keySet())
56 .addAll(transaction.getCreatedConfigurationData().keySet())
57 .addAll(transaction.getRemovedConfigurationData())
58 .addAll(transaction.getUpdatedOperationalData().keySet())
59 .addAll(transaction.getCreatedOperationalData().keySet())
60 .addAll(transaction.getRemovedOperationalData()).build();
62 log.trace("Transaction: {} Affected Subtrees:", transactionId, changedPaths);
64 final ImmutableList.Builder<ListenerStateCapture<P, D, DCL>> listenersBuilder = ImmutableList.builder();
65 listenersBuilder.addAll(dataBroker.affectedListeners(changedPaths));
66 filterProbablyAffectedListeners(dataBroker.probablyAffectedListeners(changedPaths),listenersBuilder);
70 final ImmutableList<ListenerStateCapture<P, D, DCL>> listeners = listenersBuilder.build();
71 final Iterable<DataCommitHandler<P, D>> commitHandlers = dataBroker.affectedCommitHandlers(changedPaths);
72 captureInitialState(listeners);
75 log.trace("Transaction: {} Starting Request Commit.",transactionId);
76 final List<DataCommitTransaction<P, D>> handlerTransactions = new ArrayList<>();
78 for (final DataCommitHandler<P, D> handler : commitHandlers) {
79 DataCommitTransaction<P, D> requestCommit = handler.requestCommit(this.transaction);
80 if (requestCommit != null) {
81 handlerTransactions.add(requestCommit);
83 log.debug("Transaction: {}, Handler {} is not participating in transaction.", transactionId,
87 } catch (Exception e) {
88 log.error("Transaction: {} Request Commit failed", transactionId, e);
89 dataBroker.getFailedTransactionsCount().getAndIncrement();
90 this.transaction.changeStatus(TransactionStatus.FAILED);
91 return this.rollback(handlerTransactions, e);
95 log.trace("Transaction: {} Starting Finish.",transactionId);
96 final List<RpcResult<Void>> results = new ArrayList<RpcResult<Void>>();
98 for (final DataCommitTransaction<P, D> subtransaction : handlerTransactions) {
99 results.add(subtransaction.finish());
101 } catch (Exception e) {
102 log.error("Transaction: {} Finish Commit failed", transactionId, e);
103 dataBroker.getFailedTransactionsCount().getAndIncrement();
104 transaction.changeStatus(TransactionStatus.FAILED);
105 return this.rollback(handlerTransactions, e);
109 dataBroker.getFinishedTransactionsCount().getAndIncrement();
110 transaction.changeStatus(TransactionStatus.COMMITED);
112 log.trace("Transaction: {} Finished successfully.", transactionId);
114 captureFinalState(listeners);
116 log.trace("Transaction: {} Notifying listeners.");
118 publishDataChangeEvent(listeners);
119 return Rpcs.<TransactionStatus> getRpcResult(true, TransactionStatus.COMMITED,
120 Collections.<RpcError> emptySet());
123 private void captureInitialState(ImmutableList<ListenerStateCapture<P, D, DCL>> listeners) {
124 for (ListenerStateCapture<P, D, DCL> state : listeners) {
125 state.setInitialConfigurationState(dataBroker.readConfigurationData(state.getPath()));
126 state.setInitialOperationalState(dataBroker.readOperationalData(state.getPath()));
131 private void captureFinalState(ImmutableList<ListenerStateCapture<P, D, DCL>> listeners) {
132 for (ListenerStateCapture<P, D, DCL> state : listeners) {
133 state.setFinalConfigurationState(dataBroker.readConfigurationData(state.getPath()));
134 state.setFinalOperationalState(dataBroker.readOperationalData(state.getPath()));
138 private void filterProbablyAffectedListeners(
139 ImmutableList<ListenerStateCapture<P, D, DCL>> probablyAffectedListeners, Builder<ListenerStateCapture<P, D, DCL>> reallyAffected) {
141 for(ListenerStateCapture<P, D, DCL> listenerSet : probablyAffectedListeners) {
142 P affectedPath = listenerSet.getPath();
143 Optional<RootedChangeSet<P,D>> configChange = resolveConfigChange(affectedPath);
144 Optional<RootedChangeSet<P, D>> operChange = resolveOperChange(affectedPath);
146 if(configChange.isPresent() || operChange.isPresent()) {
147 reallyAffected.add(listenerSet);
148 if(configChange.isPresent()) {
149 listenerSet.setNormalizedConfigurationChanges(configChange.get());
152 if(operChange.isPresent()) {
153 listenerSet.setNormalizedOperationalChanges(operChange.get());
159 private Optional<RootedChangeSet<P, D>> resolveOperChange(P affectedPath) {
160 Map<P, D> originalOper = dataBroker.deepGetBySubpath(transaction.getOriginalOperationalData(),affectedPath);
161 Map<P, D> createdOper = dataBroker.deepGetBySubpath(transaction.getCreatedOperationalData(),affectedPath);
162 Map<P, D> updatedOper = dataBroker.deepGetBySubpath(transaction.getUpdatedOperationalData(),affectedPath);
163 Set<P> removedOper = Sets.filter(transaction.getRemovedOperationalData(), dataBroker.createIsContainedPredicate(affectedPath));
164 return resolveChanges(affectedPath,originalOper,createdOper,updatedOper,removedOper);
167 private Optional<RootedChangeSet<P, D>> resolveConfigChange(P affectedPath) {
168 Map<P, D> originalConfig = dataBroker.deepGetBySubpath(transaction.getOriginalConfigurationData(),affectedPath);
169 Map<P, D> createdConfig = dataBroker.deepGetBySubpath(transaction.getCreatedConfigurationData(),affectedPath);
170 Map<P, D> updatedConfig = dataBroker.deepGetBySubpath(transaction.getUpdatedConfigurationData(),affectedPath);
171 Set<P> removedConfig = Sets.filter(transaction.getRemovedConfigurationData(), dataBroker.createIsContainedPredicate(affectedPath));
172 return resolveChanges(affectedPath,originalConfig,createdConfig,updatedConfig,removedConfig);
175 private Optional<RootedChangeSet<P,D>> resolveChanges(P affectedPath, Map<P, D> originalConfig, Map<P, D> createdConfig, Map<P, D> updatedConfig,Set<P> potentialDeletions) {
176 Predicate<P> isContained = dataBroker.createIsContainedPredicate(affectedPath);
178 if(createdConfig.isEmpty() && updatedConfig.isEmpty() && potentialDeletions.isEmpty()) {
179 return Optional.absent();
181 RootedChangeSet<P, D> changeSet = new RootedChangeSet<P,D>(affectedPath,originalConfig);
182 changeSet.addCreated(createdConfig);
184 for(Entry<P, D> entry : updatedConfig.entrySet()) {
185 if(originalConfig.containsKey(entry.getKey())) {
186 changeSet.addUpdated(entry);
188 changeSet.addCreated(entry);
192 for(Entry<P,D> entry : originalConfig.entrySet()) {
193 for(P deletion : potentialDeletions) {
194 if(isContained.apply(deletion)) {
195 changeSet.addRemoval(entry.getKey());
200 if(changeSet.isChange()) {
201 return Optional.of(changeSet);
203 return Optional.absent();
208 public void publishDataChangeEvent(final ImmutableList<ListenerStateCapture<P, D, DCL>> listeners) {
209 ExecutorService executor = this.dataBroker.getExecutor();
210 final Runnable notifyTask = new Runnable() {
213 for (final ListenerStateCapture<P, D, DCL> listenerSet : listeners) {
215 DataChangeEvent<P, D> changeEvent = listenerSet.createEvent(transaction);
216 for (final DataChangeListenerRegistration<P, D, DCL> listener : listenerSet.getListeners()) {
218 listener.getInstance().onDataChanged(changeEvent);
219 } catch (Exception e) {
220 log.error("Unhandled exception when invoking listener {}", listener);
227 executor.submit(notifyTask);
230 public RpcResult<TransactionStatus> rollback(final List<DataCommitTransaction<P, D>> transactions, final Exception e) {
231 for (final DataCommitTransaction<P, D> transaction : transactions) {
232 transaction.rollback();
234 Set<RpcError> _emptySet = Collections.<RpcError> emptySet();
235 return Rpcs.<TransactionStatus> getRpcResult(false, TransactionStatus.FAILED, _emptySet);