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 org.apache.commons.lang3.tuple.MutablePair;
  12 import org.apache.commons.lang3.tuple.Pair;
  13 import org.eclipse.osgi.framework.console.CommandInterpreter;
  14 import org.eclipse.osgi.framework.console.CommandProvider;
  15 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  16 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerContext;
  17 import org.opendaylight.controller.sal.binding.api.BindingAwareConsumer;
  18 import org.opendaylight.controller.sal.binding.api.NotificationListener;
  19 import org.opendaylight.controller.sal.binding.api.NotificationService;
  20 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
  21 import org.opendaylight.lispflowmapping.implementation.dao.MappingServiceKey;
  22 import org.opendaylight.lispflowmapping.implementation.dao.MappingServiceKeyUtil;
  23 import org.opendaylight.lispflowmapping.implementation.dao.MappingServiceNoMaskKey;
  24 import org.opendaylight.lispflowmapping.implementation.lisp.MapResolver;
  25 import org.opendaylight.lispflowmapping.implementation.lisp.MapServer;
  26 import org.opendaylight.lispflowmapping.implementation.serializer.LispMessage;
  27 import org.opendaylight.lispflowmapping.implementation.util.LispAFIConvertor;
  28 import org.opendaylight.lispflowmapping.implementation.util.LispNotificationHelper;
  29 import org.opendaylight.lispflowmapping.interfaces.dao.ILispDAO;
  30 import org.opendaylight.lispflowmapping.interfaces.dao.ILispTypeConverter;
  31 import org.opendaylight.lispflowmapping.interfaces.dao.IRowVisitor;
  32 import org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMapping;
  33 import org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMappingShell;
  34 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
  35 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
  36 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
  37 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
  38 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.AddMapping;
  39 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.LispflowmappingService;
  40 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapNotify;
  41 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapRegister;
  42 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapReply;
  43 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapRequest;
  44 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.RequestMapping;
  45 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.SendMapNotifyInputBuilder;
  46 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.SendMapReplyInputBuilder;
  47 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.SendMapRequestInputBuilder;
  48 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispaddress.LispAddressContainer;
  49 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispaddress.LispAddressContainerBuilder;
  50 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispaddress.lispaddresscontainer.Address;
  51 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispaddress.lispaddresscontainer.address.Ipv4Builder;
  52 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.mapnotifymessage.MapNotifyBuilder;
  53 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.mapreplymessage.MapReplyBuilder;
  54 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.maprequestmessage.MapRequestBuilder;
  55 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.transportaddress.TransportAddress;
  56 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.transportaddress.TransportAddressBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
  60 import org.opendaylight.yangtools.yang.binding.Notification;
  61 import org.osgi.framework.BundleContext;
  62 import org.osgi.framework.FrameworkUtil;
  63 import org.slf4j.Logger;
  64 import org.slf4j.LoggerFactory;
  65
  66 public class LispMappingService implements CommandProvider, IFlowMapping, IFlowMappingShell, BindingAwareConsumer,
  67         IMapRequestResultHandler, IMapNotifyHandler {
  68     protected static final Logger LOG = LoggerFactory.getLogger(LispMappingService.class);
  69
  70     private static final ConfigIni configIni = new ConfigIni();
  71     private ILispDAO lispDao = null;
  72     private IMapResolverAsync mapResolver;
  73     private IMapServerAsync mapServer;
  74     private volatile boolean shouldIterateMask;
  75     private volatile boolean shouldAuthenticate;
  76     private volatile boolean smr = configIni.smrIsSet();
  77     private ThreadLocal<MapReply> tlsMapReply = new ThreadLocal<MapReply>();
  78     private ThreadLocal<MapNotify> tlsMapNotify = new ThreadLocal<MapNotify>();
  79     private ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequest = new ThreadLocal<Pair<MapRequest, TransportAddress>>();
  80
  81     private LispflowmappingService lispSB = null;
  82
  83     private ConsumerContext session;
  84
  85     private NotificationService notificationService;
  86
  87     class LispIpv4AddressInMemoryConverter implements ILispTypeConverter<Ipv4Address, Integer> {
  88     }
  89
  90     class LispIpv6AddressInMemoryConverter implements ILispTypeConverter<Ipv6Address, Integer> {
  91     }
  92
  93     class MappingServiceKeyConvertor implements ILispTypeConverter<MappingServiceKey, Integer> {
  94     }
  95
  96     class MappingServiceNoMaskKeyConvertor implements ILispTypeConverter<MappingServiceNoMaskKey, Integer> {
  97     }
  98
  99     void setBindingAwareBroker(BindingAwareBroker bindingAwareBroker) {
 100         LOG.trace("BindingAwareBroker set!");
 101         BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass()).getBundleContext();
 102         bindingAwareBroker.registerConsumer(this, bundleContext);
 103     }
 104
 105     void unsetBindingAwareBroker(BindingAwareBroker bindingAwareBroker) {
 106         LOG.debug("BindingAwareBroker was unset in LispMappingService");
 107     }
 108
 109     public void basicInit(ILispDAO dao) {
 110         lispDao = dao;
 111         mapResolver = new MapResolver(dao);
 112         mapServer = new MapServer(dao);
 113     }
 114
 115     void setLispDao(ILispDAO dao) {
 116         LOG.trace("LispDAO set in LispMappingService");
 117         basicInit(dao);
 118     }
 119
 120     void unsetLispDao(ILispDAO dao) {
 121         LOG.trace("LispDAO was unset in LispMappingService");
 122         mapServer = null;
 123         mapResolver = null;
 124         lispDao = null;
 125     }
 126
 127     public void init() {
 128         try {
 129             registerWithOSGIConsole();
 130             LOG.info("LISP (RFC6830) Mapping Service init finished");
 131         } catch (Exception e) {
 132             LOG.error(e.getStackTrace().toString());
 133         }
 134     }
 135
 136     private void registerWithOSGIConsole() {
 137         BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass()).getBundleContext();
 138         bundleContext.registerService(CommandProvider.class.getName(), this, null);
 139     }
 140
 141     public void destroy() {
 142         LOG.info("LISP (RFC6830) Mapping Service is destroyed!");
 143         mapResolver = null;
 144         mapServer = null;
 145     }
 146
 147     public void _removeEid(final CommandInterpreter ci) {
 148         LispAddressContainer eid = LispAFIConvertor.getIPContainer(ci.nextArgument());
 149         lispDao.remove(MappingServiceKeyUtil.generateMappingServiceKey(eid));
 150     }
 151
 152     public void _dumpAll(final CommandInterpreter ci) {
 153         ci.print(printMappings());
 154     }
 155
 156     public String printMappings() {
 157         final StringBuffer sb = new StringBuffer();
 158         sb.append("EID\tRLOCs\n");
 159         lispDao.getAll(new IRowVisitor() {
 160             String lastKey = "";
 161
 162             public void visitRow(Object keyId, String valueKey, Object value) {
 163                 String key = keyId.getClass().getSimpleName() + "#" + keyId;
 164                 if (!lastKey.equals(key)) {
 165                     sb.append("\n" + key + "\t");
 166                 }
 167                 sb.append(valueKey + "=" + value + "\t");
 168                 lastKey = key;
 169             }
 170         });
 171         sb.append("\n");
 172         return sb.toString();
 173     }
 174
 175     public void _setShouldOverwriteRlocs(final CommandInterpreter ci) {
 176         try {
 177             boolean shouldOverwriteRloc = Boolean.parseBoolean(ci.nextArgument());
 178             setOverwrite(shouldOverwriteRloc);
 179         } catch (Exception e) {
 180             ci.println("Bad Usage!!");
 181         }
 182
 183     }
 184
 185     public void _addDefaultPassword(final CommandInterpreter ci) {
 186         addDefaultKeyIPv4();
 187     }
 188
 189     public void addDefaultKeyIPv4() {
 190         LispAddressContainerBuilder builder = new LispAddressContainerBuilder();
 191         builder.setAddress((Address) (new Ipv4Builder().setIpv4Address(new Ipv4Address("0.0.0.0")).build()));
 192         addAuthenticationKey(builder.build(), 0, "password");
 193     }
 194
 195     public String getHelp() {
 196         StringBuffer help = new StringBuffer();
 197         help.append("---LISP Mapping Service---\n");
 198         help.append("\t dumpAll                               - Dump all current EID -> RLOC mappings\n");
 199         help.append("\t removeEid <EID>                       - Remove a single EID (/32 or /128)\n");
 200         help.append("\t setShouldOverwriteRlocs <true|false>  - Set the map server's behavior regarding existing RLOCs\n");
 201         help.append("\t addDefaultPassword                    - Add \"password\" as default password for IPv4 EIDs");
 202         return help.toString();
 203     }
 204
 205     public MapReply handleMapRequest(MapRequest request) {
 206         return handleMapRequest(request, smr);
 207     }
 208
 209     public MapReply handleMapRequest(MapRequest request, boolean smr) {
 210         tlsMapReply.set(null);
 211         tlsMapRequest.set(null);
 212         mapResolver.handleMapRequest(request, smr, this);
 213         // After this invocation we assume that the thread local is filled with
 214         // the reply
 215         if (tlsMapRequest.get() != null) {
 216             SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
 217             new MapRequestBuilder(tlsMapRequest.get().getLeft());
 218             smrib.setMapRequest(new MapRequestBuilder(tlsMapRequest.get().getLeft()).build());
 219             smrib.setTransportAddress(tlsMapRequest.get().getRight());
 220             getLispSB().sendMapRequest(smrib.build());
 221             return null;
 222         } else {
 223             return tlsMapReply.get();
 224         }
 225
 226     }
 227
 228     public MapNotify handleMapRegister(MapRegister mapRegister) {
 229         return handleMapRegister(mapRegister, smr);
 230     }
 231
 232     public MapNotify handleMapRegister(MapRegister mapRegister, boolean smr) {
 233         tlsMapNotify.set(null);
 234         mapServer.handleMapRegister(mapRegister, smr, this);
 235         // After this invocation we assume that the thread local is filled with
 236         // the reply
 237         return tlsMapNotify.get();
 238     }
 239
 240     public String getAuthenticationKey(LispAddressContainer address, int maskLen) {
 241         return mapServer.getAuthenticationKey(address, maskLen);
 242     }
 243
 244     public void removeAuthenticationKey(LispAddressContainer address, int maskLen) {
 245         mapServer.removeAuthenticationKey(address, maskLen);
 246     }
 247
 248     public void addAuthenticationKey(LispAddressContainer address, int maskLen, String key) {
 249         mapServer.addAuthenticationKey(address, maskLen, key);
 250     }
 251
 252     public void removeMapping(LispAddressContainer address, int maskLen) {
 253         mapServer.removeMapping(address, maskLen, smr, this);
 254     }
 255
 256     public boolean shouldIterateMask() {
 257         return this.shouldIterateMask;
 258     }
 259
 260     public boolean shouldUseSmr() {
 261         return this.smr;
 262     }
 263
 264     public void setShouldUseSmr(boolean smr) {
 265         this.smr = smr;
 266     }
 267
 268     public void setShouldIterateMask(boolean shouldIterateMask) {
 269         this.shouldIterateMask = shouldIterateMask;
 270         this.mapResolver.setShouldIterateMask(shouldIterateMask);
 271         this.mapServer.setShouldIterateMask(shouldIterateMask);
 272     }
 273
 274     public void setShouldAuthenticate(boolean shouldAuthenticate) {
 275         this.shouldAuthenticate = shouldAuthenticate;
 276         this.mapResolver.setShouldAuthenticate(shouldAuthenticate);
 277         this.mapServer.setShouldAuthenticate(shouldAuthenticate);
 278     }
 279
 280     public boolean shouldAuthenticate() {
 281         return shouldAuthenticate;
 282     }
 283
 284     public void onSessionInitialized(ConsumerContext session) {
 285         LOG.info("Lisp Consumer session initialized!");
 286         notificationService = session.getSALService(NotificationService.class);
 287         registerNotificationListener(AddMapping.class, new MapRegisterNotificationHandler());
 288         registerNotificationListener(RequestMapping.class, new MapRequestNotificationHandler());
 289         this.session = session;
 290     }
 291
 292     public <T extends Notification> void registerNotificationListener(Class<T> notificationType, NotificationListener<T> listener) {
 293         notificationService.registerNotificationListener(notificationType, listener);
 294     }
 295
 296     private class MapRegisterNotificationHandler implements NotificationListener<AddMapping> {
 297
 298         @Override
 299         public void onNotification(AddMapping mapRegisterNotification) {
 300             MapNotify mapNotify = handleMapRegister(mapRegisterNotification.getMapRegister(), smr);
 301             if (mapNotify != null) {
 302                 TransportAddressBuilder tab = new TransportAddressBuilder();
 303                 tab.setIpAddress(mapRegisterNotification.getTransportAddress().getIpAddress());
 304                 tab.setPort(new PortNumber(LispMessage.PORT_NUM));
 305                 SendMapNotifyInputBuilder smnib = new SendMapNotifyInputBuilder();
 306                 smnib.setMapNotify(new MapNotifyBuilder(mapNotify).build());
 307                 smnib.setTransportAddress(tab.build());
 308                 getLispSB().sendMapNotify(smnib.build());
 309             } else {
 310                 LOG.warn("got null map notify");
 311             }
 312
 313         }
 314     }
 315
 316     private class MapRequestNotificationHandler implements NotificationListener<RequestMapping> {
 317
 318         @Override
 319         public void onNotification(RequestMapping mapRequestNotification) {
 320             MapReply mapReply = handleMapRequest(mapRequestNotification.getMapRequest());
 321             if (mapReply != null) {
 322                 SendMapReplyInputBuilder smrib = new SendMapReplyInputBuilder();
 323                 smrib.setMapReply((new MapReplyBuilder(mapReply).build()));
 324                 smrib.setTransportAddress(mapRequestNotification.getTransportAddress());
 325                 getLispSB().sendMapReply(smrib.build());
 326             } else {
 327                 LOG.warn("got null map reply");
 328             }
 329         }
 330     }
 331
 332     private LispflowmappingService getLispSB() {
 333         if (lispSB == null) {
 334             lispSB = session.getRpcService(LispflowmappingService.class);
 335         }
 336         return lispSB;
 337     }
 338
 339     public void handleMapReply(MapReply reply) {
 340         tlsMapReply.set(reply);
 341     }
 342
 343     public void handleMapNotify(MapNotify notify) {
 344         tlsMapNotify.set(notify);
 345     }
 346
 347     public void handleSMR(MapRequest smr, LispAddressContainer subscriber) {
 348         LOG.debug("Sending SMR to " + subscriber.toString());
 349         SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
 350         smrib.setMapRequest(new MapRequestBuilder(smr).build());
 351         smrib.setTransportAddress(LispNotificationHelper.getTransportAddressFromContainer(subscriber));
 352         getLispSB().sendMapRequest(smrib.build());
 353
 354     }
 355
 356     @Override
 357     public void handleNonProxyMapRequest(MapRequest mapRequest, TransportAddress transportAddress) {
 358         tlsMapRequest.set(new MutablePair<MapRequest, TransportAddress>(mapRequest, transportAddress));
 359     }
 360
 361     @Override
 362     public void clean() {
 363         lispDao.removeAll();
 364     }
 365
 366     @Override
 367     public boolean shouldOverwrite() {
 368         return mapServer.shouldOverwrite();
 369     }
 370
 371     @Override
 372     public void setOverwrite(boolean overwrite) {
 373         mapServer.setOverwrite(overwrite);
 374     }
 375
 376 }