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