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