1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/*
* Copyright 2014-2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onlab.packet;
import java.util.Arrays;
/**
* The class representing MAC address.
*/
public class MacAddress {
public static final MacAddress NONE = valueOf("a4:23:05:00:00:00");
public static final MacAddress ZERO = valueOf("00:00:00:00:00:00");
public static final MacAddress BROADCAST = valueOf("ff:ff:ff:ff:ff:ff");
private static final byte[] LL = new byte[]{
0x01, (byte) 0x80, (byte) 0xc2, 0x00, 0x00,
0x00, 0x0e, 0x03
};
public static final int MAC_ADDRESS_LENGTH = 6;
private byte[] address = new byte[MacAddress.MAC_ADDRESS_LENGTH];
public MacAddress(final byte[] address) {
this.address = Arrays.copyOf(address, MacAddress.MAC_ADDRESS_LENGTH);
}
/**
* Returns a MAC address instance representing the value of the specified
* {@code String}.
*
* @param address the String representation of the MAC Address to be parsed.
* @return a MAC Address instance representing the value of the specified
* {@code String}.
* @throws IllegalArgumentException if the string cannot be parsed as a MAC address.
*/
public static MacAddress valueOf(final String address) {
final String[] elements = address.split(":");
if (elements.length != MacAddress.MAC_ADDRESS_LENGTH) {
throw new IllegalArgumentException(
"Specified MAC Address must contain 12 hex digits"
+ " separated pairwise by :'s.");
}
final byte[] addressInBytes = new byte[MacAddress.MAC_ADDRESS_LENGTH];
for (int i = 0; i < MacAddress.MAC_ADDRESS_LENGTH; i++) {
final String element = elements[i];
addressInBytes[i] = (byte) Integer.parseInt(element, 16);
}
return new MacAddress(addressInBytes);
}
/**
* Returns a MAC address instance representing the specified {@code byte}
* array.
*
* @param address the byte array to be parsed.
* @return a MAC address instance representing the specified {@code byte}
* array.
* @throws IllegalArgumentException if the byte array cannot be parsed as a MAC address.
*/
public static MacAddress valueOf(final byte[] address) {
if (address.length != MacAddress.MAC_ADDRESS_LENGTH) {
throw new IllegalArgumentException("the length is not "
+ MacAddress.MAC_ADDRESS_LENGTH);
}
return new MacAddress(address);
}
/**
* Returns a MAC address instance representing the specified {@code long}
* value. The lower 48 bits of the long value are used to parse as a MAC
* address.
*
* @param address the long value to be parsed. The lower 48 bits are used for a
* MAC address.
* @return a MAC address instance representing the specified {@code long}
* value.
* @throws IllegalArgumentException if the long value cannot be parsed as a MAC address.
*/
public static MacAddress valueOf(final long address) {
final byte[] addressInBytes = new byte[]{
(byte) (address >> 40 & 0xff), (byte) (address >> 32 & 0xff),
(byte) (address >> 24 & 0xff), (byte) (address >> 16 & 0xff),
(byte) (address >> 8 & 0xff), (byte) (address >> 0 & 0xff)};
return new MacAddress(addressInBytes);
}
/**
* Returns the length of the {@code MACAddress}.
*
* @return the length of the {@code MACAddress}.
*/
public int length() {
return this.address.length;
}
/**
* Returns the value of the {@code MACAddress} as a {@code byte} array.
*
* @return the numeric value represented by this object after conversion to
* type {@code byte} array.
*/
public byte[] toBytes() {
return Arrays.copyOf(this.address, this.address.length);
}
/**
* Returns the value of the {@code MACAddress} as a {@code long}.
*
* @return the numeric value represented by this object after conversion to
* type {@code long}.
*/
public long toLong() {
long mac = 0;
for (int i = 0; i < 6; i++) {
final long t = (this.address[i] & 0xffL) << (5 - i) * 8;
mac |= t;
}
return mac;
}
/**
* Returns {@code true} if the MAC address is the broadcast address.
*
* @return {@code true} if the MAC address is the broadcast address.
*/
public boolean isBroadcast() {
for (final byte b : this.address) {
if (b != -1) {
return false;
}
}
return true;
}
/**
* Returns {@code true} if the MAC address is the multicast address.
*
* @return {@code true} if the MAC address is the multicast address.
*/
public boolean isMulticast() {
if (this.isBroadcast()) {
return false;
}
return (this.address[0] & 0x01) != 0;
}
/**
* Returns true if this MAC address is link local.
*
* @return true if link local
*/
public boolean isLinkLocal() {
return LL[0] == address[0] && LL[1] == address[1] && LL[2] == address[2] &&
LL[3] == address[3] && LL[4] == address[4] &&
(LL[5] == address[5] || LL[6] == address[5] || LL[7] == address[5]);
}
@Override
public boolean equals(final Object o) {
if (o == this) {
return true;
}
if (!(o instanceof MacAddress)) {
return false;
}
final MacAddress other = (MacAddress) o;
return Arrays.equals(this.address, other.address);
}
@Override
public int hashCode() {
return Long.hashCode(toLong());
}
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
for (final byte b : this.address) {
if (builder.length() > 0) {
builder.append(":");
}
builder.append(String.format("%02X", b & 0xFF));
}
return builder.toString();
}
/**
* @return MAC address in string representation without colons (useful for
* radix tree storage)
*/
public String toStringNoColon() {
final StringBuilder builder = new StringBuilder();
for (final byte b : this.address) {
builder.append(String.format("%02X", b & 0xFF));
}
return builder.toString();
}
}
|
