Merge "Technical debt MeterUtil, GroupUtil, FlowUtil"
[openflowplugin.git] / extension / openflowplugin-extension-nicira / src / main / java / org / opendaylight / openflowplugin / extension / vendor / nicira / convertor / match / MatchUtil.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.Joiner;
11 import com.google.common.base.Splitter;
12
13 import com.google.common.primitives.Longs;
14 import com.google.common.primitives.UnsignedBytes;
15 import java.util.Iterator;
16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
17 import java.util.HashSet;
18 import java.util.Set;
19 import org.opendaylight.openflowplugin.extension.api.GroupingResolver;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmClassBase;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntryBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.MatchEntryValue;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.general.extension.grouping.Extension;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNodesNodeTableFlow;
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.NxAugMatchNotifSwitchFlowRemoved;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchNotifUpdateFlowStats;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcAddFlow;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcRemoveFlow;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcUpdateFlowOriginal;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxAugMatchRpcUpdateFlowUpdated;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxArpShaGrouping;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxArpThaGrouping;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxCtStateGrouping;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxCtZoneGrouping;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshc1Grouping;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshc2Grouping;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshc3Grouping;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshc4Grouping;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNsiGrouping;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNspGrouping;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxRegGrouping;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxTunIdGrouping;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxTunIpv4DstGrouping;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxTunIpv4SrcGrouping;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfArpOpGrouping;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfArpSpaGrouping;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfArpTpaGrouping;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfEthDstGrouping;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfEthSrcGrouping;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfEthTypeGrouping;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxEncapEthTypeGrouping;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxEncapEthSrcGrouping;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxEncapEthDstGrouping;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshMdtypeGrouping;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxNshNpGrouping;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmNxTunGpeNpGrouping;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfTcpDstGrouping;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfTcpSrcGrouping;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfUdpDstGrouping;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.NxmOfUdpSrcGrouping;
63 import org.opendaylight.yangtools.yang.binding.Augmentation;
64
65 /**
66  * @author msunal
67  *
68  */
69 public class MatchUtil {
70     private static final Splitter SPLITTER = Splitter.on('.');
71     private static final Joiner JOINER = Joiner.on('.');
72
73     private final static Set<Class<? extends Augmentation<Extension>>> augmentationsOfExtension = new HashSet<>();
74     public final static GroupingResolver<NxmNxRegGrouping, Extension> regResolver = new GroupingResolver<>(
75             NxmNxRegGrouping.class);
76     public final static GroupingResolver<NxmNxTunIdGrouping, Extension> tunIdResolver = new GroupingResolver<>(
77             NxmNxTunIdGrouping.class);
78     public final static GroupingResolver<NxmNxArpShaGrouping, Extension> arpShaResolver = new GroupingResolver<>(
79             NxmNxArpShaGrouping.class);
80     public final static GroupingResolver<NxmNxArpThaGrouping, Extension> arpThaResolver = new GroupingResolver<>(
81             NxmNxArpThaGrouping.class);
82     public final static GroupingResolver<NxmOfArpOpGrouping, Extension> arpOpResolver = new GroupingResolver<>(
83             NxmOfArpOpGrouping.class);
84     public final static GroupingResolver<NxmOfArpSpaGrouping, Extension> arpSpaResolver = new GroupingResolver<>(
85             NxmOfArpSpaGrouping.class);
86     public final static GroupingResolver<NxmOfArpTpaGrouping, Extension> arpTpaResolver = new GroupingResolver<>(
87             NxmOfArpTpaGrouping.class);
88     public final static GroupingResolver<NxmNxTunIpv4DstGrouping, Extension> tunIpv4DstResolver = new GroupingResolver<>(
89             NxmNxTunIpv4DstGrouping.class);
90     public final static GroupingResolver<NxmNxTunIpv4SrcGrouping, Extension> tunIpv4SrcResolver = new GroupingResolver<>(
91             NxmNxTunIpv4SrcGrouping.class);
92     public final static GroupingResolver<NxmOfEthDstGrouping, Extension> ethDstResolver = new GroupingResolver<>(
93             NxmOfEthDstGrouping.class);
94     public final static GroupingResolver<NxmOfEthSrcGrouping, Extension> ethSrcResolver = new GroupingResolver<>(
95             NxmOfEthSrcGrouping.class);
96     public final static GroupingResolver<NxmOfEthTypeGrouping, Extension> ethTypeResolver = new GroupingResolver<>(
97             NxmOfEthTypeGrouping.class);
98     public final static GroupingResolver<NxmNxNsiGrouping, Extension> nsiResolver = new GroupingResolver<>(
99             NxmNxNsiGrouping.class);
100     public final static GroupingResolver<NxmNxNspGrouping, Extension> nspResolver = new GroupingResolver<>(
101             NxmNxNspGrouping.class);
102     public final static GroupingResolver<NxmNxNshc1Grouping, Extension> nsc1Resolver = new GroupingResolver<>(
103             NxmNxNshc1Grouping.class);
104     public final static GroupingResolver<NxmNxNshc2Grouping, Extension> nsc2Resolver = new GroupingResolver<>(
105             NxmNxNshc2Grouping.class);
106     public final static GroupingResolver<NxmNxNshc3Grouping, Extension> nsc3Resolver = new GroupingResolver<>(
107             NxmNxNshc3Grouping.class);
108     public final static GroupingResolver<NxmNxNshc4Grouping, Extension> nsc4Resolver = new GroupingResolver<>(
109             NxmNxNshc4Grouping.class);
110     public final static GroupingResolver<NxmNxEncapEthTypeGrouping, Extension> encapEthTypeResolver = new GroupingResolver<>(
111             NxmNxEncapEthTypeGrouping.class);
112     public final static GroupingResolver<NxmNxEncapEthSrcGrouping, Extension> encapEthSrcResolver = new GroupingResolver<>(
113             NxmNxEncapEthSrcGrouping.class);
114     public final static GroupingResolver<NxmNxEncapEthDstGrouping, Extension> encapEthDstResolver = new GroupingResolver<>(
115             NxmNxEncapEthDstGrouping.class);
116     public final static GroupingResolver<NxmNxNshMdtypeGrouping, Extension> nshMdtypeResolver = new GroupingResolver<>(
117             NxmNxNshMdtypeGrouping.class);
118     public final static GroupingResolver<NxmNxNshNpGrouping, Extension> nshNpResolver = new GroupingResolver<>(
119             NxmNxNshNpGrouping.class);
120     public final static GroupingResolver<NxmNxTunGpeNpGrouping, Extension> tunGpeNpResolver = new GroupingResolver<>(
121             NxmNxTunGpeNpGrouping.class);
122     public final static GroupingResolver<NxmOfTcpSrcGrouping, Extension> tcpSrcResolver = new GroupingResolver<>(
123             NxmOfTcpSrcGrouping.class);
124     public final static GroupingResolver<NxmOfTcpDstGrouping, Extension> tcpDstResolver = new GroupingResolver<>(
125             NxmOfTcpDstGrouping.class);
126     public final static GroupingResolver<NxmOfUdpSrcGrouping, Extension> udpSrcResolver = new GroupingResolver<>(
127             NxmOfUdpSrcGrouping.class);
128     public final static GroupingResolver<NxmOfUdpDstGrouping, Extension> udpDstResolver = new GroupingResolver<>(
129             NxmOfUdpDstGrouping.class);
130     public final static GroupingResolver<NxmNxCtStateGrouping, Extension> ctStateResolver = new GroupingResolver<>(
131             NxmNxCtStateGrouping.class);
132     public final static GroupingResolver<NxmNxCtZoneGrouping, Extension> ctZoneResolver = new GroupingResolver<>(
133             NxmNxCtZoneGrouping.class);
134
135
136     static {
137         augmentationsOfExtension.add(NxAugMatchRpcAddFlow.class);
138         augmentationsOfExtension.add(NxAugMatchRpcRemoveFlow.class);
139         augmentationsOfExtension.add(NxAugMatchRpcUpdateFlowOriginal.class);
140         augmentationsOfExtension.add(NxAugMatchRpcUpdateFlowUpdated.class);
141         augmentationsOfExtension.add(NxAugMatchNodesNodeTableFlow.class);
142         augmentationsOfExtension.add(NxAugMatchNotifSwitchFlowRemoved.class);
143         augmentationsOfExtension.add(NxAugMatchNotifPacketIn.class);
144         augmentationsOfExtension.add(NxAugMatchNotifUpdateFlowStats.class);
145         regResolver.setAugmentations(augmentationsOfExtension);
146         tunIdResolver.setAugmentations(augmentationsOfExtension);
147         arpShaResolver.setAugmentations(augmentationsOfExtension);
148         arpThaResolver.setAugmentations(augmentationsOfExtension);
149         arpOpResolver.setAugmentations(augmentationsOfExtension);
150         arpSpaResolver.setAugmentations(augmentationsOfExtension);
151         arpTpaResolver.setAugmentations(augmentationsOfExtension);
152         tunIpv4DstResolver.setAugmentations(augmentationsOfExtension);
153         tunIpv4SrcResolver.setAugmentations(augmentationsOfExtension);
154         ethDstResolver.setAugmentations(augmentationsOfExtension);
155         ethSrcResolver.setAugmentations(augmentationsOfExtension);
156         ethTypeResolver.setAugmentations(augmentationsOfExtension);
157         nspResolver.setAugmentations(augmentationsOfExtension);
158         nsiResolver.setAugmentations(augmentationsOfExtension);
159         nsc1Resolver.setAugmentations(augmentationsOfExtension);
160         nsc2Resolver.setAugmentations(augmentationsOfExtension);
161         nsc3Resolver.setAugmentations(augmentationsOfExtension);
162         nsc4Resolver.setAugmentations(augmentationsOfExtension);
163         encapEthTypeResolver.setAugmentations(augmentationsOfExtension);
164         encapEthSrcResolver.setAugmentations(augmentationsOfExtension);
165         encapEthDstResolver.setAugmentations(augmentationsOfExtension);
166         nshMdtypeResolver.setAugmentations(augmentationsOfExtension);
167         nshNpResolver.setAugmentations(augmentationsOfExtension);
168         tunGpeNpResolver.setAugmentations(augmentationsOfExtension);
169         tcpSrcResolver.setAugmentations(augmentationsOfExtension);
170         tcpDstResolver.setAugmentations(augmentationsOfExtension);
171         udpSrcResolver.setAugmentations(augmentationsOfExtension);
172         udpDstResolver.setAugmentations(augmentationsOfExtension);
173         ctStateResolver.setAugmentations(augmentationsOfExtension);
174         ctZoneResolver.setAugmentations(augmentationsOfExtension);
175
176     }
177
178     public static MatchEntryBuilder createDefaultMatchEntryBuilder(Class<? extends MatchField> matchField,
179                                                                    Class<? extends OxmClassBase> oxmClass,
180                                                                    MatchEntryValue matchEntryValue){
181         MatchEntryBuilder matchEntryBuilder = new MatchEntryBuilder();
182         matchEntryBuilder.setHasMask(false);
183         matchEntryBuilder.setOxmMatchField(matchField);
184         matchEntryBuilder.setOxmClass(oxmClass);
185         matchEntryBuilder.setMatchEntryValue(matchEntryValue);
186         return matchEntryBuilder;
187     }
188
189     public static Long ipv4ToLong(Ipv4Address ipv4) {
190         Iterator<String> iterator = SPLITTER.split(ipv4.getValue()).iterator();
191         byte[] bytes = new byte[8];
192         for(int i =0;i < bytes.length;i++) {
193             if(i<4) {
194                 bytes[i] = 0;
195             } else {
196                 bytes[i] = UnsignedBytes.parseUnsignedByte((iterator.next()));
197             }
198         }
199         Long result = Longs.fromByteArray(bytes);
200         return result;
201     }
202
203     public static Ipv4Address longToIpv4Address(Long l) {
204         byte[] bytes = Longs.toByteArray(l);
205         String[] strArray = new String[4];
206         for(int i = 4;i < bytes.length;i++) {
207             strArray[i-4]=UnsignedBytes.toString(bytes[i]);
208         }
209         String str = JOINER.join(strArray);
210         Ipv4Address result = new Ipv4Address(str);
211         return result;
212     }
213 }