/**
* 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.math.BigInteger;
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.device.DeviceContext;
import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
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.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);
}
ListenableFuture> handleServiceCall(final BigInteger connectionID,
final FlowModInputBuilder flowModInputBuilder, final Function, ListenableFuture>> function) {
LOG.debug("Calling the FlowMod RPC method on MessageDispatchService");
final RequestContext requestContext = requestContextStack.createRequestContext();
final SettableFuture> result = requestContextStack.storeOrFail(requestContext);
if (!result.isDone()) {
final DataCrate dataCrate = DataCrateBuilder.builder().setiDConnection(connectionID)
.setRequestContext(requestContext).setFlowModInputBuilder(flowModInputBuilder).build();
requestContext.setXid(deviceContext.getNextXid());
LOG.trace("Hooking xid {} to device context - precaution.", requestContext.getXid().getValue());
deviceContext.hookRequestCtx(requestContext.getXid(), requestContext);
final ListenableFuture> resultFromOFLib = function.apply(dataCrate);
final OFJResult2RequestCtxFuture OFJResult2RequestCtxFuture = new OFJResult2RequestCtxFuture<>(requestContext, deviceContext);
OFJResult2RequestCtxFuture.processResultFromOfJava(resultFromOFLib);
} else {
RequestContextUtil.closeRequstContext(requestContext);
}
return result;
}
@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 FlowHash flowHash = FlowHashFactory.create(input);
final FlowDescriptor flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId);
deviceContext.getDeviceFlowRegistry().store(flowHash, flowDescriptor);
final List ofFlowModInputs = FlowConvertor.toFlowModInputs(input, version, datapathId);
final ListenableFuture future = processFlowModInputBuilders(ofFlowModInputs);
Futures.addCallback(future, new FutureCallback() {
@Override
public void onSuccess(final Object o) {
messageSpy.spyMessage(input, MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_SUCCESS);
LOG.debug("flow add finished without error, id={}", flowId.getValue());
}
@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> removeFlow(final RemoveFlowInput input) {
LOG.trace("Calling remove flow for flow with ID ={}.", input.getFlowRef());
return this.handleServiceCall(PRIMARY_CONNECTION,
new Function, ListenableFuture>>() {
@Override
public ListenableFuture> apply(final DataCrate data) {
final FlowModInputBuilder ofFlowModInput = FlowConvertor.toFlowModInput(input, version,
datapathId);
final ListenableFuture> 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 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, version)) {
// We would need to remove original and add updated.
// remove flow
final RemoveFlowInputBuilder removeflow = new RemoveFlowInputBuilder(original);
final List ofFlowRemoveInput = FlowConvertor.toFlowModInputs(removeflow.build(),
version, datapathId);
// remove flow should be the first
allFlowMods.addAll(ofFlowRemoveInput);
final AddFlowInputBuilder addFlowInputBuilder = new AddFlowInputBuilder(updated);
ofFlowModInputs = FlowConvertor.toFlowModInputs(addFlowInputBuilder.build(), version, datapathId);
} else {
ofFlowModInputs = FlowConvertor.toFlowModInputs(updated, version, datapathId);
}
allFlowMods.addAll(ofFlowModInputs);
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 ListenableFuture> processFlowModInputBuilders(
final List ofFlowModInputs) {
final List>> partialFutures = new ArrayList<>();
for (FlowModInputBuilder flowModInputBuilder : ofFlowModInputs) {
ListenableFuture> partialFuture = handleServiceCall(PRIMARY_CONNECTION, flowModInputBuilder,
new Function, ListenableFuture>>() {
@Override
public ListenableFuture> apply(final DataCrate data) {
return createResultForFlowMod(data);
}
});
partialFutures.add(partialFuture);
}
final ListenableFuture>> allFutures = Futures.allAsList(partialFutures);
final SettableFuture> finalFuture = SettableFuture.create();
Futures.addCallback(allFutures, new FutureCallback>>() {
@Override
public void onSuccess(List> results) {
Iterator flowModInputBldIterator = ofFlowModInputs.iterator();
List rpcErrorLot = new ArrayList<>();
for (RpcResult rpcResult : results) {
FlowModInputBuilder flowModInputBld = flowModInputBldIterator.next();
if (rpcResult.isSuccessful()) {
Long xid = flowModInputBld.getXid();
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 {
rpcErrorLot.addAll(rpcResult.getErrors());
}
}
finalFuture.set(RpcResultBuilder.failed().withRpcErrors(rpcErrorLot).build());
}
@Override
public void onFailure(Throwable t) {
LOG.trace("Flow mods chained future failed.");
RpcResultBuilder resultBuilder;
if (allFutures.isCancelled()) {
if (LOG.isTraceEnabled()) {
for (FlowModInputBuilder ofFlowModInput : ofFlowModInputs) {
LOG.trace("flow future result was cancelled [{}] = barrier passed it without error",
ofFlowModInput.getXid());
}
}
resultBuilder = RpcResultBuilder.success();
} else {
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);
final RequestContext requestContext = data.getRequestContext();
Futures.addCallback(result, new FutureCallback>() {
@Override
public void onSuccess(final RpcResult voidRpcResult) {
if (!voidRpcResult.isSuccessful()) {
// remove current request from request cache in deviceContext
messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
deviceContext.getRequests().remove(requestContext.getXid().getValue());
// handle requestContext failure
StringBuilder rpcErrors = new StringBuilder();
if (null != voidRpcResult.getErrors() && voidRpcResult.getErrors().size() > 0) {
for (RpcError error : voidRpcResult.getErrors()) {
rpcErrors.append(error.getMessage());
}
}
LOG.trace("OF Java result for XID {} was not successful. Errors : {}", requestContext.getXid().getValue(), rpcErrors.toString());
requestContext.getFuture().set(
RpcResultBuilder.failed().withRpcErrors(voidRpcResult.getErrors()).build());
RequestContextUtil.closeRequstContext(requestContext);
}
}
@Override
public void onFailure(final Throwable throwable) {
if (result.isCancelled()) {
messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
LOG.trace("Asymmetric message - no response from OF Java expected for XID {}. Closing as successful.", requestContext.getXid().getValue());
requestContext.getFuture().set(RpcResultBuilder.success().build());
} else {
messageSpy.spyMessage(flowModInput, MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
LOG.trace("Exception occured while processing OF Java response for XID {}.", requestContext.getXid().getValue(), throwable);
requestContext.getFuture().set(
RpcResultBuilder.failed()
.withError(RpcError.ErrorType.APPLICATION, "", "Flow translation to OF JAVA failed.")
.build());
}
RequestContextUtil.closeRequstContext(requestContext);
}
});
return result;
}
}