2 * Copyright (c) 2014, 2017 Contextream, Inc. and others. All rights reserved.
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
9 package org.opendaylight.lispflowmapping.implementation.lisp;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.Maps;
13 import com.google.common.util.concurrent.ThreadFactoryBuilder;
14 import java.net.InetAddress;
15 import java.net.NetworkInterface;
16 import java.net.SocketException;
17 import java.util.ArrayList;
18 import java.util.Arrays;
19 import java.util.Enumeration;
20 import java.util.Iterator;
21 import java.util.LinkedHashSet;
22 import java.util.List;
25 import java.util.concurrent.Executors;
26 import java.util.concurrent.ScheduledExecutorService;
27 import java.util.concurrent.ScheduledFuture;
28 import java.util.concurrent.ThreadFactory;
29 import java.util.concurrent.TimeUnit;
30 import org.apache.commons.lang3.BooleanUtils;
31 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
32 import org.opendaylight.lispflowmapping.config.ConfigIni;
33 import org.opendaylight.lispflowmapping.implementation.util.LoggingUtil;
34 import org.opendaylight.lispflowmapping.implementation.util.MSNotificationInputUtil;
35 import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
36 import org.opendaylight.lispflowmapping.interfaces.dao.Subscriber;
37 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
38 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
39 import org.opendaylight.lispflowmapping.interfaces.lisp.ISmrNotificationListener;
40 import org.opendaylight.lispflowmapping.interfaces.lisp.SmrEvent;
41 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
42 import org.opendaylight.lispflowmapping.lisp.authentication.LispAuthenticationUtil;
43 import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
44 import org.opendaylight.lispflowmapping.lisp.type.MappingData;
45 import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
46 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
47 import org.opendaylight.lispflowmapping.lisp.util.MapNotifyBuilderHelper;
48 import org.opendaylight.lispflowmapping.lisp.util.MapRequestUtil;
49 import org.opendaylight.lispflowmapping.lisp.util.MappingRecordUtil;
50 import org.opendaylight.lispflowmapping.lisp.util.MaskUtil;
51 import org.opendaylight.lispflowmapping.lisp.util.SourceDestKeyHelper;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.IpAddressBinary;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4PrefixBinary;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4PrefixBinaryBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6PrefixBinary;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6PrefixBinaryBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegister;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.SiteId;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.EidBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItem;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItemBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapnotifymessage.MapNotifyBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItem;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItemBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequestBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChanged;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.OdlMappingserviceListener;
77 import org.opendaylight.yangtools.concepts.ListenerRegistration;
78 import org.slf4j.Logger;
79 import org.slf4j.LoggerFactory;
81 public class MapServer implements IMapServerAsync, OdlMappingserviceListener, ISmrNotificationListener {
83 private static final Logger LOG = LoggerFactory.getLogger(MapServer.class);
84 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};
85 private IMappingService mapService;
86 private boolean subscriptionService;
87 private IMapNotifyHandler notifyHandler;
88 private NotificationService notificationService;
89 private ListenerRegistration<MapServer> mapServerListenerRegistration;
90 private SmrScheduler scheduler;
92 public MapServer(IMappingService mapService, boolean subscriptionService,
93 IMapNotifyHandler notifyHandler, NotificationService notificationService) {
94 Preconditions.checkNotNull(mapService);
95 this.mapService = mapService;
96 this.subscriptionService = subscriptionService;
97 this.notifyHandler = notifyHandler;
98 this.notificationService = notificationService;
99 if (notificationService != null) {
100 notificationService.registerNotificationListener(this);
102 scheduler = new SmrScheduler();
106 public void setSubscriptionService(boolean subscriptionService) {
107 this.subscriptionService = subscriptionService;
110 @SuppressWarnings("unchecked")
111 public void handleMapRegister(MapRegister mapRegister) {
112 boolean mappingUpdated = false;
113 boolean merge = ConfigIni.getInstance().mappingMergeIsSet() && mapRegister.isMergeEnabled();
114 MappingRecord oldMapping;
117 if (!mapRegister.isXtrSiteIdPresent() || mapRegister.getXtrId() == null) {
118 LOG.error("Merge bit is set in Map-Register, but xTR-ID is not present. Will not merge.");
120 } else if (Arrays.equals(mapRegister.getXtrId().getValue(), ALL_ZEROES_XTR_ID)) {
121 LOG.warn("Merge bit is set in Map-Register, but xTR-ID is all zeroes.");
125 for (MappingRecordItem record : mapRegister.getMappingRecordItem()) {
126 MappingRecord mapping = record.getMappingRecord();
127 Eid eid = mapping.getEid();
128 MappingData mappingData = new MappingData(mapping, System.currentTimeMillis());
129 mappingData.setMergeEnabled(merge);
130 mappingData.setXtrId(mapRegister.getXtrId());
132 oldMapping = getMappingRecord(mapService.getMapping(MappingOrigin.Southbound, eid));
133 mapService.addMapping(MappingOrigin.Southbound, eid, getSiteId(mapRegister), mappingData);
135 MappingRecord newMapping = getMappingRecord(mapService.getMapping(MappingOrigin.Southbound, eid));
136 if (MappingRecordUtil.mappingChanged(oldMapping, newMapping)) {
137 // If there is a SB mapping change with merge on, Map-Notify will be sent to ALL xTRs, not jus the
138 // one registering (merging is done in the MappingSystem code)
139 mappingUpdated = true;
143 if (BooleanUtils.isTrue(mapRegister.isWantMapNotify())) {
144 LOG.trace("MapRegister wants MapNotify");
145 MapNotifyBuilder builder = new MapNotifyBuilder();
146 List<TransportAddress> rlocs = null;
148 Set<IpAddressBinary> notifyRlocs = new LinkedHashSet<IpAddressBinary>();
149 List<MappingRecordItem> mergedMappings = new ArrayList<MappingRecordItem>();
150 for (MappingRecordItem record : mapRegister.getMappingRecordItem()) {
151 MappingRecord mapping = record.getMappingRecord();
152 MappingRecord currentRecord = getMappingRecord(mapService.getMapping(MappingOrigin.Southbound,
154 mergedMappings.add(new MappingRecordItemBuilder().setMappingRecord(currentRecord).build());
155 Set<IpAddressBinary> sourceRlocs = (Set<IpAddressBinary>) mapService.getData(
156 MappingOrigin.Southbound, mapping.getEid(), SubKeys.SRC_RLOCS);
157 if (sourceRlocs != null) {
158 notifyRlocs.addAll(sourceRlocs);
161 MapNotifyBuilderHelper.setFromMapRegisterAndMappingRecordItems(builder, mapRegister, mergedMappings);
162 // send map-notify to merge group only when mapping record is changed
163 if (mappingUpdated) {
164 rlocs = getTransportAddresses(notifyRlocs);
167 MapNotifyBuilderHelper.setFromMapRegister(builder, mapRegister);
169 List<MappingRecordItem> mappings = builder.getMappingRecordItem();
170 if (mappings != null && mappings.get(0) != null && mappings.get(0).getMappingRecord() != null
171 && mappings.get(0).getMappingRecord().getEid() != null) {
172 MappingAuthkey authkey = mapService.getAuthenticationKey(mappings.get(0).getMappingRecord().getEid());
173 if (authkey != null) {
174 builder.setAuthenticationData(LispAuthenticationUtil.createAuthenticationData(builder.build(),
175 authkey.getKeyString()));
178 notifyHandler.handleMapNotify(builder.build(), rlocs);
182 private static List<TransportAddress> getTransportAddresses(Set<IpAddressBinary> addresses) {
183 List<TransportAddress> rlocs = new ArrayList<TransportAddress>();
184 for (IpAddressBinary address : addresses) {
185 TransportAddressBuilder tab = new TransportAddressBuilder();
186 tab.setIpAddress(address);
187 tab.setPort(new PortNumber(LispMessage.PORT_NUM));
188 rlocs.add(tab.build());
193 private static SiteId getSiteId(MapRegister mapRegister) {
194 return (mapRegister.getSiteId() != null) ? new SiteId(mapRegister.getSiteId()) : null;
197 private static MappingRecord getMappingRecord(MappingData mappingData) {
198 return (mappingData != null) ? mappingData.getRecord() : null;
202 public void onMappingChanged(MappingChanged notification) {
203 if (subscriptionService) {
204 Eid eid = notification.getEid();
206 eid = notification.getMappingRecord().getEid();
208 LOG.trace("MappingChanged event for {} of type: `{}'", LispAddressStringifier.getString(eid),
209 notification.getChangeType());
210 Set<Subscriber> subscribers = MSNotificationInputUtil.toSubscriberSet(notification.getSubscriberItem());
211 LoggingUtil.logSubscribers(LOG, eid, subscribers);
212 if (mapService.isMaster()) {
213 sendSmrs(eid, subscribers);
214 if (eid.getAddress() instanceof SourceDestKey) {
215 Set<Subscriber> dstSubscribers = MSNotificationInputUtil.toSubscriberSetFromDst(
216 notification.getDstSubscriberItem());
217 LoggingUtil.logSubscribers(LOG, SourceDestKeyHelper.getDstBinary(eid), dstSubscribers);
218 sendSmrs(SourceDestKeyHelper.getDstBinary(eid), dstSubscribers);
224 private void handleSmr(Eid eid, Set<Subscriber> subscribers) {
225 sendSmrs(eid, subscribers);
227 // For SrcDst LCAF also send SMRs to Dst prefix
228 if (eid.getAddress() instanceof SourceDestKey) {
229 Eid dstAddr = SourceDestKeyHelper.getDstBinary(eid);
230 Set<Subscriber> dstSubs = mapService.getSubscribers(dstAddr);
231 sendSmrs(dstAddr, dstSubs);
235 private void sendSmrs(Eid eid, Set<Subscriber> subscribers) {
236 if (subscribers == null) {
239 final MapRequestBuilder mrb = MapRequestUtil.prepareSMR(eid, LispAddressUtil.toRloc(getLocalAddress()));
240 LOG.trace("Built SMR packet template (EID field will be set later): " + mrb.build().toString());
242 scheduler.scheduleSmrs(mrb, subscribers.iterator());
245 private static InetAddress getLocalAddress() {
247 Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces();
248 while (interfaces.hasMoreElements()) {
249 NetworkInterface current = interfaces.nextElement();
250 LOG.trace("Interface " + current.toString());
251 if (!current.isUp() || current.isLoopback() || current.isVirtual()) {
254 Enumeration<InetAddress> addresses = current.getInetAddresses();
255 while (addresses.hasMoreElements()) {
256 InetAddress currentAddr = addresses.nextElement();
257 // Skip loopback and link local addresses
258 if (currentAddr.isLoopbackAddress() || currentAddr.isLinkLocalAddress()) {
261 LOG.debug(currentAddr.getHostAddress());
265 } catch (SocketException se) {
266 LOG.debug("Caught socket exception", se);
272 public void onSmrInvokedReceived(SmrEvent event) {
273 scheduler.smrReceived(event);
277 * Task scheduler is responsible for resending SMR messages to a subscriber (xTR)
278 * {@value ConfigIni#LISP_SMR_RETRY_COUNT} times, or until {@link ISmrNotificationListener#onSmrInvokedReceived}
281 private class SmrScheduler {
282 final int cpuCores = Runtime.getRuntime().availableProcessors();
283 private final ThreadFactory threadFactory = new ThreadFactoryBuilder()
284 .setNameFormat("smr-executor-%d").build();
285 private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(cpuCores * 2, threadFactory);
286 private final Map<Eid, Map<Subscriber, ScheduledFuture<?>>> eidFutureMap = Maps.newConcurrentMap();
288 void scheduleSmrs(MapRequestBuilder mrb, Iterator<Subscriber> subscribers) {
289 final Eid srcEid = fixSrcEidMask(mrb.getSourceEid().getEid());
290 cancelExistingFuturesForEid(srcEid);
292 final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = Maps.newConcurrentMap();
294 // Using Iterator ensures that we don't get a ConcurrentModificationException when removing a Subscriber
296 while (subscribers.hasNext()) {
297 Subscriber subscriber = subscribers.next();
298 if (subscriber.timedOut()) {
299 LOG.debug("Lazy removing expired subscriber entry " + subscriber.getString());
300 subscribers.remove();
302 final ScheduledFuture<?> future = executor.scheduleAtFixedRate(new CancellableRunnable(
303 mrb, subscriber), 0L, ConfigIni.getInstance().getSmrTimeout(), TimeUnit.MILLISECONDS);
304 subscriberFutureMap.put(subscriber, future);
308 if (subscriberFutureMap.isEmpty()) {
311 eidFutureMap.put(srcEid, subscriberFutureMap);
314 void smrReceived(SmrEvent event) {
315 final List<Subscriber> subscriberList = event.getSubscriberList();
316 for (Subscriber subscriber : subscriberList) {
317 if (LOG.isTraceEnabled()) {
318 LOG.trace("SMR-invoked event, EID {}, subscriber {}",
319 LispAddressStringifier.getString(event.getEid()),
320 subscriber.getString());
321 LOG.trace("eidFutureMap: {}", eidFutureMap);
323 final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(event.getEid());
324 if (subscriberFutureMap != null) {
325 final ScheduledFuture<?> future = subscriberFutureMap.get(subscriber);
326 if (future != null && !future.isCancelled()) {
328 if (LOG.isDebugEnabled()) {
329 LOG.debug("SMR-invoked MapRequest received, scheduled task for subscriber {}, EID {} with"
330 + " nonce {} has been cancelled", subscriber.getString(),
331 LispAddressStringifier.getString(event.getEid()), event.getNonce());
333 subscriberFutureMap.remove(subscriber);
335 if (future == null) {
336 LOG.trace("No outstanding SMR tasks for EID {}, subscriber {}",
337 LispAddressStringifier.getString(event.getEid()), subscriber.getString());
339 LOG.trace("Future {} is cancelled", future);
342 if (subscriberFutureMap.isEmpty()) {
343 eidFutureMap.remove(event.getEid());
346 if (LOG.isTraceEnabled()) {
347 LOG.trace("No outstanding SMR tasks for EID {}",
348 LispAddressStringifier.getString(event.getEid()));
354 private void cancelExistingFuturesForEid(Eid eid) {
355 synchronized (eidFutureMap) {
356 if (eidFutureMap.containsKey(eid)) {
357 final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(eid);
358 Iterator<Subscriber> oldSubscribers = subscriberFutureMap.keySet().iterator();
359 while (oldSubscribers.hasNext()) {
360 Subscriber subscriber = oldSubscribers.next();
361 ScheduledFuture<?> subscriberFuture = subscriberFutureMap.get(subscriber);
362 subscriberFuture.cancel(true);
364 eidFutureMap.remove(eid);
370 * See https://bugs.opendaylight.org/show_bug.cgi?id=8469#c1 why this is necessary.
372 * TL;DR The sourceEid field in the MapRequestBuilder object will be serialized to a packet on the wire, and
373 * a Map-Request can't store the prefix length in the source EID.
375 * Since we store all prefixes as binary internally, we only care about and fix those address types.
377 private Eid fixSrcEidMask(Eid eid) {
378 Address address = eid.getAddress();
379 if (address instanceof Ipv4PrefixBinary) {
380 return new EidBuilder(eid).setAddress(new Ipv4PrefixBinaryBuilder((Ipv4PrefixBinary) address)
381 .setIpv4MaskLength(MaskUtil.IPV4_MAX_MASK).build()).build();
382 } else if (address instanceof Ipv6PrefixBinary) {
383 return new EidBuilder(eid).setAddress(new Ipv6PrefixBinaryBuilder((Ipv6PrefixBinary) address)
384 .setIpv6MaskLength(MaskUtil.IPV6_MAX_MASK).build()).build();
389 private final class CancellableRunnable implements Runnable {
390 private MapRequestBuilder mrb;
391 private Subscriber subscriber;
392 private int executionCount = 1;
394 CancellableRunnable(MapRequestBuilder mrb, Subscriber subscriber) {
396 this.subscriber = subscriber;
399 @SuppressWarnings("checkstyle:IllegalCatch")
402 final Eid srcEid = mrb.getSourceEid().getEid();
405 // The address stored in the SMR's EID record is used as Source EID in the SMR-invoked
406 // Map-Request. To ensure consistent behavior it is set to the value used to originally request
408 if (executionCount <= ConfigIni.getInstance().getSmrRetryCount()) {
410 mrb.setEidItem(new ArrayList<EidItem>());
411 mrb.getEidItem().add(new EidItemBuilder().setEid(subscriber.getSrcEid()).build());
412 notifyHandler.handleSMR(mrb.build(), subscriber.getSrcRloc());
413 if (LOG.isTraceEnabled()) {
414 LOG.trace("Attempt #{} to send SMR to subscriber {} for EID {}",
416 subscriber.getString(),
417 LispAddressStringifier.getString(mrb.getSourceEid().getEid()));
421 LOG.trace("Cancelling execution of a SMR Map-Request after {} failed attempts.",
423 cancelAndRemove(subscriber, srcEid);
426 } catch (Exception e) {
427 LOG.error("Errors encountered while handling SMR:", e);
428 cancelAndRemove(subscriber, srcEid);
434 private void cancelAndRemove(Subscriber sub, Eid eid) {
435 final Map<Subscriber, ScheduledFuture<?>> subscriberFutureMap = eidFutureMap.get(eid);
436 if (subscriberFutureMap == null) {
437 LOG.warn("Couldn't find subscriber {} in SMR scheduler internal list", sub);
441 if (subscriberFutureMap.containsKey(sub)) {
442 ScheduledFuture<?> eidFuture = subscriberFutureMap.get(sub);
443 subscriberFutureMap.remove(sub);
444 eidFuture.cancel(false);
446 if (subscriberFutureMap.isEmpty()) {
447 eidFutureMap.remove(eid);