mappingservice/implementation/src/main/java/org/opendaylight/lispflowmapping/implementation/LispMappingService.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;
  10
  11 import java.util.List;
  12
  13 import org.apache.commons.lang3.tuple.MutablePair;
  14 import org.apache.commons.lang3.tuple.Pair;
  15 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  16 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
  17 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  18 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  19 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
  20 import org.opendaylight.lispflowmapping.implementation.lisp.MapResolver;
  21 import org.opendaylight.lispflowmapping.implementation.lisp.MapServer;
  22 import org.opendaylight.lispflowmapping.implementation.util.LispNotificationHelper;
  23 import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
  24 import org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMapping;
  25 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
  26 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
  27 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
  28 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
  29 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
  30 import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.AddMapping;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapNotify;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapReply;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapNotify;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegister;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapReply;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.OdlLispProtoListener;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RequestMapping;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrReplyMapping;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrRequestMapping;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapnotifymessage.MapNotifyBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestmessage.MapRequestBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.OdlLispSbService;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyInputBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReplyInputBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequestInputBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 public class LispMappingService implements IFlowMapping, BindingAwareProvider, IMapRequestResultHandler,
  57         IMapNotifyHandler, OdlLispProtoListener, AutoCloseable {
  58     protected static final Logger LOG = LoggerFactory.getLogger(LispMappingService.class);
  59
  60     private volatile boolean shouldAuthenticate = true;
  61
  62     private volatile boolean smr = ConfigIni.getInstance().smrIsSet();
  63     private volatile String elpPolicy = ConfigIni.getInstance().getElpPolicy();
  64
  65     private ThreadLocal<MapReply> tlsMapReply = new ThreadLocal<MapReply>();
  66     private ThreadLocal<Pair<MapNotify, List<TransportAddress>>> tlsMapNotify =
  67             new ThreadLocal<Pair<MapNotify, List<TransportAddress>>>();
  68     private ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequest =
  69             new ThreadLocal<Pair<MapRequest, TransportAddress>>();
  70
  71     private OdlLispSbService lispSB = null;
  72     private IMapResolverAsync mapResolver;
  73     private IMapServerAsync mapServer;
  74
  75     private IMappingService mapService;
  76     private NotificationService notificationService;
  77     private BindingAwareBroker broker;
  78     private ProviderContext session;
  79
  80     public LispMappingService() {
  81         LOG.debug("LispMappingService Module constructed!");
  82     }
  83
  84     public void setBindingAwareBroker(BindingAwareBroker broker) {
  85         this.broker = broker;
  86     }
  87
  88     public void setNotificationService(NotificationService ns) {
  89         this.notificationService = ns;
  90     }
  91
  92     public void setMappingService(IMappingService ms) {
  93         LOG.trace("MappingService set in LispMappingService");
  94         this.mapService = ms;
  95     }
  96
  97     public boolean shouldUseSmr() {
  98         return this.smr;
  99     }
 100
 101     public void setShouldUseSmr(boolean smr) {
 102         this.smr = smr;
 103         if (mapServer != null) {
 104             mapServer.setSubscriptionService(smr);
 105         }
 106         if (mapResolver != null) {
 107             mapResolver.setSubscriptionService(smr);
 108         }
 109         ConfigIni.getInstance().setSmr(smr);
 110     }
 111
 112     public NotificationService getNotificationService() {
 113         return this.notificationService;
 114     }
 115
 116     public void initialize() {
 117         broker.registerProvider(this);
 118         notificationService.registerNotificationListener(this);
 119         mapResolver = new MapResolver(mapService, smr, elpPolicy, this);
 120         mapServer = new MapServer(mapService, shouldAuthenticate, smr, this, notificationService);
 121     }
 122
 123     public void basicInit() {
 124         mapResolver = new MapResolver(mapService, smr, elpPolicy, this);
 125         mapServer = new MapServer(mapService, shouldAuthenticate, smr, this, notificationService);
 126     }
 127
 128     @Override
 129     public void onSessionInitiated(ProviderContext session) {
 130         LOG.info("Lisp Consumer session initialized!");
 131         this.session = session;
 132         LOG.info("LISP (RFC6830) Mapping Service init finished");
 133     }
 134
 135     public MapReply handleMapRequest(MapRequest request) {
 136         if (LOG.isDebugEnabled()) {
 137             LOG.debug("DAO: Retrieving mapping for {}",
 138                     LispAddressStringifier.getString(request.getEidItem().get(0).getEid()));
 139         }
 140
 141         tlsMapReply.set(null);
 142         tlsMapRequest.set(null);
 143         mapResolver.handleMapRequest(request);
 144         // After this invocation we assume that the thread local is filled with the reply
 145         if (tlsMapRequest.get() != null) {
 146             SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
 147             smrib.setMapRequest(new MapRequestBuilder(tlsMapRequest.get().getLeft()).build());
 148             smrib.setTransportAddress(tlsMapRequest.get().getRight());
 149             getLispSB().sendMapRequest(smrib.build());
 150             return null;
 151         } else {
 152             return tlsMapReply.get();
 153         }
 154     }
 155
 156     public Pair<MapNotify, List<TransportAddress>> handleMapRegister(MapRegister mapRegister) {
 157         if (LOG.isDebugEnabled()) {
 158             LOG.debug("DAO: Adding mapping for {}",
 159                     LispAddressStringifier.getString(mapRegister.getMappingRecordItem().get(0)
 160                             .getMappingRecord().getEid()));
 161         }
 162
 163         tlsMapNotify.set(null);
 164         mapServer.handleMapRegister(mapRegister);
 165         // After this invocation we assume that the thread local is filled with the reply
 166         return tlsMapNotify.get();
 167     }
 168
 169     public void setShouldAuthenticate(boolean shouldAuthenticate) {
 170         this.shouldAuthenticate = shouldAuthenticate;
 171         this.mapResolver.setShouldAuthenticate(shouldAuthenticate);
 172         this.mapServer.setShouldAuthenticate(shouldAuthenticate);
 173     }
 174
 175     public boolean shouldAuthenticate() {
 176         return shouldAuthenticate;
 177     }
 178
 179     private void sendMapNotify(MapNotify mapNotify, TransportAddress address) {
 180         SendMapNotifyInputBuilder smnib = new SendMapNotifyInputBuilder();
 181         smnib.setMapNotify(new MapNotifyBuilder(mapNotify).build());
 182         smnib.setTransportAddress(address);
 183         getLispSB().sendMapNotify(smnib.build());
 184     }
 185
 186     @Override
 187     public void onAddMapping(AddMapping mapRegisterNotification) {
 188         Pair<MapNotify, List<TransportAddress>> result = handleMapRegister(mapRegisterNotification.getMapRegister());
 189         if (result != null && result.getLeft() != null) {
 190             MapNotify mapNotify = result.getLeft();
 191             List <TransportAddress> rlocs = result.getRight();
 192             if (rlocs == null) {
 193                 TransportAddressBuilder tab = new TransportAddressBuilder();
 194                 tab.setIpAddress(mapRegisterNotification.getTransportAddress().getIpAddress());
 195                 tab.setPort(new PortNumber(LispMessage.PORT_NUM));
 196                 sendMapNotify(mapNotify, tab.build());
 197             } else {
 198                 for (TransportAddress ta : rlocs) {
 199                     sendMapNotify(mapNotify, ta);
 200                 }
 201             }
 202         } else {
 203             LOG.debug("Not sending Map-Notify");
 204         }
 205     }
 206
 207     @Override
 208     public void onRequestMapping(RequestMapping mapRequestNotification) {
 209         MapReply mapReply = handleMapRequest(mapRequestNotification.getMapRequest());
 210         if (mapReply != null) {
 211             SendMapReplyInputBuilder smrib = new SendMapReplyInputBuilder();
 212             smrib.setMapReply((new MapReplyBuilder(mapReply).build()));
 213             smrib.setTransportAddress(mapRequestNotification.getTransportAddress());
 214             getLispSB().sendMapReply(smrib.build());
 215         } else {
 216             LOG.warn("got null map reply");
 217         }
 218     }
 219
 220     @Override
 221     public void onGotMapReply(GotMapReply notification) {
 222         LOG.debug("Received GotMapReply notification, ignoring");
 223     }
 224
 225     @Override
 226     public void onGotMapNotify(GotMapNotify notification) {
 227         LOG.debug("Received GotMapNotify notification, ignoring");
 228     }
 229
 230     @Override
 231     public void onXtrRequestMapping(XtrRequestMapping notification) {
 232         LOG.debug("Received XtrRequestMapping notification, ignoring");
 233     }
 234
 235     @Override
 236     public void onXtrReplyMapping(XtrReplyMapping notification) {
 237         LOG.debug("Received XtrReplyMapping notification, ignoring");
 238     }
 239
 240     private OdlLispSbService getLispSB() {
 241         if (lispSB == null) {
 242             lispSB = session.getRpcService(OdlLispSbService.class);
 243         }
 244         return lispSB;
 245     }
 246
 247     @Override
 248     public void handleMapReply(MapReply reply) {
 249         tlsMapReply.set(reply);
 250     }
 251
 252     @Override
 253     public void handleMapNotify(MapNotify notify, List<TransportAddress> rlocs) {
 254         tlsMapNotify.set(new MutablePair<MapNotify, List<TransportAddress>>(notify, rlocs));
 255     }
 256
 257     @Override
 258     public void handleSMR(MapRequest smr, Rloc subscriber) {
 259         if (LOG.isDebugEnabled()) {
 260             LOG.debug("Sending SMR to {} with Source-EID {} and EID Record {}",
 261                     LispAddressStringifier.getString(subscriber),
 262                     LispAddressStringifier.getString(smr.getSourceEid().getEid()),
 263                     LispAddressStringifier.getString(smr.getEidItem().get(0).getEid()));
 264         }
 265         SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
 266         smrib.setMapRequest(new MapRequestBuilder(smr).build());
 267         smrib.setTransportAddress(LispNotificationHelper.getTransportAddressFromRloc(subscriber));
 268         getLispSB().sendMapRequest(smrib.build());
 269
 270     }
 271
 272     @Override
 273     public void handleNonProxyMapRequest(MapRequest mapRequest, TransportAddress transportAddress) {
 274         tlsMapRequest.set(new MutablePair<MapRequest, TransportAddress>(mapRequest, transportAddress));
 275     }
 276
 277     public void destroy() {
 278         LOG.info("LISP (RFC6830) Mapping Service is destroyed!");
 279         mapResolver = null;
 280         mapServer = null;
 281     }
 282
 283     @Override
 284     public void close() throws Exception {
 285         destroy();
 286     }
 287 }