2 * Copyright (c) 2013 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.openflowplugin.openflow.md.core.sal;
10 import com.google.common.base.Function;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.collect.Lists;
13 import com.google.common.util.concurrent.AsyncFunction;
14 import com.google.common.util.concurrent.FutureCallback;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import java.util.ArrayList;
18 import java.util.Collection;
19 import java.util.Collections;
20 import java.util.List;
21 import java.util.concurrent.Future;
22 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
23 import org.opendaylight.openflowplugin.api.OFConstants;
24 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
25 import org.opendaylight.openflowplugin.api.openflow.md.core.sal.NotificationComposer;
26 import org.opendaylight.openflowplugin.api.openflow.statistics.MessageSpy;
27 import org.opendaylight.openflowplugin.openflow.md.util.RpcInputOutputTuple;
28 import org.opendaylight.openflowplugin.openflow.md.util.TaskUtil;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierInput;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput;
32 import org.opendaylight.yangtools.yang.binding.DataContainer;
33 import org.opendaylight.yangtools.yang.binding.Notification;
34 import org.opendaylight.yangtools.yang.common.RpcError;
35 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
36 import org.opendaylight.yangtools.yang.common.RpcResult;
37 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
44 public abstract class OFRpcTaskUtil {
45 protected static final Logger LOG = LoggerFactory.getLogger(OFRpcTaskUtil.class);
50 * @return rpcResult of given type, containing wrapped errors of barrier sending (if any) or success
52 private OFRpcTaskUtil() {
53 //hiding implicit constructor
56 public static Collection<RpcError> manageBarrier(final OFRpcTaskContext taskContext, final Boolean isBarrier,
57 final SwitchConnectionDistinguisher cookie) {
58 Collection<RpcError> errors = null;
59 if (MoreObjects.firstNonNull(isBarrier, Boolean.FALSE)) {
60 RpcInputOutputTuple<BarrierInput, ListenableFuture<RpcResult<BarrierOutput>>> sendBarrierRpc =
61 TaskUtil.sendBarrier(taskContext.getSession(), cookie, taskContext.getMessageService());
62 Future<RpcResult<BarrierOutput>> barrierFuture = sendBarrierRpc.getOutput();
64 RpcResult<BarrierOutput> barrierResult = barrierFuture.get(
65 taskContext.getMaxTimeout(), taskContext.getMaxTimeoutUnit());
66 if (!barrierResult.isSuccessful()) {
67 errors = barrierResult.getErrors();
69 } catch (Exception e) {
70 RpcError rpcError = RpcResultBuilder.newWarning(
72 OFConstants.ERROR_TAG_TIMEOUT,
73 "barrier sending failed",
74 OFConstants.APPLICATION_TAG,
75 "switch failed to respond on barrier request - message ordering is not preserved",
77 errors = Lists.newArrayList(rpcError);
82 errors = Collections.emptyList();
90 * @param originalResult original result
91 * @param notificationProviderService notification provider service
92 * @param notificationComposer lazy notification composer
93 * @param <I> data container
94 * @param <N> notification
97 public static <R extends RpcResult<? extends TransactionAware>, N extends Notification, I extends DataContainer>
98 void hookFutureNotification(
99 final OFRpcTask<I, R> task,
100 final ListenableFuture<R> originalResult,
101 final NotificationProviderService notificationProviderService,
102 final NotificationComposer<N> notificationComposer) {
104 class FutureCallbackImpl implements FutureCallback<R> {
106 public void onSuccess(final R result) {
107 if(null == notificationProviderService) {
108 LOG.warn("onSuccess(): notificationServiceProvider is null, could not publish result {}",result);
109 } else if (notificationComposer == null) {
110 LOG.warn("onSuccess(): notificationComposer is null, could not publish result {}",result);
111 } else if(result == null) {
112 LOG.warn("onSuccess(): result is null, could not publish result {}",result);
113 } else if (result.getResult() == null) {
114 LOG.warn("onSuccess(): result.getResult() is null, could not publish result {}",result);
115 } else if (result.getResult().getTransactionId() == null) {
116 LOG.warn("onSuccess(): result.getResult().getTransactionId() is null, could not publish result {}",result);
118 notificationProviderService.publish(notificationComposer.compose(result.getResult().getTransactionId()));
119 task.getTaskContext().getMessageSpy().spyMessage(
120 task.getInput(), MessageSpy.StatisticsGroup.TO_SWITCH_SUBMITTED_SUCCESS);
125 public void onFailure(final Throwable t) {
126 //TODO: good place to notify MD-SAL about errors
127 task.getTaskContext().getMessageSpy().spyMessage(
128 task.getInput(), MessageSpy.StatisticsGroup.TO_SWITCH_SUBMITTED_FAILURE);
132 Futures.addCallback(originalResult, new FutureCallbackImpl());
137 * @param originalResult original result
140 * @return chained result with barrier
142 public static <T extends TransactionAware, I extends DataContainer>
143 ListenableFuture<RpcResult<T>> chainFutureBarrier(
144 final OFRpcTask<I, RpcResult<T>> task,
145 final ListenableFuture<RpcResult<T>> originalResult) {
147 ListenableFuture<RpcResult<T>> chainResult = originalResult;
148 if (MoreObjects.firstNonNull(task.isBarrier(), Boolean.FALSE)) {
150 chainResult = Futures.transform(originalResult, new AsyncFunction<RpcResult<T>, RpcResult<T>>() {
153 public ListenableFuture<RpcResult<T>> apply(final RpcResult<T> input) throws Exception {
154 if (input.isSuccessful()) {
155 RpcInputOutputTuple<BarrierInput, ListenableFuture<RpcResult<BarrierOutput>>> sendBarrierRpc = TaskUtil.sendBarrier(
156 task.getSession(), task.getCookie(), task.getMessageService());
157 ListenableFuture<RpcResult<T>> barrierTxResult = Futures.transform(
158 sendBarrierRpc.getOutput(),
159 transformBarrierToTransactionAware(input, sendBarrierRpc.getInput()));
160 return barrierTxResult;
162 return Futures.immediateFuture(input);
173 * @param originalInput original input
174 * @param barrierInput barrier input
178 protected static <T extends TransactionAware> Function<RpcResult<BarrierOutput>, RpcResult<T>> transformBarrierToTransactionAware(
179 final RpcResult<T> originalInput, final BarrierInput barrierInput) {
181 class FunctionImpl implements Function<RpcResult<BarrierOutput>, RpcResult<T>> {
184 public RpcResult<T> apply(final RpcResult<BarrierOutput> barrierResult) {
185 RpcResultBuilder<T> rpcBuilder = null;
186 if (barrierResult.isSuccessful()) {
187 rpcBuilder = RpcResultBuilder.<T>success();
189 rpcBuilder = RpcResultBuilder.<T>failed();
190 RpcError rpcError = RpcResultBuilder.newWarning(
192 OFConstants.ERROR_TAG_TIMEOUT,
193 "barrier sending failed",
194 OFConstants.APPLICATION_TAG,
195 "switch failed to respond on barrier request, barrier.xid = "+barrierInput.getXid(),
197 List<RpcError> chainedErrors = new ArrayList<>();
198 chainedErrors.add(rpcError);
199 chainedErrors.addAll(barrierResult.getErrors());
200 rpcBuilder.withRpcErrors(chainedErrors);
203 rpcBuilder.withResult(originalInput.getResult());
205 return rpcBuilder.build();
209 return new FunctionImpl();