framework/src/android/net/IpPrefix.java - LeafOS-Project/android_packages_modules_Connectivity - Gitiles

 /*
  * Copyright (C) 2014 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 package android.net;

 import android.annotation.IntRange;
 import android.annotation.NonNull;
 import android.annotation.Nullable;
 import android.annotation.SystemApi;
 import android.os.Parcel;
 import android.os.Parcelable;
 import android.util.Pair;

 import com.android.net.module.util.NetUtils;

 import java.net.Inet4Address;
 import java.net.Inet6Address;
 import java.net.InetAddress;
 import java.net.UnknownHostException;
 import java.util.Arrays;
 import java.util.Comparator;

 /**
  * This class represents an IP prefix, i.e., a contiguous block of IP addresses aligned on a
  * power of two boundary (also known as an "IP subnet"). A prefix is specified by two pieces of
  * information:
  *
  * <ul>
  * <li>A starting IP address (IPv4 or IPv6). This is the first IP address of the prefix.
  * <li>A prefix length. This specifies the length of the prefix by specifing the number of bits
  *     in the IP address, starting from the most significant bit in network byte order, that
  *     are constant for all addresses in the prefix.
  * </ul>
  *
  * For example, the prefix <code>192.0.2.0/24</code> covers the 256 IPv4 addresses from
  * <code>192.0.2.0</code> to <code>192.0.2.255</code>, inclusive, and the prefix
  * <code>2001:db8:1:2</code>  covers the 2^64 IPv6 addresses from <code>2001:db8:1:2::</code> to
  * <code>2001:db8:1:2:ffff:ffff:ffff:ffff</code>, inclusive.
  *
  * Objects of this class are immutable.
  */
 public final class IpPrefix implements Parcelable {
     private final byte[] address;  // network byte order
     private final int prefixLength;

     private void checkAndMaskAddressAndPrefixLength() {
         if (address.length != 4 && address.length != 16) {
             throw new IllegalArgumentException(
                     "IpPrefix has " + address.length + " bytes which is neither 4 nor 16");
         }
         NetUtils.maskRawAddress(address, prefixLength);
     }

     /**
      * Constructs a new {@code IpPrefix} from a byte array containing an IPv4 or IPv6 address in
      * network byte order and a prefix length. Silently truncates the address to the prefix length,
      * so for example {@code 192.0.2.1/24} is silently converted to {@code 192.0.2.0/24}.
      *
      * @param address the IP address. Must be non-null and exactly 4 or 16 bytes long.
      * @param prefixLength the prefix length. Must be &gt;= 0 and &lt;= (32 or 128) (IPv4 or IPv6).
      *
      * @hide
      */
     public IpPrefix(@NonNull byte[] address, @IntRange(from = 0, to = 128) int prefixLength) {
         this.address = address.clone();
         this.prefixLength = prefixLength;
         checkAndMaskAddressAndPrefixLength();
     }

     /**
      * Constructs a new {@code IpPrefix} from an IPv4 or IPv6 address and a prefix length. Silently
      * truncates the address to the prefix length, so for example {@code 192.0.2.1/24} is silently
      * converted to {@code 192.0.2.0/24}.
      *
      * @param address the IP address. Must be non-null.
      * @param prefixLength the prefix length. Must be &gt;= 0 and &lt;= (32 or 128) (IPv4 or IPv6).
      */
     public IpPrefix(@NonNull InetAddress address, @IntRange(from = 0, to = 128) int prefixLength) {
         // We don't reuse the (byte[], int) constructor because it calls clone() on the byte array,
         // which is unnecessary because getAddress() already returns a clone.
         this.address = address.getAddress();
         this.prefixLength = prefixLength;
         checkAndMaskAddressAndPrefixLength();
     }

     /**
      * Constructs a new IpPrefix from a string such as "192.0.2.1/24" or "2001:db8::1/64".
      * Silently truncates the address to the prefix length, so for example {@code 192.0.2.1/24}
      * is silently converted to {@code 192.0.2.0/24}.
      *
      * @param prefix the prefix to parse
      *
      * @hide
      */
     @SystemApi
     public IpPrefix(@NonNull String prefix) {
         // We don't reuse the (InetAddress, int) constructor because "error: call to this must be
         // first statement in constructor". We could factor out setting the member variables to an
         // init() method, but if we did, then we'd have to make the members non-final, or "error:
         // cannot assign a value to final variable address". So we just duplicate the code here.
         Pair<InetAddress, Integer> ipAndMask = NetworkUtils.legacyParseIpAndMask(prefix);
         this.address = ipAndMask.first.getAddress();
         this.prefixLength = ipAndMask.second;
         checkAndMaskAddressAndPrefixLength();
     }

     /**
      * Compares this {@code IpPrefix} object against the specified object in {@code obj}. Two
      * objects are equal if they have the same startAddress and prefixLength.
      *
      * @param obj the object to be tested for equality.
      * @return {@code true} if both objects are equal, {@code false} otherwise.
      */
     @Override
     public boolean equals(@Nullable Object obj) {
         if (!(obj instanceof IpPrefix)) {
             return false;
         }
         IpPrefix that = (IpPrefix) obj;
         return Arrays.equals(this.address, that.address) && this.prefixLength == that.prefixLength;
     }

     /**
      * Gets the hashcode of the represented IP prefix.
      *
      * @return the appropriate hashcode value.
      */
     @Override
     public int hashCode() {
         return Arrays.hashCode(address) + 11 * prefixLength;
     }

     /**
      * Returns a copy of the first IP address in the prefix. Modifying the returned object does not
      * change this object's contents.
      *
      * @return the address in the form of a byte array.
      */
     public @NonNull InetAddress getAddress() {
         try {
             return InetAddress.getByAddress(address);
         } catch (UnknownHostException e) {
             // Cannot happen. InetAddress.getByAddress can only throw an exception if the byte
             // array is the wrong length, but we check that in the constructor.
             throw new IllegalArgumentException("Address is invalid");
         }
     }

     /**
      * Returns a copy of the IP address bytes in network order (the highest order byte is the zeroth
      * element). Modifying the returned array does not change this object's contents.
      *
      * @return the address in the form of a byte array.
      */
     public @NonNull byte[] getRawAddress() {
         return address.clone();
     }

     /**
      * Returns the prefix length of this {@code IpPrefix}.
      *
      * @return the prefix length.
      */
     @IntRange(from = 0, to = 128)
     public int getPrefixLength() {
         return prefixLength;
     }

     /**
      * Determines whether the prefix contains the specified address.
      *
      * @param address An {@link InetAddress} to test.
      * @return {@code true} if the prefix covers the given address. {@code false} otherwise.
      */
     public boolean contains(@NonNull InetAddress address) {
         byte[] addrBytes = address.getAddress();
         if (addrBytes == null || addrBytes.length != this.address.length) {
             return false;
         }
         NetUtils.maskRawAddress(addrBytes, prefixLength);
         return Arrays.equals(this.address, addrBytes);
     }

     /**
      * Returns whether the specified prefix is entirely contained in this prefix.
      *
      * Note this is mathematical inclusion, so a prefix is always contained within itself.
      * @param otherPrefix the prefix to test
      * @hide
      */
     public boolean containsPrefix(@NonNull IpPrefix otherPrefix) {
         if (otherPrefix.getPrefixLength() < prefixLength) return false;
         final byte[] otherAddress = otherPrefix.getRawAddress();
         NetUtils.maskRawAddress(otherAddress, prefixLength);
         return Arrays.equals(otherAddress, address);
     }

     /**
      * @hide
      */
     public boolean isIPv6() {
         return getAddress() instanceof Inet6Address;
     }

     /**
      * @hide
      */
     public boolean isIPv4() {
         return getAddress() instanceof Inet4Address;
     }

     /**
      * Returns a string representation of this {@code IpPrefix}.
      *
      * @return a string such as {@code "192.0.2.0/24"} or {@code "2001:db8:1:2::/64"}.
      */
     public String toString() {
         try {
             return InetAddress.getByAddress(address).getHostAddress() + "/" + prefixLength;
         } catch(UnknownHostException e) {
             // Cosmic rays?
             throw new IllegalStateException("IpPrefix with invalid address! Shouldn't happen.", e);
         }
     }

     /**
      * Implement the Parcelable interface.
      */
     public int describeContents() {
         return 0;
     }

     /**
      * Implement the Parcelable interface.
      */
     public void writeToParcel(Parcel dest, int flags) {
         dest.writeByteArray(address);
         dest.writeInt(prefixLength);
     }

     /**
      * Returns a comparator ordering IpPrefixes by length, shorter to longer.
      * Contents of the address will break ties.
      * @hide
      */
     public static Comparator<IpPrefix> lengthComparator() {
         return new Comparator<IpPrefix>() {
             @Override
             public int compare(IpPrefix prefix1, IpPrefix prefix2) {
                 if (prefix1.isIPv4()) {
                     if (prefix2.isIPv6()) return -1;
                 } else {
                     if (prefix2.isIPv4()) return 1;
                 }
                 final int p1len = prefix1.getPrefixLength();
                 final int p2len = prefix2.getPrefixLength();
                 if (p1len < p2len) return -1;
                 if (p2len < p1len) return 1;
                 final byte[] a1 = prefix1.address;
                 final byte[] a2 = prefix2.address;
                 final int len = a1.length < a2.length ? a1.length : a2.length;
                 for (int i = 0; i < len; ++i) {
                     if (a1[i] < a2[i]) return -1;
                     if (a1[i] > a2[i]) return 1;
                 }
                 if (a2.length < len) return 1;
                 if (a1.length < len) return -1;
                 return 0;
             }
         };
     }

     /**
      * Implement the Parcelable interface.
      */
     public static final @android.annotation.NonNull Creator<IpPrefix> CREATOR =
             new Creator<IpPrefix>() {
                 public IpPrefix createFromParcel(Parcel in) {
                     byte[] address = in.createByteArray();
                     int prefixLength = in.readInt();
                     return new IpPrefix(address, prefixLength);
                 }

                 public IpPrefix[] newArray(int size) {
                     return new IpPrefix[size];
                 }
             };
 }
	/*
	* Copyright (C) 2014 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	package android.net;

	import android.annotation.IntRange;
	import android.annotation.NonNull;
	import android.annotation.Nullable;
	import android.annotation.SystemApi;
	import android.os.Parcel;
	import android.os.Parcelable;
	import android.util.Pair;

	import com.android.net.module.util.NetUtils;

	import java.net.Inet4Address;
	import java.net.Inet6Address;
	import java.net.InetAddress;
	import java.net.UnknownHostException;
	import java.util.Arrays;
	import java.util.Comparator;

	/**
	* This class represents an IP prefix, i.e., a contiguous block of IP addresses aligned on a
	* power of two boundary (also known as an "IP subnet"). A prefix is specified by two pieces of
	* information:
	*
	* <ul>
	* <li>A starting IP address (IPv4 or IPv6). This is the first IP address of the prefix.
	* <li>A prefix length. This specifies the length of the prefix by specifing the number of bits
	* in the IP address, starting from the most significant bit in network byte order, that
	* are constant for all addresses in the prefix.
	* </ul>
	*
	* For example, the prefix <code>192.0.2.0/24</code> covers the 256 IPv4 addresses from
	* <code>192.0.2.0</code> to <code>192.0.2.255</code>, inclusive, and the prefix
	* <code>2001:db8:1:2</code> covers the 2^64 IPv6 addresses from <code>2001:db8:1:2::</code> to
	* <code>2001:db8:1:2:ffff:ffff:ffff:ffff</code>, inclusive.
	*
	* Objects of this class are immutable.
	*/
	public final class IpPrefix implements Parcelable {
	private final byte[] address; // network byte order
	private final int prefixLength;

	private void checkAndMaskAddressAndPrefixLength() {
	if (address.length != 4 && address.length != 16) {
	throw new IllegalArgumentException(
	"IpPrefix has " + address.length + " bytes which is neither 4 nor 16");
	}
	NetUtils.maskRawAddress(address, prefixLength);
	}

	/**
	* Constructs a new {@code IpPrefix} from a byte array containing an IPv4 or IPv6 address in
	* network byte order and a prefix length. Silently truncates the address to the prefix length,
	* so for example {@code 192.0.2.1/24} is silently converted to {@code 192.0.2.0/24}.
	*
	* @param address the IP address. Must be non-null and exactly 4 or 16 bytes long.
	* @param prefixLength the prefix length. Must be >= 0 and <= (32 or 128) (IPv4 or IPv6).
	*
	* @hide
	*/
	public IpPrefix(@NonNull byte[] address, @IntRange(from = 0, to = 128) int prefixLength) {
	this.address = address.clone();
	this.prefixLength = prefixLength;
	checkAndMaskAddressAndPrefixLength();
	}

	/**
	* Constructs a new {@code IpPrefix} from an IPv4 or IPv6 address and a prefix length. Silently
	* truncates the address to the prefix length, so for example {@code 192.0.2.1/24} is silently
	* converted to {@code 192.0.2.0/24}.
	*
	* @param address the IP address. Must be non-null.
	* @param prefixLength the prefix length. Must be >= 0 and <= (32 or 128) (IPv4 or IPv6).
	*/
	public IpPrefix(@NonNull InetAddress address, @IntRange(from = 0, to = 128) int prefixLength) {
	// We don't reuse the (byte[], int) constructor because it calls clone() on the byte array,
	// which is unnecessary because getAddress() already returns a clone.
	this.address = address.getAddress();
	this.prefixLength = prefixLength;
	checkAndMaskAddressAndPrefixLength();
	}

	/**
	* Constructs a new IpPrefix from a string such as "192.0.2.1/24" or "2001:db8::1/64".
	* Silently truncates the address to the prefix length, so for example {@code 192.0.2.1/24}
	* is silently converted to {@code 192.0.2.0/24}.
	*
	* @param prefix the prefix to parse
	*
	* @hide
	*/
	@SystemApi
	public IpPrefix(@NonNull String prefix) {
	// We don't reuse the (InetAddress, int) constructor because "error: call to this must be
	// first statement in constructor". We could factor out setting the member variables to an
	// init() method, but if we did, then we'd have to make the members non-final, or "error:
	// cannot assign a value to final variable address". So we just duplicate the code here.
	Pair<InetAddress, Integer> ipAndMask = NetworkUtils.legacyParseIpAndMask(prefix);
	this.address = ipAndMask.first.getAddress();
	this.prefixLength = ipAndMask.second;
	checkAndMaskAddressAndPrefixLength();
	}

	/**
	* Compares this {@code IpPrefix} object against the specified object in {@code obj}. Two
	* objects are equal if they have the same startAddress and prefixLength.
	*
	* @param obj the object to be tested for equality.
	* @return {@code true} if both objects are equal, {@code false} otherwise.
	*/
	@Override
	public boolean equals(@Nullable Object obj) {
	if (!(obj instanceof IpPrefix)) {
	return false;
	}
	IpPrefix that = (IpPrefix) obj;
	return Arrays.equals(this.address, that.address) && this.prefixLength == that.prefixLength;
	}

	/**
	* Gets the hashcode of the represented IP prefix.
	*
	* @return the appropriate hashcode value.
	*/
	@Override
	public int hashCode() {
	return Arrays.hashCode(address) + 11 * prefixLength;
	}

	/**
	* Returns a copy of the first IP address in the prefix. Modifying the returned object does not
	* change this object's contents.
	*
	* @return the address in the form of a byte array.
	*/
	public @NonNull InetAddress getAddress() {
	try {
	return InetAddress.getByAddress(address);
	} catch (UnknownHostException e) {
	// Cannot happen. InetAddress.getByAddress can only throw an exception if the byte
	// array is the wrong length, but we check that in the constructor.
	throw new IllegalArgumentException("Address is invalid");
	}
	}

	/**
	* Returns a copy of the IP address bytes in network order (the highest order byte is the zeroth
	* element). Modifying the returned array does not change this object's contents.
	*
	* @return the address in the form of a byte array.
	*/
	public @NonNull byte[] getRawAddress() {
	return address.clone();
	}

	/**
	* Returns the prefix length of this {@code IpPrefix}.
	*
	* @return the prefix length.
	*/
	@IntRange(from = 0, to = 128)
	public int getPrefixLength() {
	return prefixLength;
	}

	/**
	* Determines whether the prefix contains the specified address.
	*
	* @param address An {@link InetAddress} to test.
	* @return {@code true} if the prefix covers the given address. {@code false} otherwise.
	*/
	public boolean contains(@NonNull InetAddress address) {
	byte[] addrBytes = address.getAddress();
	if (addrBytes == null \|\| addrBytes.length != this.address.length) {
	return false;
	}
	NetUtils.maskRawAddress(addrBytes, prefixLength);
	return Arrays.equals(this.address, addrBytes);
	}

	/**
	* Returns whether the specified prefix is entirely contained in this prefix.
	*
	* Note this is mathematical inclusion, so a prefix is always contained within itself.
	* @param otherPrefix the prefix to test
	* @hide
	*/
	public boolean containsPrefix(@NonNull IpPrefix otherPrefix) {
	if (otherPrefix.getPrefixLength() < prefixLength) return false;
	final byte[] otherAddress = otherPrefix.getRawAddress();
	NetUtils.maskRawAddress(otherAddress, prefixLength);
	return Arrays.equals(otherAddress, address);
	}

	/**
	* @hide
	*/
	public boolean isIPv6() {
	return getAddress() instanceof Inet6Address;
	}

	/**
	* @hide
	*/
	public boolean isIPv4() {
	return getAddress() instanceof Inet4Address;
	}

	/**
	* Returns a string representation of this {@code IpPrefix}.
	*
	* @return a string such as {@code "192.0.2.0/24"} or {@code "2001:db8:1:2::/64"}.
	*/
	public String toString() {
	try {
	return InetAddress.getByAddress(address).getHostAddress() + "/" + prefixLength;
	} catch(UnknownHostException e) {
	// Cosmic rays?
	throw new IllegalStateException("IpPrefix with invalid address! Shouldn't happen.", e);
	}
	}

	/**
	* Implement the Parcelable interface.
	*/
	public int describeContents() {
	return 0;
	}

	/**
	* Implement the Parcelable interface.
	*/
	public void writeToParcel(Parcel dest, int flags) {
	dest.writeByteArray(address);
	dest.writeInt(prefixLength);
	}

	/**
	* Returns a comparator ordering IpPrefixes by length, shorter to longer.
	* Contents of the address will break ties.
	* @hide
	*/
	public static Comparator<IpPrefix> lengthComparator() {
	return new Comparator<IpPrefix>() {
	@Override
	public int compare(IpPrefix prefix1, IpPrefix prefix2) {
	if (prefix1.isIPv4()) {
	if (prefix2.isIPv6()) return -1;
	} else {
	if (prefix2.isIPv4()) return 1;
	}
	final int p1len = prefix1.getPrefixLength();
	final int p2len = prefix2.getPrefixLength();
	if (p1len < p2len) return -1;
	if (p2len < p1len) return 1;
	final byte[] a1 = prefix1.address;
	final byte[] a2 = prefix2.address;
	final int len = a1.length < a2.length ? a1.length : a2.length;
	for (int i = 0; i < len; ++i) {
	if (a1[i] < a2[i]) return -1;
	if (a1[i] > a2[i]) return 1;
	}
	if (a2.length < len) return 1;
	if (a1.length < len) return -1;
	return 0;
	}
	};
	}

	/**
	* Implement the Parcelable interface.
	*/
	public static final @android.annotation.NonNull Creator<IpPrefix> CREATOR =
	new Creator<IpPrefix>() {
	public IpPrefix createFromParcel(Parcel in) {
	byte[] address = in.createByteArray();
	int prefixLength = in.readInt();
	return new IpPrefix(address, prefixLength);
	}

	public IpPrefix[] newArray(int size) {
	return new IpPrefix[size];
	}
	};
	}