Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 1 | package org.projectfloodlight.openflow.types; |
| 2 | |
Andreas Wundsam | 85c961f | 2013-09-29 21:22:12 -0700 | [diff] [blame] | 3 | import java.util.Arrays; |
| 4 | |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 5 | import org.jboss.netty.buffer.ChannelBuffer; |
| 6 | |
Andreas Wundsam | 22ba3af | 2013-10-04 16:00:30 -0700 | [diff] [blame] | 7 | import com.google.common.hash.PrimitiveSink; |
Andreas Wundsam | 85c961f | 2013-09-29 21:22:12 -0700 | [diff] [blame] | 8 | import com.google.common.primitives.UnsignedInts; |
| 9 | |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 10 | |
| 11 | |
| 12 | /** |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 13 | * Wrapper around an IPv4Address address |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 14 | * |
| 15 | * @author Andreas Wundsam <andreas.wundsam@bigswitch.com> |
| 16 | */ |
Yotam Harchol | 4d63468 | 2013-09-26 13:21:06 -0700 | [diff] [blame] | 17 | public class IPv4Address extends IPAddress<IPv4Address> { |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 18 | static final int LENGTH = 4; |
| 19 | private final int rawValue; |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 20 | |
Gregor Maier | 1acb450 | 2013-12-12 11:25:07 -0800 | [diff] [blame] | 21 | private static final int NOT_A_CIDR_MASK = -1; |
| 22 | private static final int CIDR_MASK_CACHE_UNSET = -2; |
Gregor Maier | 5615b6c | 2013-12-11 22:29:07 -0800 | [diff] [blame] | 23 | // Must appear before the static IPv4Address constant assignments |
| 24 | private volatile int cidrMaskLengthCache = CIDR_MASK_CACHE_UNSET; |
| 25 | |
Andreas Wundsam | b75c4ad | 2013-09-23 14:45:35 -0700 | [diff] [blame] | 26 | private final static int NONE_VAL = 0x0; |
| 27 | public final static IPv4Address NONE = new IPv4Address(NONE_VAL); |
| 28 | |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 29 | public static final IPv4Address NO_MASK = IPv4Address.of(0xFFFFFFFF); |
| 30 | public static final IPv4Address FULL_MASK = IPv4Address.of(0x00000000); |
| 31 | |
| 32 | private IPv4Address(final int rawValue) { |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 33 | this.rawValue = rawValue; |
| 34 | } |
| 35 | |
Yotam Harchol | 4d63468 | 2013-09-26 13:21:06 -0700 | [diff] [blame] | 36 | @Override |
Yotam Harchol | eb023dc | 2013-09-26 15:45:44 -0700 | [diff] [blame] | 37 | public IPVersion getIpVersion() { |
| 38 | return IPVersion.IPv4; |
Yotam Harchol | 4d63468 | 2013-09-26 13:21:06 -0700 | [diff] [blame] | 39 | } |
| 40 | |
Gregor Maier | 5615b6c | 2013-12-11 22:29:07 -0800 | [diff] [blame] | 41 | private int asCidrMaskLengthInternal() { |
| 42 | if (cidrMaskLengthCache == CIDR_MASK_CACHE_UNSET) { |
| 43 | // No lock required. We only write cidrMaskLengthCache once |
| 44 | int maskint = getInt(); |
| 45 | if (maskint == 0) { |
| 46 | cidrMaskLengthCache = 0; |
| 47 | } else if (Integer.bitCount((~maskint) + 1) == 1) { |
| 48 | // IP represents a true CIDR prefix length |
| 49 | cidrMaskLengthCache = Integer.bitCount(maskint); |
| 50 | } else { |
| 51 | cidrMaskLengthCache = NOT_A_CIDR_MASK; |
| 52 | } |
| 53 | } |
| 54 | return cidrMaskLengthCache; |
| 55 | } |
| 56 | |
| 57 | @Override |
| 58 | public boolean isCidrMask() { |
| 59 | return asCidrMaskLengthInternal() != NOT_A_CIDR_MASK; |
| 60 | } |
Gregor Maier | 7f987e6 | 2013-12-10 19:34:18 -0800 | [diff] [blame] | 61 | |
| 62 | @Override |
| 63 | public int asCidrMaskLength() { |
Gregor Maier | 5615b6c | 2013-12-11 22:29:07 -0800 | [diff] [blame] | 64 | if (!isCidrMask()) { |
| 65 | throw new IllegalStateException("IP is not a valid CIDR prefix " + |
| 66 | "mask " + toString()); |
Gregor Maier | 7f987e6 | 2013-12-10 19:34:18 -0800 | [diff] [blame] | 67 | } else { |
Gregor Maier | 5615b6c | 2013-12-11 22:29:07 -0800 | [diff] [blame] | 68 | return asCidrMaskLengthInternal(); |
Gregor Maier | 7f987e6 | 2013-12-10 19:34:18 -0800 | [diff] [blame] | 69 | } |
| 70 | } |
| 71 | |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 72 | public static IPv4Address of(final byte[] address) { |
Gregor Maier | 1ff5597 | 2013-12-11 02:22:56 -0800 | [diff] [blame] | 73 | if (address == null) { |
| 74 | throw new NullPointerException("Address must not be null"); |
| 75 | } |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 76 | if (address.length != LENGTH) { |
| 77 | throw new IllegalArgumentException( |
Andreas Wundsam | c85b5c5 | 2013-09-24 13:01:43 -0700 | [diff] [blame] | 78 | "Invalid byte array length for IPv4Address address: " + address.length); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 79 | } |
| 80 | |
| 81 | int raw = |
| 82 | (address[0] & 0xFF) << 24 | (address[1] & 0xFF) << 16 |
| 83 | | (address[2] & 0xFF) << 8 | (address[3] & 0xFF) << 0; |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 84 | return IPv4Address.of(raw); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 85 | } |
| 86 | |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 87 | public static IPv4Address of(final int raw) { |
Andreas Wundsam | b75c4ad | 2013-09-23 14:45:35 -0700 | [diff] [blame] | 88 | if(raw == NONE_VAL) |
| 89 | return NONE; |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 90 | return new IPv4Address(raw); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 91 | } |
| 92 | |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 93 | public static IPv4Address of(final String string) { |
Gregor Maier | 1ff5597 | 2013-12-11 02:22:56 -0800 | [diff] [blame] | 94 | if (string == null) { |
| 95 | throw new NullPointerException("String must not be null"); |
| 96 | } |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 97 | int start = 0; |
| 98 | int shift = 24; |
| 99 | |
| 100 | int raw = 0; |
| 101 | while (shift >= 0) { |
| 102 | int end = string.indexOf('.', start); |
| 103 | if (end == start || !((shift > 0) ^ (end < 0))) |
| 104 | throw new IllegalArgumentException("IP Address not well formed: " + string); |
| 105 | |
| 106 | String substr = |
| 107 | end > 0 ? string.substring(start, end) : string.substring(start); |
| 108 | int val = Integer.parseInt(substr); |
| 109 | if (val < 0 || val > 255) |
| 110 | throw new IllegalArgumentException("IP Address not well formed: " + string); |
| 111 | |
| 112 | raw |= val << shift; |
| 113 | |
| 114 | shift -= 8; |
| 115 | start = end + 1; |
| 116 | } |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 117 | return IPv4Address.of(raw); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 118 | } |
| 119 | |
| 120 | public int getInt() { |
| 121 | return rawValue; |
| 122 | } |
| 123 | |
| 124 | volatile byte[] bytesCache = null; |
| 125 | |
| 126 | public byte[] getBytes() { |
| 127 | if (bytesCache == null) { |
| 128 | synchronized (this) { |
| 129 | if (bytesCache == null) { |
| 130 | bytesCache = |
| 131 | new byte[] { (byte) ((rawValue >>> 24) & 0xFF), |
| 132 | (byte) ((rawValue >>> 16) & 0xFF), |
| 133 | (byte) ((rawValue >>> 8) & 0xFF), |
| 134 | (byte) ((rawValue >>> 0) & 0xFF) }; |
| 135 | } |
| 136 | } |
| 137 | } |
| 138 | return bytesCache; |
| 139 | } |
| 140 | |
| 141 | @Override |
| 142 | public int getLength() { |
| 143 | return LENGTH; |
| 144 | } |
| 145 | |
| 146 | @Override |
| 147 | public String toString() { |
| 148 | StringBuilder res = new StringBuilder(); |
| 149 | res.append((rawValue >> 24) & 0xFF).append('.'); |
| 150 | res.append((rawValue >> 16) & 0xFF).append('.'); |
| 151 | res.append((rawValue >> 8) & 0xFF).append('.'); |
| 152 | res.append((rawValue >> 0) & 0xFF); |
| 153 | return res.toString(); |
| 154 | } |
| 155 | |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 156 | public void write4Bytes(ChannelBuffer c) { |
| 157 | c.writeInt(rawValue); |
| 158 | } |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 159 | |
| 160 | public static IPv4Address read4Bytes(ChannelBuffer c) { |
| 161 | return IPv4Address.of(c.readInt()); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | @Override |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 165 | public IPv4Address applyMask(IPv4Address mask) { |
| 166 | return IPv4Address.of(this.rawValue & mask.rawValue); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 167 | } |
| 168 | |
Andreas Wundsam | 85c961f | 2013-09-29 21:22:12 -0700 | [diff] [blame] | 169 | @Override |
| 170 | public int hashCode() { |
| 171 | final int prime = 31; |
| 172 | int result = 1; |
| 173 | result = prime * result + Arrays.hashCode(bytesCache); |
| 174 | result = prime * result + rawValue; |
| 175 | return result; |
| 176 | } |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 177 | |
Andreas Wundsam | 85c961f | 2013-09-29 21:22:12 -0700 | [diff] [blame] | 178 | @Override |
| 179 | public boolean equals(Object obj) { |
| 180 | if (this == obj) |
| 181 | return true; |
| 182 | if (obj == null) |
| 183 | return false; |
| 184 | if (getClass() != obj.getClass()) |
| 185 | return false; |
| 186 | IPv4Address other = (IPv4Address) obj; |
| 187 | if (!Arrays.equals(bytesCache, other.bytesCache)) |
| 188 | return false; |
| 189 | if (rawValue != other.rawValue) |
| 190 | return false; |
| 191 | return true; |
| 192 | } |
| 193 | |
| 194 | @Override |
| 195 | public int compareTo(IPv4Address o) { |
| 196 | return UnsignedInts.compare(rawValue, o.rawValue); |
| 197 | } |
Andreas Wundsam | 22ba3af | 2013-10-04 16:00:30 -0700 | [diff] [blame] | 198 | |
| 199 | @Override |
| 200 | public void putTo(PrimitiveSink sink) { |
| 201 | sink.putInt(rawValue); |
| 202 | } |
| 203 | |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 204 | } |