openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/match/MatchResponseConvertor.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.openflowplugin.openflow.md.core.sal.convertor.match;
  10
  11 import java.util.Arrays;
  12 import java.util.Collection;
  13 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.Convertor;
  14 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.ConvertorProcessor;
  15 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionDatapathIdConvertorData;
  16 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalArpOpCase;
  17 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalArpShaCase;
  18 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalArpSpaCase;
  19 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalArpThaCase;
  20 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalArpTpaCase;
  21 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalEthDstCase;
  22 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalEthSrcCase;
  23 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalEthTypeCase;
  24 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIcmpv4CodeCase;
  25 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIcmpv4TypeCase;
  26 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIcmpv6CodeCase;
  27 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIcmpv6TypeCase;
  28 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalInPhyPortCase;
  29 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalInPortCase;
  30 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpDscpCase;
  31 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpEcnCase;
  32 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpProtoCase;
  33 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv4DstCase;
  34 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv4SrcCase;
  35 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv6DstCase;
  36 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv6ExthdrCase;
  37 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv6FlabelCase;
  38 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv6NdSllCase;
  39 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv6NdTargetCase;
  40 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv6NdTllCase;
  41 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalIpv6SrcCase;
  42 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalMetadataCase;
  43 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalMplsBosCase;
  44 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalMplsLabelCase;
  45 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalMplsTcCase;
  46 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalPbbIsidCase;
  47 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalSctpDstCase;
  48 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalSctpSrcCase;
  49 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalTcpDstCase;
  50 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalExperimenterIdCase;
  51 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalTcpSrcCase;
  52 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalTunnelIdCase;
  53 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalTunnelIpv4DstCase;
  54 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalTunnelIpv4SrcCase;
  55 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalUdpDstCase;
  56 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalUdpSrcCase;
  57 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalVlanPcpCase;
  58 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.cases.OfToSalVlanVidCase;
  59 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.data.MatchResponseConvertorData;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv4MatchBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv6MatchBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.IpMatchBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.ProtocolMatchFieldsBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.TcpFlagsMatchBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.VlanMatchBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.ArpMatchBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchArbitraryBitMaskBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchArbitraryBitMaskBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.TunnelIpv4MatchBuilder;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.SctpMatchBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatchBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.UdpMatchBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchEntriesGrouping;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.MatchEntryValue;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TunnelIpv4Dst;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TunnelIpv4Src;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.set.field._case.SetFieldAction;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.Match;
  84 import org.opendaylight.yangtools.yang.binding.DataContainer;
  85
  86 /**
  87  * Converts Openflow 1.3+ specific flow match to MD-SAL format flow
  88  * match
  89  *
  90  * Example usage:
  91  * <pre>
  92  * {@code
  93  * VersionDatapathIdConvertorData data = new VersionDatapathIdConvertorData(version);
  94  * data.setDatapathId(datapathId);
  95  * Optional<MatchBuilder> salMatch = convertorManager.convert(ofMatch, data);
  96  * }
  97  * </pre>
  98  */
  99 public class MatchResponseConvertor extends Convertor<MatchEntriesGrouping, MatchBuilder, VersionDatapathIdConvertorData> {
 100     private static final ConvertorProcessor<MatchEntryValue, MatchBuilder, MatchResponseConvertorData> OF_TO_SAL_PROCESSOR = new ConvertorProcessor<MatchEntryValue, MatchBuilder, MatchResponseConvertorData>()
 101             .addCase(new OfToSalInPortCase())
 102             .addCase(new OfToSalInPhyPortCase())
 103             .addCase(new OfToSalMetadataCase())
 104             .addCase(new OfToSalEthSrcCase())
 105             .addCase(new OfToSalEthDstCase())
 106             .addCase(new OfToSalEthTypeCase())
 107             .addCase(new OfToSalVlanVidCase())
 108             .addCase(new OfToSalVlanPcpCase())
 109             .addCase(new OfToSalIpDscpCase())
 110             .addCase(new OfToSalIpEcnCase())
 111             .addCase(new OfToSalIpProtoCase())
 112             .addCase(new OfToSalTcpSrcCase())
 113             .addCase(new OfToSalTcpDstCase())
 114             .addCase(new OfToSalUdpSrcCase())
 115             .addCase(new OfToSalUdpDstCase())
 116             .addCase(new OfToSalSctpSrcCase())
 117             .addCase(new OfToSalSctpDstCase())
 118             .addCase(new OfToSalIcmpv4TypeCase())
 119             .addCase(new OfToSalIcmpv4CodeCase())
 120             .addCase(new OfToSalIcmpv6TypeCase())
 121             .addCase(new OfToSalIcmpv6CodeCase())
 122             .addCase(new OfToSalIpv4SrcCase())
 123             .addCase(new OfToSalIpv4DstCase())
 124             .addCase(new OfToSalArpOpCase())
 125             .addCase(new OfToSalArpSpaCase())
 126             .addCase(new OfToSalArpTpaCase())
 127             .addCase(new OfToSalArpShaCase())
 128             .addCase(new OfToSalArpThaCase())
 129             .addCase(new OfToSalIpv6SrcCase())
 130             .addCase(new OfToSalIpv6DstCase())
 131             .addCase(new OfToSalIpv6FlabelCase())
 132             .addCase(new OfToSalIpv6NdTargetCase())
 133             .addCase(new OfToSalIpv6NdSllCase())
 134             .addCase(new OfToSalIpv6NdTllCase())
 135             .addCase(new OfToSalIpv6ExthdrCase())
 136             .addCase(new OfToSalMplsLabelCase())
 137             .addCase(new OfToSalMplsBosCase())
 138             .addCase(new OfToSalMplsTcCase())
 139             .addCase(new OfToSalPbbIsidCase())
 140             .addCase(new OfToSalTunnelIdCase())
 141             .addCase(new OfToSalExperimenterIdCase());
 142
 143     private static final ConvertorProcessor<MatchEntryValue, MatchBuilder, MatchResponseConvertorData> OF_TO_SAL_TUNNEL_PROCESSOR = new ConvertorProcessor<MatchEntryValue, MatchBuilder, MatchResponseConvertorData>()
 144             .addCase(new OfToSalTunnelIpv4SrcCase())
 145             .addCase(new OfToSalTunnelIpv4DstCase());
 146     private static final java.util.List<Class<?>> TYPES = Arrays.asList(Match.class, SetFieldAction.class);
 147
 148     @Override
 149     public Collection<Class<?>> getTypes() {
 150         return  TYPES;
 151     }
 152
 153     @Override
 154     public MatchBuilder convert(MatchEntriesGrouping source, VersionDatapathIdConvertorData datapathIdConvertorData) {
 155         final MatchBuilder matchBuilder = new MatchBuilder();
 156
 157         final MatchResponseConvertorData data = new MatchResponseConvertorData(datapathIdConvertorData.getVersion());
 158         data.setDatapathId(datapathIdConvertorData.getDatapathId());
 159         data.setMatchBuilder(matchBuilder);
 160         data.setEthernetMatchBuilder(new EthernetMatchBuilder());
 161         data.setVlanMatchBuilder(new VlanMatchBuilder());
 162         data.setIpMatchBuilder(new IpMatchBuilder());
 163         data.setTcpMatchBuilder(new TcpMatchBuilder());
 164         data.setUdpMatchBuilder(new UdpMatchBuilder());
 165         data.setSctpMatchBuilder(new SctpMatchBuilder());
 166         data.setIcmpv4MatchBuilder(new Icmpv4MatchBuilder());
 167         data.setIcmpv6MatchBuilder(new Icmpv6MatchBuilder());
 168         data.setIpv4MatchBuilder(new Ipv4MatchBuilder());
 169         data.setIpv4MatchArbitraryBitMaskBuilder(new Ipv4MatchArbitraryBitMaskBuilder());
 170         data.setIpv6MatchArbitraryBitMaskBuilder(new Ipv6MatchArbitraryBitMaskBuilder());
 171         data.setArpMatchBuilder(new ArpMatchBuilder());
 172         data.setIpv6MatchBuilder(new Ipv6MatchBuilder());
 173         data.setProtocolMatchFieldsBuilder(new ProtocolMatchFieldsBuilder());
 174         data.setTunnelIpv4MatchBuilder(new TunnelIpv4MatchBuilder());
 175         data.setTcpFlagsMatchBuilder(new TcpFlagsMatchBuilder());
 176
 177         for (MatchEntry ofMatch : source.getMatchEntry()) {
 178             if (TunnelIpv4Dst.class.isAssignableFrom(ofMatch.getOxmMatchField()) ||
 179                     TunnelIpv4Src.class.isAssignableFrom(ofMatch.getOxmMatchField())) {
 180                 /**
 181                  * TODO: Fix TunnelIpv4Src and Ipv4Dst, because current implementation do not work
 182                  * TunnelIpv4Src and TunnelIpv4Dst are not compatible with
 183                  * org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField
 184                  * and so you cannot even set them to OxmMatchField.
 185                  * Creation of TunnelIpv4SrcCase and TunnelIpv4DstCase in
 186                  * org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value
 187                  * and proper use of it can fix this bug.
 188                  */
 189                 OF_TO_SAL_TUNNEL_PROCESSOR.process(ofMatch.getMatchEntryValue(), data, getConvertorExecutor());
 190             } else {
 191                 data.setOxmMatchField(ofMatch.getOxmMatchField());
 192                 OF_TO_SAL_PROCESSOR.process(ofMatch.getMatchEntryValue(), data, getConvertorExecutor());
 193             }
 194         }
 195
 196         return matchBuilder;
 197     }
 198 }