Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 15 | */ |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 16 | package org.onlab.packet; |
| 17 | |
Yuta HIGUCHI | bfc2e92 | 2017-06-07 21:46:05 -0700 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 19 | import java.util.Arrays; |
Charles Chan | 928ff8b | 2017-05-04 12:22:54 -0700 | [diff] [blame] | 20 | import java.util.Set; |
Dominika Molenda | 52cc3a9 | 2017-06-19 17:08:35 +0200 | [diff] [blame] | 21 | import java.util.regex.Matcher; |
| 22 | import java.util.regex.Pattern; |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 23 | |
| 24 | /** |
| 25 | * The class representing MAC address. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 26 | */ |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 27 | public class MacAddress { |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 28 | |
Dominika Molenda | 52cc3a9 | 2017-06-19 17:08:35 +0200 | [diff] [blame] | 29 | private static final Pattern MAC_PATTERN = Pattern.compile("^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$"); |
Charles Chan | ba13871 | 2016-04-06 22:19:13 -0700 | [diff] [blame] | 30 | /** |
Charles Chan | 928ff8b | 2017-05-04 12:22:54 -0700 | [diff] [blame] | 31 | * First MAC address in ONOS OUI range. |
| 32 | */ |
| 33 | public static final MacAddress ONOS = valueOf("a4:23:05:00:00:00"); |
| 34 | /** |
Charles Chan | 79cddb1 | 2017-05-12 18:07:16 -0700 | [diff] [blame] | 35 | * Dummy MAC address. We use the first MAC address in ONOS OUI range as the dummy MAC address. |
| 36 | */ |
| 37 | public static final MacAddress NONE = ONOS; |
| 38 | /** |
Charles Chan | 928ff8b | 2017-05-04 12:22:54 -0700 | [diff] [blame] | 39 | * ONOS LLDP MAC address with multicast bit set. |
| 40 | */ |
| 41 | public static final MacAddress ONOS_LLDP = valueOf("a5:23:05:00:00:01"); |
Charles Chan | ba13871 | 2016-04-06 22:19:13 -0700 | [diff] [blame] | 42 | /** |
| 43 | * All-zero MAC address. |
| 44 | */ |
tom | 545708e | 2014-10-09 17:10:02 -0700 | [diff] [blame] | 45 | public static final MacAddress ZERO = valueOf("00:00:00:00:00:00"); |
Charles Chan | ba13871 | 2016-04-06 22:19:13 -0700 | [diff] [blame] | 46 | /** |
| 47 | * Broadcast MAC address. |
| 48 | */ |
tom | 545708e | 2014-10-09 17:10:02 -0700 | [diff] [blame] | 49 | public static final MacAddress BROADCAST = valueOf("ff:ff:ff:ff:ff:ff"); |
Charles Chan | ba13871 | 2016-04-06 22:19:13 -0700 | [diff] [blame] | 50 | /** |
| 51 | * IPv4 multicast MAC address. |
| 52 | */ |
| 53 | public static final MacAddress IPV4_MULTICAST = valueOf("01:00:5e:00:00:00"); |
| 54 | /** |
| 55 | * IPv4 multicast MAC mask. |
| 56 | */ |
| 57 | public static final MacAddress IPV4_MULTICAST_MASK = valueOf("ff:ff:ff:80:00:00"); |
Charles Chan | 928ff8b | 2017-05-04 12:22:54 -0700 | [diff] [blame] | 58 | /** |
| 59 | * A set of LLDP MAC addresses. |
| 60 | */ |
Yuta HIGUCHI | bfc2e92 | 2017-06-07 21:46:05 -0700 | [diff] [blame] | 61 | public static final Set<MacAddress> LLDP = ImmutableSet.of( |
Charles Chan | 928ff8b | 2017-05-04 12:22:54 -0700 | [diff] [blame] | 62 | MacAddress.valueOf("01:80:c2:00:00:00"), |
| 63 | MacAddress.valueOf("01:80:c2:00:00:03"), |
| 64 | MacAddress.valueOf("01:80:c2:00:00:0e")); |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 65 | |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 66 | public static final int MAC_ADDRESS_LENGTH = 6; |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 67 | private byte[] address = new byte[MacAddress.MAC_ADDRESS_LENGTH]; |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 68 | |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 69 | public MacAddress(final byte[] address) { |
| 70 | this.address = Arrays.copyOf(address, MacAddress.MAC_ADDRESS_LENGTH); |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Returns a MAC address instance representing the value of the specified |
| 75 | * {@code String}. |
| 76 | * |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 77 | * @param address the String representation of the MAC Address to be parsed. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 78 | * @return a MAC Address instance representing the value of the specified |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 79 | * {@code String}. |
| 80 | * @throws IllegalArgumentException if the string cannot be parsed as a MAC address. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 81 | */ |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 82 | public static MacAddress valueOf(final String address) { |
Dominika Molenda | 52cc3a9 | 2017-06-19 17:08:35 +0200 | [diff] [blame] | 83 | if (!isValid(address)) { |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 84 | throw new IllegalArgumentException( |
| 85 | "Specified MAC Address must contain 12 hex digits" |
| 86 | + " separated pairwise by :'s."); |
| 87 | } |
Dominika Molenda | 52cc3a9 | 2017-06-19 17:08:35 +0200 | [diff] [blame] | 88 | final String[] elements = address.split(":"); |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 89 | final byte[] addressInBytes = new byte[MacAddress.MAC_ADDRESS_LENGTH]; |
| 90 | for (int i = 0; i < MacAddress.MAC_ADDRESS_LENGTH; i++) { |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 91 | final String element = elements[i]; |
| 92 | addressInBytes[i] = (byte) Integer.parseInt(element, 16); |
| 93 | } |
| 94 | |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 95 | return new MacAddress(addressInBytes); |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Returns a MAC address instance representing the specified {@code byte} |
| 100 | * array. |
| 101 | * |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 102 | * @param address the byte array to be parsed. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 103 | * @return a MAC address instance representing the specified {@code byte} |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 104 | * array. |
| 105 | * @throws IllegalArgumentException if the byte array cannot be parsed as a MAC address. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 106 | */ |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 107 | public static MacAddress valueOf(final byte[] address) { |
| 108 | if (address.length != MacAddress.MAC_ADDRESS_LENGTH) { |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 109 | throw new IllegalArgumentException("the length is not " |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 110 | + MacAddress.MAC_ADDRESS_LENGTH); |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 111 | } |
| 112 | |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 113 | return new MacAddress(address); |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Returns a MAC address instance representing the specified {@code long} |
| 118 | * value. The lower 48 bits of the long value are used to parse as a MAC |
| 119 | * address. |
| 120 | * |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 121 | * @param address the long value to be parsed. The lower 48 bits are used for a |
| 122 | * MAC address. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 123 | * @return a MAC address instance representing the specified {@code long} |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 124 | * value. |
| 125 | * @throws IllegalArgumentException if the long value cannot be parsed as a MAC address. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 126 | */ |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 127 | public static MacAddress valueOf(final long address) { |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 128 | final byte[] addressInBytes = new byte[]{ |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 129 | (byte) (address >> 40 & 0xff), (byte) (address >> 32 & 0xff), |
| 130 | (byte) (address >> 24 & 0xff), (byte) (address >> 16 & 0xff), |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 131 | (byte) (address >> 8 & 0xff), (byte) (address >> 0 & 0xff)}; |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 132 | |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 133 | return new MacAddress(addressInBytes); |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Returns the length of the {@code MACAddress}. |
| 138 | * |
| 139 | * @return the length of the {@code MACAddress}. |
| 140 | */ |
| 141 | public int length() { |
| 142 | return this.address.length; |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * Returns the value of the {@code MACAddress} as a {@code byte} array. |
| 147 | * |
| 148 | * @return the numeric value represented by this object after conversion to |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 149 | * type {@code byte} array. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 150 | */ |
| 151 | public byte[] toBytes() { |
| 152 | return Arrays.copyOf(this.address, this.address.length); |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Returns the value of the {@code MACAddress} as a {@code long}. |
| 157 | * |
| 158 | * @return the numeric value represented by this object after conversion to |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 159 | * type {@code long}. |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 160 | */ |
| 161 | public long toLong() { |
| 162 | long mac = 0; |
| 163 | for (int i = 0; i < 6; i++) { |
| 164 | final long t = (this.address[i] & 0xffL) << (5 - i) * 8; |
| 165 | mac |= t; |
| 166 | } |
| 167 | return mac; |
| 168 | } |
| 169 | |
| 170 | /** |
| 171 | * Returns {@code true} if the MAC address is the broadcast address. |
| 172 | * |
| 173 | * @return {@code true} if the MAC address is the broadcast address. |
| 174 | */ |
| 175 | public boolean isBroadcast() { |
| 176 | for (final byte b : this.address) { |
| 177 | if (b != -1) { |
| 178 | return false; |
| 179 | } |
| 180 | } |
| 181 | return true; |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Returns {@code true} if the MAC address is the multicast address. |
| 186 | * |
| 187 | * @return {@code true} if the MAC address is the multicast address. |
| 188 | */ |
| 189 | public boolean isMulticast() { |
| 190 | if (this.isBroadcast()) { |
| 191 | return false; |
| 192 | } |
| 193 | return (this.address[0] & 0x01) != 0; |
| 194 | } |
| 195 | |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 196 | /** |
| 197 | * Returns true if this MAC address is link local. |
| 198 | * |
| 199 | * @return true if link local |
Charles Chan | 928ff8b | 2017-05-04 12:22:54 -0700 | [diff] [blame] | 200 | * @deprecated in Kingfisher release. Link local is not a correct description for |
| 201 | * this MAC address. Replaced with {@link #isLldp()} |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 202 | */ |
Charles Chan | 928ff8b | 2017-05-04 12:22:54 -0700 | [diff] [blame] | 203 | @Deprecated |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 204 | public boolean isLinkLocal() { |
Charles Chan | 928ff8b | 2017-05-04 12:22:54 -0700 | [diff] [blame] | 205 | return isLldp(); |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Returns true if this MAC address is used by link layer discovery protocol. |
| 210 | * |
| 211 | * @return true if this MAC is LLDP MAC. |
| 212 | */ |
| 213 | public boolean isLldp() { |
| 214 | return LLDP.contains(this); |
| 215 | } |
| 216 | |
| 217 | /** |
| 218 | * Returns true if the Organizationally Unique Identifier (OUI) of this MAC |
| 219 | * address matches ONOS OUI. |
| 220 | * |
| 221 | * @return true if the OUI of this MAC address matches ONOS OUI. |
| 222 | */ |
| 223 | public boolean isOnos() { |
| 224 | return Arrays.equals(this.oui(), ONOS.oui()); |
| 225 | } |
| 226 | |
| 227 | /** |
| 228 | * Returns the Organizationally Unique Identifier (OUI) of this MAC address. |
| 229 | * |
| 230 | * @return the OUI of this MAC address. |
| 231 | */ |
| 232 | public byte[] oui() { |
| 233 | return Arrays.copyOfRange(this.address, 0, 3); |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 234 | } |
| 235 | |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 236 | @Override |
| 237 | public boolean equals(final Object o) { |
| 238 | if (o == this) { |
| 239 | return true; |
| 240 | } |
| 241 | |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 242 | if (!(o instanceof MacAddress)) { |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 243 | return false; |
| 244 | } |
| 245 | |
Ayaka Koshibe | a9c199f | 2014-09-16 16:21:40 -0700 | [diff] [blame] | 246 | final MacAddress other = (MacAddress) o; |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 247 | return Arrays.equals(this.address, other.address); |
| 248 | } |
| 249 | |
| 250 | @Override |
| 251 | public int hashCode() { |
Brian O'Connor | 8576c2a | 2014-11-19 16:49:26 -0800 | [diff] [blame] | 252 | return Long.hashCode(toLong()); |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 253 | } |
| 254 | |
| 255 | @Override |
| 256 | public String toString() { |
Yuta HIGUCHI | ed1ef3a | 2017-05-15 18:10:01 -0700 | [diff] [blame] | 257 | final StringBuilder builder = new StringBuilder(2 * 6 + 5); |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 258 | for (final byte b : this.address) { |
| 259 | if (builder.length() > 0) { |
Yuta HIGUCHI | ed1ef3a | 2017-05-15 18:10:01 -0700 | [diff] [blame] | 260 | builder.append(':'); |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 261 | } |
| 262 | builder.append(String.format("%02X", b & 0xFF)); |
| 263 | } |
| 264 | return builder.toString(); |
| 265 | } |
| 266 | |
| 267 | /** |
| 268 | * @return MAC address in string representation without colons (useful for |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 269 | * radix tree storage) |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 270 | */ |
| 271 | public String toStringNoColon() { |
| 272 | final StringBuilder builder = new StringBuilder(); |
| 273 | for (final byte b : this.address) { |
| 274 | builder.append(String.format("%02X", b & 0xFF)); |
| 275 | } |
| 276 | return builder.toString(); |
| 277 | } |
Dominika Molenda | 52cc3a9 | 2017-06-19 17:08:35 +0200 | [diff] [blame] | 278 | |
| 279 | private static boolean isValid(final String mac) { |
| 280 | Matcher matcher = MAC_PATTERN.matcher(mac); |
| 281 | return matcher.matches(); |
| 282 | } |
alshabib | c4901cd | 2014-09-05 16:50:40 -0700 | [diff] [blame] | 283 | } |