Bug 7453 - FlowRemoved doesn't have Removed Reason Information
[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
9 package org.opendaylight.openflowplugin.openflow.md.core.translator;
10
11 import java.math.BigInteger;
12 import java.util.Collections;
13 import java.util.HashMap;
14 import java.util.List;
15 import java.util.Map;
16 import java.util.Optional;
17 import java.util.Objects;
18 import java.util.concurrent.CopyOnWriteArrayList;
19 import org.opendaylight.openflowjava.util.ByteBufUtils;
20 import org.opendaylight.openflowplugin.api.OFConstants;
21 import org.opendaylight.openflowplugin.api.openflow.md.core.IMDMessageTranslator;
22 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
23 import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionContext;
24 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
25 import org.opendaylight.openflowplugin.extension.api.AugmentTuple;
26 import org.opendaylight.openflowplugin.extension.api.path.MatchPath;
27 import org.opendaylight.openflowplugin.openflow.md.core.extension.MatchExtensionHelper;
28 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
29 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.IpConversionUtil;
30 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionDatapathIdConvertorData;
31 import org.opendaylight.openflowplugin.openflow.md.util.ByteUtil;
32 import org.opendaylight.openflowplugin.openflow.md.util.InventoryDataServiceUtil;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SwitchFlowRemovedBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.RemovedFlowReason;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.mod.removed.Match;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.mod.removed.MatchBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpSourceHardwareAddressBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpTargetHardwareAddressBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetDestinationBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetSourceBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetTypeBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ipv6.match.fields.Ipv6ExtHeaderBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ipv6.match.fields.Ipv6LabelBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv4MatchBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv6MatchBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.IpMatchBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.MetadataBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.ProtocolMatchFieldsBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.TunnelBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.VlanMatchBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.ArpMatchBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.SctpMatchBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatchBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.UdpMatchBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.protocol.match.fields.PbbBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.vlan.match.fields.VlanIdBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Ipv6ExthdrFlags;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.ArpOp;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.ArpSha;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.ArpSpa;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.ArpTha;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.ArpTpa;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.EthDst;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.EthSrc;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.EthType;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Icmpv4Code;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Icmpv4Type;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Icmpv6Code;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Icmpv6Type;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.InPhyPort;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.InPort;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.IpDscp;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.IpEcn;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.IpProto;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv4Dst;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv4Src;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6Dst;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6Exthdr;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6Flabel;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6NdSll;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6NdTarget;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6NdTll;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Ipv6Src;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.Metadata;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MplsBos;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MplsLabel;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MplsTc;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.PbbIsid;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.SctpDst;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.SctpSrc;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.TcpDst;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.TcpSrc;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.TunnelId;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.UdpDst;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.UdpSrc;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.VlanPcp;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.VlanVid;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ArpOpCase;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ArpShaCase;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ArpSpaCase;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ArpThaCase;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ArpTpaCase;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.EthDstCase;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.EthSrcCase;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.EthTypeCase;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Icmpv4CodeCase;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Icmpv4TypeCase;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Icmpv6CodeCase;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Icmpv6TypeCase;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.InPhyPortCase;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.InPortCase;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.IpDscpCase;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.IpEcnCase;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.IpProtoCase;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv4DstCase;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv4SrcCase;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6DstCase;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6ExthdrCase;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6FlabelCase;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6NdSllCase;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6NdTargetCase;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6NdTllCase;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv6SrcCase;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.MetadataCase;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.MplsBosCase;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.MplsLabelCase;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.MplsTcCase;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.PbbIsidCase;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.SctpDstCase;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.SctpSrcCase;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.TcpDstCase;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.TcpSrcCase;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.TunnelIdCase;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.UdpDstCase;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.UdpSrcCase;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.VlanPcpCase;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.VlanVidCase;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TunnelIpv4Dst;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TunnelIpv4Src;
155 import org.opendaylight.yangtools.yang.binding.DataObject;
156 import org.slf4j.Logger;
157 import org.slf4j.LoggerFactory;
158
159 public class FlowRemovedTranslator implements IMDMessageTranslator<OfHeader, List<DataObject>> {
160
161     private static final Logger LOG = LoggerFactory.getLogger(FlowRemovedTranslator.class);
162     private static final String PREFIX_SEPARATOR = "/";
163     private final ConvertorExecutor convertorExecutor;
164
165     public FlowRemovedTranslator(ConvertorExecutor convertorExecutor) {
166         this.convertorExecutor = convertorExecutor;
167     }
168
169     @Override
170     public List<DataObject> translate(final SwitchConnectionDistinguisher cookie, final SessionContext sc, final OfHeader msg) {
171         if (msg instanceof FlowRemovedMessage) {
172             FlowRemovedMessage ofFlow = (FlowRemovedMessage) msg;
173             List<DataObject> list = new CopyOnWriteArrayList<DataObject>();
174             LOG.debug("Flow Removed Message received: Table Id={}, Flow removed reason={} ", ofFlow.getTableId(),
175                     ofFlow.getReason());
176
177             SwitchFlowRemovedBuilder salFlowRemoved = new SwitchFlowRemovedBuilder();
178
179             if (ofFlow.getCookie() != null) {
180                 salFlowRemoved.setCookie(new FlowCookie(ofFlow.getCookie()));
181             }
182             salFlowRemoved.setPriority(ofFlow.getPriority());
183
184             if (ofFlow.getTableId() != null) {
185                 salFlowRemoved.setTableId(ofFlow.getTableId().getValue().shortValue());
186             }
187
188             salFlowRemoved.setDurationSec(ofFlow.getDurationSec());
189             salFlowRemoved.setDurationNsec(ofFlow.getDurationNsec());
190             salFlowRemoved.setIdleTimeout(ofFlow.getIdleTimeout());
191             salFlowRemoved.setHardTimeout(ofFlow.getHardTimeout());
192             salFlowRemoved.setPacketCount(ofFlow.getPacketCount());
193             salFlowRemoved.setByteCount(ofFlow.getByteCount());
194
195             if(Objects.nonNull(ofFlow.getReason())) {
196                 salFlowRemoved.setRemovedReason(translateReason(ofFlow));
197             }
198
199             OpenflowVersion ofVersion = OpenflowVersion.get(sc.getPrimaryConductor().getVersion());
200             org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.Match ofMatch = ofFlow
201                     .getMatch();
202             if (ofMatch != null) {
203                 salFlowRemoved.setMatch(fromMatch(ofMatch, sc.getFeatures().getDatapathId(), ofVersion));
204             } else if (ofFlow.getMatchV10() != null) {
205                 final VersionDatapathIdConvertorData data = new VersionDatapathIdConvertorData(sc.getPrimaryConductor().getVersion());
206                 data.setDatapathId(sc.getFeatures().getDatapathId());
207
208                 final Optional<MatchBuilder> matchBuilderOptional = convertorExecutor.convert(ofFlow.getMatchV10(), data);
209                 salFlowRemoved.setMatch(matchBuilderOptional.orElse(new MatchBuilder()).build());
210             }
211             salFlowRemoved.setNode(new NodeRef(InventoryDataServiceUtil.identifierFromDatapathId(sc.getFeatures()
212                     .getDatapathId())));
213             list.add(salFlowRemoved.build());
214             return list;
215         } else {
216             LOG.error("Message is not a flow removed message ");
217             return Collections.emptyList();
218         }
219     }
220     private RemovedFlowReason translateReason(FlowRemoved removedFlow) {
221         LOG.debug("--Entering translateReason within FlowRemovedTranslator with reason:{} " + removedFlow.getReason());
222         switch (removedFlow.getReason()) {
223             case OFPRRIDLETIMEOUT:
224                 return RemovedFlowReason.OFPRRIDLETIMEOUT;
225             case OFPRRHARDTIMEOUT:
226                 return RemovedFlowReason.OFPRRHARDTIMEOUT;
227             case OFPRRDELETE:
228                 return RemovedFlowReason.OFPRRDELETE;
229             case OFPRRGROUPDELETE:
230                 return RemovedFlowReason.OFPRRGROUPDELETE;
231             default:
232                 LOG.debug("The flow being default and hence deleting it ");
233                 return RemovedFlowReason.OFPRRDELETE;
234         }
235     }
236
237     public Match fromMatch(final org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.Match ofMatch,
238                            final BigInteger datapathid, final OpenflowVersion ofVersion) {
239         MatchBuilder matchBuilder = new MatchBuilder();
240         EthernetMatchBuilder ethernetMatch = null;
241         VlanMatchBuilder vlanMatch = null;
242         IpMatchBuilder ipMatch = null;
243         TcpMatchBuilder tcpMatch = null;
244         UdpMatchBuilder udpMatch = null;
245         SctpMatchBuilder sctpMatch = null;
246         Icmpv4MatchBuilder icmpv4Match = null;
247         Icmpv6MatchBuilder icmpv6Match = null;
248         Ipv4MatchBuilder ipv4Match = null;
249         ArpMatchBuilder arpMatch = null;
250         Ipv6MatchBuilder ipv6Match = null;
251         ProtocolMatchFieldsBuilder protocolMatchFields = null;
252
253         for (MatchEntry entry : ofMatch.getMatchEntry()) {
254             Class<? extends MatchField> field = entry.getOxmMatchField();
255             if (field.equals(InPort.class)) {
256                 matchBuilder.setInPort(InventoryDataServiceUtil.nodeConnectorIdfromDatapathPortNo(datapathid,
257                         ((InPortCase) entry.getMatchEntryValue()).getInPort().getPortNumber().getValue(), ofVersion));
258             } else if (field.equals(InPhyPort.class)) {
259                 matchBuilder.setInPhyPort(InventoryDataServiceUtil.nodeConnectorIdfromDatapathPortNo(datapathid,
260                         ((InPhyPortCase) entry.getMatchEntryValue()).getInPhyPort().getPortNumber().getValue(), ofVersion));
261             } else if (field.equals(Metadata.class)) {
262                 MetadataBuilder metadata = new MetadataBuilder();
263                 MetadataCase metadataCase = ((MetadataCase) entry.getMatchEntryValue());
264                 metadata.setMetadata(new BigInteger(OFConstants.SIGNUM_UNSIGNED, metadataCase.getMetadata().getMetadata()));
265                 if (entry.isHasMask()) {
266                     metadata.setMetadataMask(new BigInteger(OFConstants.SIGNUM_UNSIGNED, metadataCase.getMetadata().getMask()));
267                 }
268                 matchBuilder.setMetadata(metadata.build());
269             } else if (field.equals(EthDst.class) || field.equals(EthSrc.class) || field.equals(EthType.class)) {
270                 if (ethernetMatch == null) {
271                     ethernetMatch = new EthernetMatchBuilder();
272                 }
273                 if (field.equals(EthDst.class)) {
274                     EthernetDestinationBuilder ethDst = new EthernetDestinationBuilder();
275                     EthDstCase ethDstCase = (EthDstCase) entry.getMatchEntryValue();
276                     ethDst.setAddress(ethDstCase.getEthDst().getMacAddress());
277                     if (entry.isHasMask()) {
278                         ethDst.setMask(new MacAddress(ByteUtil.bytesToHexstring(ethDstCase.getEthDst().getMask(), ":")));
279                     }
280                     ethernetMatch.setEthernetDestination(ethDst.build());
281                 } else if (field.equals(EthSrc.class)) {
282                     EthernetSourceBuilder ethSrc = new EthernetSourceBuilder();
283                     EthSrcCase ethSrcCase = ((EthSrcCase) entry.getMatchEntryValue());
284                     ethSrc.setAddress(ethSrcCase.getEthSrc().getMacAddress());
285                     if (entry.isHasMask()) {
286                         ethSrc.setMask(new MacAddress(ByteUtil.bytesToHexstring(ethSrcCase.getEthSrc().getMask(), ":")));
287                     }
288                     ethernetMatch.setEthernetSource(ethSrc.build());
289                 } else if (field.equals(EthType.class)) {
290                     EthernetTypeBuilder ethType = new EthernetTypeBuilder();
291                     EthTypeCase ethTypeCase = ((EthTypeCase) entry.getMatchEntryValue());
292                     ethType.setType(new EtherType(ethTypeCase.getEthType().getEthType().getValue().longValue()));
293                     ethernetMatch.setEthernetType(ethType.build());
294                 }
295             } else if (field.equals(VlanVid.class) || field.equals(VlanPcp.class)) {
296                 if (vlanMatch == null) {
297                     vlanMatch = new VlanMatchBuilder();
298                 }
299                 if (field.equals(VlanVid.class)) {
300                     boolean vlanIdPresent = false;
301                     VlanIdBuilder vlanId = new VlanIdBuilder();
302                     VlanVidCase vlanVidCase = ((VlanVidCase) entry.getMatchEntryValue());
303                     Integer vlanVidValue = vlanVidCase.getVlanVid().getVlanVid();
304                     if (vlanVidCase.getVlanVid().isCfiBit()) {
305                         vlanIdPresent = true;
306                     }
307                     vlanId.setVlanIdPresent(vlanIdPresent);
308                     if (vlanVidValue != null) {
309                         vlanId.setVlanId(new VlanId(vlanVidValue));
310                     }
311                     vlanMatch.setVlanId(vlanId.build());
312                 } else if (field.equals(VlanPcp.class)) {
313                     VlanPcpCase vlanPcpCase = ((VlanPcpCase) entry.getMatchEntryValue());
314                     vlanMatch.setVlanPcp(new org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp(vlanPcpCase.getVlanPcp().getVlanPcp()));
315                 }
316             } else if (field.equals(IpDscp.class) || field.equals(IpEcn.class) || field.equals(IpProto.class)) {
317                 if (ipMatch == null) {
318                     ipMatch = new IpMatchBuilder();
319                 }
320                 if (field.equals(IpDscp.class)) {
321                     IpDscpCase ipDscpCase = ((IpDscpCase) entry.getMatchEntryValue());
322                     ipMatch.setIpDscp(new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp(
323                             ipDscpCase.getIpDscp().getDscp()));
324                 } else if (field.equals(IpEcn.class)) {
325                     IpEcnCase ipEcnCase = ((IpEcnCase) entry.getMatchEntryValue());
326                     ipMatch.setIpEcn(ipEcnCase.getIpEcn().getEcn());
327                 } else if (field.equals(IpProto.class)) {
328                     IpProtoCase ipProtoCase = ((IpProtoCase) entry.getMatchEntryValue());
329                     ipMatch.setIpProtocol(ipProtoCase.getIpProto().getProtocolNumber());
330                 }
331             } else if (field.equals(TcpSrc.class) || field.equals(TcpDst.class)) {
332                 if (tcpMatch == null) {
333                     tcpMatch = new TcpMatchBuilder();
334                 }
335                 if (field.equals(TcpSrc.class)) {
336                     TcpSrcCase tcpSrcCase = ((TcpSrcCase) entry.getMatchEntryValue());
337                     tcpMatch.setTcpSourcePort(new PortNumber(tcpSrcCase.getTcpSrc().getPort().getValue()));
338                 } else if (field.equals(TcpDst.class)) {
339                     TcpDstCase tcpDstCase = ((TcpDstCase) entry.getMatchEntryValue());
340                     tcpMatch.setTcpDestinationPort(new PortNumber(tcpDstCase.getTcpDst().getPort().getValue()));
341                 }
342             } else if (field.equals(UdpSrc.class) || field.equals(UdpDst.class)) {
343                 if (udpMatch == null) {
344                     udpMatch = new UdpMatchBuilder();
345                 }
346                 if (field.equals(UdpSrc.class)) {
347                     UdpSrcCase udpSrcCase = ((UdpSrcCase) entry.getMatchEntryValue());
348                     udpMatch.setUdpSourcePort(new PortNumber(udpSrcCase.getUdpSrc().getPort().getValue()));
349                 } else if (field.equals(UdpDst.class)) {
350                     UdpDstCase udpDstCase = ((UdpDstCase) entry.getMatchEntryValue());
351                     udpMatch.setUdpDestinationPort(new PortNumber(udpDstCase.getUdpDst().getPort()));
352                 }
353             } else if (field.equals(SctpSrc.class) || field.equals(SctpDst.class)) {
354                 if (sctpMatch == null) {
355                     sctpMatch = new SctpMatchBuilder();
356                 }
357                 if (field.equals(SctpSrc.class)) {
358                     SctpSrcCase sctpSrcCase = ((SctpSrcCase) entry.getMatchEntryValue());
359                     sctpMatch.setSctpSourcePort(new PortNumber(sctpSrcCase.getSctpSrc().getPort()));
360                 } else if (field.equals(SctpDst.class)) {
361                     SctpDstCase sctpDstCase = ((SctpDstCase) entry.getMatchEntryValue());
362                     sctpMatch.setSctpDestinationPort(new PortNumber(sctpDstCase.getSctpDst().getPort()));
363                 }
364             } else if (field.equals(Icmpv4Type.class) || field.equals(Icmpv4Code.class)) {
365                 if (icmpv4Match == null) {
366                     icmpv4Match = new Icmpv4MatchBuilder();
367                 }
368                 if (field.equals(Icmpv4Type.class)) {
369                     Icmpv4TypeCase icmpv4TypeCase = ((Icmpv4TypeCase) entry.getMatchEntryValue());
370                     icmpv4Match.setIcmpv4Type(icmpv4TypeCase.getIcmpv4Type().getIcmpv4Type());
371                 } else if (field.equals(Icmpv4Code.class)) {
372                     Icmpv4CodeCase icmpv4CodeCase = ((Icmpv4CodeCase) entry.getMatchEntryValue());
373                     icmpv4Match.setIcmpv4Code(icmpv4CodeCase.getIcmpv4Code().getIcmpv4Code());
374                 }
375             } else if (field.equals(Icmpv6Type.class) || field.equals(Icmpv6Code.class)) {
376                 if (icmpv6Match == null) {
377                     icmpv6Match = new Icmpv6MatchBuilder();
378                 }
379                 if (field.equals(Icmpv6Type.class)) {
380                     Icmpv6TypeCase icmpv6TypeCase = ((Icmpv6TypeCase) entry.getMatchEntryValue());
381                     icmpv6Match.setIcmpv6Type(icmpv6TypeCase.getIcmpv6Type().getIcmpv6Type());
382                 } else if (field.equals(Icmpv6Code.class)) {
383                     Icmpv6CodeCase icmpv6CodeCase = ((Icmpv6CodeCase) entry.getMatchEntryValue());
384                     icmpv6Match.setIcmpv6Code(icmpv6CodeCase.getIcmpv6Code().getIcmpv6Code());
385                 }
386             } else if (field.equals(Ipv4Src.class) || field.equals(Ipv4Dst.class)) {
387                 if (ipv4Match == null) {
388                     ipv4Match = new Ipv4MatchBuilder();
389                 }
390                 if (field.equals(Ipv4Src.class)) {
391                     Ipv4SrcCase ipv4SrcCase = ((Ipv4SrcCase) entry.getMatchEntryValue());
392                     int prefix;
393                     if (entry.isHasMask()) {
394                         prefix = IpConversionUtil.countBits(ipv4SrcCase.getIpv4Src().getMask());
395                     } else {
396                         prefix = 32;
397                     }
398                     ipv4Match.setIpv4Source(
399                         IpConversionUtil.createPrefix(ipv4SrcCase.getIpv4Src().getIpv4Address(), prefix)
400                     );
401
402                 } else if (field.equals(Ipv4Dst.class)) {
403                     Ipv4DstCase ipv4DstCase = ((Ipv4DstCase) entry.getMatchEntryValue());
404                     int prefix;
405                     if (entry.isHasMask()) {
406                         prefix = IpConversionUtil.countBits(ipv4DstCase.getIpv4Dst().getMask());
407                     } else {
408                         prefix = 32;
409                     }
410                     ipv4Match.setIpv4Destination(
411                         IpConversionUtil.createPrefix(ipv4DstCase.getIpv4Dst().getIpv4Address(), prefix)
412                     );
413                 }
414             } else if (field.equals(ArpOp.class) || field.equals(ArpSpa.class) || field.equals(ArpTpa.class)
415                     || field.equals(ArpSha.class) || field.equals(ArpTha.class)) {
416                 if (arpMatch == null) {
417                     arpMatch = new ArpMatchBuilder();
418                 }
419                 if (field.equals(ArpOp.class)) {
420                     ArpOpCase arpOpCase = ((ArpOpCase) entry.getMatchEntryValue());
421                     arpMatch.setArpOp(arpOpCase.getArpOp().getOpCode());
422                 } else if (field.equals(ArpSpa.class)) {
423
424                     ArpSpaCase arpSpaCase = ((ArpSpaCase) entry.getMatchEntryValue());
425                     int prefix;
426                     if (entry.isHasMask()) {
427                         prefix = IpConversionUtil.countBits(arpSpaCase.getArpSpa().getMask());
428                     } else {
429                         prefix = 32;
430                     }
431                     arpMatch.setArpSourceTransportAddress(
432                         IpConversionUtil.createPrefix(arpSpaCase.getArpSpa().getIpv4Address(), prefix)
433                     );
434                 } else if (field.equals(ArpTpa.class)) {
435                     ArpTpaCase arpTpaCase = ((ArpTpaCase) entry.getMatchEntryValue());
436                     int prefix;
437                     if (entry.isHasMask()) {
438                         prefix = IpConversionUtil.countBits(arpTpaCase.getArpTpa().getMask());
439                     } else {
440                         prefix = 32;
441                     }
442
443                     arpMatch.setArpTargetTransportAddress(
444                         IpConversionUtil.createPrefix(arpTpaCase.getArpTpa().getIpv4Address(), prefix)
445                     );
446                 } else if (field.equals(ArpSha.class)) {
447                     ArpSourceHardwareAddressBuilder arpSha = new ArpSourceHardwareAddressBuilder();
448                     ArpShaCase arpShaCase = ((ArpShaCase) entry.getMatchEntryValue());
449                     arpSha.setAddress(arpShaCase.getArpSha().getMacAddress());
450                     if (entry.isHasMask()) {
451                         arpSha.setMask(new MacAddress(ByteUtil.bytesToHexstring(arpShaCase.getArpSha().getMask(), ":")));
452                     }
453                     arpMatch.setArpSourceHardwareAddress(arpSha.build());
454                 } else if (field.equals(ArpTha.class)) {
455                     ArpThaCase arpThaCase = ((ArpThaCase) entry.getMatchEntryValue());
456                     ArpTargetHardwareAddressBuilder arpTha = new ArpTargetHardwareAddressBuilder();
457                     arpTha.setAddress(arpThaCase.getArpTha().getMacAddress());
458                     if (entry.isHasMask()) {
459                         arpTha.setMask(new MacAddress(ByteUtil.bytesToHexstring(arpThaCase.getArpTha().getMask(), ":")));
460                     }
461                     arpMatch.setArpTargetHardwareAddress(arpTha.build());
462                 }
463             } else if (field.equals(TunnelIpv4Src.class) || field.equals(TunnelIpv4Dst.class)) {
464                 if (ipv4Match == null) {
465                     ipv4Match = new Ipv4MatchBuilder();
466                 }
467                 if (field.equals(TunnelIpv4Src.class)) {
468                     Ipv4SrcCase ipv4SrcCase = ((Ipv4SrcCase) entry.getMatchEntryValue());
469                     int prefix;
470                     if (entry.isHasMask()) {
471                         prefix = IpConversionUtil.countBits(ipv4SrcCase.getIpv4Src().getMask());
472                     } else {
473                         prefix = 32;
474                     }
475
476                     ipv4Match.setIpv4Source(
477                         IpConversionUtil.createPrefix(ipv4SrcCase.getIpv4Src().getIpv4Address(), prefix)
478                     );
479                 } else if (field.equals(TunnelIpv4Dst.class)) {
480                     Ipv4DstCase ipv4DstCase = ((Ipv4DstCase) entry.getMatchEntryValue());
481                     int prefix;
482                     if (entry.isHasMask()) {
483                         prefix = IpConversionUtil.countBits(ipv4DstCase.getIpv4Dst().getMask());
484                     } else {
485                         prefix = 32;
486                     }
487
488                     ipv4Match.setIpv4Destination(
489                         IpConversionUtil.createPrefix(ipv4DstCase.getIpv4Dst().getIpv4Address(), prefix)
490                     );               }
491             } else if (field.equals(Ipv6Src.class) || field.equals(Ipv6Dst.class) || field.equals(Ipv6Flabel.class)
492                     || field.equals(Ipv6NdTarget.class) || field.equals(Ipv6NdSll.class)
493                     || field.equals(Ipv6NdTll.class) || field.equals(Ipv6Exthdr.class)) {
494                 if (ipv6Match == null) {
495                     ipv6Match = new Ipv6MatchBuilder();
496                 }
497                 if (field.equals(Ipv6Src.class)) {
498                     Ipv6SrcCase ipv6SrcCase = ((Ipv6SrcCase) entry.getMatchEntryValue());
499                     int prefix ;
500                     if (entry.isHasMask()) {
501                         prefix = IpConversionUtil.countBits(ipv6SrcCase.getIpv6Src().getMask());
502                     } else {
503                         prefix = 128;
504                     }
505                     ipv6Match.setIpv6Source(
506                         IpConversionUtil.createPrefix(ipv6SrcCase.getIpv6Src().getIpv6Address(), prefix)
507                     );
508                 } else if (field.equals(Ipv6Dst.class)) {
509                     Ipv6DstCase ipv6DstCase = ((Ipv6DstCase) entry.getMatchEntryValue());
510                     int prefix;
511                     if (entry.isHasMask()) {
512                         prefix = IpConversionUtil.countBits(ipv6DstCase.getIpv6Dst().getMask());
513                     } else {
514                         prefix = 128;
515                     }
516                     ipv6Match.setIpv6Destination(
517                         IpConversionUtil.createPrefix(ipv6DstCase.getIpv6Dst().getIpv6Address(), prefix)
518                     );
519                 } else if (field.equals(Ipv6Flabel.class)) {
520                     Ipv6LabelBuilder ipv6Label = new Ipv6LabelBuilder();
521                     Ipv6FlabelCase ipv6FlabelCase = ((Ipv6FlabelCase) entry.getMatchEntryValue());
522                     ipv6Label.setIpv6Flabel(ipv6FlabelCase.getIpv6Flabel().getIpv6Flabel());
523                     if (entry.isHasMask()) {
524                         ipv6Label.setFlabelMask(new Ipv6FlowLabel(ByteUtil.bytesToUnsignedInt(ipv6FlabelCase.getIpv6Flabel().getMask())));
525                     }
526                     ipv6Match.setIpv6Label(ipv6Label.build());
527                 } else if (field.equals(Ipv6NdTarget.class)) {
528                     Ipv6NdTargetCase ipv6NdTargetCase = ((Ipv6NdTargetCase) entry.getMatchEntryValue());
529                     ipv6Match.setIpv6NdTarget(ipv6NdTargetCase.getIpv6NdTarget().getIpv6Address());
530                 } else if (field.equals(Ipv6NdSll.class)) {
531                     Ipv6NdSllCase ipv6NdSllCase = ((Ipv6NdSllCase) entry.getMatchEntryValue());
532                     ipv6Match.setIpv6NdSll(ipv6NdSllCase.getIpv6NdSll().getMacAddress());
533                 } else if (field.equals(Ipv6NdTll.class)) {
534                     Ipv6NdTllCase ipv6NdTllCase = ((Ipv6NdTllCase) entry.getMatchEntryValue());
535                     ipv6Match.setIpv6NdTll(ipv6NdTllCase.getIpv6NdTll().getMacAddress());
536                 } else if (field.equals(Ipv6Exthdr.class)) {
537                     Ipv6ExthdrCase ipv6ExthdrCase = ((Ipv6ExthdrCase) entry.getMatchEntryValue());
538                     // verify
539                     Ipv6ExtHeaderBuilder ipv6ExtHeaderBuilder = new Ipv6ExtHeaderBuilder();
540                     Ipv6ExthdrFlags pseudoField = ipv6ExthdrCase.getIpv6Exthdr().getPseudoField();
541                     Map<Integer, Boolean> map = new HashMap<>();
542                     map.put(0, pseudoField.isNonext());
543                     map.put(1, pseudoField.isEsp());
544                     map.put(2, pseudoField.isAuth());
545                     map.put(3, pseudoField.isDest());
546                     map.put(4, pseudoField.isFrag());
547                     map.put(5, pseudoField.isRouter());
548                     map.put(6, pseudoField.isHop());
549                     map.put(7, pseudoField.isUnrep());
550                     map.put(8, pseudoField.isUnseq());
551                     int bitmap = ByteBufUtils.fillBitMaskFromMap(map);
552                     ipv6ExtHeaderBuilder.setIpv6Exthdr(bitmap);
553                     if (entry.isHasMask()) {
554                         ipv6ExtHeaderBuilder.setIpv6ExthdrMask(
555                                 ByteUtil.bytesToUnsignedShort(ipv6ExthdrCase.getIpv6Exthdr().getMask()));
556                     }
557                     ipv6Match.setIpv6ExtHeader(ipv6ExtHeaderBuilder.build());
558                 }
559             } else if (field.equals(MplsLabel.class) || field.equals(MplsTc.class) || field.equals(MplsBos.class)
560                     || field.equals(PbbIsid.class)) {
561                 if (protocolMatchFields == null) {
562                     protocolMatchFields = new ProtocolMatchFieldsBuilder();
563                 }
564                 if (field.equals(MplsLabel.class)) {
565                     MplsLabelCase mplsLabelCase = ((MplsLabelCase) entry.getMatchEntryValue());
566                     protocolMatchFields.setMplsLabel(mplsLabelCase.getMplsLabel().getMplsLabel());
567                 } else if (field.equals(MplsTc.class)) {
568                     MplsTcCase mplsTcCase = ((MplsTcCase) entry.getMatchEntryValue());
569                     protocolMatchFields.setMplsTc(mplsTcCase.getMplsTc().getTc());
570                 } else if (field.equals(MplsBos.class)) {
571                     MplsBosCase mplsBosCase = ((MplsBosCase) entry.getMatchEntryValue());
572                     protocolMatchFields
573                             .setMplsBos((short) (mplsBosCase.getMplsBos().isBos() ? 1 : 0));
574                 } else if (field.equals(PbbIsid.class)) {
575                     PbbIsidCase pbbIsidCase = ((PbbIsidCase) entry.getMatchEntryValue());
576                     PbbBuilder pbb = new PbbBuilder();
577                     pbb.setPbbIsid(pbbIsidCase.getPbbIsid().getIsid());
578                     if (entry.isHasMask()) {
579                         pbb.setPbbMask(ByteUtil.bytesToUnsignedInt(pbbIsidCase.getPbbIsid().getMask()));
580                     }
581                     protocolMatchFields.setPbb(pbb.build());
582                 }
583             } else if (field.equals(TunnelId.class)) {
584                 TunnelIdCase tunnelIdCase = ((TunnelIdCase) entry.getMatchEntryValue());
585                 TunnelBuilder tunnel = new TunnelBuilder();
586                 tunnel.setTunnelId(new BigInteger(OFConstants.SIGNUM_UNSIGNED, tunnelIdCase.getTunnelId().getTunnelId()));
587                 if (entry.isHasMask()) {
588                     tunnel.setTunnelMask(new BigInteger(OFConstants.SIGNUM_UNSIGNED, tunnelIdCase.getTunnelId().getMask()));
589                 }
590                 matchBuilder.setTunnel(tunnel.build());
591             }
592         }
593
594         AugmentTuple<Match> matchExtensionWrap =
595                 MatchExtensionHelper.processAllExtensions(
596                         ofMatch.getMatchEntry(), ofVersion, MatchPath.SWITCHFLOWREMOVED_MATCH);
597         if (matchExtensionWrap != null) {
598             matchBuilder.addAugmentation(matchExtensionWrap.getAugmentationClass(), matchExtensionWrap.getAugmentationObject());
599         }
600
601
602         if (ethernetMatch != null) {
603             matchBuilder.setEthernetMatch(ethernetMatch.build());
604         }
605         if (vlanMatch != null) {
606             matchBuilder.setVlanMatch(vlanMatch.build());
607         }
608         if (ipMatch != null) {
609             matchBuilder.setIpMatch(ipMatch.build());
610         }
611
612         if (tcpMatch != null) {
613             matchBuilder.setLayer4Match(tcpMatch.build());
614         } else if (udpMatch != null) {
615             matchBuilder.setLayer4Match(udpMatch.build());
616         } else if (sctpMatch != null) {
617             matchBuilder.setLayer4Match(sctpMatch.build());
618         }
619
620         if (icmpv4Match != null) {
621             matchBuilder.setIcmpv4Match(icmpv4Match.build());
622         } else if (icmpv6Match != null) {
623             matchBuilder.setIcmpv6Match(icmpv6Match.build());
624         }
625
626         if (ipv4Match != null) {
627             matchBuilder.setLayer3Match(ipv4Match.build());
628         } else if (arpMatch != null) {
629             matchBuilder.setLayer3Match(arpMatch.build());
630         } else if (ipv6Match != null) {
631             matchBuilder.setLayer3Match(ipv6Match.build());
632         }
633         if (protocolMatchFields != null) {
634             matchBuilder.setProtocolMatchFields(protocolMatchFields.build());
635         }
636         return matchBuilder.build();
637     }
638
639 }