Bug-835 - Reserve Ports should be logical ports
[openflowplugin.git] / openflowplugin / src / main / java / org / opendaylight / openflowplugin / openflow / md / core / translator / FlowRemovedTranslator.java
1 /**
2  * Copyright (c) 2014 Ericsson India Global Services Pvt Ltd. 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  * Contributor: deepthi.v.v@ericsson.com
9  */
10 package org.opendaylight.openflowplugin.openflow.md.core.translator;
11
12 import org.opendaylight.openflowplugin.openflow.md.OFConstants;
13 import org.opendaylight.openflowplugin.openflow.md.core.IMDMessageTranslator;
14 import org.opendaylight.openflowplugin.openflow.md.core.SwitchConnectionDistinguisher;
15 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.MatchConvertorImpl;
16 import org.opendaylight.openflowplugin.openflow.md.core.session.SessionContext;
17 import org.opendaylight.openflowplugin.openflow.md.util.ByteUtil;
18 import org.opendaylight.openflowplugin.openflow.md.util.InventoryDataServiceUtil;
19 import org.opendaylight.openflowplugin.openflow.md.util.OpenflowVersion;
20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6FlowLabel;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Prefix;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SwitchFlowRemovedBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.RemovedReasonFlags;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.mod.removed.Match;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.mod.removed.MatchBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpSourceHardwareAddressBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpTargetHardwareAddressBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetDestinationBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetSourceBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetTypeBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ipv6.match.fields.Ipv6ExtHeaderBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ipv6.match.fields.Ipv6LabelBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv4MatchBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv6MatchBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.IpMatchBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.MetadataBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.ProtocolMatchFieldsBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.TunnelBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.VlanMatchBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.ArpMatchBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.SctpMatchBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatchBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.UdpMatchBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.protocol.match.fields.PbbBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.vlan.match.fields.VlanIdBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.BosMatchEntry;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.DscpMatchEntry;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EcnMatchEntry;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EthTypeMatchEntry;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv4CodeMatchEntry;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv4TypeMatchEntry;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv6CodeMatchEntry;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Icmpv6TypeMatchEntry;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv4AddressMatchEntry;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv6AddressMatchEntry;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.Ipv6FlabelMatchEntry;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.IsidMatchEntry;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MacAddressMatchEntry;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MaskMatchEntry;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataMatchEntry;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MplsLabelMatchEntry;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.OpCodeMatchEntry;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortMatchEntry;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortNumberMatchEntry;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ProtocolNumberMatchEntry;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PseudoFieldMatchEntry;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TcMatchEntry;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanPcpMatchEntry;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanVidMatchEntry;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowRemovedReason;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Ipv6ExthdrFlags;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpOp;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpSha;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpSpa;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpTha;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.ArpTpa;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthDst;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthSrc;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.EthType;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv4Code;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv4Type;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv6Code;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Icmpv6Type;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.InPhyPort;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.InPort;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpDscp;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpEcn;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.IpProto;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv4Dst;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv4Src;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Dst;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Exthdr;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Flabel;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdSll;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdTarget;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6NdTll;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Ipv6Src;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MatchField;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.Metadata;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsBos;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsLabel;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MplsTc;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.PbbIsid;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.SctpDst;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.SctpSrc;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TcpDst;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TcpSrc;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.TunnelId;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.UdpDst;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.UdpSrc;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.VlanPcp;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.VlanVid;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.oxm.fields.grouping.MatchEntries;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
126 import org.opendaylight.yangtools.yang.binding.DataObject;
127 import org.slf4j.Logger;
128 import org.slf4j.LoggerFactory;
129
130 import java.math.BigInteger;
131 import java.util.Collections;
132 import java.util.HashMap;
133 import java.util.List;
134 import java.util.Map;
135 import java.util.Map.Entry;
136 import java.util.concurrent.CopyOnWriteArrayList;
137
138 public class FlowRemovedTranslator implements IMDMessageTranslator<OfHeader, List<DataObject>> {
139
140     protected static final Logger LOG = LoggerFactory.getLogger(FlowRemovedTranslator.class);
141     private static final String PREFIX_SEPARATOR = "/";
142
143     @Override
144     public List<DataObject> translate(SwitchConnectionDistinguisher cookie, SessionContext sc, OfHeader msg) {
145         if (msg instanceof FlowRemovedMessage) {
146             FlowRemovedMessage ofFlow = (FlowRemovedMessage) msg;
147             List<DataObject> list = new CopyOnWriteArrayList<DataObject>();
148             LOG.debug("Flow Removed Message received: Table Id={}, Flow removed reason={} ", ofFlow.getTableId(),
149                     ofFlow.getReason());
150
151             SwitchFlowRemovedBuilder salFlowRemoved = new SwitchFlowRemovedBuilder();
152
153             salFlowRemoved.setCookie(new FlowCookie(ofFlow.getCookie()));
154             salFlowRemoved.setPriority(ofFlow.getPriority());
155
156             if (ofFlow.getTableId() != null) {
157                 salFlowRemoved.setTableId(ofFlow.getTableId().getValue().shortValue());
158             }
159
160             salFlowRemoved.setDurationSec(ofFlow.getDurationSec());
161             salFlowRemoved.setDurationNsec(ofFlow.getDurationNsec());
162             salFlowRemoved.setIdleTimeout(ofFlow.getIdleTimeout());
163             salFlowRemoved.setHardTimeout(ofFlow.getHardTimeout());
164             salFlowRemoved.setPacketCount(ofFlow.getPacketCount());
165             salFlowRemoved.setByteCount(ofFlow.getByteCount());
166             RemovedReasonFlags removeReasonFlag = new RemovedReasonFlags(
167                     FlowRemovedReason.OFPRRDELETE.equals(ofFlow.getReason()),
168                     FlowRemovedReason.OFPRRGROUPDELETE.equals(ofFlow.getReason()),
169                     FlowRemovedReason.OFPRRHARDTIMEOUT.equals(ofFlow.getReason()),
170                     FlowRemovedReason.OFPRRIDLETIMEOUT.equals(ofFlow.getReason())
171                     );
172
173             salFlowRemoved.setRemovedReason(removeReasonFlag);
174
175             OpenflowVersion ofVersion = OpenflowVersion.get(sc.getPrimaryConductor().getVersion());
176             org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.match.grouping.Match ofMatch = ofFlow
177                     .getMatch();
178             if (ofMatch != null) {
179                 salFlowRemoved.setMatch(fromMatch(ofMatch, sc.getFeatures().getDatapathId(), ofVersion));
180             }
181             else if(ofFlow.getMatchV10() != null){
182                 MatchBuilder matchBuilder = new MatchBuilder(MatchConvertorImpl.fromOFMatchV10ToSALMatch(ofFlow.getMatchV10(), sc.getFeatures().getDatapathId(), ofVersion));
183                 salFlowRemoved.setMatch(matchBuilder.build());
184             }
185             salFlowRemoved.setNode(new NodeRef(InventoryDataServiceUtil.identifierFromDatapathId(sc.getFeatures()
186                     .getDatapathId())));
187             list.add(salFlowRemoved.build());
188             return list;
189         } else {
190             LOG.error("Message is not a flow removed message ");
191             return Collections.emptyList();
192         }
193     }
194
195
196     public Match fromMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.match.grouping.Match ofMatch,
197             BigInteger datapathid, OpenflowVersion ofVersion) {
198         MatchBuilder matchBuilder = new MatchBuilder();
199         EthernetMatchBuilder ethernetMatch = null;
200         VlanMatchBuilder vlanMatch = null;
201         IpMatchBuilder ipMatch = null;
202         TcpMatchBuilder tcpMatch = null;
203         UdpMatchBuilder udpMatch = null;
204         SctpMatchBuilder sctpMatch = null;
205         Icmpv4MatchBuilder icmpv4Match = null;
206         Icmpv6MatchBuilder icmpv6Match = null;
207         Ipv4MatchBuilder ipv4Match = null;
208         ArpMatchBuilder arpMatch = null;
209         Ipv6MatchBuilder ipv6Match = null;
210         ProtocolMatchFieldsBuilder protocolMatchFields = null;
211
212         for (MatchEntries entry : ofMatch.getMatchEntries()) {
213             Class<? extends MatchField> field = entry.getOxmMatchField();
214             if (field.equals(InPort.class)) {
215                 matchBuilder.setInPort(InventoryDataServiceUtil.nodeConnectorIdfromDatapathPortNo(datapathid,
216                         entry.getAugmentation(PortNumberMatchEntry.class).getPortNumber().getValue().longValue(), ofVersion));
217             } else if (field.equals(InPhyPort.class)) {
218                 matchBuilder.setInPhyPort(InventoryDataServiceUtil.nodeConnectorIdfromDatapathPortNo(datapathid,
219                         entry.getAugmentation(PortNumberMatchEntry.class).getPortNumber().getValue().longValue(), ofVersion));
220             } else if (field.equals(Metadata.class)) {
221                 MetadataBuilder metadata = new MetadataBuilder();
222                 metadata.setMetadata(new BigInteger(1, entry.getAugmentation(MetadataMatchEntry.class).getMetadata()));
223                 if (entry.isHasMask()) {
224                     metadata.setMetadataMask(new BigInteger(OFConstants.SIGNUM_UNSIGNED, entry.getAugmentation(MaskMatchEntry.class).getMask()));
225                 }
226                 matchBuilder.setMetadata(metadata.build());
227             } else if (field.equals(EthDst.class) || field.equals(EthSrc.class) || field.equals(EthType.class)) {
228                 if (ethernetMatch == null) {
229                     ethernetMatch = new EthernetMatchBuilder();
230                 }
231                 if (field.equals(EthDst.class)) {
232                     EthernetDestinationBuilder ethDst = new EthernetDestinationBuilder();
233                     ethDst.setAddress(entry.getAugmentation(MacAddressMatchEntry.class).getMacAddress());
234                     if (entry.isHasMask()) {
235                         ethDst.setMask(new MacAddress(ByteUtil.bytesToHexstring(entry.getAugmentation(MaskMatchEntry.class).getMask(),":")));
236                     }
237                     ethernetMatch.setEthernetDestination(ethDst.build());
238                 } else if (field.equals(EthSrc.class)) {
239                     EthernetSourceBuilder ethSrc = new EthernetSourceBuilder();
240                     ethSrc.setAddress(entry.getAugmentation(MacAddressMatchEntry.class).getMacAddress());
241                     if (entry.isHasMask()) {
242                         ethSrc.setMask(new MacAddress(ByteUtil.bytesToHexstring(entry.getAugmentation(MaskMatchEntry.class).getMask(),":")));
243                     }
244                     ethernetMatch.setEthernetSource(ethSrc.build());
245                 } else if (field.equals(EthType.class)) {
246                     EthernetTypeBuilder ethType = new EthernetTypeBuilder();
247                     ethType.setType(new EtherType(entry.getAugmentation(EthTypeMatchEntry.class).getEthType()
248                             .getValue().longValue()));
249                     ethernetMatch.setEthernetType(ethType.build());
250                 }
251             } else if (field.equals(VlanVid.class) || field.equals(VlanPcp.class)) {
252                 if (vlanMatch == null) {
253                     vlanMatch = new VlanMatchBuilder();
254                 }
255                 if (field.equals(VlanVid.class)) {
256                     boolean vlanIdPresent = false;
257                     VlanIdBuilder vlanId = new VlanIdBuilder();
258                     VlanVidMatchEntry vlanVid = entry.getAugmentation(VlanVidMatchEntry.class);
259                     Integer vlanVidValue = vlanVid.getVlanVid();
260                     if (vlanVid.isCfiBit()) {
261                         vlanIdPresent = true;
262                     }
263                     vlanId.setVlanIdPresent(vlanIdPresent);
264                     if (vlanVidValue != null) {
265                         vlanId.setVlanId(new VlanId(vlanVidValue));
266                     }
267                     vlanMatch.setVlanId(vlanId.build());
268                 } else if (field.equals(VlanPcp.class)) {
269                     vlanMatch.setVlanPcp(new org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp(
270                             entry.getAugmentation(VlanPcpMatchEntry.class).getVlanPcp().shortValue()));
271                 }
272             } else if (field.equals(IpDscp.class) || field.equals(IpEcn.class) || field.equals(IpProto.class)) {
273                 if (ipMatch == null) {
274                     ipMatch = new IpMatchBuilder();
275                 }
276                 if (field.equals(IpDscp.class)) {
277                     ipMatch.setIpDscp(new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Dscp(
278                             entry.getAugmentation(DscpMatchEntry.class).getDscp().getValue()));
279                 } else if (field.equals(IpEcn.class)) {
280                     ipMatch.setIpEcn(entry.getAugmentation(EcnMatchEntry.class).getEcn());
281                 } else if (field.equals(IpProto.class)) {
282                     ipMatch.setIpProtocol(entry.getAugmentation(ProtocolNumberMatchEntry.class).getProtocolNumber());
283                 }
284             } else if (field.equals(TcpSrc.class) || field.equals(TcpDst.class)) {
285                 if (tcpMatch == null) {
286                     tcpMatch = new TcpMatchBuilder();
287                 }
288                 if (field.equals(TcpSrc.class)) {
289                     tcpMatch.setTcpSourcePort(new PortNumber(entry.getAugmentation(PortMatchEntry.class).getPort()
290                             .getValue()));
291                 } else if (field.equals(TcpDst.class)) {
292                     tcpMatch.setTcpDestinationPort(new PortNumber(entry.getAugmentation(PortMatchEntry.class).getPort()
293                             .getValue()));
294                 }
295             } else if (field.equals(UdpSrc.class) || field.equals(UdpDst.class)) {
296                 if (udpMatch == null) {
297                     udpMatch = new UdpMatchBuilder();
298                 }
299                 if (field.equals(UdpSrc.class)) {
300                     udpMatch.setUdpSourcePort(new PortNumber(entry.getAugmentation(PortMatchEntry.class).getPort()
301                             .getValue()));
302                 } else if (field.equals(UdpDst.class)) {
303                     udpMatch.setUdpDestinationPort(new PortNumber(entry.getAugmentation(PortMatchEntry.class).getPort()
304                             .getValue()));
305                 }
306             } else if (field.equals(SctpSrc.class) || field.equals(SctpDst.class)) {
307                 if (sctpMatch == null) {
308                     sctpMatch = new SctpMatchBuilder();
309                 }
310                 if (field.equals(SctpSrc.class)) {
311                     sctpMatch.setSctpSourcePort(new PortNumber(entry.getAugmentation(PortMatchEntry.class).getPort()
312                             .getValue()));
313                 } else if (field.equals(SctpDst.class)) {
314                     sctpMatch.setSctpDestinationPort(new PortNumber(entry.getAugmentation(PortMatchEntry.class)
315                             .getPort().getValue()));
316                 }
317             } else if (field.equals(Icmpv4Type.class) || field.equals(Icmpv4Code.class)) {
318                 if (icmpv4Match == null) {
319                     icmpv4Match = new Icmpv4MatchBuilder();
320                 }
321                 if (field.equals(Icmpv4Type.class)) {
322                     icmpv4Match.setIcmpv4Type(entry.getAugmentation(Icmpv4TypeMatchEntry.class).getIcmpv4Type());
323                 } else if (field.equals(Icmpv4Code.class)) {
324                     icmpv4Match.setIcmpv4Code(entry.getAugmentation(Icmpv4CodeMatchEntry.class).getIcmpv4Code());
325                 }
326             } else if (field.equals(Icmpv6Type.class) || field.equals(Icmpv6Code.class)) {
327                 if (icmpv6Match == null) {
328                     icmpv6Match = new Icmpv6MatchBuilder();
329                 }
330                 if (field.equals(Icmpv6Type.class)) {
331                     icmpv6Match.setIcmpv6Type(entry.getAugmentation(Icmpv6TypeMatchEntry.class).getIcmpv6Type());
332                 } else if (field.equals(Icmpv6Code.class)) {
333                     icmpv6Match.setIcmpv6Code(entry.getAugmentation(Icmpv6CodeMatchEntry.class).getIcmpv6Code());
334                 }
335             } else if (field.equals(Ipv4Src.class) || field.equals(Ipv4Dst.class)) {
336                 if (ipv4Match == null) {
337                     ipv4Match = new Ipv4MatchBuilder();
338                 }
339                 if (field.equals(Ipv4Src.class)) {
340                     ipv4Match.setIpv4Source(toIpv4Prefix(entry));
341                 } else if (field.equals(Ipv4Dst.class)) {
342                     ipv4Match.setIpv4Destination(toIpv4Prefix(entry));
343                 }
344             } else if (field.equals(ArpOp.class) || field.equals(ArpSpa.class) || field.equals(ArpTpa.class)
345                     || field.equals(ArpSha.class) || field.equals(ArpTha.class)) {
346                 if (arpMatch == null) {
347                     arpMatch = new ArpMatchBuilder();
348                 }
349                 if (field.equals(ArpOp.class)) {
350                     arpMatch.setArpOp(entry.getAugmentation(OpCodeMatchEntry.class).getOpCode());
351                 } else if (field.equals(ArpSpa.class)) {
352                     arpMatch.setArpSourceTransportAddress(toIpv4Prefix(entry));
353                 } else if (field.equals(ArpTpa.class)) {
354                     arpMatch.setArpTargetTransportAddress(toIpv4Prefix(entry));
355                 } else if (field.equals(ArpSha.class)) {
356                     ArpSourceHardwareAddressBuilder arpSha = new ArpSourceHardwareAddressBuilder();
357                     arpSha.setAddress(entry.getAugmentation(MacAddressMatchEntry.class).getMacAddress());
358                     if (entry.isHasMask()) {
359                         arpSha.setMask(new MacAddress(ByteUtil.bytesToHexstring(entry.getAugmentation(MaskMatchEntry.class).getMask(),":")));
360                     }
361                     arpMatch.setArpSourceHardwareAddress(arpSha.build());
362                 } else if (field.equals(ArpTha.class)) {
363                     ArpTargetHardwareAddressBuilder arpTha = new ArpTargetHardwareAddressBuilder();
364                     arpTha.setAddress(entry.getAugmentation(MacAddressMatchEntry.class).getMacAddress());
365                     if (entry.isHasMask()) {
366                         arpTha.setMask(new MacAddress(ByteUtil.bytesToHexstring(entry.getAugmentation(MaskMatchEntry.class).getMask(),":")));
367                     }
368                     arpMatch.setArpTargetHardwareAddress(arpTha.build());
369                 }
370             } else if (field.equals(Ipv6Src.class) || field.equals(Ipv6Dst.class) || field.equals(Ipv6Flabel.class)
371                     || field.equals(Ipv6NdTarget.class) || field.equals(Ipv6NdSll.class)
372                     || field.equals(Ipv6NdTll.class) || field.equals(Ipv6Exthdr.class)) {
373                 if (ipv6Match == null) {
374                     ipv6Match = new Ipv6MatchBuilder();
375                 }
376                 if (field.equals(Ipv6Src.class)) {
377                     ipv6Match.setIpv6Source(toIpv6Prefix(entry));
378                 } else if (field.equals(Ipv6Dst.class)) {
379                     ipv6Match.setIpv6Destination(toIpv6Prefix(entry));
380                 } else if (field.equals(Ipv6Flabel.class)) {
381                     Ipv6LabelBuilder ipv6Label = new Ipv6LabelBuilder();
382                     ipv6Label.setIpv6Flabel(entry.getAugmentation(Ipv6FlabelMatchEntry.class).getIpv6Flabel());
383                     if (entry.isHasMask()) {
384                         ipv6Label.setFlabelMask(new Ipv6FlowLabel(ByteUtil.bytesToUnsignedInt(entry.getAugmentation(MaskMatchEntry.class).getMask())));
385                     }
386                     ipv6Match.setIpv6Label(ipv6Label.build());
387                 } else if (field.equals(Ipv6NdTarget.class)) {
388                     ipv6Match.setIpv6NdTarget(entry.getAugmentation(Ipv6AddressMatchEntry.class).getIpv6Address());
389                 } else if (field.equals(Ipv6NdSll.class)) {
390                     ipv6Match.setIpv6NdSll(entry.getAugmentation(MacAddressMatchEntry.class).getMacAddress());
391                 } else if (field.equals(Ipv6NdTll.class)) {
392                     ipv6Match.setIpv6NdTll(entry.getAugmentation(MacAddressMatchEntry.class).getMacAddress());
393                 } else if (field.equals(Ipv6Exthdr.class)) {
394                     // verify
395                     Ipv6ExtHeaderBuilder ipv6ExtHeaderBuilder = new Ipv6ExtHeaderBuilder();
396                     Ipv6ExthdrFlags pseudoField = entry.getAugmentation(PseudoFieldMatchEntry.class).getPseudoField();
397                     Map<Integer, Boolean> map = new HashMap<>();
398                     map.put(0, pseudoField.isNonext());
399                     map.put(1, pseudoField.isEsp());
400                     map.put(2, pseudoField.isAuth());
401                     map.put(3, pseudoField.isDest());
402                     map.put(4, pseudoField.isFrag());
403                     map.put(5, pseudoField.isRouter());
404                     map.put(6, pseudoField.isHop());
405                     map.put(7, pseudoField.isUnrep());
406                     map.put(8, pseudoField.isUnseq());
407                     int bitmap = fillBitMaskFromMap(map);
408                     ipv6ExtHeaderBuilder.setIpv6Exthdr(bitmap);
409                     if (entry.isHasMask()) {
410                         ipv6ExtHeaderBuilder.setIpv6ExthdrMask(
411                             ByteUtil.bytesToUnsignedShort(entry.getAugmentation(MaskMatchEntry.class).getMask()));
412                     }
413                     ipv6Match.setIpv6ExtHeader(ipv6ExtHeaderBuilder.build());
414                 }
415             } else if (field.equals(MplsLabel.class) || field.equals(MplsTc.class) || field.equals(MplsBos.class)
416                     || field.equals(PbbIsid.class)) {
417                 if (protocolMatchFields == null) {
418                     protocolMatchFields = new ProtocolMatchFieldsBuilder();
419                 }
420                 if (field.equals(MplsLabel.class)) {
421                     protocolMatchFields.setMplsLabel(entry.getAugmentation(MplsLabelMatchEntry.class).getMplsLabel());
422                 } else if (field.equals(MplsTc.class)) {
423                     protocolMatchFields.setMplsTc(entry.getAugmentation(TcMatchEntry.class).getTc());
424                 } else if (field.equals(MplsBos.class)) {
425                     protocolMatchFields
426                             .setMplsBos((short) (entry.getAugmentation(BosMatchEntry.class).isBos() ? 1 : 0));
427                 } else if (field.equals(PbbIsid.class)) {
428                     PbbBuilder pbb = new PbbBuilder();
429                     pbb.setPbbIsid(entry.getAugmentation(IsidMatchEntry.class).getIsid());
430                     if (entry.isHasMask()) {
431                         pbb.setPbbMask(ByteUtil.bytesToUnsignedInt(entry.getAugmentation(MaskMatchEntry.class).getMask()));
432                     }
433                     protocolMatchFields.setPbb(pbb.build());
434                 }
435             } else if (field.equals(TunnelId.class)) {
436                 TunnelBuilder tunnel = new TunnelBuilder();
437                 tunnel.setTunnelId(new BigInteger(1, entry.getAugmentation(MetadataMatchEntry.class).getMetadata()));
438                 if (entry.isHasMask()) {
439                     tunnel.setTunnelMask(new BigInteger(OFConstants.SIGNUM_UNSIGNED, entry.getAugmentation(MaskMatchEntry.class).getMask()));
440                 }
441                 matchBuilder.setTunnel(tunnel.build());
442             }
443         }
444
445         if (ethernetMatch != null) {
446             matchBuilder.setEthernetMatch(ethernetMatch.build());
447         }
448         if (vlanMatch != null) {
449             matchBuilder.setVlanMatch(vlanMatch.build());
450         }
451         if (ipMatch != null) {
452             matchBuilder.setIpMatch(ipMatch.build());
453         }
454
455         if (tcpMatch != null) {
456             matchBuilder.setLayer4Match(tcpMatch.build());
457         } else if (udpMatch != null) {
458             matchBuilder.setLayer4Match(udpMatch.build());
459         } else if (sctpMatch != null) {
460             matchBuilder.setLayer4Match(sctpMatch.build());
461         }
462
463         if (icmpv4Match != null) {
464             matchBuilder.setIcmpv4Match(icmpv4Match.build());
465         } else if (icmpv6Match != null) {
466             matchBuilder.setIcmpv6Match(icmpv6Match.build());
467         }
468
469         if (ipv4Match != null) {
470             matchBuilder.setLayer3Match(ipv4Match.build());
471         } else if (arpMatch != null) {
472             matchBuilder.setLayer3Match(arpMatch.build());
473         } else if (ipv6Match != null) {
474             matchBuilder.setLayer3Match(ipv6Match.build());
475         }
476         if (protocolMatchFields != null) {
477             matchBuilder.setProtocolMatchFields(protocolMatchFields.build());
478         }
479         return matchBuilder.build();
480     }
481
482     /**
483      * Fills the bitmask from boolean map where key is bit position
484      *
485      * @param booleanMap
486      *            bit to boolean mapping
487      * @return bit mask
488      */
489     private int fillBitMaskFromMap(Map<Integer, Boolean> booleanMap) {
490         int bitmask = 0;
491
492         for (Entry<Integer, Boolean> iterator : booleanMap.entrySet()) {
493             if (iterator.getValue() != null && iterator.getValue().booleanValue()) {
494                 bitmask |= 1 << iterator.getKey();
495             }
496         }
497         return bitmask;
498     }
499
500     private Ipv4Prefix toIpv4Prefix(MatchEntries entry) {
501         String ipv4Prefix = entry.getAugmentation(Ipv4AddressMatchEntry.class).getIpv4Address().toString();
502         if (entry.isHasMask()) {
503             byte[] mask = entry.getAugmentation(MaskMatchEntry.class).getMask();
504             ipv4Prefix = ipv4Prefix + PREFIX_SEPARATOR + countBits(mask);
505         }
506         return new Ipv4Prefix(ipv4Prefix);
507     }
508
509     private Ipv6Prefix toIpv6Prefix(MatchEntries entry) {
510         String ipv6Prefix = entry.getAugmentation(Ipv6AddressMatchEntry.class).getIpv6Address().toString();
511         if (entry.isHasMask()) {
512             byte[] mask = entry.getAugmentation(MaskMatchEntry.class).getMask();
513             ipv6Prefix = ipv6Prefix + PREFIX_SEPARATOR + countBits(mask);
514         }
515         return new Ipv6Prefix(ipv6Prefix);
516     }
517
518     private int toInt(byte b) {
519         return b < 0 ? b + 256 : b;
520     }
521
522     private int countBits(byte[] mask) {
523         int netmask = 0;
524         for (byte b : mask) {
525             netmask += Integer.bitCount(toInt(b));
526         }
527         return netmask;
528     }
529 }