interfacemgr/interfacemgr-impl/src/main/java/org/opendaylight/vpnservice/interfacemgr/renderer/ovs/utilities/SouthboundUtils.java

   1 /*
   2  * Copyright (c) 2015 Ericsson India Global Services Pvt Ltd. 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 package org.opendaylight.vpnservice.interfacemgr.renderer.ovs.utilities;
   9
  10 import com.google.common.collect.Maps;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  13 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.*;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.*;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.*;
  22 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  23 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  24 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  25 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 import java.util.ArrayList;
  39 import java.util.List;
  40 import java.util.Map;
  41
  42 public class SouthboundUtils {
  43     private static final Logger LOG = LoggerFactory.getLogger(SouthboundUtils.class);
  44     public static final TopologyId OVSDB_TOPOLOGY_ID = new TopologyId(new Uri("ovsdb:1"));
  45
  46     public static void addPortToBridge(InstanceIdentifier<?> bridgeIid, Interface iface,
  47                                        OvsdbBridgeAugmentation bridgeAugmentation, String bridgeName,
  48                                        String portName, DataBroker dataBroker, List<ListenableFuture<Void>> futures) {
  49         WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
  50         IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
  51         if (ifTunnel != null) {
  52             addTunnelPortToBridge(ifTunnel, bridgeIid, iface, bridgeAugmentation, bridgeName, portName, dataBroker, tx);
  53         }
  54         futures.add(tx.submit());
  55     }
  56
  57     public static void addBridge(InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid,
  58                                  OvsdbBridgeAugmentation bridgeAugmentation,
  59                                  DataBroker dataBroker, List<ListenableFuture<Void>> futures){
  60         WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
  61         NodeId nodeId = InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)).getNodeId();
  62         NodeBuilder bridgeNodeBuilder = new NodeBuilder();
  63         bridgeNodeBuilder.setNodeId(nodeId);
  64         bridgeNodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class, bridgeAugmentation);
  65         tx.put(LogicalDatastoreType.CONFIGURATION, createNodeInstanceIdentifier(nodeId), bridgeNodeBuilder.build(), true);
  66         futures.add(tx.submit());
  67     }
  68
  69     public static void deleteBridge(InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid,
  70                                  DataBroker dataBroker, List<ListenableFuture<Void>> futures){
  71         WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
  72         NodeId nodeId = InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)).getNodeId();
  73         tx.delete(LogicalDatastoreType.CONFIGURATION, createNodeInstanceIdentifier(nodeId));
  74         futures.add(tx.submit());
  75     }
  76
  77     private static void addVlanPortToBridge(InstanceIdentifier<?> bridgeIid, IfL2vlan ifL2vlan,
  78                                               OvsdbBridgeAugmentation bridgeAugmentation, String bridgeName,
  79                                               String portName, DataBroker dataBroker, WriteTransaction t) {
  80         if(ifL2vlan.getVlanId() != null) {
  81             addTerminationPoint(bridgeIid, bridgeAugmentation, bridgeName, portName, ifL2vlan.getVlanId().getValue(), null, null, dataBroker, t);
  82         }
  83     }
  84
  85     private static void addTunnelPortToBridge(IfTunnel ifTunnel, InstanceIdentifier<?> bridgeIid, Interface iface,
  86                                              OvsdbBridgeAugmentation bridgeAugmentation, String bridgeName,
  87                                              String portName, DataBroker dataBroker, WriteTransaction t) {
  88         Class type = null;
  89         LOG.debug("adding tunnel port {} to bridge {}",portName, bridgeName);
  90
  91         if (ifTunnel.getTunnelInterfaceType().isAssignableFrom(TunnelTypeGre.class) ||
  92                 ifTunnel.getTunnelInterfaceType().isAssignableFrom(TunnelTypeMplsOverGre.class)) {
  93             type = InterfaceTypeGre.class;
  94         } else if (ifTunnel.getTunnelInterfaceType().isAssignableFrom(TunnelTypeVxlan.class)) {
  95             type = InterfaceTypeVxlan.class;
  96         }
  97
  98         if (type == null) {
  99             LOG.warn("Unknown Tunnel Type obtained while creating interface: {}", iface);
 100             return;
 101         }
 102
 103         int vlanId = 0;
 104         IfL2vlan ifL2vlan = iface.getAugmentation(IfL2vlan.class);
 105         if (ifL2vlan != null && ifL2vlan.getVlanId() != null) {
 106             vlanId = ifL2vlan.getVlanId().getValue();
 107         }
 108
 109         Map<String, String> options = Maps.newHashMap();
 110         options.put("key", "flow");
 111
 112         IpAddress localIp = ifTunnel.getTunnelSource();
 113         options.put("local_ip", localIp.getIpv4Address().getValue());
 114
 115         IpAddress remoteIp = ifTunnel.getTunnelDestination();
 116         options.put("remote_ip", remoteIp.getIpv4Address().getValue());
 117
 118         addTerminationPoint(bridgeIid, bridgeAugmentation, bridgeName, portName, vlanId, type, options, dataBroker, t);
 119     }
 120
 121     private static void addTerminationPoint(InstanceIdentifier<?> bridgeIid, OvsdbBridgeAugmentation bridgeNode,
 122                                             String bridgeName, String portName, int vlanId, Class type,
 123                                             Map<String, String> options, DataBroker dataBroker, WriteTransaction t) {
 124         InstanceIdentifier<TerminationPoint> tpIid = createTerminationPointInstanceIdentifier(
 125                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), portName);
 126         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 127
 128         tpAugmentationBuilder.setName(portName);
 129
 130         if (type != null) {
 131             tpAugmentationBuilder.setInterfaceType(type);
 132         }
 133
 134         if (options != null) {
 135             List<Options> optionsList = new ArrayList<Options>();
 136             for (Map.Entry<String, String> entry : options.entrySet()) {
 137                 OptionsBuilder optionsBuilder = new OptionsBuilder();
 138                 optionsBuilder.setKey(new OptionsKey(entry.getKey()));
 139                 optionsBuilder.setOption(entry.getKey());
 140                 optionsBuilder.setValue(entry.getValue());
 141                 optionsList.add(optionsBuilder.build());
 142             }
 143             tpAugmentationBuilder.setOptions(optionsList);
 144         }
 145
 146         if (vlanId != 0) {
 147                 tpAugmentationBuilder.setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.Access);
 148                 tpAugmentationBuilder.setVlanTag(new VlanId(vlanId));
 149         }
 150
 151         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 152         tpBuilder.setKey(InstanceIdentifier.keyOf(tpIid));
 153         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
 154
 155         t.put(LogicalDatastoreType.CONFIGURATION, tpIid, tpBuilder.build(), true);
 156     }
 157
 158     private static InstanceIdentifier<TerminationPoint> createTerminationPointInstanceIdentifier(Node node,
 159                                                                                                  String portName){
 160         InstanceIdentifier<TerminationPoint> terminationPointPath = InstanceIdentifier
 161                 .create(NetworkTopology.class)
 162                 .child(Topology.class, new TopologyKey(OVSDB_TOPOLOGY_ID))
 163                 .child(Node.class,node.getKey())
 164                 .child(TerminationPoint.class, new TerminationPointKey(new TpId(portName)));
 165
 166         LOG.debug("Termination point InstanceIdentifier generated : {}", terminationPointPath);
 167         return terminationPointPath;
 168     }
 169
 170     public static InstanceIdentifier<TerminationPoint> createTerminationPointInstanceIdentifier(NodeKey nodekey,
 171                                                                                                 String portName){
 172         InstanceIdentifier<TerminationPoint> terminationPointPath = InstanceIdentifier
 173                 .create(NetworkTopology.class)
 174                 .child(Topology.class, new TopologyKey(OVSDB_TOPOLOGY_ID))
 175                 .child(Node.class,nodekey)
 176                 .child(TerminationPoint.class, new TerminationPointKey(new TpId(portName)));
 177
 178         LOG.debug("Termination point InstanceIdentifier generated : {}",terminationPointPath);
 179         return terminationPointPath;
 180     }
 181
 182     public static InstanceIdentifier<Node> createNodeInstanceIdentifier(NodeId nodeId) {
 183         return InstanceIdentifier
 184                 .create(NetworkTopology.class)
 185                 .child(Topology.class, new TopologyKey(OVSDB_TOPOLOGY_ID))
 186                 .child(Node.class,new NodeKey(nodeId));
 187     }
 188 }