2 * Copyright (c) 2016 Cisco Systems, Inc. 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.openflowplugin.openflow.md.core.sal.convertor.match.cases;
11 import java.util.Optional;
12 import javax.annotation.Nonnull;
13 import org.opendaylight.openflowplugin.api.OFConstants;
14 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.ConvertorCase;
15 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.IpConversionUtil;
16 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.data.MatchResponseConvertorData;
17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchArbitraryBitMaskBuilder;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Ipv4SrcCase;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv4.src._case.Ipv4Src;
26 public class OfToSalIpv4SrcCase extends ConvertorCase<Ipv4SrcCase, MatchBuilder, MatchResponseConvertorData> {
27 public OfToSalIpv4SrcCase() {
28 super(Ipv4SrcCase.class, true, OFConstants.OFP_VERSION_1_0, OFConstants.OFP_VERSION_1_3);
31 private static void setIpv4MatchBuilderFields(final Ipv4MatchBuilder ipv4MatchBuilder, final byte[] mask, final String ipv4PrefixStr) {
32 final Ipv4Prefix ipv4Prefix;
34 ipv4Prefix = IpConversionUtil.createPrefix(new Ipv4Address(ipv4PrefixStr), mask);
36 //Openflow Spec : 1.3.2
37 //An all-one-bits oxm_mask is equivalent to specifying 0 for oxm_hasmask and omitting oxm_mask.
38 // So when user specify 32 as a mast, switch omit that mast and we get null as a mask in flow
39 // statistics response.
40 ipv4Prefix = IpConversionUtil.createPrefix(new Ipv4Address(ipv4PrefixStr));
43 ipv4MatchBuilder.setIpv4Source(ipv4Prefix);
46 private static void setSrcIpv4MatchArbitraryBitMaskBuilderFields(
47 final Ipv4MatchArbitraryBitMaskBuilder ipv4MatchArbitraryBitMaskBuilder,
48 final DottedQuad mask, final String ipv4AddressStr) {
50 ipv4MatchArbitraryBitMaskBuilder.setIpv4SourceArbitraryBitmask(mask);
53 ipv4MatchArbitraryBitMaskBuilder.setIpv4SourceAddressNoMask(new Ipv4Address(ipv4AddressStr));
56 private static void setDstIpv4MatchArbitraryBitMaskBuilderFields(
57 final Ipv4MatchArbitraryBitMaskBuilder ipv4MatchArbitraryBitMaskBuilder,
58 final DottedQuad mask, final String ipv4AddressStr) {
60 ipv4MatchArbitraryBitMaskBuilder.setIpv4DestinationArbitraryBitmask(mask);
63 ipv4MatchArbitraryBitMaskBuilder.setIpv4DestinationAddressNoMask(new Ipv4Address(ipv4AddressStr));
67 public Optional<MatchBuilder> process(@Nonnull Ipv4SrcCase source, MatchResponseConvertorData data) {
68 final MatchBuilder matchBuilder = data.getMatchBuilder();
69 final Ipv4MatchBuilder ipv4MatchBuilder = data.getIpv4MatchBuilder();
70 final Ipv4MatchArbitraryBitMaskBuilder ipv4MatchArbitraryBitMaskBuilder = data.getIpv4MatchArbitraryBitMaskBuilder();
72 Ipv4Src ipv4Address = source.getIpv4Src();
74 if (ipv4Address != null) {
75 byte[] mask = ipv4Address.getMask();
77 if (mask != null && IpConversionUtil.isArbitraryBitMask(mask)) {
78 // case where ipv4dst is of type ipv4MatchBuilder and ipv4src is of type ipv4MatchArbitrary.
79 // Needs to convert ipv4dst to ipv4MatchArbitrary.
80 if (ipv4MatchBuilder.getIpv4Destination() != null) {
81 Ipv4Prefix ipv4PrefixDestinationAddress = ipv4MatchBuilder.getIpv4Destination();
82 Ipv4Address ipv4DstAddress = IpConversionUtil.extractIpv4Address(ipv4PrefixDestinationAddress);
83 DottedQuad dstDottedQuadMask = IpConversionUtil.extractIpv4AddressMask(ipv4PrefixDestinationAddress);
85 setDstIpv4MatchArbitraryBitMaskBuilderFields(
86 ipv4MatchArbitraryBitMaskBuilder,
87 dstDottedQuadMask, ipv4DstAddress.getValue());
90 DottedQuad srcDottedQuadMask = IpConversionUtil.createArbitraryBitMask(mask);
91 String stringIpv4SrcAddress = ipv4Address.getIpv4Address().getValue();
92 setSrcIpv4MatchArbitraryBitMaskBuilderFields(
93 ipv4MatchArbitraryBitMaskBuilder,
94 srcDottedQuadMask, stringIpv4SrcAddress);
95 matchBuilder.setLayer3Match(ipv4MatchArbitraryBitMaskBuilder.build());
96 } else if (ipv4MatchArbitraryBitMaskBuilder.getIpv4DestinationAddressNoMask() != null) {
98 Case where destination is of type ipv4MatchArbitraryBitMask already exists in Layer3Match,
99 source which of type ipv4Match needs to be converted to ipv4MatchArbitraryBitMask.
100 We convert 36.36.36.0/24 to 36.36.0/255.255.255.0
101 expected output example:-
102 <ipv4-destination>36.36.36.0/24</ipv4-destination>
103 <ipv4-source-address-no-mask>36.36.36.0</ipv4-source-address-no-mask>
104 <ipv4-source-arbitrary-bitmask>255.0.255.0</ipv4-source-arbitrary-bitmask>
105 after conversion output example:-
106 <ipv4-destination-address-no-mask>36.36.36.0</ipv4-destination-address-no-mask>
107 <ipv4-destination-arbitrary-bitmask>255.255.255.0</ipv4-destination-arbitrary-bitmask>
108 <ipv4-source-address-no-mask>36.36.36.0</ipv4-source-address-no-mask>
109 <ipv4-source-arbitrary-bitmask>255.0.255.0</ipv4-source-arbitrary-bitmask>
111 DottedQuad srcDottedQuadMask = IpConversionUtil.createArbitraryBitMask(mask);
112 String stringIpv4SrcAddress = ipv4Address.getIpv4Address().getValue();
113 setSrcIpv4MatchArbitraryBitMaskBuilderFields(
114 ipv4MatchArbitraryBitMaskBuilder,
115 srcDottedQuadMask, stringIpv4SrcAddress);
116 matchBuilder.setLayer3Match(ipv4MatchArbitraryBitMaskBuilder.build());
118 String stringIpv4SrcAddress = ipv4Address.getIpv4Address().getValue();
119 setIpv4MatchBuilderFields(ipv4MatchBuilder, mask, stringIpv4SrcAddress);
120 matchBuilder.setLayer3Match(ipv4MatchBuilder.build());
124 return Optional.of(matchBuilder);