/* * 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.sal; import com.google.common.collect.EvictingQueue; import com.google.common.collect.Queues; import com.google.common.util.concurrent.FutureCallback; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.MoreExecutors; import com.google.common.util.concurrent.SettableFuture; import java.time.LocalDateTime; import java.util.ArrayList; import java.util.List; import java.util.Queue; import org.opendaylight.openflowplugin.api.OFConstants; import org.opendaylight.openflowplugin.api.openflow.FlowGroupCache; import org.opendaylight.openflowplugin.api.openflow.FlowGroupCacheManager; import org.opendaylight.openflowplugin.api.openflow.FlowGroupStatus; import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext; import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack; 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.FlowRegistryKey; import org.opendaylight.openflowplugin.impl.registry.flow.FlowDescriptorFactory; import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory; import org.opendaylight.openflowplugin.impl.services.multilayer.MultiLayerFlowService; import org.opendaylight.openflowplugin.impl.services.singlelayer.SingleLayerFlowService; import org.opendaylight.openflowplugin.impl.util.ErrorUtil; import org.opendaylight.openflowplugin.impl.util.FlowCreatorUtil; import org.opendaylight.openflowplugin.impl.util.PathUtil; import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor; 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.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.inventory.rev130819.NodeId; 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.RpcResult; import org.opendaylight.yangtools.yang.common.RpcResultBuilder; import org.opendaylight.yangtools.yang.common.Uint8; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class SalFlowServiceImpl implements SalFlowService { private static final Logger LOG = LoggerFactory.getLogger(SalFlowServiceImpl.class); private final MultiLayerFlowService flowUpdate; private final MultiLayerFlowService flowAdd; private final MultiLayerFlowService flowRemove; private final SingleLayerFlowService flowAddMessage; private final SingleLayerFlowService flowUpdateMessage; private final SingleLayerFlowService flowRemoveMessage; private final DeviceContext deviceContext; private static final Uint8 OFPTT_ALL = Uint8.MAX_VALUE; private final FlowGroupCacheManager provider; public static final int FLOWGROUP_CACHE_SIZE = 10000; public SalFlowServiceImpl(final RequestContextStack requestContextStack, final DeviceContext deviceContext, final ConvertorExecutor convertorExecutor, final FlowGroupCacheManager provider) { this.deviceContext = deviceContext; this.provider = provider; flowRemove = new MultiLayerFlowService<>(requestContextStack, deviceContext, RemoveFlowOutput.class, convertorExecutor); flowAdd = new MultiLayerFlowService<>(requestContextStack, deviceContext, AddFlowOutput.class, convertorExecutor); flowUpdate = new MultiLayerFlowService<>(requestContextStack, deviceContext, UpdateFlowOutput.class, convertorExecutor); flowAddMessage = new SingleLayerFlowService<>(requestContextStack, deviceContext, AddFlowOutput.class); flowUpdateMessage = new SingleLayerFlowService<>(requestContextStack, deviceContext, UpdateFlowOutput.class); flowRemoveMessage = new SingleLayerFlowService<>(requestContextStack, deviceContext, RemoveFlowOutput.class); } @Override public ListenableFuture> addFlow(final AddFlowInput input) { final FlowRegistryKey flowRegistryKey = FlowRegistryKeyFactory.create(deviceContext.getDeviceInfo().getVersion(), input); final ListenableFuture> future; NodeId nodeId = PathUtil.extractNodeId(input.getNode()); if (flowAddMessage.canUseSingleLayerSerialization()) { future = flowAddMessage.handleServiceCall(input); Futures.addCallback(future, new AddFlowCallback(input, flowRegistryKey, nodeId), MoreExecutors.directExecutor()); } else { future = flowAdd.processFlowModInputBuilders(flowAdd.toFlowModInputs(input)); Futures.addCallback(future, new AddFlowCallback(input, flowRegistryKey, nodeId), MoreExecutors.directExecutor()); } return future; } @Override public ListenableFuture> removeFlow(final RemoveFlowInput input) { final ListenableFuture> future; NodeId nodeId = PathUtil.extractNodeId(input.getNode()); if (flowRemoveMessage.canUseSingleLayerSerialization()) { future = flowRemoveMessage.handleServiceCall(input); Futures.addCallback(future, new RemoveFlowCallback(input, nodeId), MoreExecutors.directExecutor()); } else { future = flowRemove.processFlowModInputBuilders(flowRemove.toFlowModInputs(input)); Futures.addCallback(future, new RemoveFlowCallback(input, nodeId), MoreExecutors.directExecutor()); } return future; } @Override public ListenableFuture> updateFlow(final UpdateFlowInput input) { final UpdatedFlow updated = input.getUpdatedFlow(); final OriginalFlow original = input.getOriginalFlow(); String nodeId = PathUtil.extractNodeId(input.getNode()).getValue(); final List allFlowMods = new ArrayList<>(); final List ofFlowModInputs; ListenableFuture> future; if (flowUpdateMessage.canUseSingleLayerSerialization()) { if (!FlowCreatorUtil.canModifyFlow(original, updated, flowUpdateMessage.getVersion())) { final SettableFuture> objectSettableFuture = SettableFuture.create(); final ListenableFuture>> listListenableFuture = Futures.successfulAsList(flowUpdateMessage.handleServiceCall(input.getOriginalFlow()), flowUpdateMessage.handleServiceCall(input.getUpdatedFlow())); Futures.addCallback(listListenableFuture, new FutureCallback>>() { @Override public void onSuccess(final List> results) { final ArrayList errors = new ArrayList(); for (RpcResult flowModResult : results) { if (flowModResult == null) { errors.add(RpcResultBuilder.newError( RpcError.ErrorType.PROTOCOL, OFConstants.APPLICATION_TAG, "unexpected flowMod result (null) occurred")); } else if (!flowModResult.isSuccessful()) { errors.addAll(flowModResult.getErrors()); } } final RpcResultBuilder rpcResultBuilder; if (errors.isEmpty()) { rpcResultBuilder = RpcResultBuilder.success(); } else { rpcResultBuilder = RpcResultBuilder.failed().withRpcErrors(errors); } objectSettableFuture.set(rpcResultBuilder.build()); } @Override public void onFailure(final Throwable throwable) { RpcResultBuilder rpcResultBuilder = RpcResultBuilder.failed(); objectSettableFuture.set(rpcResultBuilder.build()); } }, MoreExecutors.directExecutor()); future = objectSettableFuture; } else { future = flowUpdateMessage.handleServiceCall(input.getUpdatedFlow()); } } else { if (!FlowCreatorUtil.canModifyFlow(original, updated, flowUpdate.getVersion())) { // We would need to remove original and add updated. // remove flow final RemoveFlowInputBuilder removeflow = new RemoveFlowInputBuilder(original); final List ofFlowRemoveInput = flowUpdate.toFlowModInputs(removeflow.build()); // remove flow should be the first allFlowMods.addAll(ofFlowRemoveInput); final AddFlowInputBuilder addFlowInputBuilder = new AddFlowInputBuilder(updated); ofFlowModInputs = flowUpdate.toFlowModInputs(addFlowInputBuilder.build()); } else { ofFlowModInputs = flowUpdate.toFlowModInputs(updated); } allFlowMods.addAll(ofFlowModInputs); future = flowUpdate.processFlowModInputBuilders(allFlowMods); } Futures.addCallback(future, new UpdateFlowCallback(input, nodeId), MoreExecutors.directExecutor()); return future; } private final class AddFlowCallback implements FutureCallback> { private final AddFlowInput input; private final FlowRegistryKey flowRegistryKey; private final NodeId nodeId; private AddFlowCallback(final AddFlowInput input, final FlowRegistryKey flowRegistryKey, final NodeId nodeId) { this.input = input; this.flowRegistryKey = flowRegistryKey; this.nodeId = nodeId; } @Override public void onSuccess(final RpcResult rpcResult) { if (rpcResult.isSuccessful()) { final FlowDescriptor flowDescriptor; final FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class).getId(); FlowGroupCache cache = new FlowGroupCache(flowId.getValue(), input.getTableId().toString(), FlowGroupStatus.ADDED, LocalDateTime.now()); if (provider.getAllNodesFlowGroupCache().containsKey(nodeId.getValue())) { provider.getAllNodesFlowGroupCache().get(nodeId.getValue()).add(cache); } else { Queue flowGroupCacheList = Queues.synchronizedQueue(EvictingQueue.create(FLOWGROUP_CACHE_SIZE)); flowGroupCacheList.add(cache); provider.getAllNodesFlowGroupCache().put(nodeId.getValue(), flowGroupCacheList); } if (input.getFlowRef() != null) { flowDescriptor = FlowDescriptorFactory.create(input.getTableId(), flowId); deviceContext.getDeviceFlowRegistry().storeDescriptor(flowRegistryKey, flowDescriptor); } else { deviceContext.getDeviceFlowRegistry().store(flowRegistryKey); flowDescriptor = deviceContext.getDeviceFlowRegistry().retrieveDescriptor(flowRegistryKey); } if (LOG.isDebugEnabled()) { LOG.debug("Flow add with id={} finished without error", flowDescriptor.getFlowId().getValue()); } } else { if (LOG.isDebugEnabled()) { LOG.debug("Flow add failed for flow={}, errors={}", input, ErrorUtil.errorsToString(rpcResult.getErrors())); } } } @Override public void onFailure(final Throwable throwable) { LOG.warn("Service call for adding flow={} failed", input, throwable); } } private final class RemoveFlowCallback implements FutureCallback> { private final RemoveFlowInput input; private final NodeId nodeId; private RemoveFlowCallback(final RemoveFlowInput input, final NodeId nodeId) { this.input = input; this.nodeId = nodeId; } @Override public void onSuccess(final RpcResult result) { if (result.isSuccessful()) { if (LOG.isDebugEnabled()) { LOG.debug("Flow remove finished without error for flow={}", input); } if (input.getTableId() != null && !input.getTableId().equals(OFPTT_ALL)) { FlowRegistryKey flowRegistryKey = FlowRegistryKeyFactory.create(deviceContext.getDeviceInfo().getVersion(), input); deviceContext.getDeviceFlowRegistry().addMark(flowRegistryKey); final FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class).getId(); FlowGroupCache cache = new FlowGroupCache(flowId.getValue(), input.getTableId().toString(), FlowGroupStatus.REMOVED, LocalDateTime.now()); if (provider.getAllNodesFlowGroupCache().containsKey(nodeId.getValue())) { provider.getAllNodesFlowGroupCache().get(nodeId.getValue()).add(cache); } else { Queue flowGroupCacheList = Queues.synchronizedQueue(EvictingQueue.create(FLOWGROUP_CACHE_SIZE)); flowGroupCacheList.add(cache); provider.getAllNodesFlowGroupCache().put(nodeId.getValue(), flowGroupCacheList); } } else { deviceContext.getDeviceFlowRegistry().clearFlowRegistry(); } } else { if (LOG.isDebugEnabled()) { LOG.debug("Flow remove failed for flow={}, errors={}", input, ErrorUtil.errorsToString(result.getErrors())); } } } @Override public void onFailure(final Throwable throwable) { LOG.warn("Service call for removing flow={} failed", input, throwable); } } private final class UpdateFlowCallback implements FutureCallback> { private final UpdateFlowInput input; private final String nodeId; private UpdateFlowCallback(UpdateFlowInput input, String nodeId) { this.input = input; this.nodeId = nodeId; } @Override public void onSuccess(final RpcResult updateFlowOutputRpcResult) { final DeviceFlowRegistry deviceFlowRegistry = deviceContext.getDeviceFlowRegistry(); final FlowId flowId = input.getFlowRef().getValue().firstKeyOf(Flow.class).getId(); final UpdatedFlow updated = input.getUpdatedFlow(); final OriginalFlow original = input.getOriginalFlow(); final FlowRegistryKey origFlowRegistryKey = FlowRegistryKeyFactory.create(deviceContext.getDeviceInfo().getVersion(), original); final FlowRegistryKey updatedFlowRegistryKey = FlowRegistryKeyFactory.create(deviceContext.getDeviceInfo().getVersion(), updated); final FlowDescriptor origFlowDescriptor = deviceFlowRegistry.retrieveDescriptor(origFlowRegistryKey); final boolean isUpdate = origFlowDescriptor != null; final FlowDescriptor updatedFlowDescriptor; FlowGroupCache cache = new FlowGroupCache(flowId.getValue(), updated.getTableId().toString(), FlowGroupStatus.MODIFIED, LocalDateTime.now()); if (provider.getAllNodesFlowGroupCache().containsKey(nodeId)) { provider.getAllNodesFlowGroupCache().get(nodeId).add(cache); } else { Queue flowGroupCacheList = Queues.synchronizedQueue(EvictingQueue.create(FLOWGROUP_CACHE_SIZE)); flowGroupCacheList.add(cache); provider.getAllNodesFlowGroupCache().put(nodeId, flowGroupCacheList); } if (input.getFlowRef() != null) { updatedFlowDescriptor = FlowDescriptorFactory.create(updated.getTableId(), input.getFlowRef().getValue().firstKeyOf(Flow.class).getId()); } else { if (isUpdate) { updatedFlowDescriptor = origFlowDescriptor; } else { deviceFlowRegistry.store(updatedFlowRegistryKey); updatedFlowDescriptor = deviceFlowRegistry.retrieveDescriptor(updatedFlowRegistryKey); } } if (isUpdate) { deviceFlowRegistry.addMark(origFlowRegistryKey); deviceFlowRegistry.storeDescriptor(updatedFlowRegistryKey, updatedFlowDescriptor); } } @Override public void onFailure(final Throwable throwable) { LOG.warn("Service call for updating flow={} failed", input, throwable); } } }