com.github.jgonian.ipmath.PrefixUtils Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2011-2017, Yannis Gonianakis
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.github.jgonian.ipmath;

import static java.math.BigInteger.ZERO;

import java.math.BigInteger;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;

public final class PrefixUtils {

    private PrefixUtils() {
    }

    public static , R extends AbstractIpRange>
    boolean isLegalPrefix(AbstractIpRange range) {
        int prefixLength = range.start().getCommonPrefixLength(range.end());
        C lowerBoundForPrefix = range.start().lowerBoundForPrefix(prefixLength);
        C upperBoundForPrefix = range.end().upperBoundForPrefix(prefixLength);
        return range.start().equals(lowerBoundForPrefix) && range.end().equals(upperBoundForPrefix);
    }

    public static , R extends AbstractIpRange>
    int getPrefixLength(AbstractIpRange range) {
        Validate.isTrue(isLegalPrefix(range), range.toStringInRangeNotation() + " is not a legal prefix, cannot get prefix length!");
        return range.start().getCommonPrefixLength(range.end());
    }

    public static , R extends AbstractIpRange>
    Optional findMinimumPrefixForPrefixLength(R range, int prefixLength) {
        Validate.checkRange(prefixLength, 0, range.start().bitSize());
        return findPrefixForPrefixLength(range, prefixLength, SizeComparator.get());
    }

    public static , R extends AbstractIpRange>
    Optional findMaximumPrefixForPrefixLength(R range, int prefixLength) {
        Validate.checkRange(prefixLength, 0, range.start().bitSize());
        return findPrefixForPrefixLength(range, prefixLength, SizeComparator.reverse());
    }

    private static , R extends AbstractIpRange>
    Optional findPrefixForPrefixLength(R range, int prefixLength, Comparator comparator) {
        List prefixes = range.splitToPrefixes();
        Collections.sort(prefixes, comparator);
        for (R prefix : prefixes) {
            if (prefixLength >= PrefixUtils.getPrefixLength(prefix)) {
                return Optional.of(prefix);
            }
        }
        return Optional.absent();
    }

    // TODO(yg): generify and move to AbstractIp
    public static int findMaxPrefixLengthForAddress(Ipv6 address) {
        return getMaxValidPrefix(address.value());
    }

    private static int getMaxValidPrefix(BigInteger number) {
        int powerOfTwo = 0;
        int maxPowerOfTwo = powerOfTwo;

        while (powerOfTwo <= Ipv6.NUMBER_OF_BITS && number.divideAndRemainder(BigInteger.ONE.shiftLeft(powerOfTwo))[1].compareTo(ZERO) == 0) {
            maxPowerOfTwo = powerOfTwo;
            powerOfTwo++;
        }
        return Ipv6.NUMBER_OF_BITS - maxPowerOfTwo;
    }

    public static int sumIpv4Prefixes(List ipv4Prefixes) {
        return doSumIpvX(ipv4Prefixes, Ipv4.NUMBER_OF_BITS);
    }

    public static int sumIpv6Prefixes(List ipv6Prefixes) {
        return doSumIpvX(ipv6Prefixes, Ipv6.NUMBER_OF_BITS);
    }

    private static int doSumIpvX(List prefixes, int bitSize) {
        double addressSize = 0;
        for (Integer prefix: prefixes) {
            Validate.checkRange(prefix, 1, bitSize);
            addressSize += Math.pow(2, bitSize - prefix);
        }
        return (int) Math.floor(bitSize - (Math.log(addressSize) / Math.log(2)));
    }

    public static , R extends AbstractIpRange>
    SortedSet excludeFromRangeAndSplitIntoPrefixes(R originalRange, Set rangesToExclude) {

        SortedRangeSet remainingRanges = new SortedRangeSet();
        remainingRanges.add(originalRange);
        remainingRanges.removeAll(rangesToExclude);

        SortedSet prefixes = new TreeSet(StartAndSizeComparator.get());

        for (R assignmentRange : remainingRanges) {
            for (R range : assignmentRange.splitToPrefixes()) {
                prefixes.add(range);
            }
        }
        return prefixes;
    }

}