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.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         setLispDao(new HashMapDb());
 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     void setLispDao(ILispDAO dao) {
 161         LOG.trace("LispDAO set in LispMappingService");
 162         basicInit(dao);
 163         restoreDaoFromDatastore();
 164     }
 165
 166     void unsetLispDao(ILispDAO dao) {
 167         LOG.trace("LispDAO was unset in LispMappingService");
 168         mapServer = null;
 169         mapResolver = null;
 170         lispDao = null;
 171     }
 172
 173     private void restoreDaoFromDatastore() {
 174         List<Mapping> mappings = dsbe.getAllMappings();
 175         List<AuthenticationKey> authKeys = dsbe.getAllAuthenticationKeys();
 176
 177         LOG.info("Restoring {} mappings and {} keys from datastore into DAO", mappings.size(), authKeys.size());
 178
 179         // restore southbound registered entries first ...
 180         for (Mapping mapping : mappings) {
 181             if (mapping.getOrigin() == MappingOrigin.Southbound) {
 182                 MapRegister register = MapServerMapResolverUtil.getMapRegister(mapping);
 183                 handleMapRegister(register, false);
 184             }
 185         }
 186
 187         // because northbound registrations have priority
 188         for (Mapping mapping : mappings) {
 189             if (mapping.getOrigin() == MappingOrigin.Northbound) {
 190                 MapRegister register = MapServerMapResolverUtil.getMapRegister(mapping);
 191                 handleMapRegister(register, false);
 192             }
 193         }
 194
 195         for (AuthenticationKey authKey : authKeys) {
 196             addAuthenticationKey(authKey.getLispAddressContainer(), authKey.getMaskLength(), authKey.getAuthkey());
 197         }
 198     }
 199
 200     public void destroy() {
 201         LOG.info("LISP (RFC6830) Mapping Service is destroyed!");
 202         mapResolver = null;
 203         mapServer = null;
 204         closeDataListeners();
 205     }
 206
 207     public String printMappings() {
 208         final StringBuffer sb = new StringBuffer();
 209         sb.append("EID\tRLOCs\n");
 210         lispDao.getAll(new IRowVisitor() {
 211             String lastKey = "";
 212
 213             public void visitRow(Object keyId, String valueKey, Object value) {
 214                 String key = keyId.getClass().getSimpleName() + "#" + keyId;
 215                 if (!lastKey.equals(key)) {
 216                     sb.append("\n" + key + "\t");
 217                 }
 218                 sb.append(valueKey + "=" + value + "\t");
 219                 lastKey = key;
 220             }
 221         });
 222         sb.append("\n");
 223         return sb.toString();
 224     }
 225
 226     public void addDefaultKeyIPv4() {
 227         LispAddressContainer address = LispAFIConvertor.toContainer(
 228                 new Ipv4AddressBuilder().setIpv4Address(new Ipv4Address("0.0.0.0")).build());
 229         addAuthenticationKey(address, 0, "password");
 230     }
 231
 232     public MapReply handleMapRequest(MapRequest request) {
 233         return handleMapRequest(request, smr);
 234     }
 235
 236     public MapReply handleMapRequest(MapRequest request, boolean smr) {
 237         LOG.debug("DAO: Retrieving mapping for {}",
 238                 LispAddressStringifier.getString(request.getEidRecord().get(0).getLispAddressContainer(),
 239                 request.getEidRecord().get(0).getMask()));
 240
 241         tlsMapReply.set(null);
 242         tlsMapRequest.set(null);
 243         mapResolver.handleMapRequest(request, smr, this);
 244         // After this invocation we assume that the thread local is filled with
 245         // the reply
 246         if (tlsMapRequest.get() != null) {
 247             SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
 248             new MapRequestBuilder(tlsMapRequest.get().getLeft());
 249             smrib.setMapRequest(new MapRequestBuilder(tlsMapRequest.get().getLeft()).build());
 250             smrib.setTransportAddress(tlsMapRequest.get().getRight());
 251             getLispSB().sendMapRequest(smrib.build());
 252             return null;
 253         } else {
 254             return tlsMapReply.get();
 255         }
 256
 257     }
 258
 259     public MapNotify handleMapRegister(MapRegister mapRegister) {
 260         return handleMapRegister(mapRegister, smr);
 261     }
 262
 263     public MapNotify handleMapRegister(MapRegister mapRegister, boolean smr) {
 264         LOG.debug("DAO: Adding mapping for {}",
 265                 LispAddressStringifier.getString(mapRegister.getEidToLocatorRecord().get(0).getLispAddressContainer(),
 266                 mapRegister.getEidToLocatorRecord().get(0).getMaskLength()));
 267
 268         tlsMapNotify.set(null);
 269         mapServer.handleMapRegister(mapRegister, smr, this);
 270         // After this invocation we assume that the thread local is filled with
 271         // the reply
 272         return tlsMapNotify.get();
 273     }
 274
 275     public String getAuthenticationKey(LispAddressContainer address, int maskLen) {
 276         LOG.debug("DAO: Retrieving authentication key for {}", LispAddressStringifier.getString(address, maskLen));
 277         return mapServer.getAuthenticationKey(address, maskLen);
 278     }
 279
 280     public void removeAuthenticationKey(LispAddressContainer address, int maskLen) {
 281         LOG.debug("DAO: Removing authentication key for {}", LispAddressStringifier.getString(address, maskLen));
 282         mapServer.removeAuthenticationKey(address, maskLen);
 283     }
 284
 285     public void addAuthenticationKey(LispAddressContainer address, int maskLen, String key) {
 286         LOG.debug("DAO: Adding authentication key '{}' for {}", key,
 287                 LispAddressStringifier.getString(address, maskLen));
 288         mapServer.addAuthenticationKey(address, maskLen, key);
 289     }
 290
 291     public void removeMapping(LispAddressContainer address, int maskLen) {
 292         LOG.debug("DAO: Removing mapping for {}", LispAddressStringifier.getString(address, maskLen));
 293         mapServer.removeMapping(address, maskLen, smr, this);
 294     }
 295
 296     public boolean shouldIterateMask() {
 297         return this.shouldIterateMask;
 298     }
 299
 300     public boolean shouldUseSmr() {
 301         return this.smr;
 302     }
 303
 304     public void setShouldUseSmr(boolean smr) {
 305         this.smr = smr;
 306     }
 307
 308     public void setShouldIterateMask(boolean shouldIterateMask) {
 309         this.shouldIterateMask = shouldIterateMask;
 310         this.mapResolver.setShouldIterateMask(shouldIterateMask);
 311         this.mapServer.setShouldIterateMask(shouldIterateMask);
 312     }
 313
 314     public void setShouldAuthenticate(boolean shouldAuthenticate) {
 315         this.shouldAuthenticate = shouldAuthenticate;
 316         this.mapResolver.setShouldAuthenticate(shouldAuthenticate);
 317         this.mapServer.setShouldAuthenticate(shouldAuthenticate);
 318     }
 319
 320     public boolean shouldAuthenticate() {
 321         return shouldAuthenticate;
 322     }
 323
 324     private void registerDataListeners(DataBroker broker) {
 325         keyListener = new AuthenticationKeyDataListener(broker, this);
 326         mappingListener = new MappingDataListener(broker, this);
 327     }
 328
 329     private void closeDataListeners() {
 330         keyListener.closeDataChangeListener();
 331         mappingListener.closeDataChangeListener();
 332     }
 333
 334     public <T extends Notification> void registerNotificationListener(Class<T> notificationType, NotificationListener<T> listener) {
 335         notificationService.registerNotificationListener(notificationType, listener);
 336     }
 337
 338     private class MapRegisterNotificationHandler implements NotificationListener<AddMapping> {
 339
 340         @Override
 341         public void onNotification(AddMapping mapRegisterNotification) {
 342             MapNotify mapNotify = handleMapRegister(mapRegisterNotification.getMapRegister(), smr);
 343             if (mapNotify != null) {
 344                 // store mappings in md-sal datastore only if we have a MapNotify
 345                 // XXX: this assumes that null MapNotifys are equivalent to authentication/registration errors
 346                 //      however notifies may be disabled with a flag (by the registering router). This should
 347                 //      be solved by moving southbound authentication of registrations out of handleMapRegister().
 348                 List<Mapping> mappings = LispNotificationHelper.getMapping(mapRegisterNotification);
 349                 for (Mapping mapping : mappings) {
 350                     dsbe.updateMapping(mapping);
 351                 }
 352
 353                 TransportAddressBuilder tab = new TransportAddressBuilder();
 354                 tab.setIpAddress(mapRegisterNotification.getTransportAddress().getIpAddress());
 355                 tab.setPort(new PortNumber(LispMessage.PORT_NUM));
 356                 SendMapNotifyInputBuilder smnib = new SendMapNotifyInputBuilder();
 357                 smnib.setMapNotify(new MapNotifyBuilder(mapNotify).build());
 358                 smnib.setTransportAddress(tab.build());
 359                 getLispSB().sendMapNotify(smnib.build());
 360             } else {
 361                 LOG.warn("got null map notify");
 362             }
 363
 364         }
 365     }
 366
 367     private class MapRequestNotificationHandler implements NotificationListener<RequestMapping> {
 368
 369         @Override
 370         public void onNotification(RequestMapping mapRequestNotification) {
 371             MapReply mapReply = handleMapRequest(mapRequestNotification.getMapRequest());
 372             if (mapReply != null) {
 373                 SendMapReplyInputBuilder smrib = new SendMapReplyInputBuilder();
 374                 smrib.setMapReply((new MapReplyBuilder(mapReply).build()));
 375                 smrib.setTransportAddress(mapRequestNotification.getTransportAddress());
 376                 getLispSB().sendMapReply(smrib.build());
 377             } else {
 378                 LOG.warn("got null map reply");
 379             }
 380         }
 381     }
 382
 383     private LfmControlPlaneService getLispSB() {
 384         if (lispSB == null) {
 385             lispSB = session.getRpcService(LfmControlPlaneService.class);
 386         }
 387         return lispSB;
 388     }
 389
 390     public void handleMapReply(MapReply reply) {
 391         tlsMapReply.set(reply);
 392     }
 393
 394     public void handleMapNotify(MapNotify notify) {
 395         tlsMapNotify.set(notify);
 396     }
 397
 398     public void handleSMR(MapRequest smr, LispAddressContainer subscriber) {
 399         LOG.debug("Sending SMR to " + subscriber.toString());
 400         SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
 401         smrib.setMapRequest(new MapRequestBuilder(smr).build());
 402         smrib.setTransportAddress(LispNotificationHelper.getTransportAddressFromContainer(subscriber));
 403         getLispSB().sendMapRequest(smrib.build());
 404
 405     }
 406
 407     @Override
 408     public void handleNonProxyMapRequest(MapRequest mapRequest, TransportAddress transportAddress) {
 409         tlsMapRequest.set(new MutablePair<MapRequest, TransportAddress>(mapRequest, transportAddress));
 410     }
 411
 412     @Override
 413     public void clean() {
 414         lispDao.removeAll();
 415     }
 416
 417     @Override
 418     public boolean shouldOverwrite() {
 419         return mapServer.shouldOverwrite();
 420     }
 421
 422     @Override
 423     public void setOverwrite(boolean overwrite) {
 424         mapServer.setOverwrite(overwrite);
 425     }
 426
 427     @Override
 428     public void close() throws Exception {
 429         lfmDbRpc.close();
 430         destroy();
 431     }
 432 }