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.HashSet;
  13 import java.util.List;
  14 import java.util.Map.Entry;
  15
  16 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
  17 import org.opendaylight.lispflowmapping.implementation.dao.MappingServiceKeyUtil;
  18 import org.opendaylight.lispflowmapping.implementation.util.DAOMappingUtil;
  19 import org.opendaylight.lispflowmapping.implementation.util.LispAFIConvertor;
  20 import org.opendaylight.lispflowmapping.implementation.util.LispNotificationHelper;
  21 import org.opendaylight.lispflowmapping.interfaces.dao.ILispDAO;
  22 import org.opendaylight.lispflowmapping.interfaces.dao.IMappingServiceKey;
  23 import org.opendaylight.lispflowmapping.interfaces.dao.MappingEntry;
  24 import org.opendaylight.lispflowmapping.interfaces.dao.MappingServiceRLOCGroup;
  25 import org.opendaylight.lispflowmapping.interfaces.dao.MappingServiceSubscriberRLOC;
  26 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
  27 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.EidToLocatorRecord.Action;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.LcafTrafficEngineeringAddress;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.LispAFIAddress;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.MapRequest;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.eidrecords.EidRecord;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.eidtolocatorrecords.EidToLocatorRecord;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.eidtolocatorrecords.EidToLocatorRecordBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.lcaftrafficengineeringaddress.Hops;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.lispaddress.LispAddressContainer;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.locatorrecords.LocatorRecord;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.locatorrecords.LocatorRecordBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.mapreplymessage.MapReplyBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.maprequest.ItrRloc;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 public class MapResolver extends AbstractLispComponent implements IMapResolverAsync {
  45
  46     private static final int TTL_RLOC_TIMED_OUT = 1;
  47     private static final int TTL_NO_RLOC_KNOWN = 15;
  48     protected static final Logger LOG = LoggerFactory.getLogger(MapResolver.class);
  49
  50     private static final ConfigIni configIni = new ConfigIni();
  51     private static final String elpPolicy = configIni.getElpPolicy();
  52
  53     public MapResolver(ILispDAO dao) {
  54         this(dao, true, true);
  55     }
  56
  57     public MapResolver(ILispDAO dao, boolean authenticate, boolean iterateMask) {
  58         super(dao, authenticate, iterateMask);
  59     }
  60
  61     public void handleMapRequest(MapRequest request, boolean smr, IMapRequestResultHandler callback) {
  62         if (dao == null) {
  63             LOG.warn("handleMapRequest called while dao is uninitialized");
  64             return;
  65         }
  66         if (request.isPitr()) {
  67             if (request.getEidRecord().size() > 0) {
  68                 EidRecord eid = request.getEidRecord().get(0);
  69                 Object result = DAOMappingUtil.getLocatorsSpecificByEidRecord(eid, dao, ADDRESS_SUBKEY, shouldIterateMask());
  70                 if (result != null && result instanceof MappingServiceRLOCGroup) {
  71                     MappingServiceRLOCGroup locatorsGroup = (MappingServiceRLOCGroup) result;
  72                     if (locatorsGroup != null && locatorsGroup.getRecords().size() > 0) {
  73                         callback.handleNonProxyMapRequest(request,
  74                                 LispNotificationHelper.getTransportAddressFromContainer(locatorsGroup.getRecords().get(0).getLispAddressContainer()));
  75                     }
  76                 }
  77             }
  78
  79         } else {
  80             LispAFIAddress srcEid = null;
  81             if (request.getSourceEid() != null) {
  82                 srcEid = LispAFIConvertor.toAFI(request.getSourceEid().getLispAddressContainer());
  83             }
  84             MapReplyBuilder builder = new MapReplyBuilder();
  85             builder.setEchoNonceEnabled(false);
  86             builder.setProbe(false);
  87             builder.setSecurityEnabled(false);
  88             builder.setNonce(request.getNonce());
  89             builder.setEidToLocatorRecord(new ArrayList<EidToLocatorRecord>());
  90             for (EidRecord eid : request.getEidRecord()) {
  91                 EidToLocatorRecordBuilder recordBuilder = new EidToLocatorRecordBuilder();
  92                 Entry<IMappingServiceKey, List<MappingServiceRLOCGroup>> mapping = DAOMappingUtil.getMapping(srcEid, eid, dao);
  93                 recordBuilder.setRecordTtl(0);
  94                 recordBuilder.setAction(Action.NoAction);
  95                 recordBuilder.setAuthoritative(false);
  96                 recordBuilder.setMapVersion((short) 0);
  97                 recordBuilder.setMaskLength((short) mapping.getKey().getMask());
  98                 recordBuilder.setLispAddressContainer(mapping.getKey().getEID());
  99                 recordBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
 100                 List<MappingServiceRLOCGroup> locators = mapping.getValue();
 101                 if (locators != null && locators.size() > 0) {
 102                     List<ItrRloc> itrRlocs = request.getItrRloc();
 103                     addLocatorGroups(recordBuilder, locators, itrRlocs);
 104                     if (itrRlocs != null && itrRlocs.size() > 0) {
 105                         LispAddressContainer itrRloc = itrRlocs.get(0).getLispAddressContainer();
 106                         MappingServiceSubscriberRLOC subscriberRloc = new MappingServiceSubscriberRLOC(itrRloc);
 107                         HashSet<MappingServiceSubscriberRLOC> subscribers = getSubscribers(mapping.getKey().getEID(), mapping.getKey().getMask());
 108                         if (subscribers == null) {
 109                             subscribers = new HashSet<MappingServiceSubscriberRLOC>();
 110                         } else if (subscribers.contains(subscriberRloc)) {
 111                             /*
 112                              * If there is an entry already for this
 113                              * subscriberRloc, remove it, so that it gets the
 114                              * new timestamp
 115                              */
 116                             subscribers.remove(subscriberRloc);
 117                         }
 118                         if (smr) {
 119                             IMappingServiceKey key = MappingServiceKeyUtil.generateMappingServiceKey(mapping.getKey().getEID(),
 120                                     mapping.getKey().getMask());
 121                             LOG.trace("Adding new subscriber: " + subscriberRloc.toString());
 122                             subscribers.add(subscriberRloc);
 123                             dao.put(key, new MappingEntry<HashSet<MappingServiceSubscriberRLOC>>(SUBSCRIBERS_SUBKEY, subscribers));
 124                         }
 125                     }
 126                 } else {
 127                     recordBuilder.setAction(Action.NativelyForward);
 128                     if (shouldAuthenticate() && getPassword(eid.getLispAddressContainer(), eid.getMask()) != null) {
 129                         recordBuilder.setRecordTtl(TTL_RLOC_TIMED_OUT);
 130                     } else {
 131                         recordBuilder.setRecordTtl(TTL_NO_RLOC_KNOWN);
 132
 133                     }
 134                 }
 135                 builder.getEidToLocatorRecord().add(recordBuilder.build());
 136             }
 137
 138             callback.handleMapReply(builder.build());
 139         }
 140     }
 141
 142     private void addLocatorGroups(EidToLocatorRecordBuilder recordBuilder, List<MappingServiceRLOCGroup> rlocs, List<ItrRloc> itrRlocs) {
 143         for (MappingServiceRLOCGroup rloc : rlocs) {
 144             addLocators(recordBuilder, rloc, itrRlocs);
 145             recordBuilder.setRecordTtl(rloc.getTtl());
 146         }
 147     }
 148
 149     private void addLocators(EidToLocatorRecordBuilder recordBuilder, MappingServiceRLOCGroup locatorObject, List<ItrRloc> itrRlocs) {
 150         if (locatorObject == null) {
 151             return;
 152         }
 153
 154         recordBuilder.setAction(locatorObject.getAction());
 155         recordBuilder.setAuthoritative(locatorObject.isAuthoritative());
 156         recordBuilder.setRecordTtl(locatorObject.getTtl());
 157
 158         try {
 159             for (LocatorRecord record : locatorObject.getRecords()) {
 160                 LispAddressContainer container = record.getLispAddressContainer();
 161
 162                 // For non-ELP RLOCs, or when ELP policy is default, just add the locator and be done
 163                 if ((!(container.getAddress() instanceof LcafTrafficEngineeringAddress)) || elpPolicy.equalsIgnoreCase("default")) {
 164                     recordBuilder.getLocatorRecord().add(
 165                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
 166                                     .setWeight(record.getWeight()).setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
 167                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
 168                                     .setLispAddressContainer(container).build());
 169                     continue;
 170                 }
 171
 172                 LispAddressContainer nextHop = getNextELPHop((LcafTrafficEngineeringAddress) container.getAddress(), itrRlocs);
 173                 if (nextHop != null) {
 174                     java.lang.Short priority = record.getPriority();
 175                     if (elpPolicy.equalsIgnoreCase("both")) {
 176                         recordBuilder.getLocatorRecord().add(
 177                                 new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
 178                                         .setWeight(record.getWeight()).setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
 179                                         .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
 180                                         .setLispAddressContainer(container).build());
 181                         // Make the priority of the added simple locator lower so that ELP is used by default if
 182                         // the xTR understands ELP.  Exclude 255, since that means don't use for unicast forwarding
 183                         // XXX Complex cases like several ELPs with different priorities are not handled
 184                         if (priority != 254 || priority !=255) {
 185                             priority++;
 186                         }
 187                     }
 188                     // Build and add the simple RLOC
 189                     recordBuilder.getLocatorRecord().add(
 190                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
 191                             .setWeight(record.getWeight()).setPriority(priority).setMulticastWeight(record.getMulticastWeight())
 192                             .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
 193                             .setLispAddressContainer(nextHop).build());
 194                 }
 195             }
 196         } catch (ClassCastException cce) {
 197         }
 198     }
 199
 200     private LispAddressContainer getNextELPHop(LcafTrafficEngineeringAddress elp, List<ItrRloc> itrRlocs) {
 201         LispAddressContainer nextHop = null;
 202         List<Hops> hops = elp.getHops();
 203
 204         if (hops != null && hops.size() > 0) {
 205             // By default we return the first hop
 206             nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(0).getHop().getPrimitiveAddress()));
 207             for (Hops hop : hops) {
 208                 LispAddressContainer hopContainer = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hop.getHop().getPrimitiveAddress()));
 209                 for (ItrRloc itrRloc : itrRlocs) {
 210                     if (itrRloc.getLispAddressContainer().equals(hopContainer)) {
 211                         int i = hops.indexOf(hop);
 212                         if (i < hops.size() - 1) {
 213                             nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(i+1).getHop().getPrimitiveAddress()));
 214                             return nextHop;
 215                         }
 216                     }
 217                 }
 218             }
 219         }
 220
 221         return nextHop;
 222     }
 223
 224 }