2 * Copyright (c) 2015 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.impl.services;
10 import com.google.common.base.Function;
11 import com.google.common.util.concurrent.FutureCallback;
12 import com.google.common.util.concurrent.Futures;
13 import com.google.common.util.concurrent.JdkFutureAdapters;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import com.google.common.util.concurrent.SettableFuture;
16 import java.util.ArrayList;
17 import java.util.Collection;
18 import java.util.Iterator;
19 import java.util.List;
20 import java.util.concurrent.ExecutionException;
21 import java.util.concurrent.Future;
22 import org.opendaylight.openflowplugin.api.OFConstants;
23 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
24 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
25 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
26 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
27 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowHash;
28 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
29 import org.opendaylight.openflowplugin.impl.registry.flow.FlowDescriptorFactory;
30 import org.opendaylight.openflowplugin.impl.registry.flow.FlowHashFactory;
31 import org.opendaylight.openflowplugin.impl.util.FlowUtil;
32 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.FlowConvertor;
33 import org.opendaylight.openflowplugin.openflow.md.util.FlowCreatorUtil;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutput;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInput;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowOutput;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowInput;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutput;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.OriginalFlow;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlow;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInputBuilder;
50 import org.opendaylight.yangtools.yang.common.RpcError;
51 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
52 import org.opendaylight.yangtools.yang.common.RpcResult;
53 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
54 import org.slf4j.Logger;
56 public class SalFlowServiceImpl extends CommonService implements SalFlowService {
58 private static final Logger LOG = org.slf4j.LoggerFactory.getLogger(SalFlowServiceImpl.class);
60 public SalFlowServiceImpl(final RequestContextStack requestContextStack, final DeviceContext deviceContext) {
61 super(requestContextStack, deviceContext);
65 public Future<RpcResult<AddFlowOutput>> addFlow(final AddFlowInput input) {
67 if (null != input.getFlowRef()) {
68 flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
70 flowId = FlowUtil.createAlienFlowId(input.getTableId());
74 final FlowHash flowHash = FlowHashFactory.create(input, deviceContext);
75 final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
76 deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
78 final List<FlowModInputBuilder> ofFlowModInputs = FlowConvertor.toFlowModInputs(input, version, datapathId);
79 final ListenableFuture<RpcResult<AddFlowOutput>> future = processFlowModInputBuilders(ofFlowModInputs);
81 Futures.addCallback(future, new FutureCallback<RpcResult<AddFlowOutput>>() {
83 public void onSuccess(final RpcResult<AddFlowOutput> rpcResult) {
84 messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
85 if (rpcResult.isSuccessful()) {
86 LOG.debug("flow add finished without error, id={}", flowId.getValue());
88 LOG.debug("flow add failed with error, id={}", flowId.getValue());
93 public void onFailure(final Throwable throwable) {
94 messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
95 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
96 LOG.trace("Service call for adding flows failed, id={}.", flowId.getValue(), throwable);
104 public Future<RpcResult<RemoveFlowOutput>> removeFlow(final RemoveFlowInput input) {
105 LOG.trace("Calling remove flow for flow with ID ={}.", input.getFlowRef());
106 return this.<RemoveFlowOutput, Void>handleServiceCall(PRIMARY_CONNECTION,
107 new Function<DataCrate<RemoveFlowOutput>, ListenableFuture<RpcResult<Void>>>() {
109 public ListenableFuture<RpcResult<Void>> apply(final DataCrate<RemoveFlowOutput> data) {
110 final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, version,
112 final ListenableFuture<RpcResult<Void>> future = createResultForFlowMod(data, ofFlowModInput);
113 Futures.addCallback(future, new FutureCallback() {
115 public void onSuccess(final Object o) {
116 messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
117 FlowHash flowHash = FlowHashFactory.create(input, deviceContext);
118 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
122 public void onFailure(final Throwable throwable) {
123 messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
124 StringBuffer errors = new StringBuffer();
126 RpcResult<Void> result = future.get();
127 Collection<RpcError> rpcErrors = result.getErrors();
128 if (null != rpcErrors && rpcErrors.size() > 0) {
129 for (RpcError rpcError : rpcErrors) {
130 errors.append(rpcError.getMessage());
133 } catch (InterruptedException | ExecutionException e) {
134 LOG.trace("Flow modification failed. Can't read errors from RpcResult.");
136 LOG.trace("Flow modification failed. Errors : {}", errors.toString());
145 public Future<RpcResult<UpdateFlowOutput>> updateFlow(final UpdateFlowInput input) {
146 final UpdateFlowInput in = input;
147 final UpdatedFlow updated = in.getUpdatedFlow();
148 final OriginalFlow original = in.getOriginalFlow();
150 final List<FlowModInputBuilder> allFlowMods = new ArrayList<>();
151 List<FlowModInputBuilder> ofFlowModInputs;
153 if (!FlowCreatorUtil.canModifyFlow(original, updated, version)) {
154 // We would need to remove original and add updated.
157 final RemoveFlowInputBuilder removeflow = new RemoveFlowInputBuilder(original);
158 final List<FlowModInputBuilder> ofFlowRemoveInput = FlowConvertor.toFlowModInputs(removeflow.build(),
159 version, datapathId);
160 // remove flow should be the first
161 allFlowMods.addAll(ofFlowRemoveInput);
162 final AddFlowInputBuilder addFlowInputBuilder = new AddFlowInputBuilder(updated);
163 ofFlowModInputs = FlowConvertor.toFlowModInputs(addFlowInputBuilder.build(), version, datapathId);
165 ofFlowModInputs = FlowConvertor.toFlowModInputs(updated, version, datapathId);
168 allFlowMods.addAll(ofFlowModInputs);
169 ListenableFuture future = processFlowModInputBuilders(allFlowMods);
170 Futures.addCallback(future, new FutureCallback() {
172 public void onSuccess(final Object o) {
173 messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
174 FlowHash flowHash = FlowHashFactory.create(original, deviceContext);
175 deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
177 flowHash = FlowHashFactory.create(updated, deviceContext);
178 FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
179 FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(updated.getTableId(), flowId);
180 deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
185 public void onFailure(final Throwable throwable) {
186 messageSpy.spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
192 private <T> ListenableFuture<RpcResult<T>> processFlowModInputBuilders(
193 final List<FlowModInputBuilder> ofFlowModInputs) {
194 final List<ListenableFuture<RpcResult<T>>> partialFutures = new ArrayList<>();
196 for (FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
197 DataCrateBuilder<T> dataCrateBuilder = DataCrateBuilder.<T>builder().setFlowModInputBuilder(flowModInputBuilder);
198 ListenableFuture<RpcResult<T>> partialFuture = handleServiceCall(
200 new Function<DataCrate<T>, ListenableFuture<RpcResult<Void>>>() {
202 public ListenableFuture<RpcResult<Void>> apply(final DataCrate<T> data) {
203 return createResultForFlowMod(data);
208 partialFutures.add(partialFuture);
211 // processing of final (optionally composite future)
212 final ListenableFuture<List<RpcResult<T>>> allFutures = Futures.successfulAsList(partialFutures);
213 final SettableFuture<RpcResult<T>> finalFuture = SettableFuture.create();
214 Futures.addCallback(allFutures, new FutureCallback<List<RpcResult<T>>>() {
216 public void onSuccess(List<RpcResult<T>> results) {
217 List<RpcError> rpcErrorLot = new ArrayList<>();
218 RpcResultBuilder<T> resultBuilder;
220 Iterator<FlowModInputBuilder> flowModInputBldIterator = ofFlowModInputs.iterator();
221 Iterator<RpcResult<T>> resultIterator = results.iterator();
223 for (ListenableFuture<RpcResult<T>> partFutureFromRqCtx : partialFutures) {
224 FlowModInputBuilder flowModInputBld = flowModInputBldIterator.next();
225 RpcResult<T> result = resultIterator.next();
226 Long xid = flowModInputBld.getXid();
229 LOG.trace("flowMod future processing [{}], result={}", xid, result);
230 if (partFutureFromRqCtx.isCancelled()) { // one and only positive case
231 if (LOG.isTraceEnabled()) {
232 LOG.trace("flow future result was cancelled [{}] = barrier passed it without error", xid);
234 } else { // all negative cases
235 if (result == null) { // there is exception or null value set
237 partFutureFromRqCtx.get();
238 } catch (Exception e) {
239 rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
240 "flow future result [" + xid + "] failed with exception",
241 OFConstants.APPLICATION_TAG, e.getMessage(), e));
243 // xid might be not available in case requestContext not even stored
245 deviceContext.unhookRequestCtx(new Xid(xid));
249 if (result.isSuccessful()) { // positive confirmation - never happens
250 LOG.warn("Positive confirmation of flow push is not supported by OF-spec");
251 LOG.warn("flow future result was successful [{}] = this should have never happen",
253 rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
254 "flow future result was successful [" + xid + "] = this should have never happen"));
255 } else { // standard error occurred
256 LOG.trace("passing original rpcErrors [{}]", xid);
257 if (LOG.isTraceEnabled()) {
258 for (RpcError rpcError : result.getErrors()) {
259 LOG.trace("passed rpcError [{}]: {}", xid, rpcError);
262 rpcErrorLot.addAll(result.getErrors());
268 if (rpcErrorLot.isEmpty()) {
269 resultBuilder = RpcResultBuilder.<T>success();
271 resultBuilder = RpcResultBuilder.<T>failed().withRpcErrors(rpcErrorLot);
274 finalFuture.set(resultBuilder.build());
278 public void onFailure(Throwable t) {
279 LOG.trace("Flow mods chained future failed.");
280 RpcResultBuilder<T> resultBuilder = RpcResultBuilder.<T>failed()
281 .withError(ErrorType.APPLICATION, "", t.getMessage());
282 finalFuture.set(resultBuilder.build());
289 protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data) {
290 return createResultForFlowMod(data, data.getFlowModInputBuilder());
293 protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data, final FlowModInputBuilder flowModInputBuilder) {
294 final Xid xid = data.getRequestContext().getXid();
295 flowModInputBuilder.setXid(xid.getValue());
296 final FlowModInput flowModInput = flowModInputBuilder.build();
297 Future<RpcResult<Void>> flowModResult = provideConnectionAdapter(data.getiDConnection()).flowMod(
300 final ListenableFuture<RpcResult<Void>> result = JdkFutureAdapters.listenInPoolThread(flowModResult);