Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-present Open Networking Laboratory |
| 3 | * |
| 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 |
| 7 | * |
| 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. |
| 15 | */ |
| 16 | package org.onosproject.provider.lisp.mapping.util; |
| 17 | |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 18 | import com.google.common.collect.Lists; |
| 19 | import org.onlab.packet.IpAddress; |
| 20 | import org.onlab.packet.IpPrefix; |
| 21 | import org.onlab.packet.MacAddress; |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 22 | import org.onosproject.lisp.ctl.ExtensionMappingAddressInterpreter; |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 23 | import org.onosproject.lisp.msg.protocols.LispLocator; |
| 24 | import org.onosproject.lisp.msg.protocols.LispMapRecord; |
| 25 | import org.onosproject.lisp.msg.types.LispAfiAddress; |
| 26 | import org.onosproject.lisp.msg.types.LispAsAddress; |
| 27 | import org.onosproject.lisp.msg.types.LispDistinguishedNameAddress; |
| 28 | import org.onosproject.lisp.msg.types.LispIpv4Address; |
| 29 | import org.onosproject.lisp.msg.types.LispIpv6Address; |
| 30 | import org.onosproject.lisp.msg.types.LispMacAddress; |
Jian Li | 0f0d748 | 2017-03-20 15:16:13 +0900 | [diff] [blame] | 31 | import org.onosproject.lisp.msg.types.lcaf.LispLcafAddress; |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 32 | import org.onosproject.mapping.DefaultMapping; |
| 33 | import org.onosproject.mapping.DefaultMappingEntry; |
| 34 | import org.onosproject.mapping.DefaultMappingKey; |
| 35 | import org.onosproject.mapping.DefaultMappingTreatment; |
| 36 | import org.onosproject.mapping.DefaultMappingValue; |
| 37 | import org.onosproject.mapping.Mapping; |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 38 | import org.onosproject.mapping.MappingEntry; |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 39 | import org.onosproject.mapping.MappingEntry.MappingEntryState; |
| 40 | import org.onosproject.mapping.MappingKey; |
| 41 | import org.onosproject.mapping.MappingTreatment; |
| 42 | import org.onosproject.mapping.MappingValue; |
| 43 | import org.onosproject.mapping.actions.MappingAction; |
| 44 | import org.onosproject.mapping.actions.MappingActions; |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 45 | import org.onosproject.mapping.addresses.ExtensionMappingAddress; |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 46 | import org.onosproject.mapping.addresses.MappingAddress; |
| 47 | import org.onosproject.mapping.addresses.MappingAddresses; |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 48 | import org.onosproject.net.Device; |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 49 | import org.onosproject.net.DeviceId; |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 50 | import org.onosproject.net.device.DeviceService; |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 51 | import org.slf4j.Logger; |
| 52 | import org.slf4j.LoggerFactory; |
| 53 | |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 54 | import java.util.List; |
| 55 | import java.util.UUID; |
| 56 | |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 57 | import static org.onosproject.mapping.addresses.ExtensionMappingAddressType.ExtensionMappingAddressTypes.*; |
| 58 | |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 59 | /** |
| 60 | * Mapping entry builder class. |
| 61 | */ |
| 62 | public class MappingEntryBuilder { |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 63 | private static final Logger log = |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 64 | LoggerFactory.getLogger(MappingEntryBuilder.class); |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 65 | |
| 66 | private static final int IPV4_PREFIX_LENGTH = 32; |
| 67 | private static final int IPV6_PREFIX_LENGTH = 128; |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 68 | |
| 69 | private final DeviceId deviceId; |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 70 | |
| 71 | private final MappingAddress address; |
| 72 | private final MappingAction action; |
| 73 | private final List<MappingTreatment> treatments; |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 74 | |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 75 | private final DeviceService deviceService; |
| 76 | |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 77 | /** |
| 78 | * Default constructor for MappingEntryBuilder. |
| 79 | * |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 80 | * @param deviceId device identifier |
| 81 | * @param record LISP map record |
| 82 | * @param deviceService device service |
| 83 | */ |
| 84 | public MappingEntryBuilder(DeviceId deviceId, LispMapRecord record, |
| 85 | DeviceService deviceService) { |
| 86 | this.deviceId = deviceId; |
| 87 | this.address = buildAddress(record); |
| 88 | this.action = buildAction(record); |
| 89 | this.treatments = buildTreatments(record); |
| 90 | this.deviceService = deviceService; |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * Default constructor for MappingEntryBuilder. |
| 95 | * |
| 96 | * @param deviceId device identifier |
| 97 | * @param record LISP map record |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 98 | */ |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 99 | public MappingEntryBuilder(DeviceId deviceId, LispMapRecord record) { |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 100 | this.deviceId = deviceId; |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 101 | this.address = buildAddress(record); |
| 102 | this.action = buildAction(record); |
| 103 | this.treatments = buildTreatments(record); |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 104 | this.deviceService = null; |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | /** |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 108 | * Builds mapping entry from a specific LISP control message. |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 109 | * |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 110 | * @return mapping entry |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 111 | */ |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 112 | public MappingEntry build() { |
| 113 | Mapping.Builder builder; |
| 114 | |
| 115 | // we assign leastSignificantBits of UUID as the mapping identifier for now |
| 116 | // id generation scheme can be changed later |
| 117 | UUID uuid = UUID.randomUUID(); |
| 118 | |
| 119 | builder = DefaultMapping.builder() |
| 120 | .withId(uuid.getLeastSignificantBits()) |
| 121 | .forDevice(deviceId) |
| 122 | .withKey(buildKey()) |
| 123 | .withValue(buildValue()); |
| 124 | |
| 125 | // TODO: we assume that the mapping entry will be always |
| 126 | // stored in routers without failure for now, which means |
| 127 | // the mapping entry state will always be ADDED rather than |
| 128 | // PENDING_ADD |
| 129 | // we will revisit this part when LISP driver is finished |
| 130 | return new DefaultMappingEntry(builder.build(), MappingEntryState.ADDED); |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 131 | } |
| 132 | |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 133 | /** |
| 134 | * Builds mapping key. |
| 135 | * |
| 136 | * @return mapping key |
| 137 | */ |
| 138 | private MappingKey buildKey() { |
| 139 | |
| 140 | MappingKey.Builder builder = DefaultMappingKey.builder(); |
| 141 | |
| 142 | builder.withAddress(address); |
| 143 | |
| 144 | return builder.build(); |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Builds mapping value. |
| 149 | * |
| 150 | * @return mapping value |
| 151 | */ |
| 152 | private MappingValue buildValue() { |
| 153 | |
| 154 | MappingValue.Builder builder = DefaultMappingValue.builder(); |
| 155 | builder.withAction(action); |
| 156 | |
| 157 | treatments.forEach(builder::add); |
| 158 | |
| 159 | return builder.build(); |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Builds mapping action. |
| 164 | * |
| 165 | * @param record LISP map record |
| 166 | * @return mapping action |
| 167 | */ |
| 168 | private MappingAction buildAction(LispMapRecord record) { |
| 169 | |
| 170 | if (record == null) { |
| 171 | return MappingActions.noAction(); |
| 172 | } |
| 173 | |
| 174 | switch (record.getAction()) { |
| 175 | case NoAction: |
| 176 | return MappingActions.noAction(); |
| 177 | case SendMapRequest: |
| 178 | return MappingActions.forward(); |
| 179 | case NativelyForward: |
| 180 | return MappingActions.nativeForward(); |
| 181 | case Drop: |
| 182 | return MappingActions.drop(); |
| 183 | default: |
| 184 | log.warn("Unsupported action type {}", record.getAction()); |
| 185 | return MappingActions.noAction(); |
| 186 | } |
| 187 | } |
| 188 | |
| 189 | /** |
| 190 | * Builds mapping address. |
| 191 | * |
| 192 | * @param record LISP map record |
| 193 | * @return mapping address |
| 194 | */ |
| 195 | private MappingAddress buildAddress(LispMapRecord record) { |
| 196 | |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 197 | return record == null ? null : getAddress(record.getEidPrefixAfi()); |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | /** |
| 201 | * Converts LispAfiAddress into abstracted mapping address. |
| 202 | * |
| 203 | * @param address LispAfiAddress |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 204 | * @return abstracted mapping address |
| 205 | */ |
Jian Li | 0f0d748 | 2017-03-20 15:16:13 +0900 | [diff] [blame] | 206 | private MappingAddress getAddress(LispAfiAddress address) { |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 207 | |
| 208 | if (address == null) { |
| 209 | log.warn("Address is not specified."); |
| 210 | return null; |
| 211 | } |
| 212 | |
| 213 | switch (address.getAfi()) { |
| 214 | case IP4: |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 215 | return afi2mapping(address); |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 216 | case IP6: |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 217 | return afi2mapping(address); |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 218 | case AS: |
| 219 | int asNum = ((LispAsAddress) address).getASNum(); |
| 220 | return MappingAddresses.asMappingAddress(String.valueOf(asNum)); |
| 221 | case DISTINGUISHED_NAME: |
| 222 | String dn = ((LispDistinguishedNameAddress) |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 223 | address).getDistinguishedName(); |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 224 | return MappingAddresses.dnMappingAddress(dn); |
| 225 | case MAC: |
| 226 | MacAddress macAddress = ((LispMacAddress) address).getAddress(); |
| 227 | return MappingAddresses.ethMappingAddress(macAddress); |
| 228 | case LCAF: |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 229 | return deviceService == null ? null : |
| 230 | lcaf2extension((LispLcafAddress) address); |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 231 | default: |
| 232 | log.warn("Unsupported address type {}", address.getAfi()); |
| 233 | break; |
| 234 | } |
| 235 | |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 236 | return null; |
| 237 | } |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 238 | |
| 239 | /** |
Jian Li | 0f0d748 | 2017-03-20 15:16:13 +0900 | [diff] [blame] | 240 | * Converts LCAF address to extension mapping address. |
| 241 | * |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 242 | * @param lcaf LCAF address |
Jian Li | 0f0d748 | 2017-03-20 15:16:13 +0900 | [diff] [blame] | 243 | * @return extension mapping address |
| 244 | */ |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 245 | private MappingAddress lcaf2extension(LispLcafAddress lcaf) { |
Jian Li | 0f0d748 | 2017-03-20 15:16:13 +0900 | [diff] [blame] | 246 | |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 247 | Device device = deviceService.getDevice(deviceId); |
| 248 | |
| 249 | ExtensionMappingAddressInterpreter addressInterpreter; |
| 250 | ExtensionMappingAddress mappingAddress = null; |
| 251 | if (device.is(ExtensionMappingAddressInterpreter.class)) { |
| 252 | addressInterpreter = device.as(ExtensionMappingAddressInterpreter.class); |
| 253 | } else { |
| 254 | addressInterpreter = null; |
| 255 | } |
| 256 | |
| 257 | switch (lcaf.getType()) { |
| 258 | case LIST: |
| 259 | if (addressInterpreter != null && |
| 260 | addressInterpreter.supported(LIST_ADDRESS.type())) { |
| 261 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 262 | } |
| 263 | break; |
| 264 | case SEGMENT: |
| 265 | if (addressInterpreter != null && |
| 266 | addressInterpreter.supported(SEGMENT_ADDRESS.type())) { |
| 267 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 268 | } |
| 269 | break; |
| 270 | case AS: |
| 271 | if (addressInterpreter != null && |
| 272 | addressInterpreter.supported(AS_ADDRESS.type())) { |
| 273 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 274 | } |
| 275 | break; |
| 276 | case APPLICATION_DATA: |
| 277 | if (addressInterpreter != null && |
| 278 | addressInterpreter.supported(APPLICATION_DATA_ADDRESS.type())) { |
| 279 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 280 | } |
| 281 | break; |
| 282 | case GEO_COORDINATE: |
| 283 | if (addressInterpreter != null && |
| 284 | addressInterpreter.supported(GEO_COORDINATE_ADDRESS.type())) { |
| 285 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 286 | } |
| 287 | break; |
| 288 | case NAT: |
| 289 | if (addressInterpreter != null && |
| 290 | addressInterpreter.supported(NAT_ADDRESS.type())) { |
| 291 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 292 | } |
| 293 | break; |
| 294 | case NONCE: |
| 295 | if (addressInterpreter != null && |
| 296 | addressInterpreter.supported(NONCE_ADDRESS.type())) { |
| 297 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 298 | } |
| 299 | break; |
| 300 | case MULTICAST: |
| 301 | if (addressInterpreter != null && |
| 302 | addressInterpreter.supported(MULTICAST_ADDRESS.type())) { |
| 303 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 304 | } |
| 305 | break; |
| 306 | case TRAFFIC_ENGINEERING: |
| 307 | if (addressInterpreter != null && |
| 308 | addressInterpreter.supported(TRAFFIC_ENGINEERING_ADDRESS.type())) { |
| 309 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 310 | } |
| 311 | break; |
| 312 | case SOURCE_DEST: |
| 313 | if (addressInterpreter != null && |
| 314 | addressInterpreter.supported(SOURCE_DEST_ADDRESS.type())) { |
| 315 | mappingAddress = addressInterpreter.mapLcafAddress(lcaf); |
| 316 | } |
| 317 | break; |
| 318 | default: |
| 319 | log.warn("Unsupported extension mapping address type {}", lcaf.getType()); |
| 320 | break; |
| 321 | } |
| 322 | |
| 323 | return mappingAddress != null ? |
| 324 | MappingAddresses.extensionMappingAddressWrapper(mappingAddress, deviceId) : null; |
Jian Li | 0f0d748 | 2017-03-20 15:16:13 +0900 | [diff] [blame] | 325 | } |
| 326 | |
| 327 | /** |
| 328 | * Converts AFI address to generalized mapping address. |
| 329 | * |
| 330 | * @param afiAddress IP typed AFI address |
| 331 | * @return generalized mapping address |
| 332 | */ |
Jian Li | e5aa5df | 2017-04-02 22:40:56 +0900 | [diff] [blame] | 333 | private MappingAddress afi2mapping(LispAfiAddress afiAddress) { |
Jian Li | 0f0d748 | 2017-03-20 15:16:13 +0900 | [diff] [blame] | 334 | switch (afiAddress.getAfi()) { |
| 335 | case IP4: |
| 336 | IpAddress ipv4Address = ((LispIpv4Address) afiAddress).getAddress(); |
| 337 | IpPrefix ipv4Prefix = IpPrefix.valueOf(ipv4Address, IPV4_PREFIX_LENGTH); |
| 338 | return MappingAddresses.ipv4MappingAddress(ipv4Prefix); |
| 339 | case IP6: |
| 340 | IpAddress ipv6Address = ((LispIpv6Address) afiAddress).getAddress(); |
| 341 | IpPrefix ipv6Prefix = IpPrefix.valueOf(ipv6Address, IPV6_PREFIX_LENGTH); |
| 342 | return MappingAddresses.ipv6MappingAddress(ipv6Prefix); |
| 343 | default: |
| 344 | log.warn("Only support to convert IP address type"); |
| 345 | break; |
| 346 | } |
| 347 | return null; |
| 348 | } |
| 349 | |
| 350 | /** |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 351 | * Builds a collection of mapping treatments. |
| 352 | * |
| 353 | * @param record LISP map record |
| 354 | * @return a collection of mapping treatments |
| 355 | */ |
| 356 | private List<MappingTreatment> buildTreatments(LispMapRecord record) { |
| 357 | |
| 358 | List<LispLocator> locators = record.getLocators(); |
| 359 | List<MappingTreatment> treatments = Lists.newArrayList(); |
| 360 | for (LispLocator locator : locators) { |
| 361 | MappingTreatment.Builder builder = DefaultMappingTreatment.builder(); |
| 362 | LispAfiAddress address = locator.getLocatorAfi(); |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 363 | |
Jian Li | 0f0d748 | 2017-03-20 15:16:13 +0900 | [diff] [blame] | 364 | final MappingAddress mappingAddress = getAddress(address); |
Jian Li | b8436bb | 2017-02-23 03:39:08 +0900 | [diff] [blame] | 365 | if (mappingAddress != null) { |
| 366 | builder.withAddress(mappingAddress); |
| 367 | } |
| 368 | |
| 369 | builder.setUnicastWeight(locator.getWeight()) |
| 370 | .setUnicastPriority(locator.getPriority()) |
| 371 | .setMulticastWeight(locator.getMulticastWeight()) |
| 372 | .setMulticastPriority(locator.getMulticastPriority()); |
| 373 | |
| 374 | // TODO: need to convert specific properties to |
| 375 | // abstracted extension properties |
| 376 | |
| 377 | treatments.add(builder.build()); |
| 378 | } |
| 379 | |
| 380 | return treatments; |
| 381 | } |
Jian Li | 77d6e75 | 2017-01-29 23:24:18 +0900 | [diff] [blame] | 382 | } |