1
2
3
4
5
6
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.authentication.LispAuthenticationUtil;
26 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
27 import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
28 import org.opendaylight.lispflowmapping.interfaces.dao.SubscriberRLOC;
29 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
30 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
31 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
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.rev100924.IpAddress;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
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.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.SiteId;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.container.MappingAuthkey;
59 import org.slf4j.Logger;
60 import org.slf4j.LoggerFactory;
61
62 import com.google.common.base.Preconditions;
63
64 public class MapServer implements IMapServerAsync, OdlMappingserviceListener {
65
66 protected static final Logger LOG = LoggerFactory.getLogger(MapServer.class);
67 private IMappingService mapService;
68 private boolean authenticate;
69 private boolean subscriptionService;
70 private IMapNotifyHandler notifyHandler;
71 private NotificationService notificationService;
72
73 public MapServer(IMappingService mapService, boolean authenticate, boolean subscriptionService,
74 IMapNotifyHandler notifyHandler, NotificationService notificationService) {
75 Preconditions.checkNotNull(mapService);
76 this.mapService = mapService;
77 this.authenticate = authenticate;
78 this.subscriptionService = subscriptionService;
79 this.notifyHandler = notifyHandler;
80 this.notificationService = notificationService;
81 if (notificationService != null) {
82 notificationService.registerNotificationListener(this);
83 }
84 }
85
86 @Override
87 public void setSubscriptionService(boolean subscriptionService) {
88 this.subscriptionService = subscriptionService;
89 }
90
91 @Override
92 public boolean shouldAuthenticate() {
93 return authenticate;
94 }
95
96 @Override
97 public void setShouldAuthenticate(boolean shouldAuthenticate) {
98 authenticate = shouldAuthenticate;
99 }
100
101 @SuppressWarnings("unchecked")
102 public void handleMapRegister(MapRegister mapRegister) {
103 boolean authFailed = false;
104 boolean mappingUpdated = false;
105 MappingAuthkey authkey = null;
106 Set<SubscriberRLOC> subscribers = null;
107 MappingRecord oldMapping;
108
109 for (MappingRecordItem record : mapRegister.getMappingRecordItem()) {
110 MappingRecord mapping = record.getMappingRecord();
111 if (authenticate) {
112 authkey = mapService.getAuthenticationKey(mapping.getEid());
113 if (!LispAuthenticationUtil.validate(mapRegister, mapping.getEid(), authkey)) {
114 authFailed = true;
115 break;
116 }
117 }
118
119 oldMapping = (MappingRecord) mapService.getMapping(MappingOrigin.Southbound, mapping.getEid());
120 mapService.addMapping(MappingOrigin.Southbound, mapping.getEid(), getSiteId(mapRegister), mapping);
121
122 if (subscriptionService) {
123 MappingRecord newMapping = ConfigIni.getInstance().mappingMergeIsSet() ?
124 (MappingRecord) mapService.getMapping(MappingOrigin.Southbound, mapping.getEid()) : mapping;
125
126 if (mappingChanged(oldMapping, newMapping)) {
127 if (LOG.isDebugEnabled()) {
128 LOG.debug("Mapping update occured for {} SMRs will be sent for its subscribers.",
129 LispAddressStringifier.getString(mapping.getEid()));
130 }
131 subscribers = getSubscribers(mapping.getEid());
132 sendSmrs(mapping, subscribers);
133 mappingUpdated = true;
134 }
135 }
136 }
137 if (!authFailed && BooleanUtils.isTrue(mapRegister.isWantMapNotify())) {
138 LOG.trace("MapRegister wants MapNotify");
139 MapNotifyBuilder builder = new MapNotifyBuilder();
140 List<TransportAddress> rlocs = null;
141 if (ConfigIni.getInstance().mappingMergeIsSet()) {
142 Set<IpAddress> notifyRlocs = new HashSet<IpAddress>();
143 List<MappingRecordItem> mergedMappings = new ArrayList<MappingRecordItem>();
144 for (MappingRecordItem record : mapRegister.getMappingRecordItem()) {
145 MappingRecord mapping = record.getMappingRecord();
146 MappingRecord currentRecord = (MappingRecord) mapService.getMapping(MappingOrigin.Southbound,
147 mapping.getEid());
148 mergedMappings.add(new MappingRecordItemBuilder().setMappingRecord(currentRecord).build());
149 Set<IpAddress> sourceRlocs = (Set<IpAddress>) mapService.getData(MappingOrigin.Southbound,
150 mapping.getEid(), SubKeys.SRC_RLOCS);
151 if (sourceRlocs != null) {
152 notifyRlocs.addAll(sourceRlocs);
153 }
154 }
155 MapNotifyBuilderHelper.setFromMapRegisterAndMappingRecordItems(builder, mapRegister, mergedMappings);
156
157 if (mappingUpdated) {
158 rlocs = getTransportAddresses(notifyRlocs);
159 }
160 } else {
161 MapNotifyBuilderHelper.setFromMapRegister(builder, mapRegister);
162 }
163 if (authenticate) {
164 builder.setAuthenticationData(LispAuthenticationUtil.createAuthenticationData(builder.build(),
165 authkey.getKeyString()));
166 }
167 notifyHandler.handleMapNotify(builder.build(), rlocs);
168 }
169 }
170
171 private static List<TransportAddress> getTransportAddresses(Set<IpAddress> addresses) {
172 List<TransportAddress> rlocs = new ArrayList<TransportAddress>();
173 for (IpAddress address : addresses) {
174 TransportAddressBuilder tab = new TransportAddressBuilder();
175 tab.setIpAddress(address);
176 tab.setPort(new PortNumber(LispMessage.PORT_NUM));
177 rlocs.add(tab.build());
178 }
179 return rlocs;
180 }
181
182 private SiteId getSiteId(MapRegister mapRegister) {
183 return (mapRegister.getSiteId() != null) ? new SiteId(mapRegister.getSiteId()) : null;
184 }
185
186 @Override
187 public void onMappingChanged(MappingChanged notification) {
188 if (subscriptionService) {
189 sendSmrs(notification.getMappingRecord(), getSubscribers(notification.getMappingRecord().getEid()));
190 if (notification.getChangeType().equals(MappingChange.Removed)) {
191 removeSubscribers(notification.getMappingRecord().getEid());
192 }
193 }
194 }
195
196 private static boolean mappingChanged(MappingRecord oldMapping, MappingRecord newMapping) {
197
198
199 Preconditions.checkNotNull(newMapping, "The new mapping should never be null");
200 if (oldMapping == null) {
201 LOG.trace("mappingChanged(): old mapping is null");
202 return true;
203 } else if (!Objects.equals(oldMapping.getEid(), newMapping.getEid())) {
204 LOG.trace("mappingChanged(): EID");
205 return true;
206 } else if (!Objects.equals(oldMapping.getLocatorRecord(), newMapping.getLocatorRecord())) {
207 LOG.trace("mappingChanged(): RLOC");
208 return true;
209 } else if (!Objects.equals(oldMapping.getAction(), newMapping.getAction())) {
210 LOG.trace("mappingChanged(): action");
211 return true;
212 } else if (!Objects.equals(oldMapping.getRecordTtl(), newMapping.getRecordTtl())) {
213 LOG.trace("mappingChanged(): TTL");
214 return true;
215 } else if (!Objects.equals(oldMapping.getMapVersion(), newMapping.getMapVersion())) {
216 LOG.trace("mappingChanged(): mapping version");
217 return true;
218 }
219 return false;
220 }
221
222 private void sendSmrs(MappingRecord record, Set<SubscriberRLOC> subscribers) {
223 Eid eid = record.getEid();
224 handleSmr(eid, subscribers, notifyHandler);
225
226
227 if (eid.getAddress() instanceof SourceDestKey) {
228 Eid dstAddr = SourceDestKeyHelper.getDst(eid);
229 Set<SubscriberRLOC> dstSubs = getSubscribers(dstAddr);
230 MappingRecord newRecord = new MappingRecordBuilder(record).setEid(dstAddr).build();
231 handleSmr(newRecord.getEid(), dstSubs, notifyHandler);
232 }
233 }
234
235 private void handleSmr(Eid eid, Set<SubscriberRLOC> subscribers, IMapNotifyHandler callback) {
236 if (subscribers == null) {
237 return;
238 }
239 MapRequestBuilder mrb = MapRequestUtil.prepareSMR(eid, LispAddressUtil.toRloc(getLocalAddress()));
240 LOG.trace("Built SMR packet: " + mrb.build().toString());
241
242
243 Iterator<SubscriberRLOC> iterator = subscribers.iterator();
244 while (iterator.hasNext()) {
245 SubscriberRLOC subscriber = iterator.next();
246 if (subscriber.timedOut()) {
247 LOG.trace("Lazy removing expired subscriber entry " + subscriber.toString());
248 iterator.remove();
249 } else {
250 try {
251
252
253 mrb.setEidItem(new ArrayList<EidItem>());
254 mrb.getEidItem().add(new EidItemBuilder().setEid(subscriber.getSrcEid()).build());
255 callback.handleSMR(mrb.build(), subscriber.getSrcRloc());
256 } catch (Exception e) {
257 LOG.error("Errors encountered while handling SMR:" + ExceptionUtils.getStackTrace(e));
258 }
259 }
260 }
261 addSubscribers(eid, subscribers);
262 }
263
264 @SuppressWarnings("unchecked")
265 private Set<SubscriberRLOC> getSubscribers(Eid address) {
266 return (Set<SubscriberRLOC>) mapService.getData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
267 }
268
269 private void removeSubscribers(Eid address) {
270 mapService.removeData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
271 }
272
273 private void addSubscribers(Eid address, Set<SubscriberRLOC> subscribers) {
274 mapService.addData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS, subscribers);
275 }
276
277 private static InetAddress getLocalAddress() {
278 try {
279 Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces();
280 while (interfaces.hasMoreElements()) {
281 NetworkInterface current = interfaces.nextElement();
282 LOG.debug("Interface " + current.toString());
283 if (!current.isUp() || current.isLoopback() || current.isVirtual()) {
284 continue;
285 }
286 Enumeration<InetAddress> addresses = current.getInetAddresses();
287 while (addresses.hasMoreElements()) {
288 InetAddress current_addr = addresses.nextElement();
289
290 if (current_addr.isLoopbackAddress() || current_addr.isLinkLocalAddress()) {
291 continue;
292 }
293 LOG.debug(current_addr.getHostAddress());
294 return current_addr;
295 }
296 }
297 } catch (SocketException se) {
298 LOG.debug("Caught socket exceptio", se);
299 }
300 return null;
301 }
302 }