southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/SouthboundConstants.java

   1 /*
   2  * Copyright (c) 2015 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 package org.opendaylight.ovsdb.southbound;
   9
  10 import com.google.common.collect.ImmutableBiMap;
  11 import com.google.common.collect.ImmutableCollection;
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.ImmutableSet;
  14 import java.util.Arrays;
  15 import java.util.Collections;
  16 import java.util.List;
  17
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeBase;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeNetdev;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeSystem;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdk;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkr;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhost;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhostuser;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGeneve;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre64;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeInternal;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeIpsecGre;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeIpsecGre64;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeLisp;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypePatch;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeStt;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeSystem;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeTap;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlanGpe;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow10;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow11;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow12;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow13;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow14;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow15;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeBase;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeSecure;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeStandalone;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeBase;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeEgressPolicer;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxCodel;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxFqCodel;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxHfsc;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxHtb;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxSfq;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  58
  59 public class SouthboundConstants {
  60
  61     private SouthboundConstants() { }
  62
  63     public static final String OPEN_V_SWITCH = "Open_vSwitch";
  64     public static final TopologyId OVSDB_TOPOLOGY_ID = new TopologyId(new Uri("ovsdb:1"));
  65     public static final String OVSDB_URI_PREFIX = "ovsdb";
  66     public static final String BRIDGE_URI_PREFIX = "bridge";
  67     public static final String TP_URI_PREFIX = "terminationpoint";
  68     public static final String QOS_URI_PREFIX = "qos";
  69     public static final String QOS_NAMED_UUID_PREFIX = "QOS";
  70     public static final Integer PORT_QOS_LIST_KEY = 1;
  71     public static final String QUEUE_URI_PREFIX = "queue";
  72     public static final String QUEUE_NAMED_UUID_PREFIX = "QUEUE";
  73     public static final String AUTOATTACH_URI_PREFIX = "autoattach";
  74     public static final String AUTOATTACH_SUPPORTED_OVS_SCHEMA_VERSION = "7.11.2";
  75     public static final Integer DEFAULT_OVSDB_PORT = 6640;
  76     public static final String DEFAULT_OPENFLOW_PORT = "6653";
  77     public static final String OPENFLOW_CONNECTION_PROTOCOL = "tcp";
  78     public static final String UUID = "uuid";
  79     public static final String QOS_LINUX_HTB = "linux-htb";
  80     public static final String QOS_LINUX_HFSC = "linux-hfsc";
  81     // The following four QoS types are present in OVS 2.5+
  82     // Refer to http://openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.txt
  83     public static final String QOS_LINUX_SFQ = "linux-sfq";
  84     public static final String QOS_LINUX_CODEL = "linux-codel";
  85     public static final String QOS_LINUX_FQ_CODEL = "linux-fq_codel";
  86     public static final String QOS_EGRESS_POLICER = "egress-policer";
  87     public static final ImmutableBiMap<Class<? extends QosTypeBase>,String> QOS_TYPE_MAP
  88         = new ImmutableBiMap.Builder<Class<? extends QosTypeBase>,String>()
  89             .put(QosTypeLinuxHtb.class,QOS_LINUX_HTB)
  90             .put(QosTypeLinuxHfsc.class,QOS_LINUX_HFSC)
  91             .put(QosTypeLinuxSfq.class,QOS_LINUX_SFQ)
  92             .put(QosTypeLinuxCodel.class,QOS_LINUX_CODEL)
  93             .put(QosTypeLinuxFqCodel.class,QOS_LINUX_FQ_CODEL)
  94             .put(QosTypeEgressPolicer.class,QOS_EGRESS_POLICER)
  95             .build();
  96
  97     public static final ImmutableBiMap<Class<? extends OvsdbBridgeProtocolBase>,String> OVSDB_PROTOCOL_MAP
  98         = new ImmutableBiMap.Builder<Class<? extends OvsdbBridgeProtocolBase>,String>()
  99             .put(OvsdbBridgeProtocolOpenflow10.class,"OpenFlow10")
 100             .put(OvsdbBridgeProtocolOpenflow11.class,"OpenFlow11")
 101             .put(OvsdbBridgeProtocolOpenflow12.class,"OpenFlow12")
 102             .put(OvsdbBridgeProtocolOpenflow13.class,"OpenFlow13")
 103             .put(OvsdbBridgeProtocolOpenflow14.class,"OpenFlow14")
 104             .put(OvsdbBridgeProtocolOpenflow15.class,"OpenFlow15")
 105             .build();
 106
 107     public static final ImmutableBiMap<Class<? extends OvsdbFailModeBase>,String> OVSDB_FAIL_MODE_MAP
 108         = new ImmutableBiMap.Builder<Class<? extends OvsdbFailModeBase>,String>()
 109             .put(OvsdbFailModeStandalone.class,"standalone")
 110             .put(OvsdbFailModeSecure.class,"secure")
 111             .build();
 112
 113     public static final ImmutableBiMap<String, Class<? extends InterfaceTypeBase>> OVSDB_INTERFACE_TYPE_MAP
 114         = new ImmutableBiMap.Builder<String, Class<? extends InterfaceTypeBase>>()
 115             .put("internal", InterfaceTypeInternal.class)
 116             .put("vxlan", InterfaceTypeVxlan.class)
 117             .put("vxlan-gpe", InterfaceTypeVxlanGpe.class)
 118             .put("patch", InterfaceTypePatch.class)
 119             .put("system", InterfaceTypeSystem.class)
 120             .put("tap", InterfaceTypeTap.class)
 121             .put("geneve", InterfaceTypeGeneve.class)
 122             .put("gre", InterfaceTypeGre.class)
 123             .put("ipsec_gre", InterfaceTypeIpsecGre.class)
 124             .put("gre64", InterfaceTypeGre64.class)
 125             .put("ipsec_gre64", InterfaceTypeIpsecGre64.class)
 126             .put("lisp", InterfaceTypeLisp.class)
 127             .put("dpdk", InterfaceTypeDpdk.class)
 128             .put("dpdkr", InterfaceTypeDpdkr.class)
 129             .put("dpdkvhost", InterfaceTypeDpdkvhost.class)
 130             .put("dpdkvhostuser", InterfaceTypeDpdkvhostuser.class)
 131             .put("stt", InterfaceTypeStt.class)
 132             .build();
 133
 134     public static final ImmutableBiMap<Class<? extends DatapathTypeBase>,String> DATAPATH_TYPE_MAP
 135         = new ImmutableBiMap.Builder<Class<? extends DatapathTypeBase>,String>()
 136             .put(DatapathTypeSystem.class,"system")
 137             .put(DatapathTypeNetdev.class,"netdev")
 138             .build();
 139
 140     public static final String IID_EXTERNAL_ID_KEY = "opendaylight-iid";
 141     public static final String QOS_ID_EXTERNAL_ID_KEY = "opendaylight-qos-id";
 142     public static final String QUEUE_ID_EXTERNAL_ID_KEY = "opendaylight-queue-id";
 143     public static final String AUTOATTACH_ID_EXTERNAL_ID_KEY = "opendaylight-autoattach-id";
 144
 145     static final ImmutableCollection<String> SKIP_OVSDB_TABLE = new ImmutableSet.Builder<String>()
 146             .add("Flow_Table")
 147             .add("Mirror")
 148             .add("NetFlow")
 149             .add("sFlow")
 150             .add("IPFIX")
 151             .add("Flow_Sample_Collector_Set")
 152             .build();
 153
 154     //Note: _version is an internal column of ovsdb schema, that gets updated
 155     //with every change in the row of the table.
 156     static final ImmutableMap<String,List<String>> SKIP_COLUMN_FROM_TABLE
 157             = new ImmutableMap.Builder<String,List<String>>()
 158             .put("Open_vSwitch", Arrays.asList("statistics","_version"))
 159             .put("Port", Arrays.asList("statistics","_version"))
 160             .put("Manager", Collections.singletonList("_version"))
 161             .put("SSL", Collections.singletonList("_version"))
 162             .put("QoS", Collections.singletonList("_version"))
 163             .put("Queue", Collections.singletonList("_version"))
 164             .put("Bridge", Collections.singletonList("_version"))
 165             .put("Interface", Arrays.asList("statistics","_version"))
 166             .put("Controller", Arrays.asList("status","_version"))
 167             .build();
 168
 169     public enum VlanModes {
 170         ACCESS("access"),
 171         NATIVE_TAGGED("native-tagged"),
 172         NATIVE_UNTAGGED("native-untagged"),
 173         TRUNK("trunk");
 174
 175         private final String mode;
 176
 177         VlanModes(String mode) {
 178             this.mode = mode;
 179         }
 180
 181         @Override
 182         public String toString() {
 183             return mode;
 184         }
 185
 186         public String getMode() {
 187             return this.mode;
 188         }
 189     }
 190
 191     public enum OwnershipStates {
 192         OWNER("OWNER"),
 193         NONOWNER("NON-OWNER");
 194
 195         private final String state;
 196
 197         OwnershipStates(String state) {
 198             this.state = state;
 199         }
 200
 201         @Override
 202         public String toString() {
 203             return state;
 204         }
 205
 206         public String getState() {
 207             return this.state;
 208         }
 209     }
 210 }