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

   1 /**
   2  * Copyright (c) 2014 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.Optional;
  11 import java.util.Objects;
  12 import org.opendaylight.openflowjava.nx.codec.match.NiciraMatchCodecs;
  13 import org.opendaylight.openflowplugin.extension.api.ConvertorFromOFJava;
  14 import org.opendaylight.openflowplugin.extension.api.ConvertorToOFJava;
  15 import org.opendaylight.openflowplugin.extension.api.ExtensionAugment;
  16 import org.opendaylight.openflowplugin.extension.api.path.MatchPath;
  17 import org.opendaylight.openflowplugin.extension.vendor.nicira.convertor.CodecPreconditionException;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Nxm1Class;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.reg.grouping.RegValuesBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.oxm.container.match.entry.value.RegCaseValue;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.oxm.container.match.entry.value.RegCaseValueBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.ExtensionKey;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.general.extension.grouping.Extension;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNodesNodeTableFlow;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNodesNodeTableFlowBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNotifPacketIn;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNotifPacketInBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNotifSwitchFlowRemoved;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNotifSwitchFlowRemovedBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchPacketInMessage;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchPacketInMessageBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcGetFlowStats;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcGetFlowStatsBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxReg0Key;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxReg1Key;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxReg2Key;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxReg3Key;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxReg4Key;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxReg5Key;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxReg6Key;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxReg7Key;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxRegGrouping;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.reg.grouping.NxmNxReg;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.reg.grouping.NxmNxRegBuilder;
  47 import org.opendaylight.yangtools.yang.binding.Augmentation;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 /**
  52  * @author msunal
  53  */
  54 public class RegConvertor implements ConvertorToOFJava<MatchEntry>, ConvertorFromOFJava<MatchEntry, MatchPath> {
  55
  56     private final static Logger LOG = LoggerFactory.getLogger(RegConvertor.class);
  57
  58     /*
  59      * (non-Javadoc)
  60      *
  61      * @see
  62      * org.opendaylight.openflowplugin.extension.api.ConvertorFromOFJava#convert
  63      * (org.opendaylight.yangtools.yang.binding.DataContainer,
  64      * org.opendaylight.openflowplugin.extension.api.path.AugmentationPath)
  65      */
  66     @SuppressWarnings("unchecked")
  67     @Override
  68     public ExtensionAugment<? extends Augmentation<Extension>> convert(MatchEntry input, MatchPath path) {
  69         NxmNxRegBuilder nxRegBuilder = new NxmNxRegBuilder();
  70         if (!org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg.class
  71                 .isAssignableFrom(input.getOxmMatchField())) {
  72             String msg = input.getOxmMatchField()
  73                     + " does not implement "
  74                     + org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg.class;
  75             LOG.warn(msg);
  76             throw new IllegalStateException(msg);
  77         }
  78         nxRegBuilder
  79                 .setReg((Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg>) input
  80                         .getOxmMatchField());
  81         RegCaseValue regCaseValue = ((RegCaseValue) input.getMatchEntryValue());
  82         nxRegBuilder.setValue(regCaseValue.getRegValues().getValue());
  83
  84         if (input.isHasMask()) {
  85             nxRegBuilder.setMask(regCaseValue.getRegValues().getMask());
  86         }
  87
  88         return resolveAugmentation(nxRegBuilder.build(), path, resolveRegKey(input.getOxmMatchField()));
  89     }
  90
  91     private static Class<? extends ExtensionKey> resolveRegKey(Class<? extends MatchField> oxmMatchField) {
  92         if (NiciraMatchCodecs.REG0_CODEC.getNxmField().isAssignableFrom(oxmMatchField)) {
  93             return NxmNxReg0Key.class;
  94         }
  95         if (NiciraMatchCodecs.REG1_CODEC.getNxmField().isAssignableFrom(oxmMatchField)) {
  96             return NxmNxReg1Key.class;
  97         }
  98         if (NiciraMatchCodecs.REG2_CODEC.getNxmField().isAssignableFrom(oxmMatchField)) {
  99             return NxmNxReg2Key.class;
 100         }
 101         if (NiciraMatchCodecs.REG3_CODEC.getNxmField().isAssignableFrom(oxmMatchField)) {
 102             return NxmNxReg3Key.class;
 103         }
 104         if (NiciraMatchCodecs.REG4_CODEC.getNxmField().isAssignableFrom(oxmMatchField)) {
 105             return NxmNxReg4Key.class;
 106         }
 107         if (NiciraMatchCodecs.REG5_CODEC.getNxmField().isAssignableFrom(oxmMatchField)) {
 108             return NxmNxReg5Key.class;
 109         }
 110         if (NiciraMatchCodecs.REG6_CODEC.getNxmField().isAssignableFrom(oxmMatchField)) {
 111             return NxmNxReg6Key.class;
 112         }
 113         if (NiciraMatchCodecs.REG7_CODEC.getNxmField().isAssignableFrom(oxmMatchField)) {
 114             return NxmNxReg7Key.class;
 115         }
 116         throw new CodecPreconditionException("There is no key for " + oxmMatchField);
 117     }
 118
 119     private static ExtensionAugment<? extends Augmentation<Extension>> resolveAugmentation(NxmNxReg nxmNxReg,
 120                                                                                            MatchPath path, Class<? extends ExtensionKey> key) {
 121         switch (path) {
 122             case FLOWSSTATISTICSUPDATE_FLOWANDSTATISTICSMAPLIST_MATCH:
 123                 return new ExtensionAugment<>(NxAugMatchNodesNodeTableFlow.class,
 124                         new NxAugMatchNodesNodeTableFlowBuilder().setNxmNxReg(nxmNxReg).build(), key);
 125             case RPCFLOWSSTATISTICS_FLOWANDSTATISTICSMAPLIST_MATCH:
 126                 return new ExtensionAugment<>(NxAugMatchRpcGetFlowStats.class,
 127                         new NxAugMatchRpcGetFlowStatsBuilder().setNxmNxReg(nxmNxReg).build(), key);
 128             case PACKETRECEIVED_MATCH:
 129                 return new ExtensionAugment<>(NxAugMatchNotifPacketIn.class, new NxAugMatchNotifPacketInBuilder()
 130                         .setNxmNxReg(nxmNxReg).build(), key);
 131             case SWITCHFLOWREMOVED_MATCH:
 132                 return new ExtensionAugment<>(NxAugMatchNotifSwitchFlowRemoved.class,
 133                         new NxAugMatchNotifSwitchFlowRemovedBuilder().setNxmNxReg(nxmNxReg).build(), key);
 134             case PACKETINMESSAGE_MATCH:
 135                 return new ExtensionAugment<>(NxAugMatchPacketInMessage.class,
 136                         new NxAugMatchPacketInMessageBuilder().setNxmNxReg(nxmNxReg).build(), key);
 137             default:
 138                 throw new CodecPreconditionException(path);
 139         }
 140     }
 141
 142     /*
 143      * (non-Javadoc)
 144      *
 145      * @see
 146      * org.opendaylight.openflowplugin.extension.api.ConvertorToOFJava#convert
 147      * (org
 148      * .opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general
 149      * .rev140714.general.extension.grouping.Extension)
 150      */
 151     @Override
 152     public MatchEntry convert(Extension extension) {
 153         Optional<NxmNxRegGrouping> matchGrouping = MatchUtil.regResolver.getExtension(extension);
 154         if (!matchGrouping.isPresent()) {
 155             throw new CodecPreconditionException(extension);
 156         }
 157         NxmNxReg nxmNxReg = matchGrouping.get().getNxmNxReg();
 158         RegValuesBuilder regValuesBuilder = new RegValuesBuilder()
 159             .setValue(nxmNxReg.getValue())
 160             .setMask(nxmNxReg.getMask());
 161
 162         RegCaseValueBuilder regCaseValueBuilder = new RegCaseValueBuilder();
 163         regCaseValueBuilder.setRegValues(regValuesBuilder.build());
 164         return MatchUtil.createDefaultMatchEntryBuilder(nxmNxReg.getReg(),
 165                 Nxm1Class.class,
 166                 regCaseValueBuilder.build())
 167             .setHasMask(Objects.nonNull(nxmNxReg.getMask()))
 168             .build();
 169     }
 170
 171 }