renderers/vpp/src/main/java/org/opendaylight/groupbasedpolicy/renderer/vpp/policy/BridgeDomainManagerImpl.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.policy;
  10
  11 import java.util.Arrays;
  12 import java.util.Collection;
  13
  14 import javax.annotation.Nonnull;
  15
  16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  17 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  18 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType;
  19 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
  20 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  21 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  22 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  26 import org.opendaylight.groupbasedpolicy.renderer.vpp.api.BridgeDomainManager;
  27 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.VppIidFactory;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.Config;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.BridgeDomain;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.BridgeDomainKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.bridge.domain.PhysicalLocationRef;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VxlanVni;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.NodeVbridgeAugment;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyTypesVbridgeAugment;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyTypesVbridgeAugmentBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyVbridgeAugment;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyVbridgeAugmentBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.node.BridgeMember;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.topology.types.VbridgeTopologyBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev160429.NodeVbridgeVlanAugment;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev160429.NodeVbridgeVlanAugmentBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev160429.TunnelTypeVlan;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev160429.network.topology.topology.tunnel.parameters.VlanNetworkParametersBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vxlan.rev160429.TunnelTypeVxlan;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vxlan.rev160429.network.topology.topology.tunnel.parameters.VxlanTunnelParametersBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527._802dot1q;
  48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  49 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypesBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.node.attributes.SupportingNodeBuilder;
  59 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  60 import org.opendaylight.yangtools.yang.binding.DataObject;
  61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  62 import org.slf4j.Logger;
  63 import org.slf4j.LoggerFactory;
  64
  65 import com.google.common.base.Optional;
  66 import com.google.common.base.Preconditions;
  67 import com.google.common.util.concurrent.AsyncFunction;
  68 import com.google.common.util.concurrent.CheckedFuture;
  69 import com.google.common.util.concurrent.FutureCallback;
  70 import com.google.common.util.concurrent.Futures;
  71 import com.google.common.util.concurrent.ListenableFuture;
  72 import com.google.common.util.concurrent.SettableFuture;
  73
  74 public class BridgeDomainManagerImpl implements BridgeDomainManager {
  75
  76     private static final Logger LOG = LoggerFactory.getLogger(BridgeDomainManagerImpl.class);
  77     private static final TopologyId SUPPORTING_TOPOLOGY_NETCONF = new TopologyId("topology-netconf");
  78     private static final TopologyTypes VBRIDGE_TOPOLOGY_TYPE = new TopologyTypesBuilder().addAugmentation(
  79             TopologyTypesVbridgeAugment.class,
  80             new TopologyTypesVbridgeAugmentBuilder().setVbridgeTopology(new VbridgeTopologyBuilder().build()).build())
  81         .build();
  82     private final DataBroker dataProvder;
  83
  84     private static final class ListenableFutureSetter<T extends DataObject>
  85             implements DataTreeChangeListener<T> {
  86
  87         private static final Logger LOG = LoggerFactory.getLogger(ListenableFutureSetter.class);
  88         private final SettableFuture<Void> future;
  89         private final ModificationType modificationForFutureSet;
  90         private final DataTreeIdentifier<T> iid;
  91         private final ListenerRegistration<ListenableFutureSetter<T>> registeredListener;
  92
  93         private ListenableFutureSetter(DataBroker dataProvider, SettableFuture<Void> future,
  94                 DataTreeIdentifier<T> iid, ModificationType modificationForFutureSet) {
  95             this.future = Preconditions.checkNotNull(future);
  96             Preconditions.checkArgument(!future.isDone());
  97             this.modificationForFutureSet = Preconditions.checkNotNull(modificationForFutureSet);
  98             this.iid = Preconditions.checkNotNull(iid);
  99             registeredListener = dataProvider.registerDataTreeChangeListener(iid, this);
 100             LOG.trace("Registered listener for path {}", iid.getRootIdentifier());
 101         }
 102
 103         @Override
 104         public void onDataTreeChanged(Collection<DataTreeModification<T>> changes) {
 105             changes.forEach(modif -> {
 106                 DataObjectModification<T> rootNode = modif.getRootNode();
 107                 ModificationType modificationType = rootNode.getModificationType();
 108                 if (modificationType == modificationForFutureSet) {
 109                     LOG.debug("{} in OPER DS: {}", modificationType.name(), iid.getRootIdentifier());
 110                     unregisterOnTrue(future.set(null));
 111                 }
 112             });
 113         }
 114
 115         private void unregisterOnTrue(boolean _true) {
 116             if (_true) {
 117                 LOG.trace("Unregistering listener for path {}", iid.getRootIdentifier());
 118                 if (registeredListener != null) {
 119                     registeredListener.close();
 120                 }
 121             }
 122         }
 123     }
 124
 125     public BridgeDomainManagerImpl(DataBroker dataProvder) {
 126         this.dataProvder = Preconditions.checkNotNull(dataProvder);
 127     }
 128
 129     @Override
 130     public ListenableFuture<Void> createVxlanBridgeDomainOnVppNode(@Nonnull String bridgeDomainName,
 131             @Nonnull VxlanVni vni, @Nonnull NodeId vppNodeId) {
 132         TopologyVbridgeAugment topoAug = new TopologyVbridgeAugmentBuilder().setTunnelType(TunnelTypeVxlan.class)
 133             .setArpTermination(false)
 134             .setFlood(true)
 135             .setForward(true)
 136             .setLearn(true)
 137             .setUnknownUnicastFlood(true)
 138             .setTunnelParameters(new VxlanTunnelParametersBuilder().setVni(vni).build())
 139             .build();
 140         return createBridgeDomainOnVppNode(bridgeDomainName, topoAug,
 141                 createBasicVppNodeBuilder(vppNodeId).build());
 142     }
 143
 144     @Override
 145     public ListenableFuture<Void> createVlanBridgeDomainOnVppNode(@Nonnull String bridgeDomainName,
 146             @Nonnull VlanId vlanId, @Nonnull NodeId vppNodeId) {
 147         TopologyVbridgeAugment topoAug = new TopologyVbridgeAugmentBuilder().setTunnelType(TunnelTypeVlan.class)
 148             .setArpTermination(false)
 149             .setFlood(true)
 150             .setForward(true)
 151             .setLearn(true)
 152             .setUnknownUnicastFlood(true)
 153             .setTunnelParameters(
 154                     new VlanNetworkParametersBuilder().setVlanId(vlanId).setVlanType(_802dot1q.class).build())
 155             .build();
 156         InstanceIdentifier<BridgeDomain> bridgeDomainConfigIid = InstanceIdentifier.builder(Config.class)
 157             .child(BridgeDomain.class, new BridgeDomainKey(bridgeDomainName))
 158             .build();
 159         ReadOnlyTransaction rTx = dataProvder.newReadOnlyTransaction();
 160         CheckedFuture<Optional<BridgeDomain>, ReadFailedException> futureTopology =
 161                 rTx.read(LogicalDatastoreType.CONFIGURATION, bridgeDomainConfigIid);
 162         rTx.close();
 163         return Futures.transform(futureTopology, new AsyncFunction<Optional<BridgeDomain>, Void>() {
 164
 165             @Override
 166             public ListenableFuture<Void> apply(Optional<BridgeDomain> optBridgeDomainConf) throws Exception {
 167                 if (optBridgeDomainConf.isPresent() && optBridgeDomainConf.get().getPhysicalLocationRef() != null) {
 168                     for (PhysicalLocationRef ref : optBridgeDomainConf.get().getPhysicalLocationRef()) {
 169                         if (ref.getInterface() != null && ref.getInterface().size() > 0) {
 170                             NodeVbridgeVlanAugment vppNodeVlanAug = new NodeVbridgeVlanAugmentBuilder()
 171                                 .setSuperInterface(ref.getInterface().get(0)).build();
 172                             Node vppNode = createBasicVppNodeBuilder(vppNodeId)
 173                                 .addAugmentation(NodeVbridgeVlanAugment.class, vppNodeVlanAug).build();
 174                             return createBridgeDomainOnVppNode(bridgeDomainName, topoAug, vppNode);
 175                         }
 176                     }
 177                 }
 178                 return Futures.immediateFailedFuture(
 179                         new Throwable("Failed to apply config for VLAN bridge domain " + bridgeDomainName));
 180             }
 181         });
 182     }
 183
 184     private static NodeBuilder createBasicVppNodeBuilder(NodeId nodeId) {
 185         return new NodeBuilder().setNodeId(nodeId).setSupportingNode(Arrays.asList(
 186                 new SupportingNodeBuilder().setTopologyRef(SUPPORTING_TOPOLOGY_NETCONF).setNodeRef(nodeId).build()));
 187     }
 188
 189     private ListenableFuture<Void> createBridgeDomainOnVppNode(@Nonnull String bridgeDomainName,
 190             final TopologyVbridgeAugment vBridgeAug, Node vppNode) {
 191         TopologyKey topologyKey = new TopologyKey(new TopologyId(bridgeDomainName));
 192         ReadOnlyTransaction rTx = dataProvder.newReadOnlyTransaction();
 193         InstanceIdentifier<Topology> topologyIid = VppIidFactory.getTopologyIid(topologyKey);
 194         CheckedFuture<Optional<Topology>, ReadFailedException> futureTopology =
 195                 rTx.read(LogicalDatastoreType.CONFIGURATION, topologyIid);
 196         rTx.close();
 197         return Futures.transform(futureTopology, new AsyncFunction<Optional<Topology>, Void>() {
 198
 199             @Override
 200             public ListenableFuture<Void> apply(Optional<Topology> optTopology) throws Exception {
 201                 WriteTransaction wTx = dataProvder.newWriteOnlyTransaction();
 202                 if (!optTopology.isPresent()) {
 203                     Topology topology = new TopologyBuilder().setKey(topologyKey)
 204                         .setTopologyTypes(VBRIDGE_TOPOLOGY_TYPE)
 205                         .addAugmentation(TopologyVbridgeAugment.class, vBridgeAug)
 206                         .build();
 207                     wTx.put(LogicalDatastoreType.CONFIGURATION, topologyIid,
 208                             topology, true);
 209                 }
 210                 InstanceIdentifier<Node> nodeIid = VppIidFactory.getNodeIid(topologyKey, vppNode.getKey());
 211                 wTx.put(LogicalDatastoreType.CONFIGURATION, nodeIid, vppNode);
 212                 SettableFuture<Void> future = SettableFuture.create();
 213                 Futures.addCallback(wTx.submit(), new FutureCallback<Void>() {
 214
 215                     @Override
 216                     public void onSuccess(Void result) {
 217                         DataTreeIdentifier<BridgeMember> bridgeMemberIid =
 218                                 new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL,
 219                                         nodeIid.augmentation(NodeVbridgeAugment.class).child(BridgeMember.class));
 220                         LOG.debug("Request create node in topology for VBD was stored to CONF DS. {}", nodeIid);
 221                         new ListenableFutureSetter<>(dataProvder, future, bridgeMemberIid,
 222                                 ModificationType.WRITE);
 223                     }
 224
 225                     @Override
 226                     public void onFailure(Throwable t) {
 227                         LOG.warn("Request create node in topology for VBD was not stored to CONF DS. {}", nodeIid, t);
 228                         future.setException(new Exception("Cannot send request to VBD."));
 229                     }
 230                 });
 231                 return future;
 232             }
 233         });
 234     }
 235
 236     @Override
 237     public ListenableFuture<Void> removeBridgeDomainFromVppNode(@Nonnull String bridgeDomainName, NodeId vppNode) {
 238         WriteTransaction wTx = dataProvder.newWriteOnlyTransaction();
 239         InstanceIdentifier<Node> nodeIid =
 240                 VppIidFactory.getNodeIid(new TopologyKey(new TopologyId(bridgeDomainName)), new NodeKey(vppNode));
 241         wTx.delete(LogicalDatastoreType.CONFIGURATION, nodeIid);
 242         SettableFuture<Void> future = SettableFuture.create();
 243         Futures.addCallback(wTx.submit(), new FutureCallback<Void>() {
 244
 245             @Override
 246             public void onSuccess(Void result) {
 247                 DataTreeIdentifier<BridgeMember> bridgeMemberIid =
 248                         new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL,
 249                                 nodeIid.augmentation(NodeVbridgeAugment.class).child(BridgeMember.class));
 250                 LOG.debug("Request delete node in topology for VBD was stored to CONF DS. {}", nodeIid);
 251                 new ListenableFutureSetter<>(dataProvder, future, bridgeMemberIid, ModificationType.DELETE);
 252             }
 253
 254             @Override
 255             public void onFailure(Throwable t) {
 256                 LOG.warn("Request delete node in topology for VBD was not stored to CONF DS. {}", nodeIid, t);
 257                 future.setException(new Exception("Cannot send request to VBD."));
 258             }
 259         });
 260         return future;
 261     }
 262
 263 }