interfacemanager/interfacemanager-impl/src/main/java/org/opendaylight/genius/interfacemanager/renderer/ovs/utilities/SouthboundUtils.java

   1 /*
   2  * Copyright (c) 2016 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.genius.interfacemanager.renderer.ovs.utilities;
   9
  10 import com.google.common.collect.Maps;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import java.util.ArrayList;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  17 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  19 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntry;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntry;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBfd;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlanGpe;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbPortInterfaceAttributes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfd;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdKey;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsKey;
  48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  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.TpId;
  51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  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.NodeKey;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  58 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  59 import org.slf4j.Logger;
  60 import org.slf4j.LoggerFactory;
  61
  62 public class SouthboundUtils {
  63     private static final Logger LOG = LoggerFactory.getLogger(SouthboundUtils.class);
  64
  65     public static final String BFD_PARAM_ENABLE = "enable";
  66     static final String BFD_PARAM_MIN_TX = "min_tx";
  67     static final String BFD_PARAM_MIN_RX = "min_rx";
  68     static final String BFD_PARAM_DECAY_MIN_RX = "decay_min_rx";
  69     static final String BFD_PARAM_FORWARDING_IF_RX = "forwarding_if_rx";
  70     static final String BFD_PARAM_CPATH_DOWN = "cpath_down";
  71     static final String BFD_PARAM_CHECK_TNL_KEY = "check_tnl_key";
  72
  73     // BFD parameters
  74     public static final String BFD_OP_STATE = "state";
  75     public static final String BFD_STATE_UP = "up";
  76     private static final String BFD_MIN_RX_VAL = "1000";
  77     private static final String BFD_MIN_TX_VAL = "100";
  78     private static final String BFD_DECAY_MIN_RX_VAL = "200";
  79     private static final String BFD_FORWARDING_IF_RX_VAL = "true";
  80     private static final String BFD_CPATH_DOWN_VAL = "false";
  81     private static final String BFD_CHECK_TNL_KEY_VAL = "false";
  82
  83     // Tunnel options
  84     private static final String TUNNEL_OPTIONS_KEY = "key";
  85     private static final String TUNNEL_OPTIONS_LOCAL_IP = "local_ip";
  86     private static final String TUNNEL_OPTIONS_REMOTE_IP = "remote_ip";
  87     private static final String TUNNEL_OPTIONS_DESTINATION_PORT = "dst_port";
  88
  89     // Option values for VxLAN-GPE + NSH tunnels
  90     private static final String TUNNEL_OPTIONS_EXTS = "exts";
  91     private static final String TUNNEL_OPTIONS_NSI = "nsi";
  92     private static final String TUNNEL_OPTIONS_NSP = "nsp";
  93     private static final String TUNNEL_OPTIONS_NSHC1 = "nshc1";
  94     private static final String TUNNEL_OPTIONS_NSHC2 = "nshc2";
  95     private static final String TUNNEL_OPTIONS_NSHC3 = "nshc3";
  96     private static final String TUNNEL_OPTIONS_NSHC4 = "nshc4";
  97
  98     // Option values for VxLAN-GPE + NSH tunnels
  99     private static final String TUNNEL_OPTIONS_VALUE_FLOW = "flow";
 100     private static final String TUNNEL_OPTIONS_VALUE_GPE = "gpe";
 101      // UDP port for VxLAN-GPE Tunnels
 102     private static final String TUNNEL_OPTIONS_VALUE_GPE_DESTINATION_PORT = "4880";
 103
 104     //
 105     public static final TopologyId OVSDB_TOPOLOGY_ID = new TopologyId(new Uri("ovsdb:1"));
 106
 107     // To keep the mapping between Tunnel Types and Tunnel Interfaces
 108     private static final Map<Class<? extends TunnelTypeBase>, Class<? extends InterfaceTypeBase>> TUNNEL_TYPE_MAP = new HashMap<Class<? extends TunnelTypeBase>, Class<? extends InterfaceTypeBase>>() {
 109         {
 110             put(TunnelTypeGre.class, InterfaceTypeGre.class);
 111             put(TunnelTypeVxlan.class, InterfaceTypeVxlan.class);
 112             put(TunnelTypeVxlanGpe.class, InterfaceTypeVxlan.class);
 113         }
 114     };
 115
 116     public static void addPortToBridge(InstanceIdentifier<?> bridgeIid, Interface iface, String portName, DataBroker dataBroker,
 117             List<ListenableFuture<Void>> futures) {
 118         IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
 119         if (ifTunnel != null) {
 120             addTunnelPortToBridge(ifTunnel, bridgeIid, iface, portName, dataBroker);
 121         }
 122     }
 123
 124     /*
 125      * Add all tunnels ports corresponding to the bridge to the topology config
 126      * DS
 127      */
 128     public static void addAllPortsToBridge(BridgeEntry bridgeEntry, DataBroker dataBroker,
 129             InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid, OvsdbBridgeAugmentation bridgeNew,
 130             List<ListenableFuture<Void>> futures) {
 131         String bridgeName = bridgeNew.getBridgeName().getValue();
 132         LOG.debug("adding all ports to bridge: {}", bridgeName);
 133         List<BridgeInterfaceEntry> bridgeInterfaceEntries = bridgeEntry.getBridgeInterfaceEntry();
 134         if (bridgeInterfaceEntries != null) {
 135             for (BridgeInterfaceEntry bridgeInterfaceEntry : bridgeInterfaceEntries) {
 136                 String portName = bridgeInterfaceEntry.getInterfaceName();
 137                 InterfaceKey interfaceKey = new InterfaceKey(portName);
 138                 Interface iface = InterfaceManagerCommonUtils.getInterfaceFromConfigDS(interfaceKey, dataBroker);
 139                 if (iface != null) {
 140                     IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
 141                     if (ifTunnel != null) {
 142                         addTunnelPortToBridge(ifTunnel, bridgeIid, iface, portName, dataBroker);
 143                     }
 144                 } else {
 145                     LOG.debug("Interface {} not found in config DS", portName);
 146                 }
 147             }
 148         }
 149     }
 150
 151     /*
 152      * add all tunnels ports corresponding to the bridge to the topology config
 153      * DS
 154      */
 155     public static void removeAllPortsFromBridge(BridgeEntry bridgeEntry, DataBroker dataBroker,
 156             InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid, OvsdbBridgeAugmentation bridgeNew,
 157             List<ListenableFuture<Void>> futures) {
 158         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 159         String bridgeName = bridgeNew.getBridgeName().getValue();
 160         LOG.debug("removing all ports from bridge: {}", bridgeName);
 161         List<BridgeInterfaceEntry> bridgeInterfaceEntries = bridgeEntry.getBridgeInterfaceEntry();
 162         if (bridgeInterfaceEntries != null) {
 163             for (BridgeInterfaceEntry bridgeInterfaceEntry : bridgeInterfaceEntries) {
 164                 String portName = bridgeInterfaceEntry.getInterfaceName();
 165                 InterfaceKey interfaceKey = new InterfaceKey(portName);
 166                 Interface iface = InterfaceManagerCommonUtils.getInterfaceFromConfigDS(interfaceKey, dataBroker);
 167                 if (iface != null) {
 168                     IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
 169                     if (ifTunnel != null) {
 170                         removeTerminationEndPoint(futures, dataBroker, bridgeIid, iface.getName());
 171                     }
 172                 } else {
 173                     LOG.debug("Interface {} not found in config DS", portName);
 174                 }
 175             }
 176         }
 177         futures.add(writeTransaction.submit());
 178     }
 179
 180     private static void addVlanPortToBridge(InstanceIdentifier<?> bridgeIid, IfL2vlan ifL2vlan, IfTunnel ifTunnel,
 181             OvsdbBridgeAugmentation bridgeAugmentation, String bridgeName, String portName, DataBroker dataBroker,
 182             WriteTransaction t) {
 183         if (ifL2vlan.getVlanId() != null) {
 184             addTerminationPoint(bridgeIid, portName, ifL2vlan.getVlanId().getValue(),
 185                     null, null, ifTunnel);
 186         }
 187     }
 188
 189     private static void addTunnelPortToBridge(IfTunnel ifTunnel, InstanceIdentifier<?> bridgeIid, Interface iface,
 190             String portName, DataBroker dataBroker) {
 191         LOG.debug("adding tunnel port {} to bridge {}", portName, bridgeIid);
 192
 193         Class<? extends InterfaceTypeBase> type = TUNNEL_TYPE_MAP.get(ifTunnel.getTunnelInterfaceType());
 194
 195         if (type == null) {
 196             LOG.warn("Unknown Tunnel Type obtained while creating interface: {}", iface);
 197             return;
 198         }
 199
 200         int vlanId = 0;
 201         IfL2vlan ifL2vlan = iface.getAugmentation(IfL2vlan.class);
 202         if (ifL2vlan != null && ifL2vlan.getVlanId() != null) {
 203             vlanId = ifL2vlan.getVlanId().getValue();
 204         }
 205
 206         Map<String, String> options = Maps.newHashMap();
 207
 208         // Options common to any kind of tunnel
 209         IpAddress localIp = ifTunnel.getTunnelSource();
 210         options.put(TUNNEL_OPTIONS_LOCAL_IP, localIp.getIpv4Address().getValue());
 211
 212         IpAddress remoteIp = ifTunnel.getTunnelDestination();
 213         options.put(TUNNEL_OPTIONS_REMOTE_IP, remoteIp.getIpv4Address().getValue());
 214
 215         // Specific options for each type of tunnel
 216         if (!ifTunnel.getTunnelInterfaceType().equals(TunnelTypeMplsOverGre.class)) {
 217             options.put(TUNNEL_OPTIONS_KEY, TUNNEL_OPTIONS_VALUE_FLOW);
 218         }
 219         if (ifTunnel.getTunnelInterfaceType().equals(TunnelTypeVxlanGpe.class)) {
 220             options.put(TUNNEL_OPTIONS_EXTS, TUNNEL_OPTIONS_VALUE_GPE);
 221             options.put(TUNNEL_OPTIONS_NSI, TUNNEL_OPTIONS_VALUE_FLOW);
 222             options.put(TUNNEL_OPTIONS_NSP, TUNNEL_OPTIONS_VALUE_FLOW);
 223             options.put(TUNNEL_OPTIONS_NSHC1, TUNNEL_OPTIONS_VALUE_FLOW);
 224             options.put(TUNNEL_OPTIONS_NSHC2, TUNNEL_OPTIONS_VALUE_FLOW);
 225             options.put(TUNNEL_OPTIONS_NSHC3, TUNNEL_OPTIONS_VALUE_FLOW);
 226             options.put(TUNNEL_OPTIONS_NSHC4, TUNNEL_OPTIONS_VALUE_FLOW);
 227             // VxLAN-GPE interfaces will not use the default UDP port to avoid problems with other meshes
 228             options.put(TUNNEL_OPTIONS_DESTINATION_PORT, TUNNEL_OPTIONS_VALUE_GPE_DESTINATION_PORT);
 229         }
 230         addTerminationPoint(bridgeIid, portName, vlanId, type, options, ifTunnel);
 231     }
 232
 233     // Update is allowed only for tunnel monitoring attributes
 234     public static void updateBfdParamtersForTerminationPoint(InstanceIdentifier<?> bridgeIid, IfTunnel ifTunnel,
 235             String portName, WriteTransaction transaction) {
 236         InstanceIdentifier<TerminationPoint> tpIid = createTerminationPointInstanceIdentifier(
 237                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), portName);
 238         LOG.debug("update bfd parameters for interface {}", tpIid);
 239         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 240         List<InterfaceBfd> bfdParams = getBfdParams(ifTunnel);
 241         tpAugmentationBuilder.setInterfaceBfd(bfdParams);
 242
 243         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 244         tpBuilder.setKey(InstanceIdentifier.keyOf(tpIid));
 245         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
 246
 247         transaction.merge(LogicalDatastoreType.CONFIGURATION, tpIid, tpBuilder.build(), true);
 248     }
 249
 250     private static void addTerminationPoint(InstanceIdentifier<?> bridgeIid, String portName, int vlanId,
 251                                             Class<? extends InterfaceTypeBase> type, Map<String, String> options, IfTunnel ifTunnel) {
 252         InstanceIdentifier<TerminationPoint> tpIid = createTerminationPointInstanceIdentifier(
 253                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), portName);
 254         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 255
 256         tpAugmentationBuilder.setName(portName);
 257
 258         if (type != null) {
 259             tpAugmentationBuilder.setInterfaceType(type);
 260         }
 261
 262         if (options != null) {
 263             List<Options> optionsList = new ArrayList<>();
 264             for (Map.Entry<String, String> entry : options.entrySet()) {
 265                 OptionsBuilder optionsBuilder = new OptionsBuilder();
 266                 optionsBuilder.setKey(new OptionsKey(entry.getKey()));
 267                 optionsBuilder.setOption(entry.getKey());
 268                 optionsBuilder.setValue(entry.getValue());
 269                 optionsList.add(optionsBuilder.build());
 270             }
 271             tpAugmentationBuilder.setOptions(optionsList);
 272         }
 273
 274         if (vlanId != 0) {
 275             tpAugmentationBuilder.setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.Access);
 276             tpAugmentationBuilder.setVlanTag(new VlanId(vlanId));
 277         }
 278
 279         if (bfdMonitoringEnabled(ifTunnel)) {
 280             List<InterfaceBfd> bfdParams = getBfdParams(ifTunnel);
 281             tpAugmentationBuilder.setInterfaceBfd(bfdParams);
 282         }
 283
 284         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 285         tpBuilder.setKey(InstanceIdentifier.keyOf(tpIid));
 286         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
 287
 288         BatchingUtils.write(tpIid, tpBuilder.build(), BatchingUtils.EntityType.TOPOLOGY_CONFIG);
 289
 290     }
 291
 292     private static List<InterfaceBfd> getBfdParams(IfTunnel ifTunnel) {
 293         List<InterfaceBfd> bfdParams = new ArrayList<>();
 294         bfdParams.add(getIfBfdObj(BFD_PARAM_ENABLE,ifTunnel != null ? ifTunnel.isMonitorEnabled().toString() :"false"));
 295         bfdParams.add(getIfBfdObj(BFD_PARAM_MIN_TX, ifTunnel != null &&  ifTunnel.getMonitorInterval() != null ?
 296                 ifTunnel.getMonitorInterval().toString() : BFD_MIN_TX_VAL));
 297         return bfdParams;
 298     }
 299
 300     private static InterfaceBfd getIfBfdObj(String key, String value) {
 301         InterfaceBfdBuilder bfdBuilder = new InterfaceBfdBuilder();
 302         bfdBuilder.setBfdKey(key).setKey(new InterfaceBfdKey(key)).setBfdValue(value);
 303         return bfdBuilder.build();
 304     }
 305
 306     public static InstanceIdentifier<TerminationPoint> createTerminationPointInstanceIdentifier(NodeKey nodekey,
 307             String portName) {
 308         InstanceIdentifier<TerminationPoint> terminationPointPath = InstanceIdentifier.create(NetworkTopology.class)
 309                 .child(Topology.class, new TopologyKey(OVSDB_TOPOLOGY_ID)).child(Node.class, nodekey)
 310                 .child(TerminationPoint.class, new TerminationPointKey(new TpId(portName)));
 311
 312         LOG.debug("Termination point InstanceIdentifier generated : {}", terminationPointPath);
 313         return terminationPointPath;
 314     }
 315
 316     public static void removeTerminationEndPoint(List<ListenableFuture<Void>> futures, DataBroker dataBroker,
 317             InstanceIdentifier<?> bridgeIid, String interfaceName) {
 318         LOG.debug("removing termination point for {}", interfaceName);
 319         WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 320         InstanceIdentifier<TerminationPoint> tpIid = SouthboundUtils.createTerminationPointInstanceIdentifier(
 321                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), interfaceName);
 322         transaction.delete(LogicalDatastoreType.CONFIGURATION, tpIid);
 323         futures.add(transaction.submit());
 324     }
 325
 326     public static boolean bfdMonitoringEnabled(IfTunnel ifTunnel) {
 327         if (ifTunnel.isMonitorEnabled()
 328                 && TunnelMonitoringTypeBfd.class.isAssignableFrom(ifTunnel.getMonitorProtocol())) {
 329             return true;
 330         }
 331         return false;
 332     }
 333
 334     public static boolean isMonitorProtocolBfd(IfTunnel ifTunnel) {
 335         if (TunnelMonitoringTypeBfd.class.isAssignableFrom(ifTunnel.getMonitorProtocol())) {
 336             return true;
 337         }
 338         return false;
 339     }
 340 }