Make some improvements
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / lisp / MapResolver.java
index babfc7f7bd38dc3df5baf978bb0a78e450b13d40..98cea8f77e28e5bb3824690fa5a90cac61d17ba4 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014 Contextream, Inc. and others.  All rights reserved.
+ * Copyright (c) 2014, 2017 Contextream, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -8,57 +8,64 @@
 
 package org.opendaylight.lispflowmapping.implementation.lisp;
 
+import com.google.common.base.Preconditions;
+import com.google.common.collect.Lists;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Set;
-
 import org.apache.commons.lang3.exception.ExceptionUtils;
-import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
-import org.opendaylight.lispflowmapping.interfaces.dao.SubscriberRLOC;
+import org.opendaylight.lispflowmapping.interfaces.dao.Subscriber;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
+import org.opendaylight.lispflowmapping.interfaces.lisp.ISmrNotificationListener;
+import org.opendaylight.lispflowmapping.interfaces.lisp.SmrEvent;
 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
+import org.opendaylight.lispflowmapping.lisp.type.MappingData;
 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
+import org.opendaylight.lispflowmapping.lisp.util.MappingRecordUtil;
 import org.opendaylight.lispflowmapping.lisp.util.SourceDestKeyHelper;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv4Afi;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv4PrefixAfi;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv6Afi;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv6PrefixAfi;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.SimpleAddress;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.SourceDestKeyLcaf;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.ExplicitLocatorPath;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.NoAddress;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
 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;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.IpAddressBinary;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv4BinaryAfi;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv4PrefixBinaryAfi;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv6BinaryAfi;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv6PrefixBinaryAfi;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItem;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecord;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord.Action;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecordBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItem;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItemBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.ItrRloc;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.base.Preconditions;
-import com.google.common.collect.Sets;
-
 public class MapResolver implements IMapResolverAsync {
-    protected static final Logger LOG = LoggerFactory.getLogger(MapResolver.class);
-
-    private static final int TTL_RLOC_TIMED_OUT = 1;
-    private static final int TTL_NO_RLOC_KNOWN = 15;
+    private static final Logger LOG = LoggerFactory.getLogger(MapResolver.class);
 
     private IMappingService mapService;
     private boolean subscriptionService;
     private String elpPolicy;
     private IMapRequestResultHandler requestHandler;
     private boolean authenticate = true;
+    private ISmrNotificationListener smrNotificationListener;
+    private static final int TTL_DELETE_MAPPING = 0;
 
     public MapResolver(IMappingService mapService, boolean smr, String elpPolicy,
-            IMapRequestResultHandler requestHandler) {
+                       IMapRequestResultHandler requestHandler) {
         Preconditions.checkNotNull(mapService);
         this.subscriptionService = smr;
         this.mapService = mapService;
@@ -67,6 +74,27 @@ public class MapResolver implements IMapResolverAsync {
     }
 
     public void handleMapRequest(MapRequest request) {
+        LOG.trace("Map-Request received: {}", request);
+        // SMRs and RLOC probes are directed towards xTRs and we're a Map-Resolver here, so ignore them
+        if (request.isSmr() != null && request.isSmr()) {
+            LOG.debug("Map-Resolver ignoring incoming SMR control message.");
+            return;
+        }
+        if (request.isProbe() != null && request.isProbe()) {
+            LOG.debug("Map-Resolver ignoring incoming RLOC probe control message.");
+            return;
+        }
+        if (request.isSmrInvoked()) {
+            LOG.debug("SMR-invoked request received.");
+            LOG.trace("Map-Request object: {}", request);
+            for (EidItem eidItem : request.getEidItem()) {
+                final SmrEvent event = new SmrEvent(
+                        subscriberListFromItrRlocs(request.getItrRloc(), request.getSourceEid().getEid()),
+                        eidItem.getEid(),
+                        request.getNonce());
+                smrNotificationListener.onSmrInvokedReceived(event);
+            }
+        }
         Eid srcEid = null;
         if (request.getSourceEid() != null) {
             srcEid = request.getSourceEid().getEid();
@@ -76,43 +104,93 @@ public class MapResolver implements IMapResolverAsync {
         replyBuilder.setProbe(false);
         replyBuilder.setSecurityEnabled(false);
         replyBuilder.setNonce(request.getNonce());
-        replyBuilder.setMappingRecordItem(new ArrayList<MappingRecordItem>());
+        replyBuilder.setMappingRecordItem(new ArrayList<>());
+        List<ItrRloc> itrRlocs = request.getItrRloc();
+        final IpAddressBinary sourceRloc = request.getSourceRloc();
+
         for (EidItem eidRecord : request.getEidItem()) {
-            MappingRecord mapping = (MappingRecord) mapService.getMapping(srcEid,
-                    eidRecord.getEid());
-            if (mapping != null) {
-                List<ItrRloc> itrRlocs = request.getItrRloc();
-                if (itrRlocs != null && itrRlocs.size() != 0) {
-                    if (subscriptionService) {
-                        updateSubscribers(itrRlocs.get(0).getRloc(), eidRecord.getEid(), mapping.getEid(), srcEid);
-                    }
-                    mapping = updateLocators(mapping, itrRlocs);
-                }
-                mapping = fixIfNotSDRequest(mapping, eidRecord.getEid());
+            MappingData mappingData = mapService.getMapping(srcEid, eidRecord.getEid());
+            MappingRecord mapping;
+            if (mappingData == null) {
+                mapping = mapService.addNegativeMapping(eidRecord.getEid()).getRecord();
             } else {
-                mapping = getNegativeMapping(eidRecord.getEid());
+                mapping = mappingData.getRecord();
             }
+
+            if (itrRlocs != null && itrRlocs.size() != 0) {
+                if (subscriptionService && isValidSourceEidForSubscriber(srcEid)) {
+                    final Rloc resolvedRloc = resolveRloc(itrRlocs, sourceRloc);
+                    updateSubscribers(resolvedRloc, eidRecord.getEid(), mapping.getEid(),
+                            srcEid, mapping.getRecordTtl());
+                }
+                mapping = updateLocators(mapping, itrRlocs);
+            }
+            mapping = fixIfNotSDRequest(mapping, eidRecord.getEid());
+            mapping = fixTtlIfSmrInvoked(request, mapping);
             replyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder().setMappingRecord(mapping).build());
         }
         requestHandler.handleMapReply(replyBuilder.build());
     }
 
-    private MappingRecord getNegativeMapping(Eid eid) {
-        MappingRecordBuilder recordBuilder = new MappingRecordBuilder();
-        recordBuilder.setAuthoritative(false);
-        recordBuilder.setMapVersion((short) 0);
-        recordBuilder.setEid(eid);
-        recordBuilder.setAction(Action.NativelyForward);
-        if (authenticate && mapService.getAuthenticationKey(eid) != null) {
-            recordBuilder.setRecordTtl(TTL_RLOC_TIMED_OUT);
+    private static boolean isEqualIpVersion(IpAddressBinary srcRloc, Rloc rloc) {
+        if (srcRloc.getIpv4AddressBinary() != null) {
+            if (rloc.getAddressType() == Ipv4Afi.class
+                    || rloc.getAddressType() == Ipv4BinaryAfi.class
+                    || rloc.getAddressType() == Ipv4PrefixAfi.class
+                    || rloc.getAddressType() == Ipv4PrefixBinaryAfi.class) {
+                return true;
+            }
+        } else if (rloc.getAddressType() == Ipv6Afi.class
+                || rloc.getAddressType() == Ipv6BinaryAfi.class
+                || rloc.getAddressType() == Ipv6PrefixAfi.class
+                || rloc.getAddressType() == Ipv6PrefixBinaryAfi.class) {
+            return true;
+        }
+        return false;
+    }
+
+    private static boolean isValidSourceEidForSubscriber(Eid eid) {
+        if (eid == null || eid.getAddress() instanceof NoAddress) {
+            return false;
+        }
+        return true;
+    }
+
+    private Rloc resolveRloc(List<ItrRloc> itrRlocList, IpAddressBinary srcRloc) {
+        if (srcRloc == null) {
+            return itrRlocList.get(0).getRloc();
+        }
+        byte[] srcRlocByte;
+        if (srcRloc.getIpv4AddressBinary() != null) {
+            srcRlocByte = srcRloc.getIpv4AddressBinary().getValue();
         } else {
-            recordBuilder.setRecordTtl(TTL_NO_RLOC_KNOWN);
+            srcRlocByte = srcRloc.getIpv6AddressBinary().getValue();
+        }
+
+        Rloc equalIpvRloc = null;
+        for (ItrRloc itrRloc : itrRlocList) {
+            final Rloc rloc = itrRloc.getRloc();
+            final byte[] itrRlocByte = LispAddressUtil.ipAddressToByteArray(rloc.getAddress());
+
+            // return an Rloc equal to the source Rloc
+            if (itrRlocByte != null && LispAddressUtil.compareIpAddressByteArrays(srcRlocByte, itrRlocByte) == 0) {
+                return rloc;
+            }
+            // else lookup the first Rloc with identical Ip version
+            if (equalIpvRloc == null && isEqualIpVersion(srcRloc, rloc)) {
+                equalIpvRloc = rloc;
+            }
+        }
+        if (equalIpvRloc != null) {
+            return equalIpvRloc;
+        } else {
+            // if none of the above, return the first Rloc
+            return itrRlocList.get(0).getRloc();
         }
-        return recordBuilder.build();
     }
 
-    private void updateSubscribers(Rloc itrRloc, Eid reqEid, Eid mapEid, Eid srcEid) {
-        SubscriberRLOC subscriberRloc = new SubscriberRLOC(itrRloc, srcEid);
+    private void updateSubscribers(Rloc itrRloc, Eid reqEid, Eid mapEid, Eid srcEid, Integer recordTtl) {
+        Subscriber subscriber = new Subscriber(itrRloc, srcEid, Subscriber.recordTtlToSubscriberTime(recordTtl));
         Eid subscribedEid = mapEid;
 
         // If the eid in the matched mapping is SourceDest and the requested eid IS NOT then we subscribe itrRloc only
@@ -120,20 +198,10 @@ public class MapResolver implements IMapResolverAsync {
         // mapping will be pushed to dst as well (see sendSMRs in MapServer)
         if (mapEid.getAddressType().equals(SourceDestKeyLcaf.class)
                 && !reqEid.getAddressType().equals(SourceDestKeyLcaf.class)) {
-            subscribedEid = SourceDestKeyHelper.getDst(mapEid);
+            subscribedEid = SourceDestKeyHelper.getDstBinary(mapEid);
         }
 
-        Set<SubscriberRLOC> subscribers = getSubscribers(subscribedEid);
-        if (subscribers == null) {
-            subscribers = Sets.newConcurrentHashSet();
-        } else if (subscribers.contains(subscriberRloc)) {
-            // If there is an entry already for this subscriberRloc, remove it, so that it gets the new
-            // timestamp
-            subscribers.remove(subscriberRloc);
-        }
-        LOG.trace("Adding new subscriber: " + subscriberRloc.toString());
-        subscribers.add(subscriberRloc);
-        addSubscribers(subscribedEid, subscribers);
+        mapService.subscribe(subscriber, subscribedEid);
     }
 
     // Fixes mapping if request was for simple dst EID but the matched mapping is a SourceDest
@@ -141,12 +209,26 @@ public class MapResolver implements IMapResolverAsync {
         if (mapping.getEid().getAddress() instanceof SourceDestKey
                 && !(dstEid.getAddress() instanceof SourceDestKey)) {
             return new MappingRecordBuilder(mapping).setEid(
-                    SourceDestKeyHelper.getDst(mapping.getEid())).build();
+                    SourceDestKeyHelper.getDstBinary(mapping.getEid())).build();
+        }
+        return mapping;
+    }
+
+    // When an SMR-invoked Map-Request is asking for a mapping that is negative, it is most likely an attempt to delete
+    // that mapping.
+    private MappingRecord fixTtlIfSmrInvoked(MapRequest request, MappingRecord mapping) {
+        if (request.isSmrInvoked() && MappingRecordUtil.isNegativeMapping(mapping)) {
+            return new MappingRecordBuilder(mapping).setRecordTtl(TTL_DELETE_MAPPING).build();
         }
         return mapping;
     }
 
     private boolean locatorsNeedFixing(List<LocatorRecord> locatorRecords) {
+        // no locators - no fixing needed ;)
+        if (locatorRecords == null) {
+            return false;
+        }
+
         for (LocatorRecord record : locatorRecords) {
             if (record.getRloc().getAddress() instanceof ExplicitLocatorPath) {
                 return true;
@@ -169,7 +251,7 @@ public class MapResolver implements IMapResolverAsync {
             return mapping;
         }
 
-        MappingRecordBuilder recordBuilder = new MappingRecordBuilder();
+        MappingRecordBuilder recordBuilder = new MappingRecordBuilder(mapping);
         recordBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
         try {
             for (LocatorRecord record : locatorRecords) {
@@ -214,7 +296,8 @@ public class MapResolver implements IMapResolverAsync {
                                     .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
                                     .setPriority(priority).setMulticastWeight(record.getMulticastWeight())
                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
-                                    .setRloc(LispAddressUtil.toRloc(nextHop)).setLocatorId(record.getLocatorId()).build());
+                                    .setRloc(LispAddressUtil.toRloc(nextHop))
+                                    .setLocatorId(record.getLocatorId()).build());
                 }
             }
         } catch (ClassCastException cce) {
@@ -232,13 +315,12 @@ public class MapResolver implements IMapResolverAsync {
             // By default we return the first hop
             nextHop = hops.get(0).getAddress();
             for (Hop hop : hops) {
-                SimpleAddress hopContainer = hop.getAddress();
+                Address hopAddress = LispAddressUtil.addressFromSimpleAddress(hop.getAddress());
                 for (ItrRloc itrRloc : itrRlocs) {
-                    // XXX Need conversion
-                    if (itrRloc.getRloc().equals(hopContainer)) {
-                        int i = hops.indexOf(hop);
-                        if (i < hops.size() - 1) {
-                            nextHop = hops.get(i + 1).getAddress();
+                    if (itrRloc.getRloc().getAddress().equals(hopAddress)) {
+                        int iterator = hops.indexOf(hop);
+                        if (iterator < hops.size() - 1) {
+                            nextHop = hops.get(iterator + 1).getAddress();
                             return nextHop;
                         }
                     }
@@ -249,13 +331,12 @@ public class MapResolver implements IMapResolverAsync {
         return nextHop;
     }
 
-    @SuppressWarnings("unchecked")
-    private Set<SubscriberRLOC> getSubscribers(Eid address) {
-        return (Set<SubscriberRLOC>) mapService.getData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
-    }
-
-    private void addSubscribers(Eid address, Set<SubscriberRLOC> subscribers) {
-        mapService.addData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS, subscribers);
+    private static List<Subscriber> subscriberListFromItrRlocs(List<ItrRloc> itrRlocs, Eid srcEid) {
+        List<Subscriber> subscriberList = Lists.newArrayList();
+        for (ItrRloc itrRloc : itrRlocs) {
+            subscriberList.add(new Subscriber(itrRloc.getRloc(), srcEid, Subscriber.DEFAULT_SUBSCRIBER_TIMEOUT));
+        }
+        return subscriberList;
     }
 
     @Override
@@ -272,4 +353,9 @@ public class MapResolver implements IMapResolverAsync {
     public void setShouldAuthenticate(boolean shouldAuthenticate) {
         this.authenticate = shouldAuthenticate;
     }
+
+    @Override
+    public void setSmrNotificationListener(ISmrNotificationListener smrNotificationListener) {
+        this.smrNotificationListener = smrNotificationListener;
+    }
 }