/*
- * Copyright (c) 2014 Contextream, Inc. and others. All rights reserved.
+ * Copyright (c) 2014, 2017 Contextream, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
import com.google.common.base.Preconditions;
import com.google.common.collect.Maps;
+import com.google.common.collect.Sets;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import java.net.InetAddress;
import java.net.NetworkInterface;
import org.apache.commons.lang3.BooleanUtils;
import org.opendaylight.controller.md.sal.binding.api.NotificationService;
import org.opendaylight.lispflowmapping.config.ConfigIni;
+import org.opendaylight.lispflowmapping.implementation.util.LoggingUtil;
+import org.opendaylight.lispflowmapping.implementation.util.MSNotificationInputUtil;
import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
-import org.opendaylight.lispflowmapping.interfaces.dao.SubscriberRLOC;
+import org.opendaylight.lispflowmapping.interfaces.dao.Subscriber;
import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
import org.opendaylight.lispflowmapping.interfaces.lisp.ISmrNotificationListener;
import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
import org.opendaylight.lispflowmapping.lisp.util.MapNotifyBuilderHelper;
import org.opendaylight.lispflowmapping.lisp.util.MapRequestUtil;
+import org.opendaylight.lispflowmapping.lisp.util.MappingRecordUtil;
+import org.opendaylight.lispflowmapping.lisp.util.MaskUtil;
import org.opendaylight.lispflowmapping.lisp.util.SourceDestKeyHelper;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.IpAddressBinary;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4PrefixBinary;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4PrefixBinaryBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6PrefixBinary;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6PrefixBinaryBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegister;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.SiteId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.EidBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItem;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItemBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapnotifymessage.MapNotifyBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecordBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItem;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItemBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequestBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChange;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChanged;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.OdlMappingserviceListener;
public class MapServer implements IMapServerAsync, OdlMappingserviceListener, ISmrNotificationListener {
- protected static final Logger LOG = LoggerFactory.getLogger(MapServer.class);
+ private static final Logger LOG = LoggerFactory.getLogger(MapServer.class);
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};
private IMappingService mapService;
private boolean subscriptionService;
public void handleMapRegister(MapRegister mapRegister) {
boolean mappingUpdated = false;
boolean merge = ConfigIni.getInstance().mappingMergeIsSet() && mapRegister.isMergeEnabled();
- Set<SubscriberRLOC> subscribers = null;
+ Set<Subscriber> subscribers = Sets.newConcurrentHashSet();
MappingRecord oldMapping;
if (merge) {
for (MappingRecordItem record : mapRegister.getMappingRecordItem()) {
MappingRecord mapping = record.getMappingRecord();
+ Eid eid = mapping.getEid();
MappingData mappingData = new MappingData(mapping, System.currentTimeMillis());
mappingData.setMergeEnabled(merge);
mappingData.setXtrId(mapRegister.getXtrId());
- oldMapping = getMappingRecord(mapService.getMapping(MappingOrigin.Southbound, mapping.getEid()));
- mapService.addMapping(MappingOrigin.Southbound, mapping.getEid(), getSiteId(mapRegister), mappingData);
+ oldMapping = getMappingRecord(mapService.getMapping(MappingOrigin.Southbound, eid));
+ mapService.addMapping(MappingOrigin.Southbound, eid, getSiteId(mapRegister), mappingData);
+ if (oldMapping != null
+ && MappingRecordUtil.isNegativeMapping(oldMapping)
+ && !oldMapping.getEid().equals(eid)) {
+ if (subscriptionService) {
+ // Here we save the subscribers of the OLD mapping before removing. We will add to this set the
+ // subscribers of the NEW mapping below (since the EIDs are different, the result of
+ // mappingChanged() will be true, and then send an SMR to all subscribers with the EID of the NEW
+ // mapping only.
+ Set<Subscriber> oldMappingSubscribers = mapService.getSubscribers(oldMapping.getEid());
+ if (oldMappingSubscribers != null) {
+ subscribers.addAll(oldMappingSubscribers);
+ LoggingUtil.logSubscribers(LOG, oldMapping.getEid(), subscribers);
+ }
+ }
+ mapService.removeMapping(MappingOrigin.Southbound, oldMapping.getEid());
+ }
if (subscriptionService) {
MappingRecord newMapping = merge
- ? getMappingRecord(mapService.getMapping(MappingOrigin.Southbound, mapping.getEid())) : mapping;
+ ? getMappingRecord(mapService.getMapping(MappingOrigin.Southbound, eid)) : mapping;
if (mappingChanged(oldMapping, newMapping)) {
if (LOG.isDebugEnabled()) {
LOG.debug("Mapping update occured for {} SMRs will be sent for its subscribers.",
- LispAddressStringifier.getString(mapping.getEid()));
+ LispAddressStringifier.getString(eid));
+ }
+ Set<Subscriber> newMappingSubscribers = mapService.getSubscribers(eid);
+ if (oldMapping != null && !oldMapping.getEid().equals(eid)) {
+ newMappingSubscribers = addParentSubscribers(eid, newMappingSubscribers);
+ }
+ if (newMappingSubscribers != null) {
+ subscribers.addAll(newMappingSubscribers);
+ LoggingUtil.logSubscribers(LOG, eid, subscribers);
}
- subscribers = getSubscribers(mapping.getEid());
- sendSmrs(mapping, subscribers);
+ handleSmr(eid, subscribers);
mappingUpdated = true;
}
}
@Override
public void onMappingChanged(MappingChanged notification) {
+ LOG.trace("MappingChanged event of type: `{}'", notification.getChangeType());
if (subscriptionService) {
+ Eid eid = notification.getMappingRecord().getEid();
+ Set<Subscriber> subscribers = MSNotificationInputUtil.toSubscriberSet(notification.getSubscriberItem());
+ LoggingUtil.logSubscribers(LOG, eid, subscribers);
if (mapService.isMaster()) {
- sendSmrs(notification.getMappingRecord(), getSubscribers(notification.getMappingRecord().getEid()));
- }
- if (notification.getChangeType().equals(MappingChange.Removed)) {
- removeSubscribers(notification.getMappingRecord().getEid());
+ sendSmrs(eid, subscribers);
+ if (eid.getAddress() instanceof SourceDestKey) {
+ Set<Subscriber> dstSubscribers = MSNotificationInputUtil.toSubscriberSetFromDst(
+ notification.getDstSubscriberItem());
+ LoggingUtil.logSubscribers(LOG, SourceDestKeyHelper.getDstBinary(eid), dstSubscribers);
+ sendSmrs(SourceDestKeyHelper.getDstBinary(eid), dstSubscribers);
+ }
}
}
}
return false;
}
- private void sendSmrs(MappingRecord record, Set<SubscriberRLOC> subscribers) {
- Eid eid = record.getEid();
- handleSmr(eid, subscribers);
+ private void handleSmr(Eid eid, Set<Subscriber> subscribers) {
+ sendSmrs(eid, subscribers);
// For SrcDst LCAF also send SMRs to Dst prefix
if (eid.getAddress() instanceof SourceDestKey) {
Eid dstAddr = SourceDestKeyHelper.getDstBinary(eid);
- Set<SubscriberRLOC> dstSubs = getSubscribers(dstAddr);
- MappingRecord newRecord = new MappingRecordBuilder(record).setEid(dstAddr).build();
- handleSmr(newRecord.getEid(), dstSubs);
+ Set<Subscriber> dstSubs = mapService.getSubscribers(dstAddr);
+ sendSmrs(dstAddr, dstSubs);
}
}
- private void handleSmr(Eid eid, Set<SubscriberRLOC> subscribers) {
+ private void sendSmrs(Eid eid, Set<Subscriber> subscribers) {
if (subscribers == null) {
return;
}
LOG.trace("Built SMR packet: " + mrb.build().toString());
scheduler.scheduleSmrs(mrb, subscribers.iterator());
- addSubscribers(eid, subscribers);
- }
-
- @SuppressWarnings("unchecked")
- private Set<SubscriberRLOC> getSubscribers(Eid address) {
- return (Set<SubscriberRLOC>) mapService.getData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
}
- private void removeSubscribers(Eid address) {
- mapService.removeData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
- }
+ private Set<Subscriber> addParentSubscribers(Eid eid, Set<Subscriber> subscribers) {
+ Eid parentPrefix = mapService.getParentPrefix(eid);
+ if (parentPrefix == null) {
+ return subscribers;
+ }
- private void addSubscribers(Eid address, Set<SubscriberRLOC> subscribers) {
- mapService.addData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS, subscribers);
+ Set<Subscriber> parentSubscribers = mapService.getSubscribers(parentPrefix);
+ if (parentSubscribers != null) {
+ if (subscribers != null) {
+ subscribers.addAll(parentSubscribers);
+ } else {
+ subscribers = parentSubscribers;
+ }
+ }
+ return subscribers;
}
private static InetAddress getLocalAddress() {
Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces();
while (interfaces.hasMoreElements()) {
NetworkInterface current = interfaces.nextElement();
- LOG.debug("Interface " + current.toString());
+ LOG.trace("Interface " + current.toString());
if (!current.isUp() || current.isLoopback() || current.isVirtual()) {
continue;
}
private final ThreadFactory threadFactory = new ThreadFactoryBuilder()
.setNameFormat("smr-executor-%d").build();
private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(cpuCores * 2, threadFactory);
- private final Map<IpAddressBinary, Map<Eid, ScheduledFuture<?>>> subscriberFutureMap = Maps.newConcurrentMap();
+ private final Map<Eid, Map<Subscriber, ScheduledFuture<?>>> eidFutureMap = Maps.newConcurrentMap();
- void scheduleSmrs(MapRequestBuilder mrb, Iterator<SubscriberRLOC> subscribers) {
- // Using Iterator ensures that we don't get a ConcurrentModificationException when removing a SubscriberRLOC
+ void scheduleSmrs(MapRequestBuilder mrb, Iterator<Subscriber> subscribers) {
+ final Eid srcEid = fixSrcEidMask(mrb.getSourceEid().getEid());
+ cancelExistingFuturesForEid(srcEid);
+
+ final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = Maps.newConcurrentMap();
+
+ // Using Iterator ensures that we don't get a ConcurrentModificationException when removing a Subscriber
// from a Set.
while (subscribers.hasNext()) {
- SubscriberRLOC subscriber = subscribers.next();
+ Subscriber subscriber = subscribers.next();
if (subscriber.timedOut()) {
- LOG.trace("Lazy removing expired subscriber entry " + subscriber.toString());
+ LOG.debug("Lazy removing expired subscriber entry " + subscriber.getString());
subscribers.remove();
} else {
final ScheduledFuture<?> future = executor.scheduleAtFixedRate(new CancellableRunnable(
mrb, subscriber), 0L, ConfigIni.getInstance().getSmrTimeout(), TimeUnit.MILLISECONDS);
- final IpAddressBinary subscriberAddress = LispAddressUtil
- .addressBinaryFromAddress(subscriber.getSrcRloc().getAddress());
-
- if (subscriberFutureMap.containsKey(subscriberAddress)) {
- subscriberFutureMap.get(subscriberAddress).put(mrb.getSourceEid().getEid(), future);
- } else {
- final Map<Eid, ScheduledFuture<?>> eidFutureMap = Maps.newConcurrentMap();
- eidFutureMap.put(mrb.getSourceEid().getEid(), future);
- subscriberFutureMap.put(subscriberAddress, eidFutureMap);
- }
+ subscriberFutureMap.put(subscriber, future);
}
}
+
+ if (subscriberFutureMap.isEmpty()) {
+ return;
+ }
+ eidFutureMap.put(srcEid, subscriberFutureMap);
}
void smrReceived(SmrEvent event) {
- final List<IpAddressBinary> subscriberAddressList = event.getSubscriberAddressList();
- for (IpAddressBinary subscriberAddress : subscriberAddressList) {
- final Map<Eid, ScheduledFuture<?>> eidFutureMap = subscriberFutureMap.get(subscriberAddress);
- if (eidFutureMap != null) {
- final ScheduledFuture<?> future = eidFutureMap.get(event.getEid());
+ final List<Subscriber> subscriberList = event.getSubscriberList();
+ for (Subscriber subscriber : subscriberList) {
+ if (LOG.isTraceEnabled()) {
+ LOG.trace("SMR-invoked event, EID {}, subscriber {}",
+ LispAddressStringifier.getString(event.getEid()),
+ subscriber.getString());
+ LOG.trace("eidFutureMap: {}", eidFutureMap);
+ }
+ final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(event.getEid());
+ if (subscriberFutureMap != null) {
+ final ScheduledFuture<?> future = subscriberFutureMap.get(subscriber);
if (future != null && !future.isCancelled()) {
- future.cancel(false);
- LOG.trace("SMR-invoked MapRequest received, scheduled task for subscriber {} with nonce {} has "
- + "been canceled", subscriberAddress.toString(), event.getNonce());
+ future.cancel(true);
+ if (LOG.isDebugEnabled()) {
+ LOG.debug("SMR-invoked MapRequest received, scheduled task for subscriber {}, EID {} with"
+ + " nonce {} has been cancelled", subscriber.getString(),
+ LispAddressStringifier.getString(event.getEid()), event.getNonce());
+ }
+ subscriberFutureMap.remove(subscriber);
+ } else {
+ if (future == null) {
+ LOG.trace("No outstanding SMR tasks for EID {}, subscriber {}",
+ LispAddressStringifier.getString(event.getEid()), subscriber.getString());
+ } else {
+ LOG.trace("Future {} is cancelled", future);
+ }
+ }
+ if (subscriberFutureMap.isEmpty()) {
eidFutureMap.remove(event.getEid());
}
- if (eidFutureMap.isEmpty()) {
- subscriberFutureMap.remove(subscriberAddress);
+ } else {
+ if (LOG.isTraceEnabled()) {
+ LOG.trace("No outstanding SMR tasks for EID {}",
+ LispAddressStringifier.getString(event.getEid()));
}
}
}
}
+ private void cancelExistingFuturesForEid(Eid eid) {
+ synchronized (eidFutureMap) {
+ if (eidFutureMap.containsKey(eid)) {
+ final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(eid);
+ Iterator<Subscriber> oldSubscribers = subscriberFutureMap.keySet().iterator();
+ while (oldSubscribers.hasNext()) {
+ Subscriber subscriber = oldSubscribers.next();
+ ScheduledFuture<?> subscriberFuture = subscriberFutureMap.get(subscriber);
+ subscriberFuture.cancel(true);
+ }
+ eidFutureMap.remove(eid);
+ }
+ }
+ }
+
+ /*
+ * See https://bugs.opendaylight.org/show_bug.cgi?id=8469#c1 why this is necessary.
+ *
+ * TL;DR The sourceEid field in the MapRequestBuilder object will be serialized to a packet on the wire, and
+ * a Map-Request can't store the prefix length in the source EID.
+ *
+ * Since we store all prefixes as binary internally, we only care about and fix those address types.
+ */
+ private Eid fixSrcEidMask(Eid eid) {
+ Address address = eid.getAddress();
+ if (address instanceof Ipv4PrefixBinary) {
+ return new EidBuilder(eid).setAddress(new Ipv4PrefixBinaryBuilder((Ipv4PrefixBinary) address)
+ .setIpv4MaskLength(MaskUtil.IPV4_MAX_MASK).build()).build();
+ } else if (address instanceof Ipv6PrefixBinary) {
+ return new EidBuilder(eid).setAddress(new Ipv6PrefixBinaryBuilder((Ipv6PrefixBinary) address)
+ .setIpv6MaskLength(MaskUtil.IPV6_MAX_MASK).build()).build();
+ }
+ return eid;
+ }
+
private final class CancellableRunnable implements Runnable {
private MapRequestBuilder mrb;
- private SubscriberRLOC subscriber;
+ private Subscriber subscriber;
private int executionCount = 1;
- CancellableRunnable(MapRequestBuilder mrb, SubscriberRLOC subscriber) {
+ CancellableRunnable(MapRequestBuilder mrb, Subscriber subscriber) {
this.mrb = mrb;
this.subscriber = subscriber;
}
@SuppressWarnings("checkstyle:IllegalCatch")
@Override
public void run() {
- final IpAddressBinary subscriberAddress = LispAddressUtil
- .addressBinaryFromAddress(subscriber.getSrcRloc().getAddress());
+ final Eid srcEid = mrb.getSourceEid().getEid();
+
try {
// The address stored in the SMR's EID record is used as Source EID in the SMR-invoked
// Map-Request. To ensure consistent behavior it is set to the value used to originally request
// a given mapping.
if (executionCount <= ConfigIni.getInstance().getSmrRetryCount()) {
- mrb.setEidItem(new ArrayList<EidItem>());
- mrb.getEidItem().add(new EidItemBuilder().setEid(subscriber.getSrcEid()).build());
- notifyHandler.handleSMR(mrb.build(), subscriber.getSrcRloc());
- LOG.trace("{}. attempt to send SMR for MapRequest " + subscriber.getSrcEid(), executionCount);
+ synchronized (mrb) {
+ mrb.setEidItem(new ArrayList<EidItem>());
+ mrb.getEidItem().add(new EidItemBuilder().setEid(subscriber.getSrcEid()).build());
+ notifyHandler.handleSMR(mrb.build(), subscriber.getSrcRloc());
+ if (LOG.isTraceEnabled()) {
+ LOG.trace("Attempt #{} to send SMR to subscriber {} for EID {}",
+ executionCount,
+ subscriber.getString(),
+ LispAddressStringifier.getString(mrb.getSourceEid().getEid()));
+ }
+ }
} else {
LOG.trace("Cancelling execution of a SMR Map-Request after {} failed attempts.",
executionCount - 1);
- cancelAndRemove(subscriberAddress);
+ cancelAndRemove(subscriber, srcEid);
+ return;
}
} catch (Exception e) {
LOG.error("Errors encountered while handling SMR:", e);
- cancelAndRemove(subscriberAddress);
+ cancelAndRemove(subscriber, srcEid);
+ return;
}
executionCount++;
}
- private void cancelAndRemove(IpAddressBinary subscriberAddress) {
- final Map<Eid, ScheduledFuture<?>> eidFutureMap = subscriberFutureMap.get(subscriberAddress);
- final Eid eid = mrb.getSourceEid().getEid();
- if (eidFutureMap.containsKey(eid)) {
- eidFutureMap.get(eid).cancel(false);
+ private void cancelAndRemove(Subscriber subscriber, Eid eid) {
+ final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(eid);
+ if (subscriberFutureMap == null) {
+ LOG.warn("Couldn't find subscriber {} in SMR scheduler internal list", subscriber);
+ return;
+ }
+
+ if (subscriberFutureMap.containsKey(subscriber)) {
+ ScheduledFuture<?> eidFuture = subscriberFutureMap.get(subscriber);
+ subscriberFutureMap.remove(subscriber);
+ eidFuture.cancel(false);
}
- eidFutureMap.remove(eid);
- if (eidFutureMap.isEmpty()) {
- subscriberFutureMap.remove(subscriberAddress);
+ if (subscriberFutureMap.isEmpty()) {
+ eidFutureMap.remove(eid);
}
}
}