2 * Copyright (c) 2014 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 java.util.ArrayList;
12 import java.util.List;
15 import org.apache.commons.lang3.exception.ExceptionUtils;
16 import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
17 import org.opendaylight.lispflowmapping.interfaces.dao.SubscriberRLOC;
18 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
19 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
20 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
21 import org.opendaylight.lispflowmapping.lisp.util.LcafSourceDestHelper;
22 import org.opendaylight.lispflowmapping.lisp.util.LispAFIConvertor;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidToLocatorRecord.Action;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.LcafTrafficEngineeringAddress;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eidrecords.EidRecord;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eidtolocatorrecords.EidToLocatorRecord;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eidtolocatorrecords.EidToLocatorRecordBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.lcaftrafficengineeringaddress.Hops;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.lispaddress.LispAddressContainer;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.lispaddress.lispaddresscontainer.address.LcafSourceDest;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.lispaddress.lispaddresscontainer.address.LcafTrafficEngineering;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecord;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.ItrRloc;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
41 import com.google.common.base.Preconditions;
42 import com.google.common.collect.Sets;
44 public class MapResolver implements IMapResolverAsync {
45 protected static final Logger LOG = LoggerFactory.getLogger(MapResolver.class);
47 private static final int TTL_RLOC_TIMED_OUT = 1;
48 private static final int TTL_NO_RLOC_KNOWN = 15;
50 private IMappingService mapService;
51 private boolean subscriptionService;
52 private String elpPolicy;
53 private IMapRequestResultHandler requestHandler;
54 private boolean authenticate = true;
56 public MapResolver(IMappingService mapService, boolean smr, String elpPolicy,
57 IMapRequestResultHandler requestHandler) {
58 Preconditions.checkNotNull(mapService);
59 this.subscriptionService = smr;
60 this.mapService = mapService;
61 this.elpPolicy = elpPolicy;
62 this.requestHandler = requestHandler;
65 public void handleMapRequest(MapRequest request) {
66 LispAddressContainer srcEid = null;
67 if (request.getSourceEid() != null) {
68 srcEid = request.getSourceEid().getLispAddressContainer();
70 MapReplyBuilder replyBuilder = new MapReplyBuilder();
71 replyBuilder.setEchoNonceEnabled(false);
72 replyBuilder.setProbe(false);
73 replyBuilder.setSecurityEnabled(false);
74 replyBuilder.setNonce(request.getNonce());
75 replyBuilder.setEidToLocatorRecord(new ArrayList<EidToLocatorRecord>());
76 for (EidRecord eidRecord : request.getEidRecord()) {
77 EidToLocatorRecord mapping = (EidToLocatorRecord) mapService.getMapping(srcEid,
78 eidRecord.getLispAddressContainer());
79 if (mapping != null) {
80 List<ItrRloc> itrRlocs = request.getItrRloc();
81 if (itrRlocs != null && itrRlocs.size() != 0) {
82 if (subscriptionService) {
83 updateSubscribers(itrRlocs.get(0).getLispAddressContainer(), mapping.getLispAddressContainer(),
86 mapping = updateLocators(mapping, itrRlocs);
88 mapping = fixIfNotSDRequest(mapping, eidRecord.getLispAddressContainer());
90 mapping = getNegativeMapping(eidRecord.getLispAddressContainer(), eidRecord.getMask());
92 replyBuilder.getEidToLocatorRecord().add(mapping);
94 requestHandler.handleMapReply(replyBuilder.build());
97 private EidToLocatorRecord getNegativeMapping(LispAddressContainer eid, short mask) {
98 EidToLocatorRecordBuilder recordBuilder = new EidToLocatorRecordBuilder();
99 recordBuilder.setAuthoritative(false);
100 recordBuilder.setMapVersion((short) 0);
101 recordBuilder.setMaskLength(mask);
102 recordBuilder.setLispAddressContainer(eid);
103 recordBuilder.setAction(Action.NativelyForward);
104 if (authenticate && mapService.getAuthenticationKey(eid) != null) {
105 recordBuilder.setRecordTtl(TTL_RLOC_TIMED_OUT);
107 recordBuilder.setRecordTtl(TTL_NO_RLOC_KNOWN);
109 return recordBuilder.build();
112 private void updateSubscribers(LispAddressContainer itrRloc, LispAddressContainer dstEid,
113 LispAddressContainer srcEid) {
114 SubscriberRLOC subscriberRloc = new SubscriberRLOC(itrRloc, srcEid);
115 Set<SubscriberRLOC> subscribers = getSubscribers(dstEid);
116 if (subscribers == null) {
117 subscribers = Sets.newConcurrentHashSet();
118 } else if (subscribers.contains(subscriberRloc)) {
119 // If there is an entry already for this subscriberRloc, remove it, so that it gets the new
121 subscribers.remove(subscriberRloc);
123 LOG.trace("Adding new subscriber: " + subscriberRloc.toString());
124 subscribers.add(subscriberRloc);
125 addSubscribers(dstEid, subscribers);
128 // Fixes mapping if request was for simple dst EID but the matched mapping is a SourceDest
129 private EidToLocatorRecord fixIfNotSDRequest(EidToLocatorRecord mapping, LispAddressContainer dstEid) {
130 if (mapping.getLispAddressContainer().getAddress() instanceof LcafSourceDest
131 && !(dstEid.getAddress() instanceof LcafSourceDest)) {
132 return new EidToLocatorRecordBuilder(mapping).setLispAddressContainer(
133 LcafSourceDestHelper.getDst(mapping.getLispAddressContainer())).build();
138 private boolean locatorsNeedFixing(List<LocatorRecord> locatorRecords) {
139 for (LocatorRecord record : locatorRecords) {
140 if (record.getLispAddressContainer().getAddress() instanceof LcafTrafficEngineering) {
147 // Process locators according to configured policy
148 private EidToLocatorRecord updateLocators(EidToLocatorRecord mapping, List<ItrRloc> itrRlocs) {
149 // no fixing if elpPolicy is default
150 if (elpPolicy.equalsIgnoreCase("default")) {
154 List<LocatorRecord> locatorRecords = mapping.getLocatorRecord();
156 // if no updated is needed, just return the mapping
157 if (!locatorsNeedFixing(locatorRecords)) {
161 EidToLocatorRecordBuilder recordBuilder = new EidToLocatorRecordBuilder(mapping);
162 recordBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
164 for (LocatorRecord record : locatorRecords) {
165 LispAddressContainer container = record.getLispAddressContainer();
167 // For non-ELP RLOCs, or when ELP policy is default, or itrRlocs is null, just add the locator and be
169 if ((!(container.getAddress() instanceof LcafTrafficEngineering))
170 || elpPolicy.equalsIgnoreCase("default") || itrRlocs == null) {
171 recordBuilder.getLocatorRecord().add(
172 new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
173 .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
174 .setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
175 .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
176 .setLispAddressContainer(container).setName(record.getName()).build());
180 LcafTrafficEngineeringAddress teAddress = ((LcafTrafficEngineering) container.getAddress())
181 .getLcafTrafficEngineeringAddr();
182 LispAddressContainer nextHop = getNextELPHop(teAddress, itrRlocs);
183 if (nextHop != null) {
184 java.lang.Short priority = record.getPriority();
185 if (elpPolicy.equalsIgnoreCase("both")) {
186 recordBuilder.getLocatorRecord().add(
187 new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
188 .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
189 .setPriority(record.getPriority())
190 .setMulticastWeight(record.getMulticastWeight())
191 .setMulticastPriority(record.getMulticastPriority())
192 .setRouted(record.isRouted()).setLispAddressContainer(container)
193 .setName(record.getName()).build());
194 // Make the priority of the added simple locator lower so that ELP is used by default if
195 // the xTR understands ELP. Exclude 255, since that means don't use for unicast forwarding
196 // XXX Complex cases like several ELPs with different priorities are not handled
197 if (priority != 254 || priority != 255) {
201 // Build and add the simple RLOC
202 recordBuilder.getLocatorRecord().add(
203 new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
204 .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
205 .setPriority(priority).setMulticastWeight(record.getMulticastWeight())
206 .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
207 .setLispAddressContainer(nextHop).setName(record.getName()).build());
210 } catch (ClassCastException cce) {
211 LOG.error("Class Cast Exception while building EidToLocatorRecord: {}", ExceptionUtils.getStackTrace(cce));
214 return recordBuilder.build();
217 private LispAddressContainer getNextELPHop(LcafTrafficEngineeringAddress elp, List<ItrRloc> itrRlocs) {
218 LispAddressContainer nextHop = null;
219 List<Hops> hops = elp.getHops();
221 if (hops != null && hops.size() > 0) {
222 // By default we return the first hop
223 nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(0).getHop()
224 .getPrimitiveAddress()));
225 for (Hops hop : hops) {
226 LispAddressContainer hopContainer = LispAFIConvertor.toContainer(LispAFIConvertor
227 .toAFIfromPrimitive(hop.getHop().getPrimitiveAddress()));
228 for (ItrRloc itrRloc : itrRlocs) {
229 if (itrRloc.getLispAddressContainer().equals(hopContainer)) {
230 int i = hops.indexOf(hop);
231 if (i < hops.size() - 1) {
232 nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(i + 1)
233 .getHop().getPrimitiveAddress()));
244 @SuppressWarnings("unchecked")
245 private Set<SubscriberRLOC> getSubscribers(LispAddressContainer address) {
246 return (Set<SubscriberRLOC>) mapService.getData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS);
249 private void addSubscribers(LispAddressContainer address, Set<SubscriberRLOC> subscribers) {
250 mapService.addData(MappingOrigin.Southbound, address, SubKeys.SUBSCRIBERS, subscribers);
254 public void setSubscriptionService(boolean smr) {
255 subscriptionService = smr;
259 public void setElpPolicy(String elpPolicy) {
260 this.elpPolicy = elpPolicy;
264 public void setShouldAuthenticate(boolean shouldAuthenticate) {
265 this.authenticate = shouldAuthenticate;