blob: 51d10f3904ee9bd38580c3bed2da8b22bc5ec401 [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
Yotam Harchola289d552013-09-16 10:10:40 -070036 public static IPv4Address of(final byte[] address) {
Yotam Harcholf3f11152013-09-05 16:47:16 -070037 if (address.length != LENGTH) {
38 throw new IllegalArgumentException(
Andreas Wundsamc85b5c52013-09-24 13:01:43 -070039 "Invalid byte array length for IPv4Address address: " + address.length);
Yotam Harcholf3f11152013-09-05 16:47:16 -070040 }
41
42 int raw =
43 (address[0] & 0xFF) << 24 | (address[1] & 0xFF) << 16
44 | (address[2] & 0xFF) << 8 | (address[3] & 0xFF) << 0;
Yotam Harchola289d552013-09-16 10:10:40 -070045 return IPv4Address.of(raw);
Yotam Harcholf3f11152013-09-05 16:47:16 -070046 }
47
Yotam Harchola289d552013-09-16 10:10:40 -070048 public static IPv4Address of(final int raw) {
Andreas Wundsamb75c4ad2013-09-23 14:45:35 -070049 if(raw == NONE_VAL)
50 return NONE;
Yotam Harchola289d552013-09-16 10:10:40 -070051 return new IPv4Address(raw);
Yotam Harcholf3f11152013-09-05 16:47:16 -070052 }
53
Yotam Harchola289d552013-09-16 10:10:40 -070054 public static IPv4Address of(final String string) {
Yotam Harcholf3f11152013-09-05 16:47:16 -070055 int start = 0;
56 int shift = 24;
57
58 int raw = 0;
59 while (shift >= 0) {
60 int end = string.indexOf('.', start);
61 if (end == start || !((shift > 0) ^ (end < 0)))
62 throw new IllegalArgumentException("IP Address not well formed: " + string);
63
64 String substr =
65 end > 0 ? string.substring(start, end) : string.substring(start);
66 int val = Integer.parseInt(substr);
67 if (val < 0 || val > 255)
68 throw new IllegalArgumentException("IP Address not well formed: " + string);
69
70 raw |= val << shift;
71
72 shift -= 8;
73 start = end + 1;
74 }
Yotam Harchola289d552013-09-16 10:10:40 -070075 return IPv4Address.of(raw);
Yotam Harcholf3f11152013-09-05 16:47:16 -070076 }
77
78 public int getInt() {
79 return rawValue;
80 }
81
82 volatile byte[] bytesCache = null;
83
84 public byte[] getBytes() {
85 if (bytesCache == null) {
86 synchronized (this) {
87 if (bytesCache == null) {
88 bytesCache =
89 new byte[] { (byte) ((rawValue >>> 24) & 0xFF),
90 (byte) ((rawValue >>> 16) & 0xFF),
91 (byte) ((rawValue >>> 8) & 0xFF),
92 (byte) ((rawValue >>> 0) & 0xFF) };
93 }
94 }
95 }
96 return bytesCache;
97 }
98
99 @Override
100 public int getLength() {
101 return LENGTH;
102 }
103
104 @Override
105 public String toString() {
106 StringBuilder res = new StringBuilder();
107 res.append((rawValue >> 24) & 0xFF).append('.');
108 res.append((rawValue >> 16) & 0xFF).append('.');
109 res.append((rawValue >> 8) & 0xFF).append('.');
110 res.append((rawValue >> 0) & 0xFF);
111 return res.toString();
112 }
113
Yotam Harcholf3f11152013-09-05 16:47:16 -0700114 public void write4Bytes(ChannelBuffer c) {
115 c.writeInt(rawValue);
116 }
Yotam Harchola289d552013-09-16 10:10:40 -0700117
118 public static IPv4Address read4Bytes(ChannelBuffer c) {
119 return IPv4Address.of(c.readInt());
Yotam Harcholf3f11152013-09-05 16:47:16 -0700120 }
121
122 @Override
Yotam Harchola289d552013-09-16 10:10:40 -0700123 public IPv4Address applyMask(IPv4Address mask) {
124 return IPv4Address.of(this.rawValue & mask.rawValue);
Yotam Harcholf3f11152013-09-05 16:47:16 -0700125 }
126
Andreas Wundsam85c961f2013-09-29 21:22:12 -0700127 @Override
128 public int hashCode() {
129 final int prime = 31;
130 int result = 1;
131 result = prime * result + Arrays.hashCode(bytesCache);
132 result = prime * result + rawValue;
133 return result;
134 }
Yotam Harchola289d552013-09-16 10:10:40 -0700135
Andreas Wundsam85c961f2013-09-29 21:22:12 -0700136 @Override
137 public boolean equals(Object obj) {
138 if (this == obj)
139 return true;
140 if (obj == null)
141 return false;
142 if (getClass() != obj.getClass())
143 return false;
144 IPv4Address other = (IPv4Address) obj;
145 if (!Arrays.equals(bytesCache, other.bytesCache))
146 return false;
147 if (rawValue != other.rawValue)
148 return false;
149 return true;
150 }
151
152 @Override
153 public int compareTo(IPv4Address o) {
154 return UnsignedInts.compare(rawValue, o.rawValue);
155 }
Andreas Wundsam22ba3af2013-10-04 16:00:30 -0700156
157 @Override
158 public void putTo(PrimitiveSink sink) {
159 sink.putInt(rawValue);
160 }
161
Yotam Harcholf3f11152013-09-05 16:47:16 -0700162}