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