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.DataBroker;
  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.controller.sal.binding.api.NotificationListener;
  20 import org.opendaylight.controller.sal.binding.api.NotificationService;
  21 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  22 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
  23 import org.opendaylight.lispflowmapping.implementation.dao.HashMapDb;
  24 import org.opendaylight.lispflowmapping.implementation.dao.MappingServiceKey;
  25 import org.opendaylight.lispflowmapping.implementation.dao.MappingServiceNoMaskKey;
  26 import org.opendaylight.lispflowmapping.implementation.lisp.AbstractLispComponent;
  27 import org.opendaylight.lispflowmapping.implementation.lisp.MapResolver;
  28 import org.opendaylight.lispflowmapping.implementation.lisp.MapServer;
  29 import org.opendaylight.lispflowmapping.implementation.mdsal.AuthenticationKeyDataListener;
  30 import org.opendaylight.lispflowmapping.implementation.mdsal.DataStoreBackEnd;
  31 import org.opendaylight.lispflowmapping.implementation.mdsal.MappingDataListener;
  32 import org.opendaylight.lispflowmapping.implementation.serializer.LispMessage;
  33 import org.opendaylight.lispflowmapping.implementation.util.LispAFIConvertor;
  34 import org.opendaylight.lispflowmapping.implementation.util.LispAddressStringifier;
  35 import org.opendaylight.lispflowmapping.implementation.util.LispNotificationHelper;
  36 import org.opendaylight.lispflowmapping.implementation.util.MapServerMapResolverUtil;
  37 import org.opendaylight.lispflowmapping.interfaces.dao.ILispDAO;
  38 import org.opendaylight.lispflowmapping.interfaces.dao.ILispTypeConverter;
  39 import org.opendaylight.lispflowmapping.interfaces.dao.IRowVisitor;
  40 import org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMapping;
  41 import org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMappingShell;
  42 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
  43 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
  44 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
  45 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.AddMapping;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.LfmControlPlaneService;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.MapNotify;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.MapRegister;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.MapReply;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.MapRequest;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.RequestMapping;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.SendMapNotifyInputBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.SendMapReplyInputBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.SendMapRequestInputBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.lispaddress.LispAddressContainer;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.lispaddress.lispaddresscontainer.address.ipv4.Ipv4AddressBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.mapnotifymessage.MapNotifyBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.mapreplymessage.MapReplyBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.maprequestmessage.MapRequestBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.transportaddress.TransportAddress;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.transportaddress.TransportAddressBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mapping.database.rev150314.LfmMappingDatabaseService;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mapping.database.rev150314.MappingOrigin;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mapping.database.rev150314.db.instance.AuthenticationKey;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mapping.database.rev150314.db.instance.Mapping;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;
  69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
  70 import org.opendaylight.yangtools.yang.binding.Notification;
  71 import org.slf4j.Logger;
  72 import org.slf4j.LoggerFactory;
  73
  74 public class LispMappingService implements IFlowMapping, IFlowMappingShell, BindingAwareProvider,
  75         IMapRequestResultHandler, IMapNotifyHandler, AutoCloseable {
  76     protected static final Logger LOG = LoggerFactory.getLogger(LispMappingService.class);
  77
  78     private static final ConfigIni configIni = new ConfigIni();
  79     private AuthenticationKeyDataListener keyListener;
  80     private MappingDataListener mappingListener;
  81     private ILispDAO lispDao = null;
  82     private IMapResolverAsync mapResolver;
  83     private IMapServerAsync mapServer;
  84     private volatile boolean shouldIterateMask;
  85     private volatile boolean shouldAuthenticate;
  86     private volatile boolean smr = configIni.smrIsSet();
  87     private ThreadLocal<MapReply> tlsMapReply = new ThreadLocal<MapReply>();
  88     private ThreadLocal<MapNotify> tlsMapNotify = new ThreadLocal<MapNotify>();
  89     private ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequest = new ThreadLocal<Pair<MapRequest, TransportAddress>>();
  90
  91     private LfmControlPlaneService lispSB = null;
  92     private ProviderContext session;
  93
  94     private DataStoreBackEnd dsbe;
  95     private NotificationService notificationService;
  96     private static LispMappingService lfmService = null;
  97     private BindingAwareBroker.RpcRegistration<LfmMappingDatabaseService> lfmDbRpc;
  98     private DataBroker dataBrokerService;
  99     private RpcProviderRegistry rpcRegistry;
 100     private BindingAwareBroker broker;
 101
 102     public LispMappingService() {
 103         LOG.debug("LispMappingService Module starting!");
 104         lfmService = this;
 105     }
 106
 107     public void setDataBrokerService(DataBroker dataBrokerService) {
 108         this.dataBrokerService = dataBrokerService;
 109     }
 110
 111     public void setRpcProviderRegistry(RpcProviderRegistry rpcRegistry) {
 112         this.rpcRegistry = rpcRegistry;
 113     }
 114
 115     public void setBindingAwareBroker(BindingAwareBroker broker) {
 116         this.broker = broker;
 117     }
 118
 119     public void initialize() {
 120         broker.registerProvider(this);
 121
 122         LfmMappingDatabaseRpc mappingDbProviderRpc = new LfmMappingDatabaseRpc(dataBrokerService);
 123         lfmDbRpc = rpcRegistry.addRpcImplementation(LfmMappingDatabaseService.class, mappingDbProviderRpc);
 124         dsbe = new DataStoreBackEnd(dataBrokerService);
 125         setLispDao(new HashMapDb());
 126     }
 127
 128     @Override
 129     public void onSessionInitiated(ProviderContext session) {
 130         LOG.info("Lisp Consumer session initialized!");
 131         notificationService = session.getSALService(NotificationService.class);
 132         registerNotificationListener(AddMapping.class, new MapRegisterNotificationHandler());
 133         registerNotificationListener(RequestMapping.class, new MapRequestNotificationHandler());
 134         registerDataListeners(session.getSALService(DataBroker.class));
 135         this.session = session;
 136         LOG.info("LISP (RFC6830) Mapping Service init finished");
 137     }
 138
 139     class LispIpv4AddressInMemoryConverter implements ILispTypeConverter<Ipv4Address, Integer> {
 140     }
 141
 142     class LispIpv6AddressInMemoryConverter implements ILispTypeConverter<Ipv6Address, Integer> {
 143     }
 144
 145     class MappingServiceKeyConvertor implements ILispTypeConverter<MappingServiceKey, Integer> {
 146     }
 147
 148     class MappingServiceNoMaskKeyConvertor implements ILispTypeConverter<MappingServiceNoMaskKey, Integer> {
 149     }
 150
 151     public static LispMappingService getLispMappingService() {
 152         return lfmService;
 153     }
 154
 155     public void basicInit(ILispDAO dao) {
 156         lispDao = dao;
 157         mapResolver = new MapResolver(dao);
 158         mapServer = new MapServer(dao);
 159     }
 160
 161     void setLispDao(ILispDAO dao) {
 162         LOG.trace("LispDAO set in LispMappingService");
 163         basicInit(dao);
 164         restoreDaoFromDatastore();
 165     }
 166
 167     void unsetLispDao(ILispDAO dao) {
 168         LOG.trace("LispDAO was unset in LispMappingService");
 169         mapServer = null;
 170         mapResolver = null;
 171         lispDao = null;
 172     }
 173
 174     private void restoreDaoFromDatastore() {
 175         List<Mapping> mappings = dsbe.getAllMappings();
 176         List<AuthenticationKey> authKeys = dsbe.getAllAuthenticationKeys();
 177
 178         LOG.info("Restoring {} mappings and {} keys from datastore into DAO", mappings.size(), authKeys.size());
 179
 180         // restore southbound registered entries first ...
 181         for (Mapping mapping : mappings) {
 182             if (mapping.getOrigin() == MappingOrigin.Southbound) {
 183                 MapRegister register = MapServerMapResolverUtil.getMapRegister(mapping);
 184                 handleMapRegister(register, false);
 185             }
 186         }
 187
 188         // because northbound registrations have priority
 189         for (Mapping mapping : mappings) {
 190             if (mapping.getOrigin() == MappingOrigin.Northbound) {
 191                 MapRegister register = MapServerMapResolverUtil.getMapRegister(mapping);
 192                 handleMapRegister(register, false);
 193             }
 194         }
 195
 196         for (AuthenticationKey authKey : authKeys) {
 197             addAuthenticationKey(authKey.getLispAddressContainer(), authKey.getMaskLength(), authKey.getAuthkey());
 198         }
 199     }
 200
 201     public void destroy() {
 202         LOG.info("LISP (RFC6830) Mapping Service is destroyed!");
 203         mapResolver = null;
 204         mapServer = null;
 205         closeDataListeners();
 206     }
 207
 208     public String printMappings() {
 209         final StringBuffer sb = new StringBuffer();
 210         sb.append("EID\tRLOCs\n");
 211         final IRowVisitor innerVisitor = (new IRowVisitor() {
 212             String lastKey = "";
 213
 214             public void visitRow(Object keyId, String valueKey, Object value) {
 215                 String key = keyId.getClass().getSimpleName() + "#" + keyId;
 216                 if (!lastKey.equals(key)) {
 217                     sb.append(key + "\t");
 218                 }
 219                 if (!(valueKey.equals(AbstractLispComponent.LCAF_SRCDST_SUBKEY))) {
 220                     sb.append(valueKey + "=" + value + "\t");
 221                 }
 222                 lastKey = key;
 223             }
 224         });
 225         lispDao.getAll(new IRowVisitor() {
 226             String lastKey = "";
 227
 228             public void visitRow(Object keyId, String valueKey, Object value) {
 229                 String key = keyId.getClass().getSimpleName() + "#" + keyId;
 230                 if (!lastKey.equals(key)) {
 231                     sb.append("\n" + key + "\t");
 232                 }
 233                 if (valueKey.equals(AbstractLispComponent.LCAF_SRCDST_SUBKEY)) {
 234                     sb.append(valueKey + "= { ");
 235                     ((ILispDAO)value).getAll(innerVisitor);
 236                     sb.append("}\t");
 237                 } else {
 238                     sb.append(valueKey + "=" + value + "\t");
 239                 }
 240                 lastKey = key;
 241             }
 242         });
 243         sb.append("\n");
 244         return sb.toString();
 245     }
 246
 247     public void addDefaultKeyIPv4() {
 248         LispAddressContainer address = LispAFIConvertor.toContainer(
 249                 new Ipv4AddressBuilder().setIpv4Address(new Ipv4Address("0.0.0.0")).build());
 250         addAuthenticationKey(address, 0, "password");
 251     }
 252
 253     public MapReply handleMapRequest(MapRequest request) {
 254         return handleMapRequest(request, smr);
 255     }
 256
 257     public MapReply handleMapRequest(MapRequest request, boolean smr) {
 258         LOG.debug("DAO: Retrieving mapping for {}",
 259                 LispAddressStringifier.getString(request.getEidRecord().get(0).getLispAddressContainer(),
 260                 request.getEidRecord().get(0).getMask()));
 261
 262         tlsMapReply.set(null);
 263         tlsMapRequest.set(null);
 264         mapResolver.handleMapRequest(request, smr, this);
 265         // After this invocation we assume that the thread local is filled with
 266         // the reply
 267         if (tlsMapRequest.get() != null) {
 268             SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
 269             new MapRequestBuilder(tlsMapRequest.get().getLeft());
 270             smrib.setMapRequest(new MapRequestBuilder(tlsMapRequest.get().getLeft()).build());
 271             smrib.setTransportAddress(tlsMapRequest.get().getRight());
 272             getLispSB().sendMapRequest(smrib.build());
 273             return null;
 274         } else {
 275             return tlsMapReply.get();
 276         }
 277
 278     }
 279
 280     public MapNotify handleMapRegister(MapRegister mapRegister) {
 281         return handleMapRegister(mapRegister, smr);
 282     }
 283
 284     public MapNotify handleMapRegister(MapRegister mapRegister, boolean smr) {
 285         LOG.debug("DAO: Adding mapping for {}",
 286                 LispAddressStringifier.getString(mapRegister.getEidToLocatorRecord().get(0).getLispAddressContainer(),
 287                 mapRegister.getEidToLocatorRecord().get(0).getMaskLength()));
 288
 289         tlsMapNotify.set(null);
 290         mapServer.handleMapRegister(mapRegister, smr, this);
 291         // After this invocation we assume that the thread local is filled with
 292         // the reply
 293         return tlsMapNotify.get();
 294     }
 295
 296     public String getAuthenticationKey(LispAddressContainer address, int maskLen) {
 297         LOG.debug("DAO: Retrieving authentication key for {}", LispAddressStringifier.getString(address, maskLen));
 298         return mapServer.getAuthenticationKey(address, maskLen);
 299     }
 300
 301     public void removeAuthenticationKey(LispAddressContainer address, int maskLen) {
 302         LOG.debug("DAO: Removing authentication key for {}", LispAddressStringifier.getString(address, maskLen));
 303         mapServer.removeAuthenticationKey(address, maskLen);
 304     }
 305
 306     public void addAuthenticationKey(LispAddressContainer address, int maskLen, String key) {
 307         LOG.debug("DAO: Adding authentication key '{}' for {}", key,
 308                 LispAddressStringifier.getString(address, maskLen));
 309         mapServer.addAuthenticationKey(address, maskLen, key);
 310     }
 311
 312     public void removeMapping(LispAddressContainer address, int maskLen) {
 313         LOG.debug("DAO: Removing mapping for {}", LispAddressStringifier.getString(address, maskLen));
 314         mapServer.removeMapping(address, maskLen, smr, this);
 315     }
 316
 317     public boolean shouldIterateMask() {
 318         return this.shouldIterateMask;
 319     }
 320
 321     public boolean shouldUseSmr() {
 322         return this.smr;
 323     }
 324
 325     public void setShouldUseSmr(boolean smr) {
 326         this.smr = smr;
 327     }
 328
 329     public void setShouldIterateMask(boolean shouldIterateMask) {
 330         this.shouldIterateMask = shouldIterateMask;
 331         this.mapResolver.setShouldIterateMask(shouldIterateMask);
 332         this.mapServer.setShouldIterateMask(shouldIterateMask);
 333     }
 334
 335     public void setShouldAuthenticate(boolean shouldAuthenticate) {
 336         this.shouldAuthenticate = shouldAuthenticate;
 337         this.mapResolver.setShouldAuthenticate(shouldAuthenticate);
 338         this.mapServer.setShouldAuthenticate(shouldAuthenticate);
 339     }
 340
 341     public boolean shouldAuthenticate() {
 342         return shouldAuthenticate;
 343     }
 344
 345     private void registerDataListeners(DataBroker broker) {
 346         keyListener = new AuthenticationKeyDataListener(broker, this);
 347         mappingListener = new MappingDataListener(broker, this);
 348     }
 349
 350     private void closeDataListeners() {
 351         keyListener.closeDataChangeListener();
 352         mappingListener.closeDataChangeListener();
 353     }
 354
 355     public <T extends Notification> void registerNotificationListener(Class<T> notificationType, NotificationListener<T> listener) {
 356         notificationService.registerNotificationListener(notificationType, listener);
 357     }
 358
 359     private class MapRegisterNotificationHandler implements NotificationListener<AddMapping> {
 360
 361         @Override
 362         public void onNotification(AddMapping mapRegisterNotification) {
 363             MapNotify mapNotify = handleMapRegister(mapRegisterNotification.getMapRegister(), smr);
 364             if (mapNotify != null) {
 365                 // store mappings in md-sal datastore only if we have a MapNotify
 366                 // XXX: this assumes that null MapNotifys are equivalent to authentication/registration errors
 367                 //      however notifies may be disabled with a flag (by the registering router). This should
 368                 //      be solved by moving southbound authentication of registrations out of handleMapRegister().
 369                 List<Mapping> mappings = LispNotificationHelper.getMapping(mapRegisterNotification);
 370                 for (Mapping mapping : mappings) {
 371                     dsbe.updateMapping(mapping);
 372                 }
 373
 374                 TransportAddressBuilder tab = new TransportAddressBuilder();
 375                 tab.setIpAddress(mapRegisterNotification.getTransportAddress().getIpAddress());
 376                 tab.setPort(new PortNumber(LispMessage.PORT_NUM));
 377                 SendMapNotifyInputBuilder smnib = new SendMapNotifyInputBuilder();
 378                 smnib.setMapNotify(new MapNotifyBuilder(mapNotify).build());
 379                 smnib.setTransportAddress(tab.build());
 380                 getLispSB().sendMapNotify(smnib.build());
 381             } else {
 382                 LOG.warn("got null map notify");
 383             }
 384
 385         }
 386     }
 387
 388     private class MapRequestNotificationHandler implements NotificationListener<RequestMapping> {
 389
 390         @Override
 391         public void onNotification(RequestMapping mapRequestNotification) {
 392             MapReply mapReply = handleMapRequest(mapRequestNotification.getMapRequest());
 393             if (mapReply != null) {
 394                 SendMapReplyInputBuilder smrib = new SendMapReplyInputBuilder();
 395                 smrib.setMapReply((new MapReplyBuilder(mapReply).build()));
 396                 smrib.setTransportAddress(mapRequestNotification.getTransportAddress());
 397                 getLispSB().sendMapReply(smrib.build());
 398             } else {
 399                 LOG.warn("got null map reply");
 400             }
 401         }
 402     }
 403
 404     private LfmControlPlaneService getLispSB() {
 405         if (lispSB == null) {
 406             lispSB = session.getRpcService(LfmControlPlaneService.class);
 407         }
 408         return lispSB;
 409     }
 410
 411     public void handleMapReply(MapReply reply) {
 412         tlsMapReply.set(reply);
 413     }
 414
 415     public void handleMapNotify(MapNotify notify) {
 416         tlsMapNotify.set(notify);
 417     }
 418
 419     public void handleSMR(MapRequest smr, LispAddressContainer subscriber) {
 420         LOG.debug("Sending SMR to " + subscriber.toString());
 421         SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
 422         smrib.setMapRequest(new MapRequestBuilder(smr).build());
 423         smrib.setTransportAddress(LispNotificationHelper.getTransportAddressFromContainer(subscriber));
 424         getLispSB().sendMapRequest(smrib.build());
 425
 426     }
 427
 428     @Override
 429     public void handleNonProxyMapRequest(MapRequest mapRequest, TransportAddress transportAddress) {
 430         tlsMapRequest.set(new MutablePair<MapRequest, TransportAddress>(mapRequest, transportAddress));
 431     }
 432
 433     @Override
 434     public void clean() {
 435         lispDao.removeAll();
 436     }
 437
 438     @Override
 439     public boolean shouldOverwrite() {
 440         return mapServer.shouldOverwrite();
 441     }
 442
 443     @Override
 444     public void setOverwrite(boolean overwrite) {
 445         mapServer.setOverwrite(overwrite);
 446     }
 447
 448     @Override
 449     public void close() throws Exception {
 450         lfmDbRpc.close();
 451         destroy();
 452     }
 453 }