openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/sal/AddFlowImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  * Copyright (c) 2024 PANTHEON.tech, s.r.o.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9 package org.opendaylight.openflowplugin.impl.services.sal;
  10
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import com.google.common.util.concurrent.MoreExecutors;
  15 import org.opendaylight.openflowplugin.api.openflow.FlowGroupStatus;
  16 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  17 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  18 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  19 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
  20 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
  21 import org.opendaylight.openflowplugin.impl.registry.flow.FlowDescriptorFactory;
  22 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
  23 import org.opendaylight.openflowplugin.impl.util.ErrorUtil;
  24 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlow;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutput;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowRef;
  31 import org.opendaylight.yangtools.yang.common.RpcResult;
  32 import org.opendaylight.yangtools.yang.common.Uint8;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 public final class AddFlowImpl extends AbstractFlowRpc<AddFlowOutput> implements AddFlow {
  37     private static final Logger LOG = LoggerFactory.getLogger(AddFlowImpl.class);
  38
  39     public AddFlowImpl(final RequestContextStack requestContextStack, final DeviceContext deviceContext,
  40             final ConvertorExecutor convertorExecutor) {
  41         super(requestContextStack, deviceContext, convertorExecutor, AddFlowOutput.class);
  42     }
  43
  44     @Override
  45     public ListenableFuture<RpcResult<AddFlowOutput>> invoke(final AddFlowInput input) {
  46         final var flowRegistryKey = FlowRegistryKeyFactory.create(deviceContext.getDeviceInfo().getVersion(), input);
  47         final var future = single.canUseSingleLayerSerialization() ? single.handleServiceCall(input)
  48             : multi.processFlowModInputBuilders(multi.toFlowModInputs(input));
  49         Futures.addCallback(future, new AddFlowCallback(input, flowRegistryKey),
  50             MoreExecutors.directExecutor());
  51         return future;
  52     }
  53
  54     private final class AddFlowCallback implements FutureCallback<RpcResult<AddFlowOutput>> {
  55         private final AddFlowInput input;
  56         private final FlowRegistryKey flowRegistryKey;
  57
  58         private AddFlowCallback(final AddFlowInput input, final FlowRegistryKey flowRegistryKey) {
  59             this.input = input;
  60             this.flowRegistryKey = flowRegistryKey;
  61         }
  62
  63         @Override
  64         public void onSuccess(final RpcResult<AddFlowOutput> rpcResult) {
  65             if (!rpcResult.isSuccessful()) {
  66                 if (LOG.isDebugEnabled()) {
  67                     LOG.debug("Flow add failed for flow={}, errors={}", input,
  68                             ErrorUtil.errorsToString(rpcResult.getErrors()));
  69                 }
  70                 return;
  71             }
  72
  73             final DeviceFlowRegistry flowRegistry = deviceContext.getDeviceFlowRegistry();
  74             final FlowDescriptor flowDescriptor;
  75             final FlowRef flowRef = input.getFlowRef();
  76             if (flowRef != null) {
  77                 final Uint8 tableId = input.getTableId();
  78                 final FlowId flowId = flowRef.getValue().firstKeyOf(Flow.class).getId();
  79                 flowDescriptor = FlowDescriptorFactory.create(tableId, flowId);
  80
  81                 // FIXME: this looks like an atomic operation
  82                 flowRegistry.appendHistoryFlow(flowId, tableId, FlowGroupStatus.ADDED);
  83                 flowRegistry.storeDescriptor(flowRegistryKey, flowDescriptor);
  84             } else {
  85                 // FIXME: this looks like an atomic operation
  86                 flowRegistry.store(flowRegistryKey);
  87                 flowDescriptor = flowRegistry.retrieveDescriptor(flowRegistryKey);
  88             }
  89
  90             if (LOG.isDebugEnabled()) {
  91                 LOG.debug("Flow add with id={} finished without error", flowDescriptor.getFlowId().getValue());
  92             }
  93         }
  94
  95         @Override
  96         public void onFailure(final Throwable throwable) {
  97             LOG.warn("Service call for adding flow={} failed", input, throwable);
  98         }
  99     }
 100 }