util/src/main/java/org/opendaylight/protocol/util/Ipv4Util.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. 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 package org.opendaylight.protocol.util;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.net.InetAddresses;
  12 import com.google.common.primitives.UnsignedBytes;
  13 import io.netty.buffer.ByteBuf;
  14 import io.netty.buffer.Unpooled;
  15 import java.net.InetAddress;
  16 import java.net.InetSocketAddress;
  17 import java.util.ArrayList;
  18 import java.util.Arrays;
  19 import java.util.Collections;
  20 import java.util.List;
  21 import java.util.Map;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  27
  28 /**
  29  * Util class for creating generated Ipv4Address.
  30  */
  31 public final class Ipv4Util {
  32     public static final int IP4_LENGTH = 4;
  33     public static final int IP4_BITS_LENGTH = 32;
  34     private static final Ipv4Prefix EMPTY_PREFIX = new Ipv4Prefix("0.0.0.0/0");
  35
  36     private Ipv4Util() {
  37         throw new UnsupportedOperationException();
  38     }
  39
  40     /**
  41      * Reads from ByteBuf buffer and converts bytes to Ipv4Address.
  42      *
  43      * @param buffer containing Ipv4 address, starting at reader index
  44      * @return Ipv4Address
  45      */
  46     public static Ipv4Address addressForByteBuf(final ByteBuf buffer) {
  47         return IetfInetUtil.INSTANCE.ipv4AddressFor(ByteArray.readBytes(buffer, IP4_LENGTH));
  48     }
  49
  50     /**
  51      * From string ipAddress creates an InetAddress and puts it into ByteBuf.
  52      * @param ipAddress Ipv4 address
  53      * @return ByteBuf with filled in bytes from ipAddress
  54      */
  55     public static ByteBuf byteBufForAddress(final Ipv4Address ipAddress) {
  56         return Unpooled.wrappedBuffer(bytesForAddress(ipAddress));
  57     }
  58
  59     /**
  60      * Converts Ipv4Address to byte array.
  61      *
  62      * @param address Ipv4Address to be converted
  63      * @return byte array
  64      */
  65     public static byte[] bytesForAddress(final Ipv4Address address) {
  66         return IetfInetUtil.INSTANCE.ipv4AddressBytes(address);
  67     }
  68
  69     public static int prefixBitsToBytes(final int bits) {
  70         if (bits % Byte.SIZE != 0) {
  71             return (bits / Byte.SIZE) + 1;
  72         }
  73         return bits / Byte.SIZE;
  74     }
  75
  76     /**
  77      * Returns number of minimum bytes needed to cover all bits of prefix.
  78      *
  79      * @param prefix
  80      * @return
  81      */
  82     public static int getPrefixLengthBytes(final String prefix) {
  83         return prefixBitsToBytes(Ipv4Util.getPrefixLength(prefix));
  84     }
  85
  86     /**
  87      * Converts Ipv4Prefix to byte array. Prefix length at the end.
  88      *
  89      * @param prefix Ipv4Prefix to be converted
  90      * @return byte array with prefix length at the end
  91      */
  92     public static byte[] bytesForPrefix(final Ipv4Prefix prefix) {
  93         return IetfInetUtil.INSTANCE.ipv4PrefixToBytes(prefix);
  94     }
  95
  96     /**
  97      * Creates an Ipv4Prefix object from given byte array.
  98      *
  99      * @param bytes  IPv4 address
 100      * @param length prefix length
 101      * @return Ipv4Prefix object
 102      */
 103     public static Ipv4Prefix prefixForBytes(final byte[] bytes, final int length) {
 104         Preconditions.checkArgument(length <= bytes.length * Byte.SIZE);
 105
 106         final byte[] tmp;
 107         if (bytes.length != IP4_LENGTH) {
 108             tmp = Arrays.copyOfRange(bytes, 0, IP4_LENGTH);
 109         } else {
 110             tmp = bytes;
 111         }
 112
 113         return IetfInetUtil.INSTANCE.ipv4PrefixFor(tmp, length);
 114     }
 115
 116     /**
 117      * Creates an Ipv4Prefix object from given ByteBuf. Prefix length is assumed to
 118      * be in the left most byte of the buffer.
 119      *
 120      * @param buf Buffer containing serialized prefix
 121      * @return Ipv4Prefix object
 122      */
 123     public static Ipv4Prefix prefixForByteBuf(final ByteBuf buf) {
 124         final int prefixLength = UnsignedBytes.toInt(buf.readByte());
 125         final int size = prefixLength / Byte.SIZE + ((prefixLength % Byte.SIZE == 0) ? 0 : 1);
 126         final int readable = buf.readableBytes();
 127         Preconditions.checkArgument(size <= readable, "Illegal length of IP prefix: %s/%s", size, readable);
 128
 129         final byte[] bytes = new byte[IP4_LENGTH];
 130         buf.readBytes(bytes, 0, size);
 131         return IetfInetUtil.INSTANCE.ipv4PrefixFor(bytes, prefixLength);
 132     }
 133
 134     /**
 135      * Creates a list of Ipv4 Prefixes from given byte array.
 136      *
 137      * @param bytes to be converted to List of Ipv4Prefixes.
 138      * @return A list of Ipv4Prefixes
 139      */
 140     public static List<Ipv4Prefix> prefixListForBytes(final byte[] bytes) {
 141         if (bytes.length == 0) {
 142             return Collections.emptyList();
 143         }
 144         final List<Ipv4Prefix> list = new ArrayList<>();
 145         int byteOffset = 0;
 146         while (byteOffset < bytes.length) {
 147             final int bitLength = UnsignedBytes.toInt(bytes[byteOffset]);
 148             byteOffset += 1;
 149             // if length == 0, default route will be added
 150             if (bitLength == 0) {
 151                 list.add(EMPTY_PREFIX);
 152                 continue;
 153             }
 154
 155             list.add(IetfInetUtil.INSTANCE.ipv4PrefixForShort(bytes, byteOffset, bitLength));
 156             byteOffset += bitLength / Byte.SIZE;
 157             if (bitLength % Byte.SIZE != 0) {
 158                 byteOffset++;
 159             }
 160
 161         }
 162         return list;
 163     }
 164
 165     /**
 166      * Obtains prefix length from given string prefix.
 167      *
 168      * @param prefixValue value of prefix
 169      * @return prefix length
 170      */
 171     protected static int getPrefixLength(final String prefixValue) {
 172         final int sep = prefixValue.indexOf('/');
 173         return Integer.parseInt(prefixValue.substring(sep + 1, prefixValue.length()));
 174     }
 175
 176     /**
 177      * Converts InetAddress to IpAddress.
 178      *
 179      * @param inetAddress
 180      * @return IpAddress
 181      */
 182     public static IpAddress getIpAddress(final InetAddress inetAddress) {
 183         return IetfInetUtil.INSTANCE.ipAddressFor(inetAddress);
 184     }
 185
 186     /**
 187      * Converts IpAddress and PortNumber to InetSocketAddress
 188      *
 189      * @param ipAddress
 190      * @param port
 191      * @return InetSocketAddress
 192      */
 193     public static InetSocketAddress toInetSocketAddress(final IpAddress ipAddress, final PortNumber port) {
 194         final String ipString = toStringIP(ipAddress);
 195         return new InetSocketAddress(InetAddresses.forString(ipString), port.getValue());
 196     }
 197
 198     /**
 199      * Increment Address
 200      *
 201      * @param ipv4Address String containing Ipv4Address
 202      * @return String containing Ipv4Address incremented by 1
 203      */
 204     public static String incrementIpv4Address(final String ipv4Address) {
 205         return InetAddresses.increment(InetAddresses.forString(ipv4Address)).getHostAddress();
 206     }
 207
 208     /**
 209      * Increment Address
 210      *
 211      * @param ipv4Address ipv4 address to be incremented
 212      * @return new ipv4 address
 213      */
 214     public static Ipv4Address incrementIpv4Address(final Ipv4Address ipv4Address) {
 215         return new Ipv4Address(incrementIpv4Address(ipv4Address.getValue()));
 216     }
 217
 218     public static Ipv4Prefix incrementIpv4Prefix(final Ipv4Prefix ipv4Prefix) {
 219         final Map.Entry<Ipv4Address, Integer> splitIpv4Prefix = IetfInetUtil.INSTANCE.splitIpv4Prefix(ipv4Prefix);
 220         return IetfInetUtil.INSTANCE.ipv4PrefixFor(incrementIpv4Address(splitIpv4Prefix.getKey()), splitIpv4Prefix.getValue());
 221     }
 222
 223     /**
 224      * Get string representation of IpAddress
 225      * @param ipAddress
 226      * @return String value of Ipv4Address or Ipv6Address
 227      */
 228     public static String toStringIP(final IpAddress ipAddress) {
 229         if (ipAddress.getIpv4Address() != null) {
 230             return ipAddress.getIpv4Address().getValue();
 231         }
 232         return ipAddress.getIpv6Address().getValue();
 233     }
 234 }