renderers/vpp/src/main/java/org/opendaylight/groupbasedpolicy/renderer/vpp/adapter/VppRpcServiceImpl.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.groupbasedpolicy.renderer.vpp.adapter;
  10
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.concurrent.Future;
  14 import java.util.stream.Collectors;
  15
  16 import javax.annotation.Nonnull;
  17
  18 import org.opendaylight.controller.config.yang.config.vpp_provider.impl.VppRenderer;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  21 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  24 import org.opendaylight.groupbasedpolicy.renderer.vpp.api.BridgeDomainManager;
  25 import org.opendaylight.groupbasedpolicy.renderer.vpp.commands.interfaces.ConfigCommand;
  26 import org.opendaylight.groupbasedpolicy.renderer.vpp.commands.TapPortCommand;
  27 import org.opendaylight.groupbasedpolicy.renderer.vpp.commands.VhostUserCommand;
  28 import org.opendaylight.groupbasedpolicy.renderer.vpp.commands.VhostUserCommand.VhostUserCommandBuilder;
  29 import org.opendaylight.groupbasedpolicy.renderer.vpp.iface.InterfaceManager;
  30 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.General.Operations;
  31 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.MountedDataBrokerProvider;
  32 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.VppIidFactory;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.AddInterfaceToBridgeDomainInput;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.CreateInterfaceOnNodeInput;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.CreateVirtualBridgeDomainOnNodesInput;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.DelInterfaceFromBridgeDomainInput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.DeleteInterfaceFromNodeInput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.DeleteVirtualBridgeDomainFromNodesInput;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.CloneVirtualBridgeDomainOnNodesInput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.VppAdapterService;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.bridge.domain.attributes.tunnel.type.Vlan;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_adapter.rev161201.bridge.domain.attributes.tunnel.type.Vxlan;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes.InterfaceTypeChoice;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes._interface.type.choice.TapCase;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes._interface.type.choice.VhostUserCase;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VhostUserRole;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VxlanVni;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyVbridgeAugment;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev170327.network.topology.topology.tunnel.parameters.VlanNetworkParameters;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vxlan.rev170327.network.topology.topology.tunnel.parameters.VxlanTunnelParameters;
  54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  59 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  60 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  61 import org.opendaylight.yangtools.yang.common.RpcResult;
  62 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  63 import org.slf4j.Logger;
  64 import org.slf4j.LoggerFactory;
  65
  66 import com.google.common.base.Optional;
  67 import com.google.common.util.concurrent.AsyncFunction;
  68 import com.google.common.util.concurrent.CheckedFuture;
  69 import com.google.common.util.concurrent.Futures;
  70 import com.google.common.util.concurrent.ListenableFuture;
  71 import com.google.common.util.concurrent.MoreExecutors;
  72
  73 public class VppRpcServiceImpl implements VppAdapterService, AutoCloseable {
  74
  75     private static final Logger LOG = LoggerFactory.getLogger(VppRpcServiceImpl.class);
  76
  77     private final DataBroker dataBroker;
  78     private final BridgeDomainManager bridgeDomainManager;
  79     private final InterfaceManager interfaceManager;
  80     private final MountedDataBrokerProvider mountDataProvider;
  81
  82     public VppRpcServiceImpl(@Nonnull DataBroker dataBroker, @Nonnull VppRenderer renderer) {
  83         this.dataBroker = dataBroker;
  84         this.bridgeDomainManager = renderer.getBridgeDomainManager();
  85         this.interfaceManager = renderer.getInterfaceManager();
  86         this.mountDataProvider = renderer.getMountedDataBroker();
  87     }
  88
  89     public Future<RpcResult<Void>> createVirtualBridgeDomainOnNodes(CreateVirtualBridgeDomainOnNodesInput input) {
  90         LOG.info("Processing a remote call for creating bridge domain {}", input.getId());
  91         if (input.getTunnelType() == null) {
  92             return Futures.immediateFuture(RpcResultBuilder.<Void>failed()
  93                 .withError(ErrorType.RPC,
  94                         "Failed to create bridge domain" + input.getId() + "." + "Tunnel type not specified")
  95                 .build());
  96         }
  97         List<ListenableFuture<Void>> futures = new ArrayList<>();
  98         List<NodeId> nodeIds = (input.getPhysicalLocationRef() == null) ? new ArrayList<>() : input
  99             .getPhysicalLocationRef().stream().map(locationRef -> locationRef.getNodeId()).collect(Collectors.toList());
 100         LOG.trace("Corresponding nodes for bridge-domain {}", input.getPhysicalLocationRef());
 101         if (input.getTunnelType() instanceof Vxlan) {
 102             LOG.trace("Detected VXLAN type for bridge domain {}", input.getId());
 103             Vxlan tunnelType = (Vxlan) input.getTunnelType();
 104             VxlanVni vxlanVni = new VxlanVni(tunnelType.getVni().getValue());
 105             nodeIds.forEach(nodeId -> {
 106                 futures.add(bridgeDomainManager.createVxlanBridgeDomainOnVppNode(input.getId(), vxlanVni, nodeId));
 107             });
 108         } else if (input.getTunnelType() instanceof Vlan) {
 109             LOG.trace("Detected VLAN type for bridge domain {}", input.getId());
 110             Vlan vlan = (Vlan) input.getTunnelType();
 111             VlanId vlanId = new VlanId(vlan.getVlanId().getValue());
 112             nodeIds.forEach(nodeId -> {
 113                 futures.add(bridgeDomainManager.createVlanBridgeDomainOnVppNode(input.getId(), vlanId, nodeId));
 114             });
 115         }
 116         return Futures.transformAsync(Futures.allAsList(futures), voidsToRpcResult());
 117     }
 118
 119     public Future<RpcResult<Void>> deleteVirtualBridgeDomainFromNodes(DeleteVirtualBridgeDomainFromNodesInput input) {
 120         LOG.info("Processing a remote call for removing bridge domain {}", input.getBridgeDomainId());
 121         List<ListenableFuture<Void>> futures = new ArrayList<>();
 122         input.getBridgeDomainNode().forEach(nodeId -> {
 123             futures.add(bridgeDomainManager.removeBridgeDomainFromVppNode(input.getBridgeDomainId(), nodeId));
 124         });
 125         return Futures.transformAsync(Futures.allAsList(futures), voidsToRpcResult());
 126     }
 127
 128     public ListenableFuture<RpcResult<Void>> cloneVirtualBridgeDomainOnNodes(CloneVirtualBridgeDomainOnNodesInput input) {
 129         LOG.info("Processing a remote call for clonning  bridge domain {}", input.getBridgeDomainId());
 130         List<ListenableFuture<Void>> futures = new ArrayList<>();
 131         ReadOnlyTransaction rTx = dataBroker.newReadOnlyTransaction();
 132         InstanceIdentifier<Topology> topologyIid = VppIidFactory.getTopologyIid(new TopologyKey(new TopologyId(
 133                 input.getBridgeDomainId())));
 134         return Futures.transformAsync(rTx.read(LogicalDatastoreType.CONFIGURATION, topologyIid),
 135                 new AsyncFunction<Optional<Topology>, RpcResult<Void>>() {
 136
 137                     @Override
 138                     public ListenableFuture<RpcResult<Void>> apply(Optional<Topology> optTopology) throws Exception {
 139                         if (!optTopology.isPresent()) {
 140
 141                             return Futures.immediateFuture(RpcResultBuilder.<Void>failed()
 142                                 .withError(
 143                                         ErrorType.RPC,
 144                                         "Failed to clone bridge domain. Bridge domain " + input.getBridgeDomainId()
 145                                                 + " does not exist.")
 146                                 .build());
 147                         }
 148                         TopologyVbridgeAugment vBridgeAug = optTopology.get().getAugmentation(TopologyVbridgeAugment.class);
 149                         if (vBridgeAug == null) {
 150                             return Futures.immediateFuture(RpcResultBuilder.<Void>failed()
 151                                 .withError(
 152                                         ErrorType.RPC,
 153                                         "Failed to clone bridge domain. Topology " + input.getBridgeDomainId()
 154                                                 + " is not bridge domain type.")
 155                                 .build());
 156                         }
 157                         if (vBridgeAug.getTunnelParameters() instanceof VxlanTunnelParameters) {
 158                             LOG.debug("Clonning VXLAN type bridge domain {} on nodes {}", input.getBridgeDomainId(),
 159                                     input.getBridgeDomainNode());
 160                             VxlanTunnelParameters vxlanTunnelParams = (VxlanTunnelParameters) vBridgeAug.getTunnelParameters();
 161                             VxlanVni vni = vxlanTunnelParams.getVni();
 162                             input.getBridgeDomainNode().forEach(
 163                                     nodeId -> {
 164                                         futures.add(bridgeDomainManager.createVxlanBridgeDomainOnVppNode(
 165                                                 input.getBridgeDomainId(), vni, nodeId));
 166                                     });
 167                         } else if (vBridgeAug.getTunnelParameters() instanceof VlanNetworkParameters) {
 168                             LOG.debug("Clonning VLAN type bridge domain {} on nodes {}", input.getBridgeDomainId(),
 169                                     input.getBridgeDomainNode());
 170                             VlanNetworkParameters vlanTunnelParams = (VlanNetworkParameters) vBridgeAug.getTunnelParameters();
 171                             VlanId vlanId = vlanTunnelParams.getVlanId();
 172                             input.getBridgeDomainNode().forEach(
 173                                     nodeId -> {
 174                                         futures.add(bridgeDomainManager.createVlanBridgeDomainOnVppNode(
 175                                                 input.getBridgeDomainId(), vlanId, nodeId));
 176                                     });
 177                         }
 178                         return Futures.transformAsync(Futures.allAsList(futures), voidsToRpcResult());
 179                     }
 180                 });
 181     }
 182
 183     public ListenableFuture<RpcResult<Void>> createInterfaceOnNode(CreateInterfaceOnNodeInput input) {
 184         LOG.info("Processing a remote call for creating interface {} on node {}", input.getVppInterfaceName(),
 185                 input.getVppNodeId());
 186         InterfaceTypeChoice interfaceType = input.getInterfaceTypeChoice();
 187         ConfigCommand ifaceCommand = null;
 188         if (interfaceType instanceof VhostUserCase) {
 189             VhostUserCommandBuilder vhostBuilder = VhostUserCommand.builder();
 190             vhostBuilder.setName(input.getVppInterfaceName());
 191             VhostUserCase vhostCase = (VhostUserCase) input.getInterfaceTypeChoice();
 192             vhostBuilder.setSocket(vhostCase.getSocket());
 193             vhostBuilder.setRole(VhostUserRole.Client);
 194             vhostBuilder.setDescription(input.getDescription());
 195             vhostBuilder.setOperation(Operations.PUT);
 196             ifaceCommand = vhostBuilder.build();
 197         }
 198         if (interfaceType instanceof TapCase) {
 199             TapPortCommand.TapPortCommandBuilder tapBuilder = TapPortCommand.builder();
 200             TapCase tapIface = (TapCase) input.getInterfaceTypeChoice();
 201             tapBuilder.setTapName(tapIface.getName());
 202             tapBuilder.setPhysAddress(tapIface.getPhysicalAddress());
 203             tapBuilder.setInterfaceName(input.getVppInterfaceName());
 204             tapBuilder.setDescription(input.getDescription());
 205             tapBuilder.setOperation(Operations.PUT);
 206             ifaceCommand = tapBuilder.build();
 207         }
 208         InstanceIdentifier<Node> vppNodeIid = VppIidFactory.getNetconfNodeIid(input.getVppNodeId());
 209         return Futures.transformAsync(interfaceManager.createInterfaceOnVpp(ifaceCommand, vppNodeIid),
 210                 voidToRpcResult(), MoreExecutors.directExecutor());
 211     }
 212
 213     public ListenableFuture<RpcResult<Void>> deleteInterfaceFromNode(DeleteInterfaceFromNodeInput input) {
 214         LOG.info("Processing a remote call for removing interface {} from node {}", input.getVppInterfaceName(),
 215                 input.getVppNodeId());
 216         InstanceIdentifier<Node> vppNodeIid = VppIidFactory.getNetconfNodeIid(input.getVppNodeId());
 217         return Futures.transformAsync(readInterface(vppNodeIid, input.getVppInterfaceName()),
 218                 new AsyncFunction<Optional<Interface>, RpcResult<Void>>() {
 219
 220                     @Override
 221                     public ListenableFuture<RpcResult<Void>> apply(Optional<Interface> optIface) throws Exception {
 222                         InterfaceKey iKey = new InterfaceKey(input.getVppInterfaceName());
 223                         if (!optIface.isPresent()) {
 224                             return Futures.immediateFuture(RpcResultBuilder.<Void>failed()
 225                                 .withError(
 226                                         ErrorType.RPC,
 227                                         "Cannot delete interface " + iKey + " on node " + vppNodeIid
 228                                                 + ". Not found or already deleted.")
 229                                 .build());
 230                         }
 231                         Optional<DataBroker> dataBroker = mountDataProvider.resolveDataBrokerForMountPoint(vppNodeIid);
 232                         WriteTransaction wTx = dataBroker.get().newWriteOnlyTransaction();
 233                         wTx.delete(LogicalDatastoreType.CONFIGURATION, VppIidFactory.getInterfaceIID(iKey));
 234                         return Futures.transformAsync(wTx.submit(), voidToRpcResult(), MoreExecutors.directExecutor());
 235                     }
 236                 }, MoreExecutors.directExecutor());
 237     }
 238
 239     public ListenableFuture<RpcResult<Void>> addInterfaceToBridgeDomain(AddInterfaceToBridgeDomainInput input) {
 240         LOG.info("Processing a remote call for adding interface {} to bridge domain {}", input.getVppInterfaceName(),
 241                 input.getBridgeDomainId());
 242         InstanceIdentifier<Node> vppNodeIid = VppIidFactory.getNetconfNodeIid(input.getVppNodeId());
 243         return Futures.transformAsync(readInterface(vppNodeIid, input.getVppInterfaceName()),
 244                 new AsyncFunction<Optional<Interface>, RpcResult<Void>>() {
 245
 246                     @Override
 247                     public ListenableFuture<RpcResult<Void>> apply(Optional<Interface> optIface) throws Exception {
 248                         InterfaceKey iKey = new InterfaceKey(input.getVppInterfaceName());
 249                         if (!optIface.isPresent()) {
 250                             return Futures.immediateFuture(RpcResultBuilder.<Void>failed()
 251                                 .withError(
 252                                         ErrorType.RPC,
 253                                         "Cannot add interface " + iKey + " to bridge domain on node "
 254                                                 + vppNodeIid + ". Not found or deleted.")
 255                                 .build());
 256                         }
 257                         return Futures.transformAsync(interfaceManager.configureInterface(vppNodeIid, iKey,
 258                                 input.getBridgeDomainId(), null), voidToRpcResult(), MoreExecutors.directExecutor());
 259                     }
 260                 }, MoreExecutors.directExecutor());
 261     }
 262
 263     public ListenableFuture<RpcResult<Void>> delInterfaceFromBridgeDomain(DelInterfaceFromBridgeDomainInput input) {
 264         LOG.info("Processing a remote call for removing interface {} from bridge domain.", input.getVppInterfaceName());
 265         InstanceIdentifier<Node> vppNodeIid = VppIidFactory.getNetconfNodeIid(input.getVppNodeId());
 266         return Futures.transformAsync(readInterface(vppNodeIid, input.getVppInterfaceName()),
 267                 new AsyncFunction<Optional<Interface>, RpcResult<Void>>() {
 268
 269                     @Override
 270                     public ListenableFuture<RpcResult<Void>> apply(Optional<Interface> optIface) throws Exception {
 271                         if (!optIface.isPresent()) {
 272                             return Futures.immediateFuture(RpcResultBuilder.<Void>failed()
 273                                 .withError(
 274                                         ErrorType.RPC,
 275                                         "Cannot remove interface " + input.getVppInterfaceName()
 276                                                 + " from bridge domain on node " + vppNodeIid
 277                                                 + ". Not found or deleted.")
 278                                 .build());
 279                         }
 280                         return Futures.transformAsync(interfaceManager.removeInterfaceFromBridgeDomain(vppNodeIid,
 281                                 optIface.get().getKey()), voidToRpcResult(), MoreExecutors.directExecutor());
 282                     }
 283                 }, MoreExecutors.directExecutor());
 284     }
 285
 286     private CheckedFuture<Optional<Interface>, ReadFailedException> readInterface(InstanceIdentifier<Node> nodeIid,
 287             String interfaceName) {
 288         Optional<DataBroker> optDataBroker = mountDataProvider.resolveDataBrokerForMountPoint(nodeIid);
 289         if (!optDataBroker.isPresent()) {
 290             LOG.error("Cannot find data broker for node {}", nodeIid);
 291             return Futures.immediateCheckedFuture(Optional.absent());
 292         }
 293         ReadOnlyTransaction rwTx = optDataBroker.get().newReadOnlyTransaction();
 294         InterfaceKey iKey = new InterfaceKey(interfaceName);
 295         InstanceIdentifier<Interface> interfaceIID = VppIidFactory.getInterfaceIID(iKey);
 296         CheckedFuture<Optional<Interface>, ReadFailedException> readInterface = rwTx.read(
 297                 LogicalDatastoreType.CONFIGURATION, interfaceIID);
 298         rwTx.close();
 299         return readInterface;
 300     }
 301
 302     private AsyncFunction<Void, RpcResult<Void>> voidToRpcResult() {
 303         return new AsyncFunction<Void, RpcResult<Void>>() {
 304
 305             @Override
 306             public ListenableFuture<RpcResult<Void>> apply(Void input) throws Exception {
 307                 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
 308             }
 309         };
 310     }
 311
 312     private AsyncFunction<List<Void>, RpcResult<Void>> voidsToRpcResult() {
 313         return new AsyncFunction<List<Void>, RpcResult<Void>>() {
 314
 315             @Override
 316             public ListenableFuture<RpcResult<Void>> apply(List<Void> input) throws Exception {
 317                 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
 318             }
 319         };
 320     }
 321
 322     @Override
 323     public void close() throws Exception {
 324         // NOOP
 325     }
 326 }