mappingservice/implementation/src/main/java/org/opendaylight/lispflowmapping/implementation/lisp/MapResolver.java

   1 /*
   2  * Copyright (c) 2014 Contextream, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.lispflowmapping.implementation.lisp;
  10
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.Set;
  14
  15 import org.apache.commons.lang3.exception.ExceptionUtils;
  16 import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
  17 import org.opendaylight.lispflowmapping.interfaces.dao.SubscriberRLOC;
  18 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
  19 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
  20 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
  21 import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
  22 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
  23 import org.opendaylight.lispflowmapping.lisp.util.SourceDestKeyHelper;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.SimpleAddress;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.SourceDestKeyLcaf;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.ExplicitLocatorPath;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.explicit.locator.path.explicit.locator.path.Hop;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv4BinaryAfi;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv6BinaryAfi;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItem;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecord;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord.Action;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecordBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItem;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItemBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.ItrRloc;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 import com.google.common.base.Preconditions;
  50 import com.google.common.collect.Sets;
  51
  52 public class MapResolver implements IMapResolverAsync {
  53     protected static final Logger LOG = LoggerFactory.getLogger(MapResolver.class);
  54
  55     private static final int TTL_RLOC_TIMED_OUT = 1;
  56     private static final int TTL_NO_RLOC_KNOWN = 15;
  57
  58     private IMappingService mapService;
  59     private boolean subscriptionService;
  60     private String elpPolicy;
  61     private IMapRequestResultHandler requestHandler;
  62     private boolean authenticate = true;
  63
  64     public MapResolver(IMappingService mapService, boolean smr, String elpPolicy,
  65             IMapRequestResultHandler requestHandler) {
  66         Preconditions.checkNotNull(mapService);
  67         this.subscriptionService = smr;
  68         this.mapService = mapService;
  69         this.elpPolicy = elpPolicy;
  70         this.requestHandler = requestHandler;
  71     }
  72
  73     public void handleMapRequest(MapRequest request) {
  74         // SMRs and RLOC probes are directed towards xTRs and we're a Map-Resolver here, so ignore them
  75         if (request.isSmr() != null && request.isSmr()) {
  76             LOG.debug("Map-Resolver ignoring incoming SMR control message.");
  77             return;
  78         }
  79         if (request.isProbe() != null && request.isProbe()) {
  80             LOG.debug("Map-Resolver ignoring incoming RLOC probe control message.");
  81             return;
  82         }
  83         Eid srcEid = null;
  84         if (request.getSourceEid() != null) {
  85             srcEid = request.getSourceEid().getEid();
  86         }
  87         MapReplyBuilder replyBuilder = new MapReplyBuilder();
  88         replyBuilder.setEchoNonceEnabled(false);
  89         replyBuilder.setProbe(false);
  90         replyBuilder.setSecurityEnabled(false);
  91         replyBuilder.setNonce(request.getNonce());
  92         replyBuilder.setMappingRecordItem(new ArrayList<MappingRecordItem>());
  93         for (EidItem eidRecord : request.getEidItem()) {
  94             MappingRecord mapping = (MappingRecord) mapService.getMapping(srcEid,
  95                     eidRecord.getEid());
  96             if (mapping != null) {
  97                 List<ItrRloc> itrRlocs = request.getItrRloc();
  98                 if (itrRlocs != null && itrRlocs.size() != 0) {
  99                     if (subscriptionService) {
 100                         updateSubscribers(itrRlocs.get(0).getRloc(), eidRecord.getEid(), mapping.getEid(), srcEid);
 101                     }
 102                     mapping = updateLocators(mapping, itrRlocs);
 103                 }
 104                 mapping = fixIfNotSDRequest(mapping, eidRecord.getEid());
 105             } else {
 106                 mapping = getNegativeMapping(eidRecord.getEid());
 107             }
 108             replyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder().setMappingRecord(mapping).build());
 109         }
 110         requestHandler.handleMapReply(replyBuilder.build());
 111     }
 112
 113     private MappingRecord getNegativeMapping(Eid eid) {
 114         MappingRecordBuilder recordBuilder = new MappingRecordBuilder();
 115         recordBuilder.setAuthoritative(false);
 116         recordBuilder.setMapVersion((short) 0);
 117         if (eid.getAddressType().equals(Ipv4BinaryAfi.class) || eid.getAddressType().equals(Ipv6BinaryAfi.class)) {
 118             recordBuilder.setEid(mapService.getWidestNegativePrefix(eid));
 119         } else {
 120             recordBuilder.setEid(eid);
 121         }
 122         recordBuilder.setAction(Action.NativelyForward);
 123         if (authenticate && mapService.getAuthenticationKey(eid) != null) {
 124             recordBuilder.setRecordTtl(TTL_RLOC_TIMED_OUT);
 125         } else {
 126             recordBuilder.setRecordTtl(TTL_NO_RLOC_KNOWN);
 127         }
 128         return recordBuilder.build();
 129     }
 130
 131     private void updateSubscribers(Rloc itrRloc, Eid reqEid, Eid mapEid, Eid srcEid) {
 132         SubscriberRLOC subscriberRloc = new SubscriberRLOC(itrRloc, srcEid);
 133         Eid subscribedEid = mapEid;
 134
 135         // If the eid in the matched mapping is SourceDest and the requested eid IS NOT then we subscribe itrRloc only
 136         // to dst from the src/dst since that what's been requested. Note though that any updates to to the src/dst
 137         // mapping will be pushed to dst as well (see sendSMRs in MapServer)
 138         if (mapEid.getAddressType().equals(SourceDestKeyLcaf.class)
 139                 && !reqEid.getAddressType().equals(SourceDestKeyLcaf.class)) {
 140             subscribedEid = SourceDestKeyHelper.getDstBinary(mapEid);
 141         }
 142
 143         Set<SubscriberRLOC> subscribers = getSubscribers(subscribedEid);
 144         if (subscribers == null) {
 145             subscribers = Sets.newConcurrentHashSet();
 146         } else if (subscribers.contains(subscriberRloc)) {
 147             // If there is an entry already for this subscriberRloc, remove it, so that it gets the new
 148             // timestamp
 149             subscribers.remove(subscriberRloc);
 150         }
 151         if (LOG.isTraceEnabled()) {
 152             LOG.trace("Adding new subscriber: " + LispAddressStringifier.getString(subscriberRloc.getSrcRloc()));
 153         }
 154         subscribers.add(subscriberRloc);
 155         addSubscribers(subscribedEid, subscribers);
 156     }
 157
 158     // Fixes mapping if request was for simple dst EID but the matched mapping is a SourceDest
 159     private MappingRecord fixIfNotSDRequest(MappingRecord mapping, Eid dstEid) {
 160         if (mapping.getEid().getAddress() instanceof SourceDestKey
 161                 && !(dstEid.getAddress() instanceof SourceDestKey)) {
 162             return new MappingRecordBuilder(mapping).setEid(
 163                     SourceDestKeyHelper.getDstBinary(mapping.getEid())).build();
 164         }
 165         return mapping;
 166     }
 167
 168     private boolean locatorsNeedFixing(List<LocatorRecord> locatorRecords) {
 169         for (LocatorRecord record : locatorRecords) {
 170             if (record.getRloc().getAddress() instanceof ExplicitLocatorPath) {
 171                 return true;
 172             }
 173         }
 174         return false;
 175     }
 176
 177     // Process locators according to configured policy
 178     private MappingRecord updateLocators(MappingRecord mapping, List<ItrRloc> itrRlocs) {
 179         // no fixing if elpPolicy is default
 180         if (elpPolicy.equalsIgnoreCase("default")) {
 181             return mapping;
 182         }
 183
 184         List<LocatorRecord> locatorRecords = mapping.getLocatorRecord();
 185
 186         // if no updated is needed, just return the mapping
 187         if (!locatorsNeedFixing(locatorRecords)) {
 188             return mapping;
 189         }
 190
 191         MappingRecordBuilder recordBuilder = new MappingRecordBuilder(mapping);
 192         recordBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
 193         try {
 194             for (LocatorRecord record : locatorRecords) {
 195                 Rloc container = record.getRloc();
 196
 197                 // For non-ELP RLOCs, or when ELP policy is default, or itrRlocs is null, just add the locator and be
 198                 // done
 199                 if ((!(container.getAddress() instanceof ExplicitLocatorPath))
 200                         || elpPolicy.equalsIgnoreCase("default") || itrRlocs == null) {
 201                     recordBuilder.getLocatorRecord().add(
 202                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
 203                                     .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
 204                                     .setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
 205                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
 206                                     .setRloc(container).setLocatorId(record.getLocatorId()).build());
 207                     continue;
 208                 }
 209
 210                 ExplicitLocatorPath teAddress = ((ExplicitLocatorPath) container.getAddress());
 211                 SimpleAddress nextHop = getNextELPHop(teAddress, itrRlocs);
 212                 if (nextHop != null) {
 213                     java.lang.Short priority = record.getPriority();
 214                     if (elpPolicy.equalsIgnoreCase("both")) {
 215                         recordBuilder.getLocatorRecord().add(
 216                                 new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
 217                                         .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
 218                                         .setPriority(record.getPriority())
 219                                         .setMulticastWeight(record.getMulticastWeight())
 220                                         .setMulticastPriority(record.getMulticastPriority())
 221                                         .setRouted(record.isRouted()).setRloc(container)
 222                                         .setLocatorId(record.getLocatorId()).build());
 223                         // Make the priority of the added simple locator lower so that ELP is used by default if
 224                         // the xTR understands ELP. Exclude 255, since that means don't use for unicast forwarding
 225                         // XXX Complex cases like several ELPs with different priorities are not handled
 226                         if (priority != 254 || priority != 255) {
 227                             priority++;
 228                         }
 229                     }
 230                     // Build and add the simple RLOC
 231                     recordBuilder.getLocatorRecord().add(
 232                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
 233                                     .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
 234                                     .setPriority(priority).setMulticastWeight(record.getMulticastWeight())
 235                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
 236                                     .setRloc(LispAddressUtil.toRloc(nextHop))
 237                                     .setLocatorId(record.getLocatorId()).build());
 238                 }
 239             }
 240         } catch (ClassCastException cce) {
 241             LOG.error("Class Cast Exception while building EidToLocatorRecord: {}", ExceptionUtils.getStackTrace(cce));
 242         }
 243
 244         return recordBuilder.build();
 245     }
 246
 247     private SimpleAddress getNextELPHop(ExplicitLocatorPath elp, List<ItrRloc> itrRlocs) {
 248         SimpleAddress nextHop = null;
 249         List<Hop> hops = elp.getExplicitLocatorPath().getHop();
 250
 251         if (hops != null && hops.size() > 0) {
 252             // By default we return the first hop
 253             nextHop = hops.get(0).getAddress();
 254             for (Hop hop : hops) {
 255                 Address hopAddress = LispAddressUtil.addressFromSimpleAddress(hop.getAddress());
 256                 for (ItrRloc itrRloc : itrRlocs) {
 257                     if (itrRloc.getRloc().getAddress().equals(hopAddress)) {
 258                         int i = hops.indexOf(hop);
 259                         if (i < hops.size() - 1) {
 260                             nextHop = hops.get(i + 1).getAddress();
 261                             return nextHop;
 262                         }
 263                     }
 264                 }
 265             }
 266         }
 267
 268         return nextHop;
 269     }
 270
 271     @SuppressWarnings("unchecked")
 272     private Set<SubscriberRLOC> getSubscribers(Eid address) {
 273         return (Set<SubscriberRLOC>) mapService.getData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
 274     }
 275
 276     private void addSubscribers(Eid address, Set<SubscriberRLOC> subscribers) {
 277         mapService.addData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS, subscribers);
 278     }
 279
 280     @Override
 281     public void setSubscriptionService(boolean smr) {
 282         subscriptionService = smr;
 283     }
 284
 285     @Override
 286     public void setElpPolicy(String elpPolicy) {
 287         this.elpPolicy = elpPolicy;
 288     }
 289
 290     @Override
 291     public void setShouldAuthenticate(boolean shouldAuthenticate) {
 292         this.authenticate = shouldAuthenticate;
 293     }
 294 }