Bump upstreams
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / LispMappingService.java
index 347d33fd5dac88bed230b82b6e9d07e5db5cbd3c..aeaa3f4d12beae6b19317168643ef5f2ac8e565a 100644 (file)
@@ -5,29 +5,37 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.lispflowmapping.implementation;
 
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
 import java.util.List;
-
+import java.util.Set;
+import javax.annotation.PreDestroy;
+import javax.inject.Inject;
+import javax.inject.Singleton;
 import org.apache.commons.lang3.tuple.MutablePair;
 import org.apache.commons.lang3.tuple.Pair;
-import org.opendaylight.controller.md.sal.binding.api.NotificationService;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
-import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
-import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
+import org.opendaylight.lispflowmapping.config.ConfigIni;
 import org.opendaylight.lispflowmapping.implementation.lisp.MapResolver;
 import org.opendaylight.lispflowmapping.implementation.lisp.MapServer;
 import org.opendaylight.lispflowmapping.implementation.util.LispNotificationHelper;
-import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMapping;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
-import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
+import org.opendaylight.lispflowmapping.interfaces.lisp.ISmrNotificationListener;
 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
+import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
 import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
+import org.opendaylight.mdsal.binding.api.NotificationService;
+import org.opendaylight.mdsal.binding.api.NotificationService.CompositeListener;
+import org.opendaylight.mdsal.binding.api.RpcService;
+import org.opendaylight.mdsal.singleton.api.ClusterSingletonService;
+import org.opendaylight.mdsal.singleton.api.ClusterSingletonServiceProvider;
+import org.opendaylight.mdsal.singleton.api.ServiceGroupIdentifier;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.AddMapping;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapNotify;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapReply;
@@ -35,103 +43,115 @@ 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.MapRegister;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapReply;
 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.OdlLispProtoListener;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingKeepAlive;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RequestMapping;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrReplyMapping;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrRequestMapping;
+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.map.register.cache.metadata.container.MapRegisterCacheMetadata;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.map.register.cache.metadata.EidLispAddress;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapnotifymessage.MapNotifyBuilder;
 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.maprequestmessage.MapRequestBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
 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.lisp.sb.rev150904.OdlLispSbService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotify;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReply;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReplyInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequest;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequestInputBuilder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
+import org.opendaylight.yangtools.concepts.Registration;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class LispMappingService implements IFlowMapping, BindingAwareProvider, IMapRequestResultHandler,
-        IMapNotifyHandler, OdlLispProtoListener, AutoCloseable {
-    protected static final Logger LOG = LoggerFactory.getLogger(LispMappingService.class);
+@Singleton
+@Component(service = {IFlowMapping.class, IMapRequestResultHandler.class, IMapNotifyHandler.class},
+        immediate = true, property = "type=default")
+public class LispMappingService implements IFlowMapping, IMapRequestResultHandler,
+        IMapNotifyHandler, AutoCloseable, ClusterSingletonService {
+    private static final ServiceGroupIdentifier SERVICE_GROUP_IDENTIFIER =
+        new ServiceGroupIdentifier("lispflowmapping");
 
-    private volatile boolean shouldAuthenticate = true;
+    private static final Logger LOG = LoggerFactory.getLogger(LispMappingService.class);
 
     private volatile boolean smr = ConfigIni.getInstance().smrIsSet();
     private volatile String elpPolicy = ConfigIni.getInstance().getElpPolicy();
 
-    private ThreadLocal<MapReply> tlsMapReply = new ThreadLocal<MapReply>();
-    private ThreadLocal<Pair<MapNotify, List<TransportAddress>>> tlsMapNotify = new ThreadLocal<Pair<MapNotify, List<TransportAddress>>>();
-    private ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequest = new ThreadLocal<Pair<MapRequest, TransportAddress>>();
-
-    private OdlLispSbService lispSB = null;
+    // These are non-final for testing
+    private ThreadLocal<MapReply> tlsMapReply = new ThreadLocal<>();
+    private ThreadLocal<Pair<MapNotify, List<TransportAddress>>> tlsMapNotify = new ThreadLocal<>();
+    private ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequest = new ThreadLocal<>();
     private IMapResolverAsync mapResolver;
-    private IMapServerAsync mapServer;
-
-    private IMappingService mapService;
-    private NotificationService notificationService;
-    private BindingAwareBroker broker;
-    private ProviderContext session;
-
-    public LispMappingService() {
-        LOG.debug("LispMappingService Module constructed!");
-    }
-
-    public void setBindingAwareBroker(BindingAwareBroker broker) {
-        this.broker = broker;
-    }
-
-    public void setNotificationService(NotificationService ns) {
-        this.notificationService = ns;
-    }
-
-    public void setMappingService(IMappingService ms) {
-        LOG.trace("MappingService set in LispMappingService");
-        this.mapService = ms;
+    private MapServer mapServer;
+    private SendMapRequest sendMapRequest;
+    private SendMapReply sendMapReply;
+    private SendMapNotify sendMapNotify;
+
+    private final IMappingService mapService;
+    private final NotificationService notificationService;
+    private final Registration listenerRegistration;
+    private final Registration cssRegistration;
+
+    @Inject
+    @Activate
+    public LispMappingService(@Reference final IMappingService mappingService,
+            @Reference final ClusterSingletonServiceProvider clusterSingletonService,
+            @Reference final RpcService rpcService, @Reference final NotificationService notificationService) {
+        this.mapService = mappingService;
+        sendMapRequest = rpcService.getRpc(SendMapRequest.class);
+        sendMapReply = rpcService.getRpc(SendMapReply.class);
+        sendMapNotify = rpcService.getRpc(SendMapNotify.class);
+        this.notificationService = notificationService;
+
+        // initialize
+        listenerRegistration = notificationService.registerCompositeListener(new CompositeListener(Set.of(
+                new CompositeListener.Component<>(AddMapping.class, this::onAddMapping),
+                new CompositeListener.Component<>(GotMapNotify.class, this::onGotMapNotify),
+                new CompositeListener.Component<>(RequestMapping.class, this::onRequestMapping),
+                new CompositeListener.Component<>(GotMapReply.class, this::onGotMapReply),
+                new CompositeListener.Component<>(XtrRequestMapping.class, this::onXtrRequestMapping),
+                new CompositeListener.Component<>(XtrReplyMapping.class, this::onXtrReplyMapping),
+                new CompositeListener.Component<>(MappingKeepAlive.class, this::onMappingKeepAlive))));
+        mapResolver = new MapResolver(mapService, smr, elpPolicy, this);
+        mapServer = new MapServer(mapService, smr, this, notificationService);
+        cssRegistration = clusterSingletonService.registerClusterSingletonService(this);
+        mapResolver.setSmrNotificationListener((ISmrNotificationListener) mapServer);
+        LOG.info("LISP (RFC6830) Mapping Service initialized");
     }
 
     public boolean shouldUseSmr() {
         return this.smr;
     }
 
-    public void setShouldUseSmr(boolean smr) {
-        this.smr = smr;
+    @Override
+    public void setShouldUseSmr(boolean shouldUseSmr) {
+        this.smr = shouldUseSmr;
         if (mapServer != null) {
-            mapServer.setSubscriptionService(smr);
+            mapServer.setSubscriptionService(shouldUseSmr);
         }
         if (mapResolver != null) {
-            mapResolver.setSubscriptionService(smr);
+            mapResolver.setSubscriptionService(shouldUseSmr);
         }
+        ConfigIni.getInstance().setSmr(shouldUseSmr);
     }
 
     public NotificationService getNotificationService() {
         return this.notificationService;
     }
 
-    public void initialize() {
-        broker.registerProvider(this);
-        notificationService.registerNotificationListener(this);
-        mapResolver = new MapResolver(mapService, smr, elpPolicy, this);
-        mapServer = new MapServer(mapService, shouldAuthenticate, smr, this, notificationService);
-    }
-
-    public void basicInit() {
-        mapResolver = new MapResolver(mapService, smr, elpPolicy, this);
-        mapServer = new MapServer(mapService, shouldAuthenticate, smr, this, notificationService);
-    }
-
     @Override
-    public void onSessionInitiated(ProviderContext session) {
-        LOG.info("Lisp Consumer session initialized!");
-        this.session = session;
-        LOG.info("LISP (RFC6830) Mapping Service init finished");
-    }
-
     public MapReply handleMapRequest(MapRequest request) {
-        LOG.debug("DAO: Retrieving mapping for {}",
-                LispAddressStringifier.getString(request.getEidItem().get(0).getEid()));
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("LISP: Retrieving mapping for {}",
+                    LispAddressStringifier.getString(request.getEidItem().get(0).getEid()));
+        }
 
         tlsMapReply.set(null);
         tlsMapRequest.set(null);
@@ -139,31 +159,22 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
         // After this invocation we assume that the thread local is filled with the reply
         if (tlsMapRequest.get() != null) {
             SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
-            new MapRequestBuilder(tlsMapRequest.get().getLeft());
             smrib.setMapRequest(new MapRequestBuilder(tlsMapRequest.get().getLeft()).build());
             smrib.setTransportAddress(tlsMapRequest.get().getRight());
-            getLispSB().sendMapRequest(smrib.build());
+            sendMapRequest.invoke(smrib.build());
             return null;
         } else {
             return tlsMapReply.get();
         }
     }
 
+    @Override
     public Pair<MapNotify, List<TransportAddress>> handleMapRegister(MapRegister mapRegister) {
-        LOG.debug("DAO: Adding mapping for {}",
-                LispAddressStringifier.getString(mapRegister.getMappingRecordItem().get(0)
-                        .getMappingRecord().getEid()));
-
-        tlsMapNotify.set(null);
-        mapServer.handleMapRegister(mapRegister);
-        // After this invocation we assume that the thread local is filled with the reply
-        return tlsMapNotify.get();
-    }
-
-    public Pair<MapNotify, List<TransportAddress>> handleMapRegister(MapRegister mapRegister, boolean smr) {
-        LOG.debug("DAO: Adding mapping for {}",
-                LispAddressStringifier.getString(mapRegister.getMappingRecordItem().get(0)
-                        .getMappingRecord().getEid()));
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("LISP: Adding mapping for {}",
+                    LispAddressStringifier.getString(mapRegister.getMappingRecordItem().get(0)
+                            .getMappingRecord().getEid()));
+        }
 
         tlsMapNotify.set(null);
         mapServer.handleMapRegister(mapRegister);
@@ -172,32 +183,26 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
     }
 
     public void setShouldAuthenticate(boolean shouldAuthenticate) {
-        this.shouldAuthenticate = shouldAuthenticate;
         this.mapResolver.setShouldAuthenticate(shouldAuthenticate);
-        this.mapServer.setShouldAuthenticate(shouldAuthenticate);
-    }
-
-    public boolean shouldAuthenticate() {
-        return shouldAuthenticate;
     }
 
     private void sendMapNotify(MapNotify mapNotify, TransportAddress address) {
         SendMapNotifyInputBuilder smnib = new SendMapNotifyInputBuilder();
         smnib.setMapNotify(new MapNotifyBuilder(mapNotify).build());
         smnib.setTransportAddress(address);
-        getLispSB().sendMapNotify(smnib.build());
+        sendMapNotify.invoke(smnib.build());
     }
 
-    @Override
-    public void onAddMapping(AddMapping mapRegisterNotification) {
+    @VisibleForTesting
+    void onAddMapping(AddMapping mapRegisterNotification) {
         Pair<MapNotify, List<TransportAddress>> result = handleMapRegister(mapRegisterNotification.getMapRegister());
         if (result != null && result.getLeft() != null) {
             MapNotify mapNotify = result.getLeft();
-            List <TransportAddress> rlocs = result.getRight();
+            List<TransportAddress> rlocs = result.getRight();
             if (rlocs == null) {
                 TransportAddressBuilder tab = new TransportAddressBuilder();
                 tab.setIpAddress(mapRegisterNotification.getTransportAddress().getIpAddress());
-                tab.setPort(new PortNumber(LispMessage.PORT_NUM));
+                tab.setPort(new PortNumber(LispMessage.PORT_NUMBER));
                 sendMapNotify(mapNotify, tab.build());
             } else {
                 for (TransportAddress ta : rlocs) {
@@ -209,44 +214,50 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
         }
     }
 
-    @Override
-    public void onRequestMapping(RequestMapping mapRequestNotification) {
+    @VisibleForTesting
+    void onRequestMapping(RequestMapping mapRequestNotification) {
         MapReply mapReply = handleMapRequest(mapRequestNotification.getMapRequest());
         if (mapReply != null) {
             SendMapReplyInputBuilder smrib = new SendMapReplyInputBuilder();
-            smrib.setMapReply((new MapReplyBuilder(mapReply).build()));
+            smrib.setMapReply(new MapReplyBuilder(mapReply).build());
             smrib.setTransportAddress(mapRequestNotification.getTransportAddress());
-            getLispSB().sendMapReply(smrib.build());
+            sendMapReply.invoke(smrib.build());
         } else {
-            LOG.warn("got null map reply");
+            LOG.debug("handleMapRequest: Got null MapReply");
         }
     }
 
-    @Override
-    public void onGotMapReply(GotMapReply notification) {
+    @VisibleForTesting
+    void onGotMapReply(GotMapReply notification) {
         LOG.debug("Received GotMapReply notification, ignoring");
     }
 
-    @Override
-    public void onGotMapNotify(GotMapNotify notification) {
+    @VisibleForTesting
+    void onGotMapNotify(GotMapNotify notification) {
         LOG.debug("Received GotMapNotify notification, ignoring");
     }
 
-    @Override
-    public void onXtrRequestMapping(XtrRequestMapping notification) {
+    @VisibleForTesting
+    void onXtrRequestMapping(XtrRequestMapping notification) {
         LOG.debug("Received XtrRequestMapping notification, ignoring");
     }
 
-    @Override
-    public void onXtrReplyMapping(XtrReplyMapping notification) {
+    @VisibleForTesting
+    void onXtrReplyMapping(XtrReplyMapping notification) {
         LOG.debug("Received XtrReplyMapping notification, ignoring");
     }
 
-    private OdlLispSbService getLispSB() {
-        if (lispSB == null) {
-            lispSB = session.getRpcService(OdlLispSbService.class);
+    @VisibleForTesting
+    void onMappingKeepAlive(MappingKeepAlive notification) {
+        final MapRegisterCacheMetadata cacheMetadata = notification.getMapRegisterCacheMetadata();
+        for (EidLispAddress eidLispAddress : cacheMetadata.nonnullEidLispAddress().values()) {
+            final Eid eid = eidLispAddress.getEid();
+            final XtrId xtrId = cacheMetadata.getXtrId();
+            final Long timestamp = cacheMetadata.getTimestamp();
+            LOG.debug("Update map registration for eid {} with timestamp {}", LispAddressStringifier.getString(eid),
+                    timestamp);
+            mapService.refreshMappingRegistration(eid, xtrId, timestamp);
         }
-        return lispSB;
     }
 
     @Override
@@ -256,35 +267,61 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
 
     @Override
     public void handleMapNotify(MapNotify notify, List<TransportAddress> rlocs) {
-        tlsMapNotify.set(new MutablePair<MapNotify, List<TransportAddress>>(notify, rlocs));
+        tlsMapNotify.set(new MutablePair<>(notify, rlocs));
     }
 
     @Override
-    public void handleSMR(MapRequest smr, Rloc subscriber) {
-        LOG.debug("Sending SMR to {} with Source-EID {} and EID Record {}",
-                LispAddressStringifier.getString(subscriber),
-                LispAddressStringifier.getString(smr.getSourceEid().getEid()),
-                LispAddressStringifier.getString(smr.getEidItem().get(0).getEid()));
+    public void handleSMR(MapRequest smrMapRequest, Rloc subscriber) {
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Sending SMR Map-Request to {} with Source-EID {} and EID Record {} (reversed)",
+                    LispAddressStringifier.getString(subscriber),
+                    LispAddressStringifier.getString(smrMapRequest.getSourceEid().getEid()),
+                    LispAddressStringifier.getString(smrMapRequest.getEidItem().get(0).getEid()));
+        }
         SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
-        smrib.setMapRequest(new MapRequestBuilder(smr).build());
+        smrib.setMapRequest(new MapRequestBuilder(smrMapRequest).build());
         smrib.setTransportAddress(LispNotificationHelper.getTransportAddressFromRloc(subscriber));
-        getLispSB().sendMapRequest(smrib.build());
-
+        sendMapRequest.invoke(smrib.build());
     }
 
     @Override
     public void handleNonProxyMapRequest(MapRequest mapRequest, TransportAddress transportAddress) {
-        tlsMapRequest.set(new MutablePair<MapRequest, TransportAddress>(mapRequest, transportAddress));
+        tlsMapRequest.set(new MutablePair<>(mapRequest, transportAddress));
     }
 
-    public void destroy() {
+    private void destroy() {
         LOG.info("LISP (RFC6830) Mapping Service is destroyed!");
         mapResolver = null;
-        mapServer = null;
+        if (mapServer != null) {
+            mapServer.close();
+            mapServer = null;
+        }
     }
 
+    @Deactivate
+    @PreDestroy
     @Override
     public void close() throws Exception {
         destroy();
+        cssRegistration.close();
+        listenerRegistration.close();
+    }
+
+    @Override
+    public void instantiateServiceInstance() {
+        mapService.setIsMaster(true);
+    }
+
+    @Override
+    public ListenableFuture<Void> closeServiceInstance() {
+        if (mapService != null) {
+            mapService.setIsMaster(false);
+        }
+        return Futures.<Void>immediateFuture(null);
+    }
+
+    @Override
+    public ServiceGroupIdentifier getIdentifier() {
+        return SERVICE_GROUP_IDENTIFIER;
     }
 }