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