/**
* Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
*
* 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 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 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.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.DeviceFlowRegistry;
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.RemoveFlowInput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowOutput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowInput;
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);
}
@Override
public Future> 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 DeviceContext deviceContext = getDeviceContext();
final FlowHash flowHash = FlowHashFactory.create(input, deviceContext.getPrimaryConnectionContext().getFeatures().getVersion());
final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
final List ofFlowModInputs = FlowConvertor.toFlowModInputs(input, getVersion(), getDatapathId());
final ListenableFuture> future = processFlowModInputBuilders(ofFlowModInputs);
Futures.addCallback(future, new FutureCallback>() {
@Override
public void onSuccess(final RpcResult rpcResult) {
getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
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 void onFailure(final Throwable throwable) {
getMessageSpy().spyMessage(input.getImplementedInterface(), 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> removeFlow(final RemoveFlowInput input) {
LOG.trace("Calling remove flow for flow with ID ={}.", input.getFlowRef());
return this.handleServiceCall(new Function, ListenableFuture>>() {
@Override
public ListenableFuture> apply(final DataCrate data) {
final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, getVersion(),
getDatapathId());
final ListenableFuture> future = createResultForFlowMod(data, ofFlowModInput);
Futures.addCallback(future, new FutureCallback() {
@Override
public void onSuccess(final Object o) {
final DeviceContext deviceContext = getDeviceContext();
getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
FlowHash flowHash = FlowHashFactory.create(input, deviceContext.getPrimaryConnectionContext().getFeatures().getVersion());
deviceContext.getDeviceFlowRegistry().markToBeremoved(flowHash);
}
@Override
public void onFailure(final Throwable throwable) {
getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
StringBuffer errors = new StringBuffer();
try {
RpcResult result = future.get();
Collection 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;
}
});
}
@Override
public Future> updateFlow(final UpdateFlowInput input) {
final UpdateFlowInput in = input;
final UpdatedFlow updated = in.getUpdatedFlow();
final OriginalFlow original = in.getOriginalFlow();
final List allFlowMods = new ArrayList<>();
List ofFlowModInputs;
if (!FlowCreatorUtil.canModifyFlow(original, updated, getVersion())) {
// We would need to remove original and add updated.
// remove flow
final RemoveFlowInputBuilder removeflow = new RemoveFlowInputBuilder(original);
final List ofFlowRemoveInput = FlowConvertor.toFlowModInputs(removeflow.build(),
getVersion(), getDatapathId());
// remove flow should be the first
allFlowMods.addAll(ofFlowRemoveInput);
final AddFlowInputBuilder addFlowInputBuilder = new AddFlowInputBuilder(updated);
ofFlowModInputs = FlowConvertor.toFlowModInputs(addFlowInputBuilder.build(), getVersion(), getDatapathId());
} else {
ofFlowModInputs = FlowConvertor.toFlowModInputs(updated, getVersion(), getDatapathId());
}
allFlowMods.addAll(ofFlowModInputs);
ListenableFuture future = processFlowModInputBuilders(allFlowMods);
Futures.addCallback(future, new FutureCallback() {
@Override
public void onSuccess(final Object o) {
final DeviceContext deviceContext = getDeviceContext();
getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
final short version = deviceContext.getPrimaryConnectionContext().getFeatures().getVersion();
FlowHash flowHash = FlowHashFactory.create(original, version);
FlowHash updatedflowHash = FlowHashFactory.create(updated, version);
FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class, FlowKey.class).getId();
FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(updated.getTableId(), flowId);
final DeviceFlowRegistry deviceFlowRegistry = deviceContext.getDeviceFlowRegistry();
deviceFlowRegistry.markToBeremoved(flowHash);
deviceFlowRegistry.store(updatedflowHash, flowDescriptor);
}
@Override
public void onFailure(final Throwable throwable) {
getMessageSpy().spyMessage(input.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
}
});
return future;
}
private ListenableFuture> processFlowModInputBuilders(
final List ofFlowModInputs) {
final List>> partialFutures = new ArrayList<>();
for (FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
DataCrateBuilder dataCrateBuilder = DataCrateBuilder.builder().setFlowModInputBuilder(flowModInputBuilder);
ListenableFuture> partialFuture = handleServiceCall(
getPrimaryConnection(),
new Function, ListenableFuture>>() {
@Override
public ListenableFuture> apply(final DataCrate data) {
return createResultForFlowMod(data);
}
},
dataCrateBuilder
);
partialFutures.add(partialFuture);
}
// processing of final (optionally composite future)
final ListenableFuture>> allFutures = Futures.successfulAsList(partialFutures);
final SettableFuture> finalFuture = SettableFuture.create();
Futures.addCallback(allFutures, new FutureCallback>>() {
@Override
public void onSuccess(List> results) {
List rpcErrorLot = new ArrayList<>();
RpcResultBuilder resultBuilder;
Iterator flowModInputBldIterator = ofFlowModInputs.iterator();
Iterator> resultIterator = results.iterator();
for (ListenableFuture> partFutureFromRqCtx : partialFutures) {
FlowModInputBuilder flowModInputBld = flowModInputBldIterator.next();
RpcResult 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) {
final DeviceContext deviceContext = getDeviceContext();
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.success();
} else {
resultBuilder = RpcResultBuilder.failed().withRpcErrors(rpcErrorLot);
}
finalFuture.set(resultBuilder.build());
}
@Override
public void onFailure(Throwable t) {
LOG.trace("Flow mods chained future failed.");
RpcResultBuilder resultBuilder = RpcResultBuilder.failed()
.withError(ErrorType.APPLICATION, "", t.getMessage());
finalFuture.set(resultBuilder.build());
}
});
return finalFuture;
}
protected ListenableFuture> createResultForFlowMod(final DataCrate data) {
return createResultForFlowMod(data, data.getFlowModInputBuilder());
}
protected ListenableFuture> createResultForFlowMod(final DataCrate data, final FlowModInputBuilder flowModInputBuilder) {
final Xid xid = data.getRequestContext().getXid();
flowModInputBuilder.setXid(xid.getValue());
final FlowModInput flowModInput = flowModInputBuilder.build();
Future> flowModResult = provideConnectionAdapter(data.getiDConnection()).flowMod(
flowModInput);
final ListenableFuture> result = JdkFutureAdapters.listenInPoolThread(flowModResult);
return result;
}
}