mappingservice/implementation/src/main/java/org/opendaylight/lispflowmapping/implementation/lisp/MapServer.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.lisp;
  10
  11 import java.net.InetAddress;
  12 import java.net.NetworkInterface;
  13 import java.net.SocketException;
  14 import java.util.ArrayList;
  15 import java.util.Enumeration;
  16 import java.util.HashSet;
  17 import java.util.Iterator;
  18 import java.util.List;
  19 import java.util.Objects;
  20 import java.util.Set;
  21
  22 import org.apache.commons.lang3.BooleanUtils;
  23 import org.apache.commons.lang3.exception.ExceptionUtils;
  24 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  25 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
  26 import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
  27 import org.opendaylight.lispflowmapping.interfaces.dao.SubscriberRLOC;
  28 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
  29 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
  30 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
  31 import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
  32 import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
  33 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
  34 import org.opendaylight.lispflowmapping.lisp.util.MapNotifyBuilderHelper;
  35 import org.opendaylight.lispflowmapping.lisp.util.MapRequestUtil;
  36 import org.opendaylight.lispflowmapping.lisp.util.SourceDestKeyHelper;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.IpAddressBinary;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegister;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.SiteId;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItem;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItemBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapnotifymessage.MapNotifyBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecordBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItem;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItemBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequestBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChange;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChanged;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.OdlMappingserviceListener;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.container.MappingAuthkey;
  58 import org.slf4j.Logger;
  59 import org.slf4j.LoggerFactory;
  60
  61 import com.google.common.base.Preconditions;
  62
  63 public class MapServer implements IMapServerAsync, OdlMappingserviceListener {
  64
  65     protected static final Logger LOG = LoggerFactory.getLogger(MapServer.class);
  66     private IMappingService mapService;
  67     private boolean subscriptionService;
  68     private IMapNotifyHandler notifyHandler;
  69     private NotificationService notificationService;
  70
  71     public MapServer(IMappingService mapService, boolean subscriptionService,
  72             IMapNotifyHandler notifyHandler, NotificationService notificationService) {
  73         Preconditions.checkNotNull(mapService);
  74         this.mapService = mapService;
  75         this.subscriptionService = subscriptionService;
  76         this.notifyHandler = notifyHandler;
  77         this.notificationService = notificationService;
  78         if (notificationService != null) {
  79             notificationService.registerNotificationListener(this);
  80         }
  81     }
  82
  83     @Override
  84     public void setSubscriptionService(boolean subscriptionService) {
  85         this.subscriptionService = subscriptionService;
  86     }
  87
  88     @SuppressWarnings("unchecked")
  89     public void handleMapRegister(MapRegister mapRegister) {
  90         boolean authFailed = false;
  91         boolean mappingUpdated = false;
  92         boolean merge = ConfigIni.getInstance().mappingMergeIsSet() && mapRegister.isMergeEnabled();
  93         MappingAuthkey authkey = null;
  94         Set<SubscriberRLOC> subscribers = null;
  95         MappingRecord oldMapping;
  96
  97         for (MappingRecordItem record : mapRegister.getMappingRecordItem()) {
  98             MappingRecord mapping = record.getMappingRecord();
  99
 100             oldMapping = (MappingRecord) mapService.getMapping(MappingOrigin.Southbound, mapping.getEid());
 101             mapService.addMapping(MappingOrigin.Southbound, mapping.getEid(), getSiteId(mapRegister), mapping, merge);
 102
 103             if (subscriptionService) {
 104                 MappingRecord newMapping = merge ?
 105                         (MappingRecord) mapService.getMapping(MappingOrigin.Southbound, mapping.getEid()) : mapping;
 106
 107                 if (mappingChanged(oldMapping, newMapping)) {
 108                     if (LOG.isDebugEnabled()) {
 109                         LOG.debug("Mapping update occured for {} SMRs will be sent for its subscribers.",
 110                                 LispAddressStringifier.getString(mapping.getEid()));
 111                     }
 112                     subscribers = getSubscribers(mapping.getEid());
 113                     sendSmrs(mapping, subscribers);
 114                     mappingUpdated = true;
 115                 }
 116             }
 117         }
 118         if (!authFailed && BooleanUtils.isTrue(mapRegister.isWantMapNotify())) {
 119             LOG.trace("MapRegister wants MapNotify");
 120             MapNotifyBuilder builder = new MapNotifyBuilder();
 121             List<TransportAddress> rlocs = null;
 122             if (merge) {
 123                 Set<IpAddressBinary> notifyRlocs = new HashSet<IpAddressBinary>();
 124                 List<MappingRecordItem> mergedMappings = new ArrayList<MappingRecordItem>();
 125                 for (MappingRecordItem record : mapRegister.getMappingRecordItem()) {
 126                     MappingRecord mapping = record.getMappingRecord();
 127                     MappingRecord currentRecord = (MappingRecord) mapService.getMapping(MappingOrigin.Southbound,
 128                             mapping.getEid());
 129                     mergedMappings.add(new MappingRecordItemBuilder().setMappingRecord(currentRecord).build());
 130                     Set<IpAddressBinary> sourceRlocs = (Set<IpAddressBinary>) mapService.getData(
 131                             MappingOrigin.Southbound, mapping.getEid(), SubKeys.SRC_RLOCS);
 132                     if (sourceRlocs != null) {
 133                         notifyRlocs.addAll(sourceRlocs);
 134                     }
 135                 }
 136                 MapNotifyBuilderHelper.setFromMapRegisterAndMappingRecordItems(builder, mapRegister, mergedMappings);
 137                 // send map-notify to merge group only when mapping record is changed
 138                 if (mappingUpdated) {
 139                     rlocs = getTransportAddresses(notifyRlocs);
 140                 }
 141             } else {
 142                 MapNotifyBuilderHelper.setFromMapRegister(builder, mapRegister);
 143             }
 144             notifyHandler.handleMapNotify(builder.build(), rlocs);
 145         }
 146     }
 147
 148     private static List<TransportAddress> getTransportAddresses(Set<IpAddressBinary> addresses) {
 149         List<TransportAddress> rlocs = new ArrayList<TransportAddress>();
 150         for (IpAddressBinary address : addresses) {
 151             TransportAddressBuilder tab = new TransportAddressBuilder();
 152             tab.setIpAddress(address);
 153             tab.setPort(new PortNumber(LispMessage.PORT_NUM));
 154             rlocs.add(tab.build());
 155         }
 156         return rlocs;
 157     }
 158
 159     private SiteId getSiteId(MapRegister mapRegister) {
 160         return (mapRegister.getSiteId() != null) ? new SiteId(mapRegister.getSiteId()) : null;
 161     }
 162
 163     @Override
 164     public void onMappingChanged(MappingChanged notification) {
 165         if (subscriptionService) {
 166             sendSmrs(notification.getMappingRecord(), getSubscribers(notification.getMappingRecord().getEid()));
 167             if (notification.getChangeType().equals(MappingChange.Removed)) {
 168                 removeSubscribers(notification.getMappingRecord().getEid());
 169             }
 170         }
 171     }
 172
 173     private static boolean mappingChanged(MappingRecord oldMapping, MappingRecord newMapping) {
 174         // We only check for fields we care about
 175         // XXX: This code needs to be checked and updated when the YANG model is modified
 176         Preconditions.checkNotNull(newMapping, "The new mapping should never be null");
 177         if (oldMapping == null) {
 178             LOG.trace("mappingChanged(): old mapping is null");
 179             return true;
 180         } else if (!Objects.equals(oldMapping.getEid(), newMapping.getEid())) {
 181             LOG.trace("mappingChanged(): EID");
 182             return true;
 183         } else if (!Objects.equals(oldMapping.getLocatorRecord(), newMapping.getLocatorRecord())) {
 184             LOG.trace("mappingChanged(): RLOC");
 185             return true;
 186         } else if (!Objects.equals(oldMapping.getAction(), newMapping.getAction())) {
 187             LOG.trace("mappingChanged(): action");
 188             return true;
 189         } else if (!Objects.equals(oldMapping.getRecordTtl(), newMapping.getRecordTtl())) {
 190             LOG.trace("mappingChanged(): TTL");
 191             return true;
 192         } else if (!Objects.equals(oldMapping.getMapVersion(), newMapping.getMapVersion())) {
 193             LOG.trace("mappingChanged(): mapping version");
 194             return true;
 195         }
 196         return false;
 197     }
 198
 199     private void sendSmrs(MappingRecord record, Set<SubscriberRLOC> subscribers) {
 200         Eid eid = record.getEid();
 201         handleSmr(eid, subscribers, notifyHandler);
 202
 203         // For SrcDst LCAF also send SMRs to Dst prefix
 204         if (eid.getAddress() instanceof SourceDestKey) {
 205             Eid dstAddr = SourceDestKeyHelper.getDst(eid);
 206             Set<SubscriberRLOC> dstSubs = getSubscribers(dstAddr);
 207             MappingRecord newRecord = new MappingRecordBuilder(record).setEid(dstAddr).build();
 208             handleSmr(newRecord.getEid(), dstSubs, notifyHandler);
 209         }
 210     }
 211
 212     private void handleSmr(Eid eid, Set<SubscriberRLOC> subscribers, IMapNotifyHandler callback) {
 213         if (subscribers == null) {
 214             return;
 215         }
 216         MapRequestBuilder mrb = MapRequestUtil.prepareSMR(eid, LispAddressUtil.toRloc(getLocalAddress()));
 217         LOG.trace("Built SMR packet: " + mrb.build().toString());
 218         // Using Iterator ensures that we don't get a ConcurrentModificationException when removing a SubscriberRLOC
 219         // from a Set.
 220         Iterator<SubscriberRLOC> iterator = subscribers.iterator();
 221         while (iterator.hasNext()) {
 222             SubscriberRLOC subscriber = iterator.next();
 223             if (subscriber.timedOut()) {
 224                 LOG.trace("Lazy removing expired subscriber entry " + subscriber.toString());
 225                 iterator.remove();
 226             } else {
 227                 try {
 228                     // The address stored in the SMR's EID record is used as Source EID in the SMR-invoked Map-Request.
 229                     // To ensure consistent behavior it is set to the value used to originally request a given mapping
 230                     mrb.setEidItem(new ArrayList<EidItem>());
 231                     mrb.getEidItem().add(new EidItemBuilder().setEid(subscriber.getSrcEid()).build());
 232                     callback.handleSMR(mrb.build(), subscriber.getSrcRloc());
 233                 } catch (Exception e) {
 234                     LOG.error("Errors encountered while handling SMR:" + ExceptionUtils.getStackTrace(e));
 235                 }
 236             }
 237         }
 238         addSubscribers(eid, subscribers);
 239     }
 240
 241     @SuppressWarnings("unchecked")
 242     private Set<SubscriberRLOC> getSubscribers(Eid address) {
 243         return (Set<SubscriberRLOC>) mapService.getData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
 244     }
 245
 246     private void removeSubscribers(Eid address) {
 247         mapService.removeData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
 248     }
 249
 250     private void addSubscribers(Eid address, Set<SubscriberRLOC> subscribers) {
 251         mapService.addData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS, subscribers);
 252     }
 253
 254     private static InetAddress getLocalAddress() {
 255         try {
 256             Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces();
 257             while (interfaces.hasMoreElements()) {
 258                 NetworkInterface current = interfaces.nextElement();
 259                 LOG.debug("Interface " + current.toString());
 260                 if (!current.isUp() || current.isLoopback() || current.isVirtual()) {
 261                     continue;
 262                 }
 263                 Enumeration<InetAddress> addresses = current.getInetAddresses();
 264                 while (addresses.hasMoreElements()) {
 265                     InetAddress current_addr = addresses.nextElement();
 266                     // Skip loopback and link local addresses
 267                     if (current_addr.isLoopbackAddress() || current_addr.isLinkLocalAddress()) {
 268                         continue;
 269                     }
 270                     LOG.debug(current_addr.getHostAddress());
 271                     return current_addr;
 272                 }
 273             }
 274         } catch (SocketException se) {
 275             LOG.debug("Caught socket exceptio", se);
 276         }
 277         return null;
 278     }
 279 }