Checkstyle: fix issues and enforce on implementation
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / lisp / MapResolver.java
index b35d172bc0363b4df246fe7cc6f26336de9f1a1d..7b983cb06b6b94430bae2a1051e5aa2e48ed1237 100644 (file)
@@ -8,39 +8,51 @@
 
 package org.opendaylight.lispflowmapping.implementation.lisp;
 
+import com.google.common.base.Preconditions;
+import com.google.common.collect.Sets;
 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.lisp.IMapRequestResultHandler;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
-import org.opendaylight.lispflowmapping.lisp.util.LcafSourceDestHelper;
-import org.opendaylight.lispflowmapping.lisp.util.LispAFIConvertor;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidToLocatorRecord.Action;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.LcafTrafficEngineeringAddress;
+import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
+import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
+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.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.eidrecords.EidRecord;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eidtolocatorrecords.EidToLocatorRecord;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eidtolocatorrecords.EidToLocatorRecordBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.lcaftrafficengineeringaddress.Hops;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.lispaddress.LispAddressContainer;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.lispaddress.lispaddresscontainer.address.LcafSourceDest;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.lispaddress.lispaddresscontainer.address.LcafTrafficEngineering;
+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.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);
 
@@ -63,43 +75,108 @@ public class MapResolver implements IMapResolverAsync {
     }
 
     public void handleMapRequest(MapRequest request) {
-        LispAddressContainer srcEid = null;
+        // 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;
+        }
+        Eid srcEid = null;
         if (request.getSourceEid() != null) {
-            srcEid = request.getSourceEid().getLispAddressContainer();
+            srcEid = request.getSourceEid().getEid();
         }
         MapReplyBuilder replyBuilder = new MapReplyBuilder();
         replyBuilder.setEchoNonceEnabled(false);
         replyBuilder.setProbe(false);
         replyBuilder.setSecurityEnabled(false);
         replyBuilder.setNonce(request.getNonce());
-        replyBuilder.setEidToLocatorRecord(new ArrayList<EidToLocatorRecord>());
-        for (EidRecord eidRecord : request.getEidRecord()) {
-            EidToLocatorRecord mapping = (EidToLocatorRecord) mapService.getMapping(srcEid,
-                    eidRecord.getLispAddressContainer());
+        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).getLispAddressContainer(), mapping.getLispAddressContainer(),
-                                srcEid);
+                        final Rloc resolvedRloc = resolveRloc(itrRlocs, sourceRloc);
+                        updateSubscribers(resolvedRloc, eidRecord.getEid(), mapping.getEid(), srcEid);
                     }
                     mapping = updateLocators(mapping, itrRlocs);
                 }
-                mapping = fixIfNotSDRequest(mapping, eidRecord.getLispAddressContainer());
+                mapping = fixIfNotSDRequest(mapping, eidRecord.getEid());
             } else {
-                mapping = getNegativeMapping(eidRecord.getLispAddressContainer(), eidRecord.getMask());
+                mapping = getNegativeMapping(eidRecord.getEid());
             }
-            replyBuilder.getEidToLocatorRecord().add(mapping);
+            replyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder().setMappingRecord(mapping).build());
         }
         requestHandler.handleMapReply(replyBuilder.build());
     }
 
-    private EidToLocatorRecord getNegativeMapping(LispAddressContainer eid, short mask) {
-        EidToLocatorRecordBuilder recordBuilder = new EidToLocatorRecordBuilder();
+    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 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 {
+            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();
+        }
+    }
+
+    private MappingRecord getNegativeMapping(Eid eid) {
+        MappingRecordBuilder recordBuilder = new MappingRecordBuilder();
         recordBuilder.setAuthoritative(false);
         recordBuilder.setMapVersion((short) 0);
-        recordBuilder.setMaskLength(mask);
-        recordBuilder.setLispAddressContainer(eid);
+        if (eid.getAddressType().equals(Ipv4PrefixBinaryAfi.class)
+                || eid.getAddressType().equals(Ipv6PrefixBinaryAfi.class)) {
+            recordBuilder.setEid(mapService.getWidestNegativePrefix(eid));
+        } else {
+            recordBuilder.setEid(eid);
+        }
         recordBuilder.setAction(Action.NativelyForward);
         if (authenticate && mapService.getAuthenticationKey(eid) != null) {
             recordBuilder.setRecordTtl(TTL_RLOC_TIMED_OUT);
@@ -109,10 +186,19 @@ public class MapResolver implements IMapResolverAsync {
         return recordBuilder.build();
     }
 
-    private void updateSubscribers(LispAddressContainer itrRloc, LispAddressContainer dstEid,
-            LispAddressContainer srcEid) {
+    private void updateSubscribers(Rloc itrRloc, Eid reqEid, Eid mapEid, Eid srcEid) {
         SubscriberRLOC subscriberRloc = new SubscriberRLOC(itrRloc, srcEid);
-        Set<SubscriberRLOC> subscribers = getSubscribers(dstEid);
+        Eid subscribedEid = mapEid;
+
+        // If the eid in the matched mapping is SourceDest and the requested eid IS NOT then we subscribe itrRloc only
+        // to dst from the src/dst since that what's been requested. Note though that any updates to to the src/dst
+        // 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.getDstBinary(mapEid);
+        }
+
+        Set<SubscriberRLOC> subscribers = getSubscribers(subscribedEid);
         if (subscribers == null) {
             subscribers = Sets.newConcurrentHashSet();
         } else if (subscribers.contains(subscriberRloc)) {
@@ -120,24 +206,26 @@ public class MapResolver implements IMapResolverAsync {
             // timestamp
             subscribers.remove(subscriberRloc);
         }
-        LOG.trace("Adding new subscriber: " + subscriberRloc.toString());
+        if (LOG.isTraceEnabled()) {
+            LOG.trace("Adding new subscriber: " + LispAddressStringifier.getString(subscriberRloc.getSrcRloc()));
+        }
         subscribers.add(subscriberRloc);
-        addSubscribers(dstEid, subscribers);
+        addSubscribers(subscribedEid, subscribers);
     }
 
     // Fixes mapping if request was for simple dst EID but the matched mapping is a SourceDest
-    private EidToLocatorRecord fixIfNotSDRequest(EidToLocatorRecord mapping, LispAddressContainer dstEid) {
-        if (mapping.getLispAddressContainer().getAddress() instanceof LcafSourceDest
-                && !(dstEid.getAddress() instanceof LcafSourceDest)) {
-            return new EidToLocatorRecordBuilder(mapping).setLispAddressContainer(
-                    LcafSourceDestHelper.getDst(mapping.getLispAddressContainer())).build();
+    private MappingRecord fixIfNotSDRequest(MappingRecord mapping, Eid dstEid) {
+        if (mapping.getEid().getAddress() instanceof SourceDestKey
+                && !(dstEid.getAddress() instanceof SourceDestKey)) {
+            return new MappingRecordBuilder(mapping).setEid(
+                    SourceDestKeyHelper.getDstBinary(mapping.getEid())).build();
         }
         return mapping;
     }
 
     private boolean locatorsNeedFixing(List<LocatorRecord> locatorRecords) {
         for (LocatorRecord record : locatorRecords) {
-            if (record.getLispAddressContainer().getAddress() instanceof LcafTrafficEngineering) {
+            if (record.getRloc().getAddress() instanceof ExplicitLocatorPath) {
                 return true;
             }
         }
@@ -145,7 +233,7 @@ public class MapResolver implements IMapResolverAsync {
     }
 
     // Process locators according to configured policy
-    private EidToLocatorRecord updateLocators(EidToLocatorRecord mapping, List<ItrRloc> itrRlocs) {
+    private MappingRecord updateLocators(MappingRecord mapping, List<ItrRloc> itrRlocs) {
         // no fixing if elpPolicy is default
         if (elpPolicy.equalsIgnoreCase("default")) {
             return mapping;
@@ -158,28 +246,27 @@ public class MapResolver implements IMapResolverAsync {
             return mapping;
         }
 
-        EidToLocatorRecordBuilder recordBuilder = new EidToLocatorRecordBuilder(mapping);
+        MappingRecordBuilder recordBuilder = new MappingRecordBuilder(mapping);
         recordBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
         try {
             for (LocatorRecord record : locatorRecords) {
-                LispAddressContainer container = record.getLispAddressContainer();
+                Rloc container = record.getRloc();
 
                 // For non-ELP RLOCs, or when ELP policy is default, or itrRlocs is null, just add the locator and be
                 // done
-                if ((!(container.getAddress() instanceof LcafTrafficEngineering))
+                if ((!(container.getAddress() instanceof ExplicitLocatorPath))
                         || elpPolicy.equalsIgnoreCase("default") || itrRlocs == null) {
                     recordBuilder.getLocatorRecord().add(
                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
                                     .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
                                     .setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
-                                    .setLispAddressContainer(container).setName(record.getName()).build());
+                                    .setRloc(container).setLocatorId(record.getLocatorId()).build());
                     continue;
                 }
 
-                LcafTrafficEngineeringAddress teAddress = ((LcafTrafficEngineering) container.getAddress())
-                        .getLcafTrafficEngineeringAddr();
-                LispAddressContainer nextHop = getNextELPHop(teAddress, itrRlocs);
+                ExplicitLocatorPath teAddress = ((ExplicitLocatorPath) container.getAddress());
+                SimpleAddress nextHop = getNextELPHop(teAddress, itrRlocs);
                 if (nextHop != null) {
                     java.lang.Short priority = record.getPriority();
                     if (elpPolicy.equalsIgnoreCase("both")) {
@@ -189,8 +276,8 @@ public class MapResolver implements IMapResolverAsync {
                                         .setPriority(record.getPriority())
                                         .setMulticastWeight(record.getMulticastWeight())
                                         .setMulticastPriority(record.getMulticastPriority())
-                                        .setRouted(record.isRouted()).setLispAddressContainer(container)
-                                        .setName(record.getName()).build());
+                                        .setRouted(record.isRouted()).setRloc(container)
+                                        .setLocatorId(record.getLocatorId()).build());
                         // Make the priority of the added simple locator lower so that ELP is used by default if
                         // the xTR understands ELP. Exclude 255, since that means don't use for unicast forwarding
                         // XXX Complex cases like several ELPs with different priorities are not handled
@@ -204,7 +291,8 @@ public class MapResolver implements IMapResolverAsync {
                                     .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
                                     .setPriority(priority).setMulticastWeight(record.getMulticastWeight())
                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
-                                    .setLispAddressContainer(nextHop).setName(record.getName()).build());
+                                    .setRloc(LispAddressUtil.toRloc(nextHop))
+                                    .setLocatorId(record.getLocatorId()).build());
                 }
             }
         } catch (ClassCastException cce) {
@@ -214,23 +302,20 @@ public class MapResolver implements IMapResolverAsync {
         return recordBuilder.build();
     }
 
-    private LispAddressContainer getNextELPHop(LcafTrafficEngineeringAddress elp, List<ItrRloc> itrRlocs) {
-        LispAddressContainer nextHop = null;
-        List<Hops> hops = elp.getHops();
+    private SimpleAddress getNextELPHop(ExplicitLocatorPath elp, List<ItrRloc> itrRlocs) {
+        SimpleAddress nextHop = null;
+        List<Hop> hops = elp.getExplicitLocatorPath().getHop();
 
         if (hops != null && hops.size() > 0) {
             // By default we return the first hop
-            nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(0).getHop()
-                    .getPrimitiveAddress()));
-            for (Hops hop : hops) {
-                LispAddressContainer hopContainer = LispAFIConvertor.toContainer(LispAFIConvertor
-                        .toAFIfromPrimitive(hop.getHop().getPrimitiveAddress()));
+            nextHop = hops.get(0).getAddress();
+            for (Hop hop : hops) {
+                Address hopAddress = LispAddressUtil.addressFromSimpleAddress(hop.getAddress());
                 for (ItrRloc itrRloc : itrRlocs) {
-                    if (itrRloc.getLispAddressContainer().equals(hopContainer)) {
-                        int i = hops.indexOf(hop);
-                        if (i < hops.size() - 1) {
-                            nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(i + 1)
-                                    .getHop().getPrimitiveAddress()));
+                    if (itrRloc.getRloc().getAddress().equals(hopAddress)) {
+                        int iterator = hops.indexOf(hop);
+                        if (iterator < hops.size() - 1) {
+                            nextHop = hops.get(iterator + 1).getAddress();
                             return nextHop;
                         }
                     }
@@ -242,11 +327,11 @@ public class MapResolver implements IMapResolverAsync {
     }
 
     @SuppressWarnings("unchecked")
-    private Set<SubscriberRLOC> getSubscribers(LispAddressContainer address) {
+    private Set<SubscriberRLOC> getSubscribers(Eid address) {
         return (Set<SubscriberRLOC>) mapService.getData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
     }
 
-    private void addSubscribers(LispAddressContainer address, Set<SubscriberRLOC> subscribers) {
+    private void addSubscribers(Eid address, Set<SubscriberRLOC> subscribers) {
         mapService.addData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS, subscribers);
     }