openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/match/cases/SalToOfIpv6MatchCase.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.cases;
  10
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.Optional;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  16 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.ConvertorCase;
  17 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.IpConversionUtil;
  18 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionConvertorData;
  19 import org.opendaylight.openflowplugin.openflow.md.util.ByteUtil;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6Match;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Ipv6ExthdrFlags;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6Dst;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6Exthdr;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6Flabel;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6NdSll;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6NdTarget;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6NdTll;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6Src;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OpenflowBasicClass;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntryBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6DstCaseBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6ExthdrCaseBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6FlabelCaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6NdSllCaseBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6NdTargetCaseBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6NdTllCaseBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6SrcCaseBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.dst._case.Ipv6DstBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.exthdr._case.Ipv6ExthdrBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.flabel._case.Ipv6FlabelBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.nd.sll._case.Ipv6NdSllBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.nd.target._case.Ipv6NdTargetBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.nd.tll._case.Ipv6NdTllBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.src._case.Ipv6SrcBuilder;
  48
  49 public class SalToOfIpv6MatchCase extends ConvertorCase<Ipv6Match, List<MatchEntry>, VersionConvertorData> {
  50     public SalToOfIpv6MatchCase() {
  51         super(Ipv6Match.class, true);
  52     }
  53
  54     @Override
  55     public Optional<List<MatchEntry>> process(@Nonnull Ipv6Match source, VersionConvertorData data,
  56             ConvertorExecutor convertorExecutor) {
  57         List<MatchEntry> result = new ArrayList<>();
  58
  59         if (source.getIpv6Source() != null) {
  60             Ipv6Prefix ipv6Prefix = source.getIpv6Source();
  61             MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
  62             matchEntryBuilder.setOxmClass(OpenflowBasicClass.class);
  63             matchEntryBuilder.setOxmMatchField(Ipv6Src.class);
  64
  65             Ipv6SrcCaseBuilder ipv6SrcCaseBuilder = new Ipv6SrcCaseBuilder();
  66             Ipv6SrcBuilder ipv6SrcBuilder = new Ipv6SrcBuilder();
  67             final Integer prefix = IpConversionUtil.hasIpv6Prefix(ipv6Prefix);
  68             boolean hasMask = false;
  69             if (null != prefix) {
  70                 ipv6SrcBuilder.setMask(IpConversionUtil.convertIpv6PrefixToByteArray(prefix));
  71                 hasMask = true;
  72             }
  73             ipv6SrcBuilder.setIpv6Address(IpConversionUtil.extractIpv6Address(ipv6Prefix));
  74             ipv6SrcCaseBuilder.setIpv6Src(ipv6SrcBuilder.build());
  75             matchEntryBuilder.setHasMask(hasMask);
  76             matchEntryBuilder.setMatchEntryValue(ipv6SrcCaseBuilder.build());
  77             result.add(matchEntryBuilder.build());
  78         }
  79
  80         if (source.getIpv6Destination() != null) {
  81             Ipv6Prefix ipv6Prefix = source.getIpv6Destination();
  82             MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
  83             matchEntryBuilder.setOxmClass(OpenflowBasicClass.class);
  84             matchEntryBuilder.setOxmMatchField(Ipv6Dst.class);
  85
  86             Ipv6DstCaseBuilder ipv6DstCaseBuilder = new Ipv6DstCaseBuilder();
  87             Ipv6DstBuilder ipv6DstBuilder = new Ipv6DstBuilder();
  88             final Integer prefix = IpConversionUtil.hasIpv6Prefix(ipv6Prefix);
  89             boolean hasMask = false;
  90             if (null != prefix) {
  91                 ipv6DstBuilder.setMask(IpConversionUtil.convertIpv6PrefixToByteArray(prefix));
  92                 hasMask = true;
  93             }
  94             ipv6DstBuilder.setIpv6Address(IpConversionUtil.extractIpv6Address(ipv6Prefix));
  95             ipv6DstCaseBuilder.setIpv6Dst(ipv6DstBuilder.build());
  96             matchEntryBuilder.setHasMask(hasMask);
  97             matchEntryBuilder.setMatchEntryValue(ipv6DstCaseBuilder.build());
  98             result.add(matchEntryBuilder.build());
  99         }
 100
 101         if (source.getIpv6Label() != null) {
 102             MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
 103             boolean hasmask = false;
 104             matchEntryBuilder.setOxmClass(OpenflowBasicClass.class);
 105             matchEntryBuilder.setOxmMatchField(Ipv6Flabel.class);
 106             Ipv6FlabelCaseBuilder ipv6FlabelCaseBuilder = new Ipv6FlabelCaseBuilder();
 107             Ipv6FlabelBuilder ipv6FlabelBuilder = new Ipv6FlabelBuilder();
 108             ipv6FlabelBuilder.setIpv6Flabel(source.getIpv6Label().getIpv6Flabel());
 109
 110             if (source.getIpv6Label().getFlabelMask() != null) {
 111                 hasmask = true;
 112                 ipv6FlabelBuilder.setMask(ByteUtil.unsignedIntToBytes(
 113                         source.getIpv6Label().getFlabelMask().getValue()));
 114             }
 115
 116             ipv6FlabelCaseBuilder.setIpv6Flabel(ipv6FlabelBuilder.build());
 117             matchEntryBuilder.setMatchEntryValue(ipv6FlabelCaseBuilder.build());
 118             matchEntryBuilder.setHasMask(hasmask);
 119             result.add(matchEntryBuilder.build());
 120         }
 121
 122         if (source.getIpv6NdTarget() != null) {
 123             MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
 124             matchEntryBuilder.setOxmClass(OpenflowBasicClass.class);
 125             matchEntryBuilder.setHasMask(false);
 126             matchEntryBuilder.setOxmMatchField(Ipv6NdTarget.class);
 127
 128             Ipv6NdTargetCaseBuilder ipv6NdTargetCaseBuilder = new Ipv6NdTargetCaseBuilder();
 129             Ipv6NdTargetBuilder ipv6NdTargetBuilder = new Ipv6NdTargetBuilder();
 130             ipv6NdTargetBuilder.setIpv6Address(source.getIpv6NdTarget());
 131             ipv6NdTargetCaseBuilder.setIpv6NdTarget(ipv6NdTargetBuilder.build());
 132             matchEntryBuilder.setMatchEntryValue(ipv6NdTargetCaseBuilder.build());
 133             result.add(matchEntryBuilder.build());
 134         }
 135
 136         if (source.getIpv6NdSll() != null) {
 137             MacAddress ipv6NdSll = source.getIpv6NdSll();
 138             MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
 139             matchEntryBuilder.setOxmClass(OpenflowBasicClass.class);
 140             matchEntryBuilder.setOxmMatchField(Ipv6NdSll.class);
 141
 142             Ipv6NdSllCaseBuilder ipv6NdSllCaseBuilder = new Ipv6NdSllCaseBuilder();
 143             Ipv6NdSllBuilder ipv6NdSllBuilder = new Ipv6NdSllBuilder();
 144             ipv6NdSllBuilder.setMacAddress(ipv6NdSll);
 145             ipv6NdSllCaseBuilder.setIpv6NdSll(ipv6NdSllBuilder.build());
 146             matchEntryBuilder.setMatchEntryValue(ipv6NdSllCaseBuilder.build());
 147             matchEntryBuilder.setHasMask(false);
 148             result.add(matchEntryBuilder.build());
 149         }
 150
 151         if (source.getIpv6NdTll() != null) {
 152             MacAddress ipv6NdSll = source.getIpv6NdTll();
 153             MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
 154             matchEntryBuilder.setOxmClass(OpenflowBasicClass.class);
 155             matchEntryBuilder.setOxmMatchField(Ipv6NdTll.class);
 156
 157             Ipv6NdTllCaseBuilder ipv6NdTllCaseBuilder = new Ipv6NdTllCaseBuilder();
 158             Ipv6NdTllBuilder ipv6NdTllBuilder = new Ipv6NdTllBuilder();
 159             ipv6NdTllBuilder.setMacAddress(ipv6NdSll);
 160             ipv6NdTllCaseBuilder.setIpv6NdTll(ipv6NdTllBuilder.build());
 161             matchEntryBuilder.setMatchEntryValue(ipv6NdTllCaseBuilder.build());
 162             matchEntryBuilder.setHasMask(false);
 163             result.add(matchEntryBuilder.build());
 164
 165         }
 166
 167         if (source.getIpv6ExtHeader() != null) {
 168             MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
 169             boolean hasmask = false;
 170             matchEntryBuilder.setOxmClass(OpenflowBasicClass.class);
 171             matchEntryBuilder.setOxmMatchField(Ipv6Exthdr.class);
 172             Ipv6ExthdrCaseBuilder ipv6ExthdrCaseBuilder = new Ipv6ExthdrCaseBuilder();
 173             Ipv6ExthdrBuilder ipv6ExthdrBuilder = new Ipv6ExthdrBuilder();
 174
 175             int bitmap = source.getIpv6ExtHeader().getIpv6Exthdr();
 176             ipv6ExthdrBuilder.setPseudoField(makeIpv6ExthdrFlags(bitmap));
 177
 178             if (source.getIpv6ExtHeader().getIpv6ExthdrMask() != null) {
 179                 hasmask = true;
 180                 ipv6ExthdrBuilder.setMask(ByteUtil.unsignedShortToBytes(source.getIpv6ExtHeader().getIpv6ExthdrMask()));
 181             }
 182
 183             ipv6ExthdrCaseBuilder.setIpv6Exthdr(ipv6ExthdrBuilder.build());
 184             matchEntryBuilder.setMatchEntryValue(ipv6ExthdrCaseBuilder.build());
 185             matchEntryBuilder.setHasMask(hasmask);
 186             result.add(matchEntryBuilder.build());
 187         }
 188
 189         return Optional.of(result);
 190     }
 191
 192     @SuppressWarnings("checkstyle:AbbreviationAsWordInName")
 193     private Ipv6ExthdrFlags makeIpv6ExthdrFlags(int bitmap) {
 194         final Boolean NONEXT = (bitmap & 1) != 0;
 195         final Boolean ESP = (bitmap & 1 << 1) != 0;
 196         final Boolean AUTH = (bitmap & 1 << 2) != 0;
 197         final Boolean DEST = (bitmap & 1 << 3) != 0;
 198         final Boolean FRAG = (bitmap & 1 << 4) != 0;
 199         final Boolean ROUTER = (bitmap & 1 << 5) != 0;
 200         final Boolean HOP = (bitmap & 1 << 6) != 0;
 201         final Boolean UNREP = (bitmap & 1 << 7) != 0;
 202         final Boolean UNSEQ = (bitmap & 1 << 8) != 0;
 203
 204         return new Ipv6ExthdrFlags(AUTH, DEST, ESP, FRAG, HOP, NONEXT, ROUTER, UNREP, UNSEQ);
 205     }
 206 }