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