/**
* Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
- *
+ * <p/>
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.openflowplugin.impl.services;
-import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
-import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
-import org.opendaylight.openflowplugin.api.openflow.device.Xid;
-import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
-import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
-import com.google.common.util.concurrent.FutureCallback;
-import com.google.common.util.concurrent.SettableFuture;
-import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
-import org.opendaylight.yangtools.yang.binding.DataObject;
import com.google.common.base.Function;
+import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.JdkFutureAdapters;
import com.google.common.util.concurrent.ListenableFuture;
-import java.math.BigInteger;
+import com.google.common.util.concurrent.SettableFuture;
import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Iterator;
import java.util.List;
+import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
-import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
+import org.opendaylight.openflowplugin.api.OFConstants;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
+import org.opendaylight.openflowplugin.api.openflow.device.Xid;
+import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
+import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowHash;
+import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
+import org.opendaylight.openflowplugin.impl.registry.flow.FlowDescriptorFactory;
+import org.opendaylight.openflowplugin.impl.registry.flow.FlowHashFactory;
+import org.opendaylight.openflowplugin.impl.util.FlowUtil;
import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.FlowConvertor;
import org.opendaylight.openflowplugin.openflow.md.util.FlowCreatorUtil;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.OriginalFlow;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlow;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInputBuilder;
+import org.opendaylight.yangtools.yang.common.RpcError;
+import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
import org.slf4j.Logger;
public class SalFlowServiceImpl extends CommonService implements SalFlowService {
private static final Logger LOG = org.slf4j.LoggerFactory.getLogger(SalFlowServiceImpl.class);
-
public SalFlowServiceImpl(final RequestContextStack requestContextStack, final DeviceContext deviceContext) {
super(requestContextStack, deviceContext);
}
- <T extends DataObject, F> ListenableFuture<RpcResult<T>> handleServiceCall(final BigInteger connectionID,
- final FlowModInputBuilder flowModInputBuilder, final Function<DataCrate<T>, Future<RpcResult<F>>> function) {
- LOG.debug("Calling the FlowMod RPC method on MessageDispatchService");
+ @Override
+ public Future<RpcResult<AddFlowOutput>> addFlow(final AddFlowInput input) {
+ final FlowId flowId;
+ if (null != input.getFlowRef()) {
+ flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
+ } else {
+ flowId = FlowUtil.createAlienFlowId(input.getTableId());
+ }
- final RequestContext<T> requestContext = requestContextStack.createRequestContext();
- final SettableFuture<RpcResult<T>> result = requestContextStack.storeOrFail(requestContext);
- final DataCrate<T> dataCrate = DataCrateBuilder.<T> builder().setiDConnection(connectionID)
- .setRequestContext(requestContext).setFlowModInputBuilder(flowModInputBuilder).build();
- if (!result.isDone()) {
- final Future<RpcResult<F>> resultFromOFLib = function.apply(dataCrate);
+ final FlowHash flowHash = FlowHashFactory.create(input);
+ final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
+ deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
- final RpcResultConvertor<T> rpcResultConvertor = new RpcResultConvertor<>(requestContext, deviceContext);
- rpcResultConvertor.processResultFromOfJava(resultFromOFLib);
+ final List<FlowModInputBuilder> ofFlowModInputs = FlowConvertor.toFlowModInputs(input, version, datapathId);
+ final ListenableFuture<RpcResult<AddFlowOutput>> future = processFlowModInputBuilders(ofFlowModInputs);
- } else {
- RequestContextUtil.closeRequstContext(requestContext);
- }
- return result;
- }
+ Futures.addCallback(future, new FutureCallback<RpcResult<AddFlowOutput>>() {
+ @Override
+ public void onSuccess(final RpcResult<AddFlowOutput> rpcResult) {
+ messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
+ if (rpcResult.isSuccessful()) {
+ LOG.debug("flow add finished without error, id={}", flowId.getValue());
+ } else {
+ LOG.debug("flow add failed with error, id={}", flowId.getValue());
+ }
+ }
- @Override
- public Future<RpcResult<AddFlowOutput>> addFlow(final AddFlowInput input) {
- final List<FlowModInputBuilder> ofFlowModInputs = FlowConvertor.toFlowModInputs(input, version, datapathId);
- return processFlowModInputBuilders(ofFlowModInputs);
+ @Override
+ public void onFailure(final Throwable throwable) {
+ messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
+ deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
+ LOG.trace("Service call for adding flows failed, id={}.", flowId.getValue(), throwable);
+ }
+ });
+
+ return future;
}
@Override
public Future<RpcResult<RemoveFlowOutput>> removeFlow(final RemoveFlowInput input) {
-
- return this.<RemoveFlowOutput, Void> handleServiceCall(PRIMARY_CONNECTION,
- new Function<DataCrate<RemoveFlowOutput>, Future<RpcResult<Void>>>() {
+ LOG.trace("Calling remove flow for flow with ID ={}.", input.getFlowRef());
+ return this.<RemoveFlowOutput, Void>handleServiceCall(PRIMARY_CONNECTION,
+ new Function<DataCrate<RemoveFlowOutput>, ListenableFuture<RpcResult<Void>>>() {
@Override
- public Future<RpcResult<Void>> apply(final DataCrate<RemoveFlowOutput> data) {
+ public ListenableFuture<RpcResult<Void>> apply(final DataCrate<RemoveFlowOutput> data) {
final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, version,
datapathId);
- return createResultForFlowMod(data, ofFlowModInput);
+ final ListenableFuture<RpcResult<Void>> future = createResultForFlowMod(data, ofFlowModInput);
+ Futures.addCallback(future, new FutureCallback() {
+ @Override
+ public void onSuccess(final Object o) {
+ messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
+ FlowHash flowHash = FlowHashFactory.create(input);
+ deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
+ }
+
+ @Override
+ public void onFailure(final Throwable throwable) {
+ messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
+ StringBuffer errors = new StringBuffer();
+ try {
+ RpcResult<Void> result = future.get();
+ Collection<RpcError> rpcErrors = result.getErrors();
+ if (null != rpcErrors && rpcErrors.size() > 0) {
+ for (RpcError rpcError : rpcErrors) {
+ errors.append(rpcError.getMessage());
+ }
+ }
+ } catch (InterruptedException | ExecutionException e) {
+ LOG.trace("Flow modification failed. Can't read errors from RpcResult.");
+ }
+ LOG.trace("Flow modification failed. Errors : {}", errors.toString());
+ }
+ });
+ return future;
}
});
}
}
allFlowMods.addAll(ofFlowModInputs);
- return processFlowModInputBuilders(allFlowMods);
+ ListenableFuture future = processFlowModInputBuilders(allFlowMods);
+ Futures.addCallback(future, new FutureCallback() {
+ @Override
+ public void onSuccess(final Object o) {
+ messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
+ FlowHash flowHash = FlowHashFactory.create(original);
+ deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
+
+ flowHash = FlowHashFactory.create(updated);
+ FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
+ FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(updated.getTableId(), flowId);
+ deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
+
+ }
+
+ @Override
+ public void onFailure(final Throwable throwable) {
+ messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
+ }
+ });
+ return future;
}
- private <T extends DataObject> Future<RpcResult<T>> processFlowModInputBuilders(
+ private <T> ListenableFuture<RpcResult<T>> processFlowModInputBuilders(
final List<FlowModInputBuilder> ofFlowModInputs) {
final List<ListenableFuture<RpcResult<T>>> partialFutures = new ArrayList<>();
+
for (FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
- ListenableFuture<RpcResult<T>> partialFuture = handleServiceCall(PRIMARY_CONNECTION, flowModInputBuilder,
- new Function<DataCrate<T>, Future<RpcResult<Void>>>() {
+ DataCrateBuilder<T> dataCrateBuilder = DataCrateBuilder.<T>builder().setFlowModInputBuilder(flowModInputBuilder);
+ ListenableFuture<RpcResult<T>> partialFuture = handleServiceCall(
+ PRIMARY_CONNECTION,
+ new Function<DataCrate<T>, ListenableFuture<RpcResult<Void>>>() {
@Override
public ListenableFuture<RpcResult<Void>> apply(final DataCrate<T> data) {
return createResultForFlowMod(data);
}
- });
+ },
+ dataCrateBuilder
+ );
partialFutures.add(partialFuture);
}
- ListenableFuture<List<RpcResult<T>>> allFutures = Futures.allAsList(partialFutures);
+ // processing of final (optionally composite future)
+ final ListenableFuture<List<RpcResult<T>>> allFutures = Futures.successfulAsList(partialFutures);
final SettableFuture<RpcResult<T>> finalFuture = SettableFuture.create();
Futures.addCallback(allFutures, new FutureCallback<List<RpcResult<T>>>() {
@Override
- public void onSuccess(List<RpcResult<T>> result) {
- for (RpcResult<T> rpcResult : result) {
- if (rpcResult.isSuccessful()) {
- // TODO: AddFlowOutput has getTransactionId() - shouldn't it have some value?
- finalFuture.set(RpcResultBuilder.<T> success().build());
+ public void onSuccess(List<RpcResult<T>> results) {
+ List<RpcError> rpcErrorLot = new ArrayList<>();
+ RpcResultBuilder<T> resultBuilder;
+
+ Iterator<FlowModInputBuilder> flowModInputBldIterator = ofFlowModInputs.iterator();
+ Iterator<RpcResult<T>> resultIterator = results.iterator();
+
+ for (ListenableFuture<RpcResult<T>> partFutureFromRqCtx : partialFutures) {
+ FlowModInputBuilder flowModInputBld = flowModInputBldIterator.next();
+ RpcResult<T> result = resultIterator.next();
+ Long xid = flowModInputBld.getXid();
+
+
+ LOG.trace("flowMod future processing [{}], result={}", xid, result);
+ if (partFutureFromRqCtx.isCancelled()) { // one and only positive case
+ if (LOG.isTraceEnabled()) {
+ LOG.trace("flow future result was cancelled [{}] = barrier passed it without error", xid);
+ }
+ } else { // all negative cases
+ if (result == null) { // there is exception or null value set
+ try {
+ partFutureFromRqCtx.get();
+ } catch (Exception e) {
+ rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
+ "flow future result [" + xid + "] failed with exception",
+ OFConstants.APPLICATION_TAG, e.getMessage(), e));
+
+ // xid might be not available in case requestContext not even stored
+ if (xid != null) {
+ deviceContext.unhookRequestCtx(new Xid(xid));
+ }
+ }
+ } else {
+ if (result.isSuccessful()) { // positive confirmation - never happens
+ LOG.warn("Positive confirmation of flow push is not supported by OF-spec");
+ LOG.warn("flow future result was successful [{}] = this should have never happen",
+ xid);
+ rpcErrorLot.add(RpcResultBuilder.newError(ErrorType.APPLICATION, "",
+ "flow future result was successful [" + xid + "] = this should have never happen"));
+ } else { // standard error occurred
+ LOG.trace("passing original rpcErrors [{}]", xid);
+ if (LOG.isTraceEnabled()) {
+ for (RpcError rpcError : result.getErrors()) {
+ LOG.trace("passed rpcError [{}]: {}", xid, rpcError);
+ }
+ }
+ rpcErrorLot.addAll(result.getErrors());
+ }
+ }
}
}
+
+ if (rpcErrorLot.isEmpty()) {
+ resultBuilder = RpcResultBuilder.<T>success();
+ } else {
+ resultBuilder = RpcResultBuilder.<T>failed().withRpcErrors(rpcErrorLot);
+ }
+
+ finalFuture.set(resultBuilder.build());
}
@Override
public void onFailure(Throwable t) {
- finalFuture.set(RpcResultBuilder.<T> failed().withError(ErrorType.APPLICATION, "", t.getMessage())
- .build());
+ LOG.trace("Flow mods chained future failed.");
+ RpcResultBuilder<T> resultBuilder = RpcResultBuilder.<T>failed()
+ .withError(ErrorType.APPLICATION, "", t.getMessage());
+ finalFuture.set(resultBuilder.build());
}
});
return finalFuture;
}
- protected <T extends DataObject> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data) {
- return createResultForFlowMod(data, data.getFlowModInputBuilder()) ;
+ protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data) {
+ return createResultForFlowMod(data, data.getFlowModInputBuilder());
}
- protected <T extends DataObject> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data, final FlowModInputBuilder flowModInput) {
- final Xid xId = deviceContext.getNextXid();
- flowModInput.setXid(xId.getValue());
- data.getRequestContext().setXid(xId);
+ protected <T> ListenableFuture<RpcResult<Void>> createResultForFlowMod(final DataCrate<T> data, final FlowModInputBuilder flowModInputBuilder) {
+ final Xid xid = data.getRequestContext().getXid();
+ flowModInputBuilder.setXid(xid.getValue());
+ final FlowModInput flowModInput = flowModInputBuilder.build();
Future<RpcResult<Void>> flowModResult = provideConnectionAdapter(data.getiDConnection()).flowMod(
- flowModInput.build());
- return JdkFutureAdapters.listenInPoolThread(flowModResult);
+ flowModInput);
+
+ final ListenableFuture<RpcResult<Void>> result = JdkFutureAdapters.listenInPoolThread(flowModResult);
+ return result;
}
}
Code Review / openflowplugin.git / blobdiff