Javadoc update
[openflowjava.git] / openflow-protocol-impl / src / main / java / org / opendaylight / openflowjava / protocol / impl / util / MatchDeserializer.java
1 /* Copyright (C)2013 Pantheon Technologies, s.r.o. All rights reserved. */\r
2 package org.opendaylight.openflowjava.protocol.impl.util;\r
3 \r
4 import io.netty.buffer.ByteBuf;\r
5 \r
6 import java.util.ArrayList;\r
7 import java.util.List;\r
8 \r
9 import org.opendaylight.openflowjava.protocol.impl.serialization.factories.EncodeConstants;\r
10 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Dscp;\r
11 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;\r
12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;\r
13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6FlowLabel;\r
14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;\r
15 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.BosMatchEntry;\r
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.BosMatchEntryBuilder;\r
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.DscpMatchEntry;\r
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.DscpMatchEntryBuilder;\r
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EcnMatchEntry;\r
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EcnMatchEntryBuilder;\r
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EthTypeMatchEntry;\r
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EthTypeMatchEntryBuilder;\r
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv4CodeMatchEntry;\r
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv4CodeMatchEntryBuilder;\r
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv4TypeMatchEntry;\r
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv4TypeMatchEntryBuilder;\r
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv6CodeMatchEntry;\r
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv6CodeMatchEntryBuilder;\r
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv6TypeMatchEntry;\r
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv6TypeMatchEntryBuilder;\r
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv4AddressMatchEntry;\r
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv4AddressMatchEntryBuilder;\r
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv6AddressMatchEntry;\r
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv6AddressMatchEntryBuilder;\r
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv6FlabelMatchEntry;\r
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv6FlabelMatchEntryBuilder;\r
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.IsidMatchEntry;\r
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.IsidMatchEntryBuilder;\r
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MacAddressMatchEntry;\r
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MacAddressMatchEntryBuilder;\r
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MaskMatchEntry;\r
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MaskMatchEntryBuilder;\r
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataMatchEntry;\r
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataMatchEntryBuilder;\r
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MplsLabelMatchEntry;\r
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MplsLabelMatchEntryBuilder;\r
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.OpCodeMatchEntry;\r
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.OpCodeMatchEntryBuilder;\r
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortMatchEntry;\r
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortMatchEntryBuilder;\r
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortNumberMatchEntry;\r
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortNumberMatchEntryBuilder;\r
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ProtocolNumberMatchEntry;\r
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ProtocolNumberMatchEntryBuilder;\r
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PseudoFieldMatchEntry;\r
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PseudoFieldMatchEntry.PseudoField;\r
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PseudoFieldMatchEntryBuilder;\r
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TcMatchEntry;\r
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TcMatchEntryBuilder;\r
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanPcpMatchEntry;\r
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanPcpMatchEntryBuilder;\r
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanVidMatchEntry;\r
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanVidMatchEntryBuilder;\r
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.EtherType;\r
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;\r
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.StandardMatchType;\r
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpOp;\r
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpSha;\r
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpSpa;\r
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpTha;\r
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpTpa;\r
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthDst;\r
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthSrc;\r
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthType;\r
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ExperimenterClass;\r
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv4Code;\r
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv4Type;\r
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv6Code;\r
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv6Type;\r
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.InPhyPort;\r
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.InPort;\r
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpDscp;\r
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpEcn;\r
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpProto;\r
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv4Dst;\r
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv4Src;\r
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Dst;\r
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Exthdr;\r
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Flabel;\r
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdSll;\r
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdTarget;\r
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdTll;\r
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Src;\r
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Metadata;\r
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsBos;\r
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsLabel;\r
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsTc;\r
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Nxm0Class;\r
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Nxm1Class;\r
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.OpenflowBasicClass;\r
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.OxmMatchType;\r
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.PbbIsid;\r
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.SctpDst;\r
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.SctpSrc;\r
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TcpDst;\r
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TcpSrc;\r
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TunnelId;\r
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.UdpDst;\r
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.UdpSrc;\r
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.VlanPcp;\r
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.VlanVid;\r
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.oxm.fields.MatchEntries;\r
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.oxm.fields.MatchEntriesBuilder;\r
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.match.grouping.Match;\r
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.match.grouping.MatchBuilder;\r
116 import org.slf4j.Logger;\r
117 import org.slf4j.LoggerFactory;\r
118 \r
119 import com.google.common.base.Joiner;\r
120 \r
121 /**\r
122  * Deserializes ofp_match (OpenFlow v1.3) and its oxm_fields structures\r
123  * @author timotej.kubas\r
124  * @author michal.polkorab\r
125  */\r
126 public abstract class MatchDeserializer {\r
127     private static final Logger LOGGER = LoggerFactory.getLogger(MatchDeserializer.class);\r
128     private static final byte SIZE_OF_LONG_IN_BYTES = Long.SIZE / Byte.SIZE;\r
129     private static final byte SIZE_OF_INT_IN_BYTES = Integer.SIZE / Byte.SIZE;\r
130     private static final byte SIZE_OF_SHORT_IN_BYTES = Short.SIZE / Byte.SIZE;\r
131     private static final byte SIZE_OF_BYTE_IN_BYTES = Byte.SIZE / Byte.SIZE;\r
132     private static final byte SIZE_OF_IPV6_ADDRESS_IN_BYTES = (8 * Short.SIZE) / Byte.SIZE;\r
133     \r
134     \r
135     /**\r
136      * Creates match\r
137      * @param in input ByteBuf\r
138      * @return ofp_match (OpenFlow v1.3)\r
139      */\r
140     public static Match createMatch(ByteBuf in) {\r
141         if (in.readableBytes() > 0) {\r
142             MatchBuilder builder = new MatchBuilder();\r
143             int type = in.readUnsignedShort();\r
144             int length = in.readUnsignedShort();\r
145             switch (type) {\r
146             case 0:\r
147                 builder.setType(StandardMatchType.class);\r
148                 break;\r
149             case 1:\r
150                 builder.setType(OxmMatchType.class);\r
151                 break;\r
152             default:\r
153                 break;\r
154             }\r
155             builder.setMatchEntries(createMatchEntries(in, length - 2 * (Short.SIZE / Byte.SIZE)));\r
156             int paddingRemainder = length % EncodeConstants.PADDING;\r
157             if (paddingRemainder != 0) {\r
158                 in.skipBytes(EncodeConstants.PADDING - paddingRemainder);\r
159             }\r
160             return builder.build();\r
161         }\r
162         return null;\r
163     }\r
164     \r
165     /**\r
166      * Deserializes single match entry (oxm_field)\r
167      * @param in input ByteBuf\r
168      * @param matchLength length of match entry\r
169      * @return MatchEntriesList list containing one match entry\r
170      */\r
171     public static List<MatchEntries> createMatchEntry(ByteBuf in, int matchLength) {\r
172         return createMatchEntriesInternal(in, matchLength, true);\r
173     }\r
174     \r
175     /**\r
176      * @param in input ByteBuf\r
177      * @param matchLength length of match entries\r
178      * @return MatchEntriesList list of match entries\r
179      */\r
180     public static List<MatchEntries> createMatchEntries(ByteBuf in, int matchLength) {\r
181         return createMatchEntriesInternal(in, matchLength, false);\r
182     }\r
183     \r
184     private static List<MatchEntries> createMatchEntriesInternal(ByteBuf in, int matchLength, boolean oneEntry) {\r
185         List<MatchEntries> matchEntriesList = new ArrayList<>();\r
186         int currLength = 0;\r
187         while(currLength < matchLength) {\r
188             MatchEntriesBuilder matchEntriesBuilder = new MatchEntriesBuilder(); \r
189             switch (in.readUnsignedShort()) { \r
190             case 0x0000:\r
191                         matchEntriesBuilder.setOxmClass(Nxm0Class.class);\r
192                         break;\r
193             case 0x0001:\r
194                         matchEntriesBuilder.setOxmClass(Nxm1Class.class);\r
195                         break;\r
196             case 0x8000:\r
197                         matchEntriesBuilder.setOxmClass(OpenflowBasicClass.class);\r
198                         break;\r
199             case 0xFFFF:\r
200                         matchEntriesBuilder.setOxmClass(ExperimenterClass.class);\r
201                         break;\r
202             default:\r
203                         break;\r
204             }\r
205 \r
206             int fieldAndMask = in.readUnsignedByte();\r
207             boolean hasMask = (fieldAndMask & 1) != 0;\r
208             int matchField =  fieldAndMask >> 1;\r
209             int matchEntryLength = in.readUnsignedByte();\r
210             currLength += SIZE_OF_SHORT_IN_BYTES + (2 * SIZE_OF_BYTE_IN_BYTES) + matchEntryLength;\r
211             \r
212             switch(matchField) {\r
213             case 0: \r
214                 matchEntriesBuilder.setOxmMatchField(InPort.class);\r
215                 PortNumberMatchEntryBuilder port = new PortNumberMatchEntryBuilder();\r
216                 port.setPortNumber(new PortNumber(in.readUnsignedInt())); \r
217                 matchEntriesBuilder.addAugmentation(PortNumberMatchEntry.class, port.build());\r
218                 break;\r
219             case 1:\r
220                 matchEntriesBuilder.setOxmMatchField(InPhyPort.class);\r
221                 PortNumberMatchEntryBuilder phyPort = new PortNumberMatchEntryBuilder();\r
222                 phyPort.setPortNumber(new PortNumber(in.readUnsignedInt())); \r
223                 matchEntriesBuilder.addAugmentation(PortNumberMatchEntry.class, phyPort.build());\r
224                 break;\r
225             case 2:\r
226                 matchEntriesBuilder.setOxmMatchField(Metadata.class);\r
227                 addMetadataAugmentation(matchEntriesBuilder, in);\r
228                 if (hasMask) {\r
229                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_LONG_IN_BYTES);\r
230                 }\r
231                 break;\r
232             case 3:\r
233                 matchEntriesBuilder.setOxmMatchField(EthDst.class);\r
234                 addMacAddressAugmentation(matchEntriesBuilder, in);\r
235                 if (hasMask) {\r
236                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_LONG_IN_BYTES);\r
237                 }\r
238                 break;\r
239             case 4:\r
240                 matchEntriesBuilder.setOxmMatchField(EthSrc.class);\r
241                 addMacAddressAugmentation(matchEntriesBuilder, in);\r
242                 if (hasMask) {\r
243                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_LONG_IN_BYTES);\r
244                 }\r
245                 break;\r
246             case 5:\r
247                 matchEntriesBuilder.setOxmMatchField(EthType.class);\r
248                 EthTypeMatchEntryBuilder ethertypeBuilder = new EthTypeMatchEntryBuilder();\r
249                 ethertypeBuilder.setEthType(new EtherType(in.readUnsignedShort()));\r
250                 matchEntriesBuilder.addAugmentation(EthTypeMatchEntry.class, ethertypeBuilder.build());\r
251                 break;\r
252             case 6:\r
253                 matchEntriesBuilder.setOxmMatchField(VlanVid.class);\r
254                 VlanVidMatchEntryBuilder vlanVidBuilder = new VlanVidMatchEntryBuilder();\r
255                 int vidEntryValue = in.readUnsignedShort(); \r
256                 vlanVidBuilder.setCfiBit((vidEntryValue & 1) != 0);\r
257                 vlanVidBuilder.setVlanVid(vidEntryValue >> 1);\r
258                 matchEntriesBuilder.addAugmentation(VlanVidMatchEntry.class, vlanVidBuilder.build());\r
259                 if (hasMask) {\r
260                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_SHORT_IN_BYTES);\r
261                 }\r
262                 break;\r
263             case 7:\r
264                 matchEntriesBuilder.setOxmMatchField(VlanPcp.class);\r
265                 VlanPcpMatchEntryBuilder vlanPcpBuilder = new VlanPcpMatchEntryBuilder();\r
266                 vlanPcpBuilder.setVlanPcp(in.readUnsignedByte());\r
267                 matchEntriesBuilder.addAugmentation(VlanPcpMatchEntry.class, vlanPcpBuilder.build());\r
268                 break;\r
269             case 8:\r
270                 matchEntriesBuilder.setOxmMatchField(IpDscp.class);\r
271                 DscpMatchEntryBuilder dscpBuilder = new DscpMatchEntryBuilder();\r
272                 dscpBuilder.setDscp(new Dscp(in.readUnsignedByte()));\r
273                 matchEntriesBuilder.addAugmentation(DscpMatchEntry.class, dscpBuilder.build());\r
274                 break;\r
275             case 9:\r
276                 matchEntriesBuilder.setOxmMatchField(IpEcn.class);\r
277                 EcnMatchEntryBuilder ecnBuilder = new EcnMatchEntryBuilder();\r
278                 ecnBuilder.setEcn(in.readUnsignedByte());\r
279                 matchEntriesBuilder.addAugmentation(EcnMatchEntry.class, ecnBuilder.build());\r
280                 break;\r
281             case 10:\r
282                 matchEntriesBuilder.setOxmMatchField(IpProto.class);\r
283                 ProtocolNumberMatchEntryBuilder protoNumberBuilder = new ProtocolNumberMatchEntryBuilder();\r
284                 protoNumberBuilder.setProtocolNumber(in.readUnsignedByte());\r
285                 matchEntriesBuilder.addAugmentation(ProtocolNumberMatchEntry.class, protoNumberBuilder.build());\r
286                 break;\r
287             case 11:\r
288                 matchEntriesBuilder.setOxmMatchField(Ipv4Src.class);\r
289                 // TODO - ipv4address - check format with tests\r
290                 LOGGER.warn("IPV4address(ipv4src): received but possible wrong deserialization");\r
291                 addIpv4AddressAugmentation(matchEntriesBuilder, in);\r
292                 if (hasMask) {\r
293                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_INT_IN_BYTES);\r
294                 }\r
295                 break;\r
296             case 12:\r
297                 matchEntriesBuilder.setOxmMatchField(Ipv4Dst.class);\r
298                 // TODO - ipv4address - check format with tests\r
299                 LOGGER.warn("IPV4address(ipv4dst): received but possible wrong deserialization");\r
300                 addIpv4AddressAugmentation(matchEntriesBuilder, in);\r
301                 if (hasMask) {\r
302                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_INT_IN_BYTES);\r
303                 }\r
304                 break;\r
305             case 13:\r
306                 matchEntriesBuilder.setOxmMatchField(TcpSrc.class);\r
307                 addPortAugmentation(null, in);\r
308                 break;\r
309             case 14:\r
310                 matchEntriesBuilder.setOxmMatchField(TcpDst.class);\r
311                 addPortAugmentation(null, in);\r
312                 break;\r
313             case 15:\r
314                 matchEntriesBuilder.setOxmMatchField(UdpSrc.class);\r
315                 addPortAugmentation(null, in);\r
316                 break;\r
317             case 16:\r
318                 matchEntriesBuilder.setOxmMatchField(UdpDst.class);\r
319                 addPortAugmentation(null, in);\r
320                 break;\r
321             case 17:\r
322                 matchEntriesBuilder.setOxmMatchField(SctpSrc.class);\r
323                 addPortAugmentation(null, in);\r
324                 break;\r
325             case 18:\r
326                 matchEntriesBuilder.setOxmMatchField(SctpDst.class);\r
327                 addPortAugmentation(null, in);\r
328                 break;\r
329             case 19:\r
330                 matchEntriesBuilder.setOxmMatchField(Icmpv4Type.class);\r
331                 Icmpv4TypeMatchEntryBuilder icmpv4TypeBuilder = new Icmpv4TypeMatchEntryBuilder();\r
332                 icmpv4TypeBuilder.setIcmpv4Type(in.readUnsignedByte());\r
333                 matchEntriesBuilder.addAugmentation(Icmpv4TypeMatchEntry.class, icmpv4TypeBuilder.build());\r
334                 break;\r
335             case 20:\r
336                 matchEntriesBuilder.setOxmMatchField(Icmpv4Code.class);\r
337                 Icmpv4CodeMatchEntryBuilder icmpv4CodeBuilder = new Icmpv4CodeMatchEntryBuilder();\r
338                 icmpv4CodeBuilder.setIcmpv4Code(in.readUnsignedByte());\r
339                 matchEntriesBuilder.addAugmentation(Icmpv4CodeMatchEntry.class, icmpv4CodeBuilder.build());\r
340                 break;\r
341             case 21:\r
342                 matchEntriesBuilder.setOxmMatchField(ArpOp.class);\r
343                 OpCodeMatchEntryBuilder opcodeBuilder = new OpCodeMatchEntryBuilder();\r
344                 opcodeBuilder.setOpCode(in.readUnsignedShort());\r
345                 matchEntriesBuilder.addAugmentation(OpCodeMatchEntry.class, opcodeBuilder.build());\r
346                 break;\r
347             case 22:\r
348                 matchEntriesBuilder.setOxmMatchField(ArpSpa.class);\r
349                 // TODO - ipv4address - check format with tests\r
350                 LOGGER.warn("IPV4address(arpspa): received but possible wrong deserialization");\r
351                 addIpv4AddressAugmentation(matchEntriesBuilder, in);\r
352                 if (hasMask) {\r
353                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_INT_IN_BYTES);\r
354                 }\r
355                 break;\r
356             case 23:\r
357                 matchEntriesBuilder.setOxmMatchField(ArpTpa.class);\r
358                 // TODO - ipv4address - check format with tests\r
359                 LOGGER.warn("IPV4address(arptpa): received but possible wrong deserialization");\r
360                 addIpv4AddressAugmentation(matchEntriesBuilder, in);\r
361                 if (hasMask) {\r
362                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_INT_IN_BYTES);\r
363                 }\r
364                 break;\r
365             case 24:\r
366                 matchEntriesBuilder.setOxmMatchField(ArpSha.class);\r
367                 addMacAddressAugmentation(matchEntriesBuilder, in);\r
368                 if (hasMask) {\r
369                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_LONG_IN_BYTES);\r
370                 }\r
371                 break;\r
372             case 25:\r
373                 matchEntriesBuilder.setOxmMatchField(ArpTha.class);\r
374                 addMacAddressAugmentation(matchEntriesBuilder, in);\r
375                 if (hasMask) {\r
376                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_LONG_IN_BYTES);\r
377                 }\r
378                 break;\r
379             case 26:\r
380                 matchEntriesBuilder.setOxmMatchField(Ipv6Src.class);\r
381                 // TODO - ipv6address - check format with tests\r
382                 LOGGER.warn("IPV6address(Ipv6Src): received but possible wrong deserialization");\r
383                 addIpv6AddressAugmentation(matchEntriesBuilder, in);\r
384                 if (hasMask) {\r
385                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_IPV6_ADDRESS_IN_BYTES);\r
386                 }\r
387                 break;\r
388             case 27:\r
389                 matchEntriesBuilder.setOxmMatchField(Ipv6Dst.class);\r
390                 // TODO - ipv6address - check format with tests\r
391                 LOGGER.warn("IPV6address(Ipv6Dst): received but possible wrong deserialization");\r
392                 addIpv6AddressAugmentation(matchEntriesBuilder, in);\r
393                 if (hasMask) {\r
394                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_IPV6_ADDRESS_IN_BYTES);\r
395                 }\r
396                 break;\r
397             case 28:\r
398                 matchEntriesBuilder.setOxmMatchField(Ipv6Flabel.class);\r
399                 Ipv6FlabelMatchEntryBuilder ipv6FlabelBuilder = new Ipv6FlabelMatchEntryBuilder();\r
400                 ipv6FlabelBuilder.setIpv6Flabel(new Ipv6FlowLabel(in.readUnsignedInt()));\r
401                 matchEntriesBuilder.addAugmentation(Ipv6FlabelMatchEntry.class, ipv6FlabelBuilder.build());\r
402                 if (hasMask) {\r
403                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_INT_IN_BYTES);\r
404                 }\r
405                 break;\r
406             case 29:\r
407                 matchEntriesBuilder.setOxmMatchField(Icmpv6Type.class);\r
408                 Icmpv6TypeMatchEntryBuilder icmpv6TypeBuilder = new Icmpv6TypeMatchEntryBuilder();\r
409                 icmpv6TypeBuilder.setIcmpv6Type(in.readUnsignedByte());\r
410                 matchEntriesBuilder.addAugmentation(Icmpv6TypeMatchEntry.class, icmpv6TypeBuilder.build());\r
411                 break;\r
412             case 30:\r
413                 matchEntriesBuilder.setOxmMatchField(Icmpv6Code.class);\r
414                 Icmpv6CodeMatchEntryBuilder icmpv6CodeBuilder = new Icmpv6CodeMatchEntryBuilder();\r
415                 icmpv6CodeBuilder.setIcmpv6Code(in.readUnsignedByte());\r
416                 matchEntriesBuilder.addAugmentation(Icmpv6CodeMatchEntry.class, icmpv6CodeBuilder.build());\r
417                 break;\r
418             case 31:\r
419                 matchEntriesBuilder.setOxmMatchField(Ipv6NdTarget.class);\r
420                 // TODO - ipv6address - check format with tests\r
421                 LOGGER.warn("IPV6address(Ipv6NdTarget): received but possible wrong deserialization");\r
422                 addIpv6AddressAugmentation(matchEntriesBuilder, in);\r
423                 break;\r
424             case 32:\r
425                 matchEntriesBuilder.setOxmMatchField(Ipv6NdSll.class);\r
426                 addMacAddressAugmentation(matchEntriesBuilder, in);\r
427                 break;\r
428             case 33:\r
429                 matchEntriesBuilder.setOxmMatchField(Ipv6NdTll.class);\r
430                 addMacAddressAugmentation(matchEntriesBuilder, in);\r
431                 break;\r
432             case 34:\r
433                 matchEntriesBuilder.setOxmMatchField(MplsLabel.class);\r
434                 MplsLabelMatchEntryBuilder mplsLabelBuilder = new MplsLabelMatchEntryBuilder();\r
435                 mplsLabelBuilder.setMplsLabel(in.readUnsignedInt());\r
436                 matchEntriesBuilder.addAugmentation(MplsLabelMatchEntry.class, mplsLabelBuilder.build());\r
437                 break;\r
438             case 35:\r
439                 matchEntriesBuilder.setOxmMatchField(MplsTc.class);\r
440                 TcMatchEntryBuilder tcBuilder = new TcMatchEntryBuilder();\r
441                 tcBuilder.setTc(in.readUnsignedByte());\r
442                 matchEntriesBuilder.addAugmentation(TcMatchEntry.class, tcBuilder.build());\r
443                 break;\r
444             case 36:\r
445                 matchEntriesBuilder.setOxmMatchField(MplsBos.class);\r
446                 BosMatchEntryBuilder bosBuilder = new BosMatchEntryBuilder();\r
447                 if (in.readUnsignedByte() != 0) {\r
448                     bosBuilder.setBos(true);\r
449                 } else {\r
450                     bosBuilder.setBos(false);\r
451                 }\r
452                 matchEntriesBuilder.addAugmentation(BosMatchEntry.class, bosBuilder.build());\r
453                 break;\r
454             case 37:\r
455                 matchEntriesBuilder.setOxmMatchField(PbbIsid.class);\r
456                 IsidMatchEntryBuilder isidBuilder = new IsidMatchEntryBuilder();\r
457                 isidBuilder.setIsid(in.readUnsignedInt());\r
458                 matchEntriesBuilder.addAugmentation(IsidMatchEntry.class, isidBuilder.build());\r
459                 if (hasMask) {\r
460                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_INT_IN_BYTES);\r
461                 }\r
462                 break;\r
463             case 38:\r
464                 matchEntriesBuilder.setOxmMatchField(TunnelId.class);\r
465                 addMetadataAugmentation(matchEntriesBuilder, in);\r
466                 if (hasMask) {\r
467                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_LONG_IN_BYTES);\r
468                 }\r
469                 break;\r
470             case 39:\r
471                 matchEntriesBuilder.setOxmMatchField(Ipv6Exthdr.class);\r
472                 PseudoFieldMatchEntryBuilder pseudoBuilder = new PseudoFieldMatchEntryBuilder();\r
473                 int bitmap = in.readUnsignedShort();\r
474                 final Boolean NONEXT = ((bitmap) & (1<<0)) != 0;\r
475                 final Boolean ESP = ((bitmap) & (1<<1)) != 0;\r
476                 final Boolean AUTH = ((bitmap) & (1<<2)) != 0;\r
477                 final Boolean DEST = ((bitmap) & (1<<3)) != 0;\r
478                 final Boolean FRAG = ((bitmap) & (1<<4)) != 0;\r
479                 final Boolean ROUTER = ((bitmap) & (1<<5)) != 0;\r
480                 final Boolean HOP = ((bitmap) & (1<<6)) != 0;\r
481                 final Boolean UNREP = ((bitmap) & (1<<7)) != 0;\r
482                 final Boolean UNSEQ = ((bitmap) & (1<<8)) != 0;\r
483                 pseudoBuilder.setPseudoField(new PseudoField(AUTH, DEST, ESP, FRAG, HOP, NONEXT, ROUTER, UNREP, UNSEQ));\r
484                 matchEntriesBuilder.addAugmentation(PseudoFieldMatchEntry.class, pseudoBuilder.build());\r
485                 if (hasMask) {\r
486                     addMaskAugmentation(matchEntriesBuilder, in, SIZE_OF_SHORT_IN_BYTES);\r
487                 }\r
488                 break;\r
489             default: \r
490                 break;\r
491             }\r
492           matchEntriesList.add(matchEntriesBuilder.build());\r
493           if (oneEntry) {\r
494               break;\r
495           }\r
496         }\r
497         if ((matchLength - currLength) > 0) {\r
498             in.skipBytes(matchLength - currLength);\r
499         }\r
500         return matchEntriesList;\r
501     }\r
502 \r
503     private static void addMaskAugmentation(MatchEntriesBuilder builder, ByteBuf in, int matchEntryLength) {\r
504 //         TODO - check if matchEntryLength is in bytes\r
505         MaskMatchEntryBuilder maskBuilder = new MaskMatchEntryBuilder();\r
506         byte[] mask = new byte[matchEntryLength];\r
507         in.readBytes(mask);\r
508         maskBuilder.setMask(mask);\r
509         builder.addAugmentation(MaskMatchEntry.class, maskBuilder.build());\r
510     }\r
511 \r
512     private static void addIpv6AddressAugmentation(MatchEntriesBuilder builder, ByteBuf in) {\r
513         final byte GROUPS_IN_IPV6_ADDRESS = 8;\r
514         Ipv6AddressMatchEntryBuilder ipv6AddressBuilder = new Ipv6AddressMatchEntryBuilder();\r
515         List<String> groups = new ArrayList<>();\r
516         for (int i = 0; i < GROUPS_IN_IPV6_ADDRESS; i++) {\r
517             groups.add(String.format("X", in.readUnsignedShort()));\r
518         }\r
519         Joiner joiner = Joiner.on(":");\r
520         ipv6AddressBuilder.setIpv6Address(new Ipv6Address(joiner.join(groups)));\r
521         builder.addAugmentation(Ipv6AddressMatchEntry.class, ipv6AddressBuilder.build());\r
522     }\r
523     \r
524     private static void addMetadataAugmentation(MatchEntriesBuilder builder, ByteBuf in) {\r
525         MetadataMatchEntryBuilder metadata = new MetadataMatchEntryBuilder();\r
526         byte[] metadataBytes = new byte[Long.SIZE/Byte.SIZE];\r
527         in.readBytes(metadataBytes);\r
528         metadata.setMetadata(metadataBytes); \r
529         builder.addAugmentation(MetadataMatchEntry.class, metadata.build());\r
530     }\r
531 \r
532     private static void addIpv4AddressAugmentation(MatchEntriesBuilder builder, ByteBuf in) {\r
533         final byte GROUPS_IN_IPV4_ADDRESS = 4;\r
534         Ipv4AddressMatchEntryBuilder ipv4AddressBuilder = new Ipv4AddressMatchEntryBuilder();\r
535         List<String> groups = new ArrayList<>();\r
536         for (int i = 0; i < GROUPS_IN_IPV4_ADDRESS; i++) {\r
537             groups.add(Short.toString(in.readUnsignedByte()));\r
538         }\r
539         Joiner joiner = Joiner.on(".");\r
540         ipv4AddressBuilder.setIpv4Address(new Ipv4Address(joiner.join(groups)));\r
541         builder.addAugmentation(Ipv4AddressMatchEntry.class, ipv4AddressBuilder.build());\r
542     }\r
543 \r
544     private static void addMacAddressAugmentation(MatchEntriesBuilder builder, ByteBuf in) {\r
545         MacAddressMatchEntryBuilder macAddress = new MacAddressMatchEntryBuilder();\r
546         StringBuffer macToString = new StringBuffer();\r
547         final int macAddressLength = 6;\r
548         for(int i=0; i<macAddressLength ; i++){\r
549             short mac = 0;\r
550             mac = in.readUnsignedByte();\r
551             macToString.append(String.format("%02X", mac));\r
552         }\r
553         macAddress.setMacAddress(new MacAddress(macToString.toString())); \r
554         builder.addAugmentation(MacAddressMatchEntry.class, macAddress.build());\r
555     }\r
556     \r
557     private static void addPortAugmentation(MatchEntriesBuilder builder, ByteBuf in) {\r
558         PortMatchEntryBuilder portBuilder = new PortMatchEntryBuilder();\r
559         portBuilder.setPort(new org.opendaylight.yang.gen.v1.urn.ietf.params.\r
560                 xml.ns.yang.ietf.inet.types.rev100924.PortNumber(in.readUnsignedShort()));\r
561         builder.addAugmentation(PortMatchEntry.class, portBuilder.build());\r
562     }\r
563 }\r