extension/openflowplugin-extension-nicira/src/main/java/org/opendaylight/openflowplugin/extension/vendor/nicira/convertor/match/MatchUtil.java

   1 /**
   2  * Copyright (c) 2014, 2017 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.openflowplugin.extension.vendor.nicira.convertor.match;
   9
  10 import com.google.common.base.Joiner;
  11 import com.google.common.base.Splitter;
  12 import com.google.common.primitives.Longs;
  13 import com.google.common.primitives.UnsignedBytes;
  14 import java.util.HashSet;
  15 import java.util.Iterator;
  16 import java.util.Set;
  17 import org.opendaylight.openflowplugin.extension.api.GroupingResolver;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.oxm.container.match.entry.value.ExperimenterIdCase;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.oxm.container.match.entry.value.ExperimenterIdCaseBuilder;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.oxm.container.match.entry.value.experimenter.id._case.ExperimenterBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ExperimenterId;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.ExperimenterClass;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmClassBase;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntryBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.MatchEntryValue;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.OfjAugNxExpMatch;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.OfjAugNxExpMatchBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.oxm.container.match.entry.value.experimenter.id._case.NxExpMatchEntryValue;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.general.extension.grouping.Extension;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNodesNodeTableFlow;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNotifPacketIn;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNotifSwitchFlowRemoved;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchPacketInMessage;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcAddFlow;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcRemoveFlow;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcUpdateFlowOriginal;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcUpdateFlowUpdated;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxArpShaGrouping;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxArpThaGrouping;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxCtMarkGrouping;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxCtStateGrouping;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxCtTpDstGrouping;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxCtTpSrcGrouping;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxCtZoneGrouping;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshFlagsGrouping;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshMdtypeGrouping;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshNpGrouping;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshTtlGrouping;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshc1Grouping;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshc2Grouping;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshc3Grouping;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshc4Grouping;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNsiGrouping;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNspGrouping;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxPktMarkGrouping;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxRegGrouping;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxTunIdGrouping;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxTunIpv4DstGrouping;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxTunIpv4SrcGrouping;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfArpOpGrouping;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfArpSpaGrouping;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfArpTpaGrouping;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfEthDstGrouping;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfEthSrcGrouping;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfEthTypeGrouping;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfInPortGrouping;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfTcpDstGrouping;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfTcpSrcGrouping;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfUdpDstGrouping;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfUdpSrcGrouping;
  73 import org.opendaylight.yangtools.yang.binding.Augmentation;
  74
  75 /**
  76  * Match utilities.
  77  *
  78  * @author msunal
  79  */
  80 public final class MatchUtil {
  81     private static final Splitter SPLITTER = Splitter.on('.');
  82     private static final Joiner JOINER = Joiner.on('.');
  83
  84     private static final Set<Class<? extends Augmentation<Extension>>> AUGMENTATIONS_OF_EXTENSION = new HashSet<>();
  85     public static final GroupingResolver<NxmNxRegGrouping, Extension> REG_RESOLVER = new GroupingResolver<>(
  86             NxmNxRegGrouping.class);
  87     public static final GroupingResolver<NxmNxTunIdGrouping, Extension> TUN_ID_RESOLVER = new GroupingResolver<>(
  88             NxmNxTunIdGrouping.class);
  89     public static final GroupingResolver<NxmNxArpShaGrouping, Extension> ARP_SHA_RESOLVER = new GroupingResolver<>(
  90             NxmNxArpShaGrouping.class);
  91     public static final GroupingResolver<NxmNxArpThaGrouping, Extension> ARP_THA_RESOLVER = new GroupingResolver<>(
  92             NxmNxArpThaGrouping.class);
  93     public static final GroupingResolver<NxmOfArpOpGrouping, Extension> ARP_OP_RESOLVER = new GroupingResolver<>(
  94             NxmOfArpOpGrouping.class);
  95     public static final GroupingResolver<NxmOfArpSpaGrouping, Extension> ARP_SPA_RESOLVER = new GroupingResolver<>(
  96             NxmOfArpSpaGrouping.class);
  97     public static final GroupingResolver<NxmOfArpTpaGrouping, Extension> ARP_TPA_RESOLVER = new GroupingResolver<>(
  98             NxmOfArpTpaGrouping.class);
  99     public static final GroupingResolver<NxmNxTunIpv4DstGrouping, Extension> TUN_IPV4_DST_RESOLVER =
 100             new GroupingResolver<>(NxmNxTunIpv4DstGrouping.class);
 101     public static final GroupingResolver<NxmNxTunIpv4SrcGrouping, Extension> TUN_IPV4_SRC_RESOLVER =
 102             new GroupingResolver<>(NxmNxTunIpv4SrcGrouping.class);
 103     public static final GroupingResolver<NxmOfEthDstGrouping, Extension> ETH_DST_RESOLVER = new GroupingResolver<>(
 104             NxmOfEthDstGrouping.class);
 105     public static final GroupingResolver<NxmOfEthSrcGrouping, Extension> ETH_SRC_RESOLVER = new GroupingResolver<>(
 106             NxmOfEthSrcGrouping.class);
 107     public static final GroupingResolver<NxmOfEthTypeGrouping, Extension> ETH_TYPE_RESOLVER = new GroupingResolver<>(
 108             NxmOfEthTypeGrouping.class);
 109     public static final GroupingResolver<NxmNxNsiGrouping, Extension> NSI_RESOLVER = new GroupingResolver<>(
 110             NxmNxNsiGrouping.class);
 111     public static final GroupingResolver<NxmNxNspGrouping, Extension> NSP_RESOLVER = new GroupingResolver<>(
 112             NxmNxNspGrouping.class);
 113     public static final GroupingResolver<NxmNxNshc1Grouping, Extension> NSC1_RESOLVER = new GroupingResolver<>(
 114             NxmNxNshc1Grouping.class);
 115     public static final GroupingResolver<NxmNxNshc2Grouping, Extension> NSC2_RESOLVER = new GroupingResolver<>(
 116             NxmNxNshc2Grouping.class);
 117     public static final GroupingResolver<NxmNxNshc3Grouping, Extension> NSC3_RESOLVER = new GroupingResolver<>(
 118             NxmNxNshc3Grouping.class);
 119     public static final GroupingResolver<NxmNxNshc4Grouping, Extension> NSC4_RESOLVER = new GroupingResolver<>(
 120             NxmNxNshc4Grouping.class);
 121     public static final GroupingResolver<NxmNxNshFlagsGrouping, Extension> NSH_FLAGS_RESOLVER =
 122             new GroupingResolver<>(NxmNxNshFlagsGrouping.class);
 123     public static final GroupingResolver<NxmNxNshMdtypeGrouping, Extension> NSH_MDTYPE_RESOLVER =
 124             new GroupingResolver<>(NxmNxNshMdtypeGrouping.class);
 125     public static final GroupingResolver<NxmNxNshNpGrouping, Extension> NSH_NP_RESOLVER = new GroupingResolver<>(
 126             NxmNxNshNpGrouping.class);
 127     public static final GroupingResolver<NxmNxNshTtlGrouping, Extension> NSH_TTL_RESOLVER =
 128             new GroupingResolver<>(NxmNxNshTtlGrouping.class);
 129     public static final GroupingResolver<NxmOfTcpSrcGrouping, Extension> TCP_SRC_RESOLVER = new GroupingResolver<>(
 130             NxmOfTcpSrcGrouping.class);
 131     public static final GroupingResolver<NxmOfTcpDstGrouping, Extension> TCP_DST_RESOLVER = new GroupingResolver<>(
 132             NxmOfTcpDstGrouping.class);
 133     public static final GroupingResolver<NxmOfUdpSrcGrouping, Extension> UDP_SRC_RESOLVER = new GroupingResolver<>(
 134             NxmOfUdpSrcGrouping.class);
 135     public static final GroupingResolver<NxmOfUdpDstGrouping, Extension> UDP_DST_RESOLVER = new GroupingResolver<>(
 136             NxmOfUdpDstGrouping.class);
 137     public static final GroupingResolver<NxmNxCtMarkGrouping, Extension> CT_MARK_RESOLVER = new GroupingResolver<>(
 138             NxmNxCtMarkGrouping.class);
 139     public static final GroupingResolver<NxmNxCtStateGrouping, Extension> CT_STATE_RESOLVER = new GroupingResolver<>(
 140             NxmNxCtStateGrouping.class);
 141     public static final GroupingResolver<NxmNxCtZoneGrouping, Extension> CT_ZONE_RESOLVER = new GroupingResolver<>(
 142             NxmNxCtZoneGrouping.class);
 143     public static final GroupingResolver<NxmNxCtTpSrcGrouping, Extension> CT_TP_SRC_RESOLVER = new GroupingResolver<>(
 144             NxmNxCtTpSrcGrouping.class);
 145     public static final GroupingResolver<NxmNxCtTpDstGrouping, Extension> CT_TP_DST_RESOLVER = new GroupingResolver<>(
 146             NxmNxCtTpDstGrouping.class);
 147     public static final GroupingResolver<NxmNxPktMarkGrouping, Extension> PKT_MARK_RESOLVER = new GroupingResolver<>(
 148             NxmNxPktMarkGrouping.class);
 149     public static final GroupingResolver<NxmOfInPortGrouping, Extension> NXM_OF_INPORT_RESOLVER =
 150             new GroupingResolver<>(NxmOfInPortGrouping.class);
 151
 152     static {
 153         AUGMENTATIONS_OF_EXTENSION.add(NxAugMatchRpcAddFlow.class);
 154         AUGMENTATIONS_OF_EXTENSION.add(NxAugMatchRpcRemoveFlow.class);
 155         AUGMENTATIONS_OF_EXTENSION.add(NxAugMatchRpcUpdateFlowOriginal.class);
 156         AUGMENTATIONS_OF_EXTENSION.add(NxAugMatchRpcUpdateFlowUpdated.class);
 157         AUGMENTATIONS_OF_EXTENSION.add(NxAugMatchNodesNodeTableFlow.class);
 158         AUGMENTATIONS_OF_EXTENSION.add(NxAugMatchNotifSwitchFlowRemoved.class);
 159         AUGMENTATIONS_OF_EXTENSION.add(NxAugMatchNotifPacketIn.class);
 160         //augmentationsOfExtension.add(NxAugMatchNotifUpdateFlowStats.class);
 161         AUGMENTATIONS_OF_EXTENSION.add(NxAugMatchPacketInMessage.class);
 162         REG_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 163         TUN_ID_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 164         ARP_SHA_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 165         ARP_THA_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 166         ARP_OP_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 167         ARP_SPA_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 168         ARP_TPA_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 169         TUN_IPV4_DST_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 170         TUN_IPV4_SRC_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 171         ETH_DST_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 172         ETH_SRC_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 173         ETH_TYPE_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 174         NSP_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 175         NSI_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 176         NSC1_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 177         NSC2_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 178         NSC3_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 179         NSC4_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 180         NSH_FLAGS_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 181         NSH_MDTYPE_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 182         NSH_NP_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 183         NSH_TTL_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 184         TCP_SRC_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 185         TCP_DST_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 186         UDP_SRC_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 187         UDP_DST_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 188         CT_STATE_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 189         CT_ZONE_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 190         NXM_OF_INPORT_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 191         CT_MARK_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 192         CT_TP_SRC_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 193         CT_TP_DST_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 194         PKT_MARK_RESOLVER.setAugmentations(AUGMENTATIONS_OF_EXTENSION);
 195     }
 196
 197     private MatchUtil() {
 198     }
 199
 200     public static MatchEntryBuilder createDefaultMatchEntryBuilder(Class<? extends MatchField> matchField,
 201                                                                    Class<? extends OxmClassBase> oxmClass,
 202                                                                    MatchEntryValue matchEntryValue) {
 203         MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
 204         matchEntryBuilder.setHasMask(false);
 205         matchEntryBuilder.setOxmMatchField(matchField);
 206         matchEntryBuilder.setOxmClass(oxmClass);
 207         matchEntryBuilder.setMatchEntryValue(matchEntryValue);
 208         return matchEntryBuilder;
 209     }
 210
 211     public static <V extends Augmentation<ExperimenterIdCase>> MatchEntryBuilder createExperimenterMatchEntryBuilder(
 212             Class<? extends MatchField> matchField,
 213             long experimenterId,
 214             NxExpMatchEntryValue value) {
 215         ExperimenterBuilder experimenterBuilder = new ExperimenterBuilder();
 216         experimenterBuilder.setExperimenter(new ExperimenterId(experimenterId));
 217         ExperimenterIdCaseBuilder expCaseBuilder = new ExperimenterIdCaseBuilder();
 218         expCaseBuilder.setExperimenter(experimenterBuilder.build());
 219         OfjAugNxExpMatch ofjAugNxExpMatch = new OfjAugNxExpMatchBuilder().setNxExpMatchEntryValue(value).build();
 220         expCaseBuilder.addAugmentation(OfjAugNxExpMatch.class, ofjAugNxExpMatch);
 221         return createDefaultMatchEntryBuilder(matchField, ExperimenterClass.class, expCaseBuilder.build());
 222     }
 223
 224     public static Long ipv4ToLong(Ipv4Address ipv4) {
 225         Iterator<String> iterator = SPLITTER.split(ipv4.getValue()).iterator();
 226         byte[] bytes = new byte[8];
 227         for (int i = 0; i < bytes.length; i++) {
 228             if (i < 4) {
 229                 bytes[i] = 0;
 230             } else {
 231                 bytes[i] = UnsignedBytes.parseUnsignedByte(iterator.next());
 232             }
 233         }
 234         Long result = Longs.fromByteArray(bytes);
 235         return result;
 236     }
 237
 238     public static Ipv4Address longToIpv4Address(Long value) {
 239         byte[] bytes = Longs.toByteArray(value);
 240         String[] strArray = new String[4];
 241         for (int i = 4; i < bytes.length; i++) {
 242             strArray[i - 4] = UnsignedBytes.toString(bytes[i]);
 243         }
 244         String str = JOINER.join(strArray);
 245         Ipv4Address result = new Ipv4Address(str);
 246         return result;
 247     }
 248 }