2 * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
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
9 package org.opendaylight.openflowjava.protocol.impl.util;
11 import io.netty.buffer.ByteBuf;
13 import java.util.Arrays;
14 import java.util.HashMap;
15 import java.util.List;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.BosMatchEntry;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.DscpMatchEntry;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EcnMatchEntry;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EthTypeMatchEntry;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv4CodeMatchEntry;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv4TypeMatchEntry;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv6CodeMatchEntry;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv6TypeMatchEntry;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv4AddressMatchEntry;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv6AddressMatchEntry;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv6FlabelMatchEntry;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.IsidMatchEntry;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MacAddressMatchEntry;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MaskMatchEntry;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataMatchEntry;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MplsLabelMatchEntry;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.OpCodeMatchEntry;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortMatchEntry;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortNumberMatchEntry;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ProtocolNumberMatchEntry;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PseudoFieldMatchEntry;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PseudoFieldMatchEntry.PseudoField;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TcMatchEntry;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanPcpMatchEntry;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanVidMatchEntry;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.StandardMatchType;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpOp;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpSha;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpSpa;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpTha;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpTpa;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Clazz;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthDst;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthSrc;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthType;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ExperimenterClass;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv4Code;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv4Type;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv6Code;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv6Type;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.InPhyPort;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.InPort;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpDscp;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpEcn;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpProto;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv4Dst;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv4Src;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Dst;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Exthdr;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Flabel;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdSll;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdTarget;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdTll;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Src;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MatchField;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Metadata;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsBos;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsLabel;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsTc;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Nxm0Class;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Nxm1Class;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.OpenflowBasicClass;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.OxmMatchType;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.PbbIsid;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.SctpDst;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.SctpSrc;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TcpDst;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TcpSrc;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TunnelId;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.UdpDst;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.UdpSrc;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.VlanPcp;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.VlanVid;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.oxm.fields.MatchEntries;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.match.grouping.Match;
93 import org.slf4j.Logger;
94 import org.slf4j.LoggerFactory;
97 * Serializes ofp_match (OpenFlow v1.3) and its oxm_fields structures
98 * @author michal.polkorab
99 * @author timotej.kubas
101 public class MatchSerializer {
102 private static final Logger LOGGER = LoggerFactory.getLogger(MatchSerializer.class);
103 private static final byte STANDARD_MATCH_TYPE_CODE = 0;
104 private static final byte OXM_MATCH_TYPE_CODE = 1;
105 private static final int NXM0_CLASS_CODE = 0x0000;
106 private static final int NXM1_CLASS_CODE = 0x0001;
107 private static final int OPENFLOW_BASIC_CLASS_CODE = 0x8000;
108 private static final int EXPERIMENTER_CLASS_CODE = 0xFFFF;
109 private static final byte MATCH_TYPE_AND_LENGTH_SIZE = 4;
110 private static final byte MATCH_ENTRY_HEADER_LENGTH = 4;
113 * Encodes match (OpenFlow v1.3)
114 * @param match ofp_match object
115 * @param out output ByteBuf
117 public static void encodeMatch(Match match, ByteBuf out) {
119 LOGGER.debug("Match is null");
122 encodeType(match, out);
123 // Length of ofp_match (excluding padding)
124 int length = computeMatchLengthInternal(match);
125 out.writeShort(length);
126 encodeMatchEntries(match.getMatchEntries(), out);
127 int paddingRemainder = length % EncodeConstants.PADDING;
128 if (paddingRemainder != 0) {
129 ByteBufUtils.padBuffer(EncodeConstants.PADDING - paddingRemainder, out);
133 private static void encodeType(Match match, ByteBuf out) {
134 if (match.getType().isAssignableFrom(StandardMatchType.class)) {
135 out.writeShort(STANDARD_MATCH_TYPE_CODE);
136 } else if (match.getType().isAssignableFrom(OxmMatchType.class)) {
137 out.writeShort(OXM_MATCH_TYPE_CODE);
142 * Encodes MatchEntries
143 * @param matchEntries list of match entries (oxm_fields)
144 * @param out output ByteBuf
146 public static void encodeMatchEntries(List<MatchEntries> matchEntries, ByteBuf out) {
147 if (matchEntries == null) {
148 LOGGER.warn("Match entries are null");
151 for (MatchEntries entry : matchEntries) {
152 encodeClass(entry.getOxmClass(), out);
153 encodeRest(entry, out);
157 private static void encodeClass(Class<? extends Clazz> clazz, ByteBuf out) {
158 if (clazz.isAssignableFrom(Nxm0Class.class)) {
159 out.writeShort(NXM0_CLASS_CODE);
160 } else if (clazz.isAssignableFrom(Nxm1Class.class)) {
161 out.writeShort(NXM1_CLASS_CODE);
162 } else if (clazz.isAssignableFrom(OpenflowBasicClass.class)) {
163 out.writeShort(OPENFLOW_BASIC_CLASS_CODE);
164 } else if (clazz.isAssignableFrom(ExperimenterClass.class)) {
165 out.writeShort(EXPERIMENTER_CLASS_CODE);
169 private static void encodeRest(MatchEntries entry, ByteBuf out) {
171 Class<? extends MatchField> field = entry.getOxmMatchField();
172 if (field.isAssignableFrom(InPort.class)) {
174 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_INT_IN_BYTES);
175 out.writeInt(entry.getAugmentation(PortNumberMatchEntry.class).getPortNumber().getValue().intValue());
176 } else if (field.isAssignableFrom(InPhyPort.class)) {
178 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_INT_IN_BYTES);
179 out.writeInt(entry.getAugmentation(PortNumberMatchEntry.class).getPortNumber().getValue().intValue());
180 } else if (field.isAssignableFrom(Metadata.class)) {
182 writeMetadataRelatedEntry(entry, out, fieldValue);
183 } else if (field.isAssignableFrom(EthDst.class)) {
185 writeMacAddressRelatedEntry(entry, out, fieldValue);
186 } else if (field.isAssignableFrom(EthSrc.class)) {
188 writeMacAddressRelatedEntry(entry, out, fieldValue);
189 } else if (field.isAssignableFrom(EthType.class)) {
191 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
192 out.writeShort(entry.getAugmentation(EthTypeMatchEntry.class).getEthType().getValue().shortValue());
193 } else if (field.isAssignableFrom(VlanVid.class)) {
195 VlanVidMatchEntry vlanVid = entry.getAugmentation(VlanVidMatchEntry.class);
196 int vlanVidValue = vlanVid.getVlanVid();
197 if (vlanVid.isCfiBit()) {
198 short cfi = 1 << 12; // 13-th bit
199 vlanVidValue = vlanVidValue | cfi;
202 writeOxmFieldAndLength(out, fieldValue, entry.isHasMask(),
203 EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
204 out.writeShort(vlanVidValue);
205 writeMask(entry, out, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
206 } else if (field.isAssignableFrom(VlanPcp.class)) {
208 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
209 out.writeByte(entry.getAugmentation(VlanPcpMatchEntry.class).getVlanPcp().byteValue());
210 } else if (field.isAssignableFrom(IpDscp.class)) {
212 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
213 out.writeByte(entry.getAugmentation(DscpMatchEntry.class).getDscp().getValue());
214 } else if (field.isAssignableFrom(IpEcn.class)) {
216 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
217 out.writeByte(entry.getAugmentation(EcnMatchEntry.class).getEcn());
218 } else if (field.isAssignableFrom(IpProto.class)) {
220 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
221 out.writeByte(entry.getAugmentation(ProtocolNumberMatchEntry.class).getProtocolNumber());
222 } else if (field.isAssignableFrom(Ipv4Src.class)) {
224 writeIpv4AddressRelatedEntry(entry, out, fieldValue);
225 } else if (field.isAssignableFrom(Ipv4Dst.class)) {
227 writeIpv4AddressRelatedEntry(entry, out, fieldValue);
228 } else if (field.isAssignableFrom(TcpSrc.class)) {
230 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
231 out.writeShort(entry.getAugmentation(PortMatchEntry.class).getPort().getValue().intValue());
232 } else if (field.isAssignableFrom(TcpDst.class)) {
234 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
235 out.writeShort(entry.getAugmentation(PortMatchEntry.class).getPort().getValue().intValue());
236 } else if (field.isAssignableFrom(UdpSrc.class)) {
238 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
239 out.writeShort(entry.getAugmentation(PortMatchEntry.class).getPort().getValue().intValue());
240 } else if (field.isAssignableFrom(UdpDst.class)) {
242 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
243 out.writeShort(entry.getAugmentation(PortMatchEntry.class).getPort().getValue().intValue());
244 } else if (field.isAssignableFrom(SctpSrc.class)) {
246 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
247 out.writeShort(entry.getAugmentation(PortMatchEntry.class).getPort().getValue().intValue());
248 } else if (field.isAssignableFrom(SctpDst.class)) {
250 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
251 out.writeShort(entry.getAugmentation(PortMatchEntry.class).getPort().getValue().intValue());
252 } else if (field.isAssignableFrom(Icmpv4Type.class)) {
254 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
255 out.writeByte(entry.getAugmentation(Icmpv4TypeMatchEntry.class).getIcmpv4Type());
256 } else if (field.isAssignableFrom(Icmpv4Code.class)) {
258 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
259 out.writeByte(entry.getAugmentation(Icmpv4CodeMatchEntry.class).getIcmpv4Code());
260 } else if (field.isAssignableFrom(ArpOp.class)) {
262 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
263 out.writeShort(entry.getAugmentation(OpCodeMatchEntry.class).getOpCode());
264 } else if (field.isAssignableFrom(ArpSpa.class)) {
266 writeIpv4AddressRelatedEntry(entry, out, fieldValue);
267 } else if (field.isAssignableFrom(ArpTpa.class)) {
269 writeIpv4AddressRelatedEntry(entry, out, fieldValue);
270 } else if (field.isAssignableFrom(ArpSha.class)) {
272 writeMacAddressRelatedEntry(entry, out, fieldValue);
273 } else if (field.isAssignableFrom(ArpTha.class)) {
275 writeMacAddressRelatedEntry(entry, out, fieldValue);
276 } else if (field.isAssignableFrom(Ipv6Src.class)) {
278 writeIpv6AddressRelatedEntry(entry, out, fieldValue);
279 } else if (field.isAssignableFrom(Ipv6Dst.class)) {
281 writeIpv6AddressRelatedEntry(entry, out, fieldValue);
282 } else if (field.isAssignableFrom(Ipv6Flabel.class)) {
284 writeOxmFieldAndLength(out, fieldValue, entry.isHasMask(),
285 EncodeConstants.SIZE_OF_INT_IN_BYTES);
286 out.writeInt(entry.getAugmentation(Ipv6FlabelMatchEntry.class).getIpv6Flabel().getValue().intValue());
287 writeMask(entry, out, EncodeConstants.SIZE_OF_INT_IN_BYTES);
288 } else if (field.isAssignableFrom(Icmpv6Type.class)) {
290 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
291 out.writeByte(entry.getAugmentation(Icmpv6TypeMatchEntry.class).getIcmpv6Type());
292 } else if (field.isAssignableFrom(Icmpv6Code.class)) {
294 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
295 out.writeByte(entry.getAugmentation(Icmpv6CodeMatchEntry.class).getIcmpv6Code());
296 } else if (field.isAssignableFrom(Ipv6NdTarget.class)) {
298 writeIpv6AddressRelatedEntry(entry, out, fieldValue);
299 } else if (field.isAssignableFrom(Ipv6NdSll.class)) {
301 writeMacAddressRelatedEntry(entry, out, fieldValue);
302 } else if (field.isAssignableFrom(Ipv6NdTll.class)) {
304 writeMacAddressRelatedEntry(entry, out, fieldValue);
305 } else if (field.isAssignableFrom(MplsLabel.class)) {
307 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_INT_IN_BYTES);
308 LOGGER.warn("MplsLabel match entry: possible wrong length written (wrote 4 - maybe must be 3)");
309 out.writeInt(entry.getAugmentation(MplsLabelMatchEntry.class).getMplsLabel().intValue());
310 } else if (field.isAssignableFrom(MplsTc.class)) {
312 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
313 out.writeByte(entry.getAugmentation(TcMatchEntry.class).getTc());
314 } else if (field.isAssignableFrom(MplsBos.class)) {
316 writeOxmFieldAndLength(out, fieldValue, false, EncodeConstants.SIZE_OF_BYTE_IN_BYTES);
317 out.writeBoolean(entry.getAugmentation(BosMatchEntry.class).isBos().booleanValue());
318 } else if (field.isAssignableFrom(PbbIsid.class)) {
320 writeOxmFieldAndLength(out, fieldValue, entry.isHasMask(),
321 EncodeConstants.SIZE_OF_LONG_IN_BYTES);
322 out.writeInt(entry.getAugmentation(IsidMatchEntry.class).getIsid().intValue());
323 writeMask(entry, out, EncodeConstants.SIZE_OF_LONG_IN_BYTES);
324 } else if (field.isAssignableFrom(TunnelId.class)) {
326 writeMetadataRelatedEntry(entry, out, fieldValue);
327 } else if (field.isAssignableFrom(Ipv6Exthdr.class)) {
329 fieldValue = fieldValue << 1;
330 PseudoField pseudoField = entry.getAugmentation(PseudoFieldMatchEntry.class).getPseudoField();
331 Map<Integer, Boolean> map = new HashMap<>();
332 map.put(0, pseudoField.isNonext());
333 map.put(1, pseudoField.isEsp());
334 map.put(2, pseudoField.isAuth());
335 map.put(3, pseudoField.isDest());
336 map.put(4, pseudoField.isFrag());
337 map.put(5, pseudoField.isRouter());
338 map.put(6, pseudoField.isHop());
339 map.put(7, pseudoField.isUnrep());
340 map.put(8, pseudoField.isUnseq());
341 int bitmap = ByteBufUtils.fillBitMaskFromMap(map);
343 writeOxmFieldAndLength(out, fieldValue, entry.isHasMask(),
344 EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
345 out.writeShort(bitmap);
346 writeMask(entry, out, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
355 private static void writeMask(MatchEntries entry, ByteBuf out, int length) {
356 if (entry.isHasMask()) {
357 byte[] mask = entry.getAugmentation(MaskMatchEntry.class).getMask();
358 if (mask != null && mask.length != length) {
359 throw new IllegalArgumentException("incorrect length of mask: "+
360 mask.length + ", expected: " + length);
362 out.writeBytes(mask);
366 private static void writeOxmFieldAndLength(ByteBuf out, int fieldValue, boolean hasMask, int lengthArg) {
367 int fieldAndMask = fieldValue << 1;
368 int length = lengthArg;
374 out.writeByte(fieldAndMask);
375 out.writeByte(length);
379 private static void writeMetadataRelatedEntry(MatchEntries entry, ByteBuf out, int value) {
380 int fieldValue = value;
381 writeOxmFieldAndLength(out, fieldValue, entry.isHasMask(),
382 EncodeConstants.SIZE_OF_LONG_IN_BYTES);
383 out.writeBytes(entry.getAugmentation(MetadataMatchEntry.class).getMetadata());
384 writeMask(entry, out, EncodeConstants.SIZE_OF_LONG_IN_BYTES);
387 private static void writeMacAddressRelatedEntry(MatchEntries entry, ByteBuf out, int value) {
388 int fieldValue = value;
390 writeOxmFieldAndLength(out, fieldValue, entry.isHasMask(),
391 EncodeConstants.MAC_ADDRESS_LENGTH);
392 String macAddress = entry.getAugmentation(MacAddressMatchEntry.class).getMacAddress().getValue();
393 out.writeBytes(ByteBufUtils.macAddressToBytes(macAddress)); // 48 b + mask [OF 1.3.2 spec]
394 writeMask(entry, out, EncodeConstants.MAC_ADDRESS_LENGTH);
397 private static void writeIpv4AddressRelatedEntry(MatchEntries entry, ByteBuf out, int value) {
398 int fieldValue = value;
400 writeOxmFieldAndLength(out, fieldValue, entry.isHasMask(),
401 EncodeConstants.SIZE_OF_INT_IN_BYTES);
402 writeIpv4Address(entry, out);
403 writeMask(entry, out, EncodeConstants.SIZE_OF_INT_IN_BYTES);
406 private static void writeIpv4Address(MatchEntries entry, ByteBuf out) {
407 String[] addressGroups = entry.getAugmentation(Ipv4AddressMatchEntry.class).getIpv4Address().getValue().split("\\.");
408 for (int i = 0; i < addressGroups.length; i++) {
409 out.writeByte(Integer.parseInt(addressGroups[i]));
413 private static void writeIpv6AddressRelatedEntry(MatchEntries entry, ByteBuf out, int value) {
414 int fieldValue = value;
415 String textAddress = entry.getAugmentation(Ipv6AddressMatchEntry.class).getIpv6Address().getValue();
417 if (textAddress.equals("::")) {
418 address = new String[EncodeConstants.GROUPS_IN_IPV6_ADDRESS];
419 Arrays.fill(address, "0");
421 address = parseIpv6Address(textAddress.split(":"));
424 writeOxmFieldAndLength(out, fieldValue, entry.isHasMask(),
425 EncodeConstants.SIZE_OF_IPV6_ADDRESS_IN_BYTES);
426 for (int i = 0; i < address.length; i++) {
427 out.writeShort(Integer.parseInt(address[i], 16));
429 writeMask(entry, out, EncodeConstants.SIZE_OF_IPV6_ADDRESS_IN_BYTES);
432 private static String[] parseIpv6Address(String[] addressGroups) {
434 for (int i = 0; i < addressGroups.length; i++) {
435 if (addressGroups[i].equals("")){
439 String[] ready = new String[EncodeConstants.GROUPS_IN_IPV6_ADDRESS];
440 switch (countEmpty) {
442 ready = addressGroups;
445 int zerosToBePushed = EncodeConstants.GROUPS_IN_IPV6_ADDRESS - addressGroups.length + 1;
447 for (int i = 0; i < addressGroups.length; i++) {
448 if (addressGroups[i].equals("")) {
449 for (int j = 0; j < zerosToBePushed; j++) {
454 ready[index] = addressGroups[i];
460 Arrays.fill(ready, "0");
461 ready[ready.length - 1] = addressGroups[addressGroups.length - 1];
464 throw new IllegalStateException("Incorrect ipv6 address");
470 * Computes length of match (in bytes)
472 * @return length of ofp_match (excluding padding)
474 public static int computeMatchLengthInternal(Match match) {
477 length += MATCH_TYPE_AND_LENGTH_SIZE + computeMatchEntriesLength(match.getMatchEntries());
483 * Computes length of match (in bytes)
485 * @return length of ofp_match (excluding padding)
487 public static int computeMatchLength(Match match) {
488 int length = computeMatchLengthInternal(match);
489 int paddingRemainder = length % EncodeConstants.PADDING;
490 if (paddingRemainder != 0) {
491 length += EncodeConstants.PADDING - paddingRemainder;
497 * Computes length of MatchEntries (in bytes)
498 * @param matchEntries list of match entries (oxm_fields)
499 * @return length of MatchEntries
501 public static int computeMatchEntriesLength(List<MatchEntries> matchEntries) {
503 if (matchEntries != null) {
504 for (MatchEntries entry : matchEntries) {
505 length += MATCH_ENTRY_HEADER_LENGTH;
506 Class<? extends MatchField> field = entry.getOxmMatchField();
507 if (field.isAssignableFrom(InPort.class)) {
508 length += EncodeConstants.SIZE_OF_INT_IN_BYTES;
509 } else if (field.isAssignableFrom(InPhyPort.class)) {
510 length += EncodeConstants.SIZE_OF_INT_IN_BYTES;
511 } else if (field.isAssignableFrom(Metadata.class)) {
512 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_LONG_IN_BYTES);
513 } else if (field.isAssignableFrom(EthDst.class)) {
514 length += computePossibleMaskEntryLength(entry, EncodeConstants.MAC_ADDRESS_LENGTH);
515 } else if (field.isAssignableFrom(EthSrc.class)) {
516 length += computePossibleMaskEntryLength(entry, EncodeConstants.MAC_ADDRESS_LENGTH);
517 } else if (field.isAssignableFrom(EthType.class)) {
518 length += EncodeConstants.SIZE_OF_SHORT_IN_BYTES;
519 } else if (field.isAssignableFrom(VlanVid.class)) {
520 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
521 } else if (field.isAssignableFrom(VlanPcp.class)) {
522 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
523 } else if (field.isAssignableFrom(IpDscp.class)) {
524 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
525 } else if (field.isAssignableFrom(IpEcn.class)) {
526 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
527 } else if (field.isAssignableFrom(IpProto.class)) {
528 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
529 } else if (field.isAssignableFrom(Ipv4Src.class)) {
530 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_INT_IN_BYTES);
531 } else if (field.isAssignableFrom(Ipv4Dst.class)) {
532 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_INT_IN_BYTES);
533 } else if (field.isAssignableFrom(TcpSrc.class)) {
534 length += EncodeConstants.SIZE_OF_SHORT_IN_BYTES;
535 } else if (field.isAssignableFrom(TcpDst.class)) {
536 length += EncodeConstants.SIZE_OF_SHORT_IN_BYTES;
537 } else if (field.isAssignableFrom(UdpSrc.class)) {
538 length += EncodeConstants.SIZE_OF_SHORT_IN_BYTES;
539 } else if (field.isAssignableFrom(UdpDst.class)) {
540 length += EncodeConstants.SIZE_OF_SHORT_IN_BYTES;
541 } else if (field.isAssignableFrom(SctpSrc.class)) {
542 length += EncodeConstants.SIZE_OF_SHORT_IN_BYTES;
543 } else if (field.isAssignableFrom(SctpDst.class)) {
544 length += EncodeConstants.SIZE_OF_SHORT_IN_BYTES;
545 } else if (field.isAssignableFrom(Icmpv4Type.class)) {
546 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
547 } else if (field.isAssignableFrom(Icmpv4Code.class)) {
548 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
549 } else if (field.isAssignableFrom(ArpOp.class)) {
550 length += EncodeConstants.SIZE_OF_SHORT_IN_BYTES;
551 } else if (field.isAssignableFrom(ArpSpa.class)) {
552 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_INT_IN_BYTES);
553 } else if (field.isAssignableFrom(ArpTpa.class)) {
554 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_INT_IN_BYTES);
555 } else if (field.isAssignableFrom(ArpSha.class)) {
556 length += computePossibleMaskEntryLength(entry, EncodeConstants.MAC_ADDRESS_LENGTH);
557 } else if (field.isAssignableFrom(ArpTha.class)) {
558 length += computePossibleMaskEntryLength(entry, EncodeConstants.MAC_ADDRESS_LENGTH);
559 } else if (field.isAssignableFrom(Ipv6Src.class)) {
560 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_IPV6_ADDRESS_IN_BYTES);
561 } else if (field.isAssignableFrom(Ipv6Dst.class)) {
562 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_IPV6_ADDRESS_IN_BYTES);
563 } else if (field.isAssignableFrom(Ipv6Flabel.class)) {
564 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_INT_IN_BYTES);
565 } else if (field.isAssignableFrom(Icmpv6Type.class)) {
566 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
567 } else if (field.isAssignableFrom(Icmpv6Code.class)) {
568 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
569 } else if (field.isAssignableFrom(Ipv6NdTarget.class)) {
570 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_IPV6_ADDRESS_IN_BYTES);
571 } else if (field.isAssignableFrom(Ipv6NdSll.class)) {
572 length += computePossibleMaskEntryLength(entry, EncodeConstants.MAC_ADDRESS_LENGTH);
573 } else if (field.isAssignableFrom(Ipv6NdTll.class)) {
574 length += computePossibleMaskEntryLength(entry, EncodeConstants.MAC_ADDRESS_LENGTH);
575 } else if (field.isAssignableFrom(MplsLabel.class)) {
576 length += EncodeConstants.SIZE_OF_INT_IN_BYTES;
577 } else if (field.isAssignableFrom(MplsTc.class)) {
578 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
579 } else if (field.isAssignableFrom(MplsBos.class)) {
580 length += EncodeConstants.SIZE_OF_BYTE_IN_BYTES;
581 } else if (field.isAssignableFrom(PbbIsid.class)) {
582 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_INT_IN_BYTES);
583 } else if (field.isAssignableFrom(TunnelId.class)) {
584 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_LONG_IN_BYTES);
585 } else if (field.isAssignableFrom(Ipv6Exthdr.class)) {
586 length += computePossibleMaskEntryLength(entry, EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
593 private static int computePossibleMaskEntryLength(MatchEntries entry, int length) {
594 int entryLength = length;
595 if (entry.isHasMask()) {