blob: 970a65c7278e1e404976ccc09dabdbfee699df25 [file] [log] [blame]
Yotam Harcholf3f11152013-09-05 16:47:16 -07001package org.projectfloodlight.openflow.types;
2
Andreas Wundsam85c961f2013-09-29 21:22:12 -07003import java.util.Arrays;
4
Yotam Harcholf3f11152013-09-05 16:47:16 -07005import org.jboss.netty.buffer.ChannelBuffer;
6
Andreas Wundsam22ba3af2013-10-04 16:00:30 -07007import com.google.common.hash.PrimitiveSink;
Andreas Wundsam85c961f2013-09-29 21:22:12 -07008import com.google.common.primitives.UnsignedInts;
9
Yotam Harcholf3f11152013-09-05 16:47:16 -070010
11
12/**
Yotam Harchola289d552013-09-16 10:10:40 -070013 * Wrapper around an IPv4Address address
Yotam Harcholf3f11152013-09-05 16:47:16 -070014 *
15 * @author Andreas Wundsam <andreas.wundsam@bigswitch.com>
16 */
Yotam Harchol4d634682013-09-26 13:21:06 -070017public class IPv4Address extends IPAddress<IPv4Address> {
Yotam Harcholf3f11152013-09-05 16:47:16 -070018 static final int LENGTH = 4;
19 private final int rawValue;
Yotam Harcholf3f11152013-09-05 16:47:16 -070020
Andreas Wundsamb75c4ad2013-09-23 14:45:35 -070021 private final static int NONE_VAL = 0x0;
22 public final static IPv4Address NONE = new IPv4Address(NONE_VAL);
23
Yotam Harchola289d552013-09-16 10:10:40 -070024 public static final IPv4Address NO_MASK = IPv4Address.of(0xFFFFFFFF);
25 public static final IPv4Address FULL_MASK = IPv4Address.of(0x00000000);
26
27 private IPv4Address(final int rawValue) {
Yotam Harcholf3f11152013-09-05 16:47:16 -070028 this.rawValue = rawValue;
29 }
30
Yotam Harchol4d634682013-09-26 13:21:06 -070031 @Override
Yotam Harcholeb023dc2013-09-26 15:45:44 -070032 public IPVersion getIpVersion() {
33 return IPVersion.IPv4;
Yotam Harchol4d634682013-09-26 13:21:06 -070034 }
35
Gregor Maier7f987e62013-12-10 19:34:18 -080036
37 @Override
38 public int asCidrMaskLength() {
39 int maskint = getInt();
40 if (maskint == 0)
41 return 0;
42 else if (Integer.bitCount((~maskint) + 1) == 1) {
43 // IP represents a true CIDR prefix length
44 return Integer.bitCount(maskint);
45 } else {
46 // IP is not a true prefix.
47 return -1;
48 }
49 }
50
Yotam Harchola289d552013-09-16 10:10:40 -070051 public static IPv4Address of(final byte[] address) {
Yotam Harcholf3f11152013-09-05 16:47:16 -070052 if (address.length != LENGTH) {
53 throw new IllegalArgumentException(
Andreas Wundsamc85b5c52013-09-24 13:01:43 -070054 "Invalid byte array length for IPv4Address address: " + address.length);
Yotam Harcholf3f11152013-09-05 16:47:16 -070055 }
56
57 int raw =
58 (address[0] & 0xFF) << 24 | (address[1] & 0xFF) << 16
59 | (address[2] & 0xFF) << 8 | (address[3] & 0xFF) << 0;
Yotam Harchola289d552013-09-16 10:10:40 -070060 return IPv4Address.of(raw);
Yotam Harcholf3f11152013-09-05 16:47:16 -070061 }
62
Yotam Harchola289d552013-09-16 10:10:40 -070063 public static IPv4Address of(final int raw) {
Andreas Wundsamb75c4ad2013-09-23 14:45:35 -070064 if(raw == NONE_VAL)
65 return NONE;
Yotam Harchola289d552013-09-16 10:10:40 -070066 return new IPv4Address(raw);
Yotam Harcholf3f11152013-09-05 16:47:16 -070067 }
68
Yotam Harchola289d552013-09-16 10:10:40 -070069 public static IPv4Address of(final String string) {
Yotam Harcholf3f11152013-09-05 16:47:16 -070070 int start = 0;
71 int shift = 24;
72
73 int raw = 0;
74 while (shift >= 0) {
75 int end = string.indexOf('.', start);
76 if (end == start || !((shift > 0) ^ (end < 0)))
77 throw new IllegalArgumentException("IP Address not well formed: " + string);
78
79 String substr =
80 end > 0 ? string.substring(start, end) : string.substring(start);
81 int val = Integer.parseInt(substr);
82 if (val < 0 || val > 255)
83 throw new IllegalArgumentException("IP Address not well formed: " + string);
84
85 raw |= val << shift;
86
87 shift -= 8;
88 start = end + 1;
89 }
Yotam Harchola289d552013-09-16 10:10:40 -070090 return IPv4Address.of(raw);
Yotam Harcholf3f11152013-09-05 16:47:16 -070091 }
92
93 public int getInt() {
94 return rawValue;
95 }
96
97 volatile byte[] bytesCache = null;
98
99 public byte[] getBytes() {
100 if (bytesCache == null) {
101 synchronized (this) {
102 if (bytesCache == null) {
103 bytesCache =
104 new byte[] { (byte) ((rawValue >>> 24) & 0xFF),
105 (byte) ((rawValue >>> 16) & 0xFF),
106 (byte) ((rawValue >>> 8) & 0xFF),
107 (byte) ((rawValue >>> 0) & 0xFF) };
108 }
109 }
110 }
111 return bytesCache;
112 }
113
114 @Override
115 public int getLength() {
116 return LENGTH;
117 }
118
119 @Override
120 public String toString() {
121 StringBuilder res = new StringBuilder();
122 res.append((rawValue >> 24) & 0xFF).append('.');
123 res.append((rawValue >> 16) & 0xFF).append('.');
124 res.append((rawValue >> 8) & 0xFF).append('.');
125 res.append((rawValue >> 0) & 0xFF);
126 return res.toString();
127 }
128
Yotam Harcholf3f11152013-09-05 16:47:16 -0700129 public void write4Bytes(ChannelBuffer c) {
130 c.writeInt(rawValue);
131 }
Yotam Harchola289d552013-09-16 10:10:40 -0700132
133 public static IPv4Address read4Bytes(ChannelBuffer c) {
134 return IPv4Address.of(c.readInt());
Yotam Harcholf3f11152013-09-05 16:47:16 -0700135 }
136
137 @Override
Yotam Harchola289d552013-09-16 10:10:40 -0700138 public IPv4Address applyMask(IPv4Address mask) {
139 return IPv4Address.of(this.rawValue & mask.rawValue);
Yotam Harcholf3f11152013-09-05 16:47:16 -0700140 }
141
Andreas Wundsam85c961f2013-09-29 21:22:12 -0700142 @Override
143 public int hashCode() {
144 final int prime = 31;
145 int result = 1;
146 result = prime * result + Arrays.hashCode(bytesCache);
147 result = prime * result + rawValue;
148 return result;
149 }
Yotam Harchola289d552013-09-16 10:10:40 -0700150
Andreas Wundsam85c961f2013-09-29 21:22:12 -0700151 @Override
152 public boolean equals(Object obj) {
153 if (this == obj)
154 return true;
155 if (obj == null)
156 return false;
157 if (getClass() != obj.getClass())
158 return false;
159 IPv4Address other = (IPv4Address) obj;
160 if (!Arrays.equals(bytesCache, other.bytesCache))
161 return false;
162 if (rawValue != other.rawValue)
163 return false;
164 return true;
165 }
166
167 @Override
168 public int compareTo(IPv4Address o) {
169 return UnsignedInts.compare(rawValue, o.rawValue);
170 }
Andreas Wundsam22ba3af2013-10-04 16:00:30 -0700171
172 @Override
173 public void putTo(PrimitiveSink sink) {
174 sink.putInt(rawValue);
175 }
176
Yotam Harcholf3f11152013-09-05 16:47:16 -0700177}