2 * Copyright (c) 2015 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
8 package org.opendaylight.openflowplugin.applications.statistics.manager.impl.helper;
10 import com.google.common.net.InetAddresses;
11 import java.math.BigInteger;
12 import java.net.Inet4Address;
13 import java.net.InetAddress;
14 import java.net.UnknownHostException;
15 import java.util.ArrayList;
16 import java.util.Arrays;
17 import org.slf4j.Logger;
18 import org.slf4j.LoggerFactory;
19 import com.google.common.annotations.VisibleForTesting;
20 import com.google.common.primitives.UnsignedBytes;
21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Prefix;
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.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.MacAddressFilter;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatch;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer3Match;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4Match;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6Match;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchArbitraryBitMask;
35 * @author sai.marapareddy@gmail.com
38 public class MatchComparatorHelper {
40 private static final Logger LOG = LoggerFactory.getLogger(MatchComparatorHelper.class);
41 private static final int DEFAULT_SUBNET = 32;
42 private static final int IPV4_MASK_LENGTH = 32;
43 private static final int SHIFT_OCTET_1 = 24;
44 private static final int SHIFT_OCTET_2 = 16;
45 private static final int SHIFT_OCTET_3 = 8;
46 private static final int SHIFT_OCTET_4 = 0;
47 private static final int POSITION_OCTET_1 = 0;
48 private static final int POSITION_OCTET_2 = 1;
49 private static final int POSITION_OCTET_3 = 2;
50 private static final int POSITION_OCTET_4 = 3;
51 private static final String DEFAULT_ARBITRARY_BIT_MASK = "255.255.255.255";
52 private static final String PREFIX_SEPARATOR = "/";
53 private static final int IPV4_ADDRESS_LENGTH = 32;
56 * Custom EthernetMatch is required because mac address string provided by user in EthernetMatch can be in any case
57 * (upper or lower or mix). Ethernet Match which controller receives from switch is always an upper case string.
58 * Default EthernetMatch equals doesn't use equalsIgnoreCase() and hence it fails. E.g User provided mac address
59 * string in flow match is aa:bb:cc:dd:ee:ff and when controller fetch statistic data, openflow driver library
60 * returns AA:BB:CC:DD:EE:FF and default eqauls fails here.
63 static boolean ethernetMatchEquals(final EthernetMatch statsEthernetMatch, final EthernetMatch storedEthernetMatch) {
64 boolean verdict = true;
65 final Boolean checkNullValues = checkNullValues(statsEthernetMatch, storedEthernetMatch);
66 if (checkNullValues != null) {
67 verdict = checkNullValues;
69 verdict = ethernetMatchFieldsEquals(statsEthernetMatch.getEthernetSource(),
70 storedEthernetMatch.getEthernetSource());
72 verdict = ethernetMatchFieldsEquals(statsEthernetMatch.getEthernetDestination(),
73 storedEthernetMatch.getEthernetDestination());
76 if (statsEthernetMatch.getEthernetType() == null) {
77 if (storedEthernetMatch.getEthernetType() != null) {
81 verdict = statsEthernetMatch.getEthernetType().equals(storedEthernetMatch.getEthernetType());
88 static boolean ethernetMatchFieldsEquals(final MacAddressFilter statsEthernetMatchFields,
89 final MacAddressFilter storedEthernetMatchFields) {
90 boolean verdict = true;
91 final Boolean checkNullValues = checkNullValues(statsEthernetMatchFields, storedEthernetMatchFields);
92 if (checkNullValues != null) {
93 verdict = checkNullValues;
95 verdict = macAddressEquals(statsEthernetMatchFields.getAddress(), storedEthernetMatchFields.getAddress());
97 verdict = macAddressEquals(statsEthernetMatchFields.getMask(), storedEthernetMatchFields.getMask());
103 static boolean macAddressEquals(final MacAddress statsMacAddress, final MacAddress storedMacAddress) {
104 boolean verdict = true;
105 final Boolean checkNullValues = checkNullValues(statsMacAddress, storedMacAddress);
106 if (checkNullValues != null) {
107 verdict = checkNullValues;
109 verdict = statsMacAddress.getValue().equalsIgnoreCase(storedMacAddress.getValue());
115 static boolean layer3MatchEquals(final Layer3Match statsLayer3Match, final Layer3Match storedLayer3Match) {
116 boolean verdict = true;
117 if (statsLayer3Match instanceof Ipv4Match && storedLayer3Match instanceof Ipv4Match) {
118 final Ipv4Match statsIpv4Match = (Ipv4Match) statsLayer3Match;
119 final Ipv4Match storedIpv4Match = (Ipv4Match) storedLayer3Match;
120 verdict = MatchComparatorHelper.compareIpv4PrefixNullSafe(storedIpv4Match.getIpv4Destination(),
121 statsIpv4Match.getIpv4Destination());
123 verdict = MatchComparatorHelper.compareIpv4PrefixNullSafe(statsIpv4Match.getIpv4Source(),
124 storedIpv4Match.getIpv4Source());
126 } else if(statsLayer3Match instanceof Ipv6Match && storedLayer3Match instanceof Ipv6Match) {
127 final Ipv6Match statsIpv6Match = (Ipv6Match) statsLayer3Match;
128 final Ipv6Match storedIpv6Match = (Ipv6Match) storedLayer3Match;
129 verdict = MatchComparatorHelper.compareIpv6PrefixNullSafe(storedIpv6Match.getIpv6Destination(),
130 statsIpv6Match.getIpv6Destination());
132 verdict = MatchComparatorHelper.compareIpv6PrefixNullSafe(statsIpv6Match.getIpv6Source(),
133 storedIpv6Match.getIpv6Source());
135 } else if(statsLayer3Match instanceof Ipv4MatchArbitraryBitMask && storedLayer3Match instanceof Ipv4MatchArbitraryBitMask) {
136 // At this moment storedIpv4MatchArbitraryBitMask & statsIpv4MatchArbitraryBitMask will always have non null arbitrary masks.
137 // In case of no / null arbitrary mask, statsLayer3Match will be an instance of Ipv4Match.
138 // Eg:- stats -> 1.0.1.0/255.0.255.0 stored -> 1.1.1.0/255.0.255.0
139 final Ipv4MatchArbitraryBitMask statsIpv4MatchArbitraryBitMask= (Ipv4MatchArbitraryBitMask) statsLayer3Match;
140 final Ipv4MatchArbitraryBitMask storedIpv4MatchArbitraryBitMask = (Ipv4MatchArbitraryBitMask) storedLayer3Match;
141 if((storedIpv4MatchArbitraryBitMask.getIpv4DestinationAddressNoMask() != null |
142 storedIpv4MatchArbitraryBitMask.getIpv4SourceAddressNoMask() != null)) {
143 if(storedIpv4MatchArbitraryBitMask.getIpv4DestinationAddressNoMask() != null) {
144 String storedIpAddress = extractIpv4Address(storedIpv4MatchArbitraryBitMask.getIpv4DestinationAddressNoMask(),
145 storedIpv4MatchArbitraryBitMask.getIpv4DestinationArbitraryBitmask());
146 if(MatchComparatorHelper.compareStringNullSafe(storedIpv4MatchArbitraryBitMask.getIpv4DestinationArbitraryBitmask().getValue(),
147 statsIpv4MatchArbitraryBitMask.getIpv4DestinationArbitraryBitmask().getValue())) {
148 verdict = MatchComparatorHelper.compareStringNullSafe(storedIpAddress,
149 statsIpv4MatchArbitraryBitMask.getIpv4DestinationAddressNoMask().getValue());
156 if(storedIpv4MatchArbitraryBitMask.getIpv4SourceAddressNoMask() != null) {
157 String storedIpAddress = extractIpv4Address(storedIpv4MatchArbitraryBitMask.getIpv4SourceAddressNoMask()
158 ,storedIpv4MatchArbitraryBitMask.getIpv4SourceArbitraryBitmask());
159 if(MatchComparatorHelper.compareStringNullSafe(storedIpv4MatchArbitraryBitMask.getIpv4SourceArbitraryBitmask().getValue(),
160 statsIpv4MatchArbitraryBitMask.getIpv4SourceArbitraryBitmask().getValue())) {
161 verdict = MatchComparatorHelper.compareStringNullSafe(storedIpAddress,
162 statsIpv4MatchArbitraryBitMask.getIpv4SourceAddressNoMask().getValue());
170 final Boolean nullCheckOut = checkNullValues(storedLayer3Match, statsLayer3Match);
171 if (nullCheckOut != null) {
172 verdict = nullCheckOut;
174 verdict = storedLayer3Match.equals(statsLayer3Match);
178 else if (statsLayer3Match instanceof Ipv4Match && storedLayer3Match instanceof Ipv4MatchArbitraryBitMask) {
179 // Here stored netmask is an instance of Ipv4MatchArbitraryBitMask, when it is pushed in to switch
180 // it automatically converts it in to cidr format in case of certain subnet masks ( consecutive ones or zeroes)
181 // Eg:- stats src/dest -> 1.1.1.0/24 stored src/dest -> 1.1.1.0/255.255.255.0
182 final Ipv4Match statsIpv4Match = (Ipv4Match) statsLayer3Match;
183 final Ipv4MatchArbitraryBitMask storedIpv4MatchArbitraryBitMask = (Ipv4MatchArbitraryBitMask) storedLayer3Match;
184 if (storedIpv4MatchArbitraryBitMask.getIpv4DestinationAddressNoMask() != null) {
185 Ipv4Prefix ipv4PrefixDestination;
186 if (storedIpv4MatchArbitraryBitMask.getIpv4DestinationArbitraryBitmask() != null) {
187 byte[] destByteMask = convertArbitraryMaskToByteArray(storedIpv4MatchArbitraryBitMask.getIpv4DestinationArbitraryBitmask());
188 ipv4PrefixDestination = createPrefix(storedIpv4MatchArbitraryBitMask.getIpv4DestinationAddressNoMask(), destByteMask);
191 ipv4PrefixDestination = createPrefix(storedIpv4MatchArbitraryBitMask.getIpv4DestinationAddressNoMask());
193 verdict = MatchComparatorHelper.compareIpv4PrefixNullSafe(ipv4PrefixDestination, statsIpv4Match.getIpv4Destination());
194 if(verdict == false) {
198 if (storedIpv4MatchArbitraryBitMask.getIpv4SourceAddressNoMask() != null) {
199 Ipv4Prefix ipv4PrefixSource;
200 if (storedIpv4MatchArbitraryBitMask.getIpv4SourceArbitraryBitmask() != null) {
201 byte[] srcByteMask = convertArbitraryMaskToByteArray(storedIpv4MatchArbitraryBitMask.getIpv4SourceArbitraryBitmask());
202 ipv4PrefixSource = createPrefix(storedIpv4MatchArbitraryBitMask.getIpv4SourceAddressNoMask(), srcByteMask);
205 ipv4PrefixSource = createPrefix(storedIpv4MatchArbitraryBitMask.getIpv4SourceAddressNoMask());
207 verdict = MatchComparatorHelper.compareIpv4PrefixNullSafe(ipv4PrefixSource, statsIpv4Match.getIpv4Source());
210 final Boolean nullCheckOut = checkNullValues(storedLayer3Match, statsLayer3Match);
211 if (nullCheckOut != null) {
212 verdict = nullCheckOut;
214 verdict = storedLayer3Match.equals(statsLayer3Match);
222 * TODO: why don't we use the default Ipv4Prefix.equals()?
224 * @param statsIpAddress
225 * @param storedIpAddress
226 * @return true if IPv4prefixes equals
228 static boolean IpAddressEquals(final Ipv4Prefix statsIpAddress, final Ipv4Prefix storedIpAddress) {
229 final IntegerIpAddress statsIpAddressInt = MatchComparatorHelper.strIpToIntIp(statsIpAddress.getValue());
230 final IntegerIpAddress storedIpAddressInt = MatchComparatorHelper.strIpToIntIp(storedIpAddress.getValue());
232 if (ipAndMaskBasedMatch(statsIpAddressInt, storedIpAddressInt)) {
235 if (ipBasedMatch(statsIpAddressInt, storedIpAddressInt)) {
241 static boolean ipAndMaskBasedMatch(final IntegerIpAddress statsIpAddressInt,
242 final IntegerIpAddress storedIpAddressInt) {
243 return ((statsIpAddressInt.getIp() & statsIpAddressInt.getMask()) == (storedIpAddressInt.getIp() & storedIpAddressInt
247 static boolean ipBasedMatch(final IntegerIpAddress statsIpAddressInt, final IntegerIpAddress storedIpAddressInt) {
248 return (statsIpAddressInt.getIp() == storedIpAddressInt.getIp());
252 private static boolean IpAddressEquals(Ipv6Prefix statsIpv6, Ipv6Prefix storedIpv6) {
253 final String[] statsIpMask = statsIpv6.getValue().split("/");
254 final String[] storedIpMask = storedIpv6.getValue().split("/");
255 if(! (statsIpMask.length > 1 && storedIpMask.length > 1 && statsIpMask[1].equals(storedIpMask[1]))){
258 if(InetAddresses.forString(statsIpMask[0]).equals(InetAddresses.forString(storedIpMask[0]))){
265 static Boolean checkNullValues(final Object v1, final Object v2) {
266 Boolean verdict = null;
267 if (v1 == null && v2 != null) {
268 verdict = Boolean.FALSE;
269 } else if (v1 != null && v2 == null) {
270 verdict = Boolean.FALSE;
271 } else if (v1 == null && v2 == null) {
272 verdict = Boolean.TRUE;
278 static boolean compareIpv4PrefixNullSafe(final Ipv4Prefix statsIpv4, final Ipv4Prefix storedIpv4) {
279 boolean verdict = true;
280 final Boolean checkDestNullValuesOut = checkNullValues(storedIpv4, statsIpv4);
281 if (checkDestNullValuesOut != null) {
282 verdict = checkDestNullValuesOut;
283 } else if (!IpAddressEquals(statsIpv4, storedIpv4)) {
289 static boolean compareStringNullSafe(final String stringA, final String stringB) {
290 boolean verdict = true;
291 final Boolean checkDestNullValuesOut = checkNullValues(stringA,stringB);
292 if (checkDestNullValuesOut != null) {
293 verdict = checkDestNullValuesOut;
294 }else if (!stringA.equals(stringB)) {
300 private static boolean compareIpv6PrefixNullSafe(Ipv6Prefix statsIpv6, Ipv6Prefix storedIpv6) {
301 boolean verdict = true;
302 final Boolean checkDestNullValuesOut = checkNullValues(statsIpv6, storedIpv6);
303 if (checkDestNullValuesOut != null) {
304 verdict = checkDestNullValuesOut;
305 } else if (!IpAddressEquals(statsIpv6, storedIpv6)) {
313 * Method return integer version of ip address. Converted int will be mask if mask specified
315 static IntegerIpAddress strIpToIntIp(final String ipAddresss) {
317 final String[] parts = ipAddresss.split("/");
318 final String ip = parts[0];
321 if (parts.length < 2) {
322 prefix = DEFAULT_SUBNET;
324 prefix = Integer.parseInt(parts[1]);
325 if (prefix < 0 || prefix > IPV4_MASK_LENGTH) {
326 final StringBuilder stringBuilder = new StringBuilder(
327 "Valid values for mask are from range 0 - 32. Value ");
328 stringBuilder.append(prefix);
329 stringBuilder.append(" is invalid.");
330 throw new IllegalStateException(stringBuilder.toString());
334 IntegerIpAddress integerIpAddress = null;
336 final Inet4Address addr = ((Inet4Address) InetAddresses.forString(ip));
337 final byte[] addrBytes = addr.getAddress();
338 // FIXME: what is meaning of anding with 0xFF? Probably could be removed.
339 final int ipInt = ((addrBytes[POSITION_OCTET_1] & 0xFF) << SHIFT_OCTET_1)
340 | ((addrBytes[POSITION_OCTET_2] & 0xFF) << SHIFT_OCTET_2)
341 | ((addrBytes[POSITION_OCTET_3] & 0xFF) << SHIFT_OCTET_3)
342 | ((addrBytes[POSITION_OCTET_4] & 0xFF) << SHIFT_OCTET_4);
344 // FIXME: Is this valid?
345 final int mask = 0xffffffff << DEFAULT_SUBNET - prefix;
347 integerIpAddress = new IntegerIpAddress(ipInt, mask);
349 return integerIpAddress;
352 static boolean isArbitraryBitMask(byte[] byteMask) {
353 if (byteMask == null) {
357 ArrayList<Integer> integerMaskArrayList = new ArrayList<Integer>();
359 // converting byte array to bits
360 maskInBits = new BigInteger(1, byteMask).toString(2);
361 ArrayList<String> stringMaskArrayList = new ArrayList<String>(Arrays.asList(maskInBits.split("(?!^)")));
362 for(String string:stringMaskArrayList){
363 integerMaskArrayList.add(Integer.parseInt(string));
365 return checkArbitraryBitMask(integerMaskArrayList);
369 static boolean checkArbitraryBitMask(ArrayList<Integer> arrayList) {
370 // checks 0*1* case - Leading zeros in arrayList are truncated
371 if(arrayList.size()>0 && arrayList.size()<32) {
376 for(int i=0; i<arrayList.size()-1;i++) {
377 if(arrayList.get(i) ==0 && arrayList.get(i+1) == 1) {
385 static final byte[] convertArbitraryMaskToByteArray(DottedQuad mask) {
387 if(mask.getValue() != null && mask != null){
388 maskValue = mask.getValue();
390 else maskValue = DEFAULT_ARBITRARY_BIT_MASK;
391 InetAddress maskInIpFormat = null;
393 maskInIpFormat = InetAddress.getByName(maskValue);
394 } catch (UnknownHostException e) {
395 LOG.error("Failed to recognize the host while converting mask ", e);
397 byte[] bytes = maskInIpFormat.getAddress();
402 static String extractIpv4Address(Ipv4Address ipAddress, DottedQuad netMask) {
403 String actualIpAddress="";
404 String[] netMaskParts = netMask.getValue().split("\\.");
405 String[] ipAddressParts = ipAddress.getValue().split("\\.");
407 for(int i=0; i<ipAddressParts.length;i++) {
408 int integerFormatIpAddress=Integer.parseInt(ipAddressParts[i]);
409 int integerFormatNetMask=Integer.parseInt(netMaskParts[i]);
410 int ipAddressPart=(integerFormatIpAddress) & (integerFormatNetMask);
411 actualIpAddress += ipAddressPart;
412 if(i != ipAddressParts.length -1 ) {
413 actualIpAddress = actualIpAddress+".";
416 return actualIpAddress;
419 static Ipv4Prefix createPrefix(final Ipv4Address ipv4Address, final byte [] bytemask){
420 return createPrefix(ipv4Address, String.valueOf(countBits(bytemask)));
423 static int countBits(final byte[] mask) {
425 for (byte b : mask) {
426 netmask += Integer.bitCount(UnsignedBytes.toInt(b));
431 static Ipv4Prefix createPrefix(final Ipv4Address ipv4Address){
432 return new Ipv4Prefix(ipv4Address.getValue() + PREFIX_SEPARATOR + IPV4_ADDRESS_LENGTH);
435 static Ipv4Prefix createPrefix(final Ipv4Address ipv4Address, final String mask){
437 * Ipv4Address has already validated the address part of the prefix,
438 * It is mandated to comply to the same regexp as the address
439 * There is absolutely no point rerunning additional checks vs this
440 * Note - there is no canonical form check here!!!
442 if (null != mask && !mask.isEmpty()) {
443 return new Ipv4Prefix(ipv4Address.getValue() + PREFIX_SEPARATOR + mask);
445 return new Ipv4Prefix(ipv4Address.getValue() + PREFIX_SEPARATOR + IPV4_ADDRESS_LENGTH);