Cancel ongoing SMR futures on new event
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / lisp / MapServer.java
index 36d823bc2dab2840e17594d5ec830ab090e40149..eb6d666159213fcc3a46063a4d9ad089a21c79f3 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,
@@ -31,6 +31,8 @@ import java.util.concurrent.TimeUnit;
 import org.apache.commons.lang3.BooleanUtils;
 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
 import org.opendaylight.lispflowmapping.config.ConfigIni;
+import org.opendaylight.lispflowmapping.implementation.util.LoggingUtil;
+import org.opendaylight.lispflowmapping.implementation.util.MSNotificationInputUtil;
 import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
 import org.opendaylight.lispflowmapping.interfaces.dao.Subscriber;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
@@ -45,6 +47,7 @@ import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
 import org.opendaylight.lispflowmapping.lisp.util.MapNotifyBuilderHelper;
 import org.opendaylight.lispflowmapping.lisp.util.MapRequestUtil;
+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.inet.types.rev130715.PortNumber;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
@@ -62,7 +65,6 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.ma
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequestBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChange;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChanged;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.OdlMappingserviceListener;
@@ -102,6 +104,7 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
     @SuppressWarnings("unchecked")
     public void handleMapRegister(MapRegister mapRegister) {
         boolean mappingUpdated = false;
+        boolean oldMappingRemoved = false;
         boolean merge = ConfigIni.getInstance().mappingMergeIsSet() && mapRegister.isMergeEnabled();
         Set<Subscriber> subscribers = null;
         MappingRecord oldMapping;
@@ -124,6 +127,10 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
 
             oldMapping = getMappingRecord(mapService.getMapping(MappingOrigin.Southbound, eid));
             mapService.addMapping(MappingOrigin.Southbound, eid, getSiteId(mapRegister), mappingData);
+            if (oldMapping != null && MappingRecordUtil.isNegativeMapping(oldMapping)) {
+                mapService.removeMapping(MappingOrigin.Southbound, oldMapping.getEid());
+                oldMappingRemoved = true;
+            }
 
             if (subscriptionService) {
                 MappingRecord newMapping = merge
@@ -138,7 +145,13 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
                     if (oldMapping != null && !oldMapping.getEid().equals(eid)) {
                         subscribers = addParentSubscribers(eid, subscribers);
                     }
-                    sendSmrs(eid, subscribers);
+                    LoggingUtil.logSubscribers(LOG, eid, subscribers);
+                    handleSmr(eid, subscribers);
+                    if (oldMapping != null && oldMappingRemoved && !oldMapping.getEid().equals(eid)) {
+                        subscribers = getSubscribers(oldMapping.getEid());
+                        LoggingUtil.logSubscribers(LOG, oldMapping.getEid(), subscribers);
+                        handleSmr(oldMapping.getEid(), subscribers);
+                    }
                     mappingUpdated = true;
                 }
             }
@@ -203,13 +216,19 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
 
     @Override
     public void onMappingChanged(MappingChanged notification) {
+        LOG.trace("MappingChanged event of type: `{}'", notification.getChangeType());
         if (subscriptionService) {
             Eid eid = notification.getMappingRecord().getEid();
+            Set<Subscriber> subscribers = MSNotificationInputUtil.toSubscriberSet(notification.getSubscriberItem());
+            LoggingUtil.logSubscribers(LOG, eid, subscribers);
             if (mapService.isMaster()) {
-                sendSmrs(eid, getSubscribers(eid));
-            }
-            if (notification.getChangeType().equals(MappingChange.Removed)) {
-                removeSubscribers(eid);
+                sendSmrs(eid, subscribers);
+                if (eid.getAddress() instanceof SourceDestKey) {
+                    Set<Subscriber> dstSubscribers = MSNotificationInputUtil.toSubscriberSetFromDst(
+                            notification.getDstSubscriberItem());
+                    LoggingUtil.logSubscribers(LOG, SourceDestKeyHelper.getDstBinary(eid), dstSubscribers);
+                    sendSmrs(SourceDestKeyHelper.getDstBinary(eid), dstSubscribers);
+                }
             }
         }
     }
@@ -240,18 +259,18 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
         return false;
     }
 
-    private void sendSmrs(Eid eid, Set<Subscriber> subscribers) {
-        handleSmr(eid, subscribers);
+    private void handleSmr(Eid eid, Set<Subscriber> subscribers) {
+        sendSmrs(eid, subscribers);
 
         // For SrcDst LCAF also send SMRs to Dst prefix
         if (eid.getAddress() instanceof SourceDestKey) {
             Eid dstAddr = SourceDestKeyHelper.getDstBinary(eid);
             Set<Subscriber> dstSubs = getSubscribers(dstAddr);
-            handleSmr(dstAddr, dstSubs);
+            sendSmrs(dstAddr, dstSubs);
         }
     }
 
-    private void handleSmr(Eid eid, Set<Subscriber> subscribers) {
+    private void sendSmrs(Eid eid, Set<Subscriber> subscribers) {
         if (subscribers == null) {
             return;
         }
@@ -259,7 +278,6 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
         LOG.trace("Built SMR packet: " + mrb.build().toString());
 
         scheduler.scheduleSmrs(mrb, subscribers.iterator());
-        addSubscribers(eid, subscribers);
     }
 
     @SuppressWarnings("unchecked")
@@ -284,10 +302,6 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
         return subscribers;
     }
 
-    private void removeSubscribers(Eid address) {
-        mapService.removeData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
-    }
-
     private void addSubscribers(Eid address, Set<Subscriber> subscribers) {
         mapService.addData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS, subscribers);
     }
@@ -297,7 +311,7 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
             Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces();
             while (interfaces.hasMoreElements()) {
                 NetworkInterface current = interfaces.nextElement();
-                LOG.debug("Interface " + current.toString());
+                LOG.trace("Interface " + current.toString());
                 if (!current.isUp() || current.isLoopback() || current.isVirtual()) {
                     continue;
                 }
@@ -333,48 +347,67 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
         private final ThreadFactory threadFactory = new ThreadFactoryBuilder()
                 .setNameFormat("smr-executor-%d").build();
         private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(cpuCores * 2, threadFactory);
-        private final Map<IpAddressBinary, Map<Eid, ScheduledFuture<?>>> subscriberFutureMap = Maps.newConcurrentMap();
+        private final Map<Eid, Map<Subscriber, ScheduledFuture<?>>> eidFutureMap = Maps.newConcurrentMap();
 
         void scheduleSmrs(MapRequestBuilder mrb, Iterator<Subscriber> subscribers) {
+            final Eid srcEid = mrb.getSourceEid().getEid();
+            cancelExistingFuturesForEid(srcEid);
+
+            final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = Maps.newConcurrentMap();
+
             // Using Iterator ensures that we don't get a ConcurrentModificationException when removing a Subscriber
             // from a Set.
             while (subscribers.hasNext()) {
                 Subscriber subscriber = subscribers.next();
                 if (subscriber.timedOut()) {
-                    LOG.trace("Lazy removing expired subscriber entry " + subscriber.toString());
+                    LOG.debug("Lazy removing expired subscriber entry " + subscriber.getString());
                     subscribers.remove();
                 } else {
                     final ScheduledFuture<?> future = executor.scheduleAtFixedRate(new CancellableRunnable(
                             mrb, subscriber), 0L, ConfigIni.getInstance().getSmrTimeout(), TimeUnit.MILLISECONDS);
-                    final IpAddressBinary subscriberAddress = LispAddressUtil
-                            .addressBinaryFromAddress(subscriber.getSrcRloc().getAddress());
-
-                    if (subscriberFutureMap.containsKey(subscriberAddress)) {
-                        subscriberFutureMap.get(subscriberAddress).put(mrb.getSourceEid().getEid(), future);
-                    } else {
-                        final Map<Eid, ScheduledFuture<?>> eidFutureMap = Maps.newConcurrentMap();
-                        eidFutureMap.put(mrb.getSourceEid().getEid(), future);
-                        subscriberFutureMap.put(subscriberAddress, eidFutureMap);
-                    }
+                    subscriberFutureMap.put(subscriber, future);
                 }
             }
+
+            if (subscriberFutureMap.isEmpty()) {
+                return;
+            }
+            eidFutureMap.put(srcEid, subscriberFutureMap);
         }
 
         void smrReceived(SmrEvent event) {
-            final List<IpAddressBinary> subscriberAddressList = event.getSubscriberAddressList();
-            for (IpAddressBinary subscriberAddress : subscriberAddressList) {
-                final Map<Eid, ScheduledFuture<?>> eidFutureMap = subscriberFutureMap.get(subscriberAddress);
-                if (eidFutureMap != null) {
-                    final ScheduledFuture<?> future = eidFutureMap.get(event.getEid());
+            final List<Subscriber> subscriberList = event.getSubscriberList();
+            for (Subscriber subscriber : subscriberList) {
+                LOG.trace("SMR-invoked event, EID {}, subscriber {}", LispAddressStringifier.getString(event.getEid()),
+                        subscriber.getString());
+                final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(event.getEid());
+                if (subscriberFutureMap != null) {
+                    final ScheduledFuture<?> future = subscriberFutureMap.get(subscriber);
                     if (future != null && !future.isCancelled()) {
-                        future.cancel(false);
-                        LOG.trace("SMR-invoked MapRequest received, scheduled task for subscriber {} with nonce {} has "
-                                + "been canceled", subscriberAddress.toString(), event.getNonce());
+                        future.cancel(true);
+                        LOG.debug("SMR-invoked MapRequest received, scheduled task for subscriber {}, EID {} with"
+                                + " nonce {} has been cancelled", subscriber.getString(),
+                                LispAddressStringifier.getString(event.getEid()), event.getNonce());
+                        subscriberFutureMap.remove(subscriber);
+                    }
+                    if (subscriberFutureMap.isEmpty()) {
                         eidFutureMap.remove(event.getEid());
                     }
-                    if (eidFutureMap.isEmpty()) {
-                        subscriberFutureMap.remove(subscriberAddress);
+                }
+            }
+        }
+
+        private void cancelExistingFuturesForEid(Eid eid) {
+            synchronized (eidFutureMap) {
+                if (eidFutureMap.containsKey(eid)) {
+                    final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(eid);
+                    Iterator<Subscriber> oldSubscribers = subscriberFutureMap.keySet().iterator();
+                    while (oldSubscribers.hasNext()) {
+                        Subscriber subscriber = oldSubscribers.next();
+                        ScheduledFuture<?> subscriberFuture = subscriberFutureMap.get(subscriber);
+                        subscriberFuture.cancel(true);
                     }
+                    eidFutureMap.remove(eid);
                 }
             }
         }
@@ -392,39 +425,52 @@ public class MapServer implements IMapServerAsync, OdlMappingserviceListener, IS
             @SuppressWarnings("checkstyle:IllegalCatch")
             @Override
             public void run() {
-                final IpAddressBinary subscriberAddress = LispAddressUtil
-                        .addressBinaryFromAddress(subscriber.getSrcRloc().getAddress());
+                final Eid srcEid = mrb.getSourceEid().getEid();
+
                 try {
                     // The address stored in the SMR's EID record is used as Source EID in the SMR-invoked
                     // Map-Request. To ensure consistent behavior it is set to the value used to originally request
                     // a given mapping.
                     if (executionCount <= ConfigIni.getInstance().getSmrRetryCount()) {
-                        mrb.setEidItem(new ArrayList<EidItem>());
-                        mrb.getEidItem().add(new EidItemBuilder().setEid(subscriber.getSrcEid()).build());
-                        notifyHandler.handleSMR(mrb.build(), subscriber.getSrcRloc());
-                        LOG.trace("{}. attempt to send SMR for MapRequest " + mrb.getSourceEid().getEid()
-                                + " to subscriber " + subscriber.getSrcRloc(), executionCount);
+                        synchronized (mrb) {
+                            mrb.setEidItem(new ArrayList<EidItem>());
+                            mrb.getEidItem().add(new EidItemBuilder().setEid(subscriber.getSrcEid()).build());
+                            notifyHandler.handleSMR(mrb.build(), subscriber.getSrcRloc());
+                            if (LOG.isTraceEnabled()) {
+                                LOG.trace("Attempt #{} to send SMR to subscriber {} for EID {}",
+                                        executionCount,
+                                        subscriber.getString(),
+                                        LispAddressStringifier.getString(mrb.getSourceEid().getEid()));
+                            }
+                        }
                     } else {
                         LOG.trace("Cancelling execution of a SMR Map-Request after {} failed attempts.",
                                 executionCount - 1);
-                        cancelAndRemove(subscriberAddress);
+                        cancelAndRemove(subscriber, srcEid);
+                        return;
                     }
                 } catch (Exception e) {
                     LOG.error("Errors encountered while handling SMR:", e);
-                    cancelAndRemove(subscriberAddress);
+                    cancelAndRemove(subscriber, srcEid);
+                    return;
                 }
                 executionCount++;
             }
 
-            private void cancelAndRemove(IpAddressBinary subscriberAddress) {
-                final Map<Eid, ScheduledFuture<?>> eidFutureMap = subscriberFutureMap.get(subscriberAddress);
-                final Eid eid = mrb.getSourceEid().getEid();
-                if (eidFutureMap.containsKey(eid)) {
-                    eidFutureMap.get(eid).cancel(false);
+            private void cancelAndRemove(Subscriber subscriber, Eid eid) {
+                final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(eid);
+                if (subscriberFutureMap == null) {
+                    LOG.warn("Couldn't find subscriber {} in SMR scheduler internal list", subscriber);
+                    return;
+                }
+
+                if (subscriberFutureMap.containsKey(subscriber)) {
+                    ScheduledFuture<?> eidFuture = subscriberFutureMap.get(subscriber);
+                    subscriberFutureMap.remove(subscriber);
+                    eidFuture.cancel(false);
                 }
-                eidFutureMap.remove(eid);
-                if (eidFutureMap.isEmpty()) {
-                    subscriberFutureMap.remove(subscriberAddress);
+                if (subscriberFutureMap.isEmpty()) {
+                    eidFutureMap.remove(eid);
                 }
             }
         }