2 * Copyright (c) 2013 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.protocol.util;
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 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IetfInetUtil;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
28 * Util class for creating generated Ipv4Address.
30 public final class Ipv4Util {
31 public static final int IP4_LENGTH = 4;
32 private static final Ipv4Prefix EMPTY_PREFIX = new Ipv4Prefix("0.0.0.0/0");
35 throw new UnsupportedOperationException();
39 * Reads from ByteBuf buffer and converts bytes to Ipv4Address.
41 * @param buffer containing Ipv4 address, starting at reader index
44 public static Ipv4Address addressForByteBuf(final ByteBuf buffer) {
45 return IetfInetUtil.INSTANCE.ipv4AddressFor(ByteArray.readBytes(buffer, IP4_LENGTH));
49 * From string ipAddress creates an InetAddress and puts it into ByteBuf.
50 * @param ipAddress Ipv4 address
51 * @return ByteBuf with filled in bytes from ipAddress
53 public static ByteBuf byteBufForAddress(final Ipv4Address ipAddress) {
54 return Unpooled.wrappedBuffer(bytesForAddress(ipAddress));
58 * Converts Ipv4Address to byte array.
60 * @param address Ipv4Address to be converted
63 public static byte[] bytesForAddress(final Ipv4Address address) {
64 return IetfInetUtil.INSTANCE.ipv4AddressBytes(address);
67 public static int prefixBitsToBytes(final int bits) {
68 if (bits % Byte.SIZE != 0) {
69 return (bits / Byte.SIZE) + 1;
71 return bits / Byte.SIZE;
75 * Returns number of minimum bytes needed to cover all bits of prefix.
80 public static int getPrefixLengthBytes(final String prefix) {
81 return prefixBitsToBytes(Ipv4Util.getPrefixLength(prefix));
85 * Converts Ipv4Prefix to byte array. Prefix length at the end.
87 * @param prefix Ipv4Prefix to be converted
88 * @return byte array with prefix length at the end
90 public static byte[] bytesForPrefix(final Ipv4Prefix prefix) {
91 return IetfInetUtil.INSTANCE.ipv4PrefixToBytes(prefix);
95 * Converts Ipv4Prefix to byte array. Prefix length at the beginning.
96 * Prefix bytes are trimmed from the end to match prefix length.
98 * @param prefix Ipv4Prefix to be converted
99 * @return byte array with the prefix length at the beginning
101 * @deprecated This is inefficient, refactor code to use {@link #bytesForAddress(Ipv4Address)} or
102 * {@link ByteBufWriteUtil#writeMinimalPrefix(Ipv4Prefix, ByteBuf)}.
105 public static byte[] bytesForPrefixBegin(final Ipv4Prefix prefix) {
106 final byte[] addrWithPrefix = bytesForPrefix(prefix);
107 return prefixedBytes(addrWithPrefix[IP4_LENGTH], addrWithPrefix);
110 static byte[] prefixedBytes(final byte prefixBits, final byte[] address) {
111 if (prefixBits != 0) {
112 final int prefixBytes = prefixBitsToBytes(Byte.toUnsignedInt(prefixBits));
113 final byte[] ret = new byte[prefixBytes + 1];
115 System.arraycopy(address, 0, ret, 1, prefixBytes);
118 return new byte[] { 0 };
123 * Creates an Ipv4Prefix object from given byte array.
125 * @param bytes IPv4 address
126 * @param length prefix length
127 * @return Ipv4Prefix object
129 public static Ipv4Prefix prefixForBytes(final byte[] bytes, final int length) {
130 Preconditions.checkArgument(length <= bytes.length * Byte.SIZE);
133 if (bytes.length != IP4_LENGTH) {
134 tmp = Arrays.copyOfRange(bytes, 0, IP4_LENGTH);
139 return IetfInetUtil.INSTANCE.ipv4PrefixFor(tmp, length);
143 * Creates an Ipv4Prefix object from given ByteBuf. Prefix length is assumed to
144 * be in the left most byte of the buffer.
146 * @param buf Buffer containing serialized prefix
147 * @return Ipv4Prefix object
149 public static Ipv4Prefix prefixForByteBuf(final ByteBuf buf) {
150 final int prefixLength = buf.readByte();
151 final int size = prefixLength / Byte.SIZE + ((prefixLength % Byte.SIZE == 0) ? 0 : 1);
152 final int readable = buf.readableBytes();
153 Preconditions.checkArgument(size <= readable, "Illegal length of IP prefix: %s/%s", size, readable);
155 final byte[] bytes = new byte[IP4_LENGTH];
156 buf.readBytes(bytes, 0, size);
157 return IetfInetUtil.INSTANCE.ipv4PrefixFor(bytes, prefixLength);
161 * Creates a list of Ipv4 Prefixes from given byte array.
163 * @param bytes to be converted to List of Ipv4Prefixes.
164 * @return A list of Ipv4Prefixes
166 public static List<Ipv4Prefix> prefixListForBytes(final byte[] bytes) {
167 if (bytes.length == 0) {
168 return Collections.emptyList();
170 final List<Ipv4Prefix> list = new ArrayList<>();
172 while (byteOffset < bytes.length) {
173 final int bitLength = UnsignedBytes.toInt(bytes[byteOffset]);
175 // if length == 0, default route will be added
176 if (bitLength == 0) {
177 list.add(EMPTY_PREFIX);
181 list.add(IetfInetUtil.INSTANCE.ipv4PrefixForShort(bytes, byteOffset, bitLength));
182 byteOffset += bitLength / Byte.SIZE;
183 if (bitLength % Byte.SIZE != 0) {
192 * Obtains prefix length from given string prefix.
194 * @param prefixValue value of prefix
195 * @return prefix length
197 protected static int getPrefixLength(final String prefixValue) {
198 final int sep = prefixValue.indexOf('/');
199 return Integer.parseInt(prefixValue.substring(sep + 1, prefixValue.length()));
203 * Converts InetAddress to IpAddress.
208 public static IpAddress getIpAddress(final InetAddress inetAddress) {
209 return IetfInetUtil.INSTANCE.ipAddressFor(inetAddress);
213 * Converts IpAddress and PortNumber to InetSocketAddress
217 * @return InetSocketAddress
219 public static InetSocketAddress toInetSocketAddress(final IpAddress ipAddress, final PortNumber port) {
220 final String ipString;
221 if (ipAddress.getIpv4Address() != null) {
222 ipString = ipAddress.getIpv4Address().getValue();
224 ipString = ipAddress.getIpv6Address().getValue();
226 return new InetSocketAddress(InetAddresses.forString(ipString), port.getValue());