c198ac2be1a80ecb2a795d12cb0626c4b4de6d39
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / lisp / MapResolver.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.util.ArrayList;
12 import java.util.HashSet;
13 import java.util.List;
14 import java.util.Map.Entry;
15
16 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
17 import org.opendaylight.lispflowmapping.implementation.dao.MappingServiceKeyUtil;
18 import org.opendaylight.lispflowmapping.implementation.util.DAOMappingUtil;
19 import org.opendaylight.lispflowmapping.implementation.util.LispAFIConvertor;
20 import org.opendaylight.lispflowmapping.implementation.util.LispNotificationHelper;
21 import org.opendaylight.lispflowmapping.interfaces.dao.ILispDAO;
22 import org.opendaylight.lispflowmapping.interfaces.dao.IMappingServiceKey;
23 import org.opendaylight.lispflowmapping.interfaces.dao.MappingEntry;
24 import org.opendaylight.lispflowmapping.interfaces.dao.MappingServiceRLOCGroup;
25 import org.opendaylight.lispflowmapping.interfaces.dao.MappingServiceSubscriberRLOC;
26 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
27 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
28 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.EidToLocatorRecord.Action;
29 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.LcafTrafficEngineeringAddress;
30 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapRequest;
31 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.eidrecords.EidRecord;
32 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.eidtolocatorrecords.EidToLocatorRecord;
33 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.eidtolocatorrecords.EidToLocatorRecordBuilder;
34 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lcaftrafficengineeringaddress.Hops;
35 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispaddress.LispAddressContainer;
36 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispaddress.LispAddressContainerBuilder;
37 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.locatorrecords.LocatorRecord;
38 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.locatorrecords.LocatorRecordBuilder;
39 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.mapreplymessage.MapReplyBuilder;
40 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.maprequest.ItrRloc;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43
44 public class MapResolver extends AbstractLispComponent implements IMapResolverAsync {
45
46     private static final int TTL_RLOC_TIMED_OUT = 1;
47     private static final int TTL_NO_RLOC_KNOWN = 15;
48     protected static final Logger LOG = LoggerFactory.getLogger(MapResolver.class);
49
50     private static final ConfigIni configIni = new ConfigIni();
51     private static final String elpPolicy = configIni.getElpPolicy();
52
53     public MapResolver(ILispDAO dao) {
54         this(dao, true, true);
55     }
56
57     public MapResolver(ILispDAO dao, boolean authenticate, boolean iterateMask) {
58         super(dao, authenticate, iterateMask);
59     }
60
61     public void handleMapRequest(MapRequest request, boolean smr, IMapRequestResultHandler callback) {
62         if (dao == null) {
63             LOG.warn("handleMapRequest called while dao is uninitialized");
64             return;
65         }
66         if (request.isPitr()) {
67             if (request.getEidRecord().size() > 0) {
68                 EidRecord eid = request.getEidRecord().get(0);
69                 Object result = DAOMappingUtil.getLocatorsSpecificByEidRecord(eid, dao, ADDRESS_SUBKEY, shouldIterateMask());
70                 if (result != null && result instanceof MappingServiceRLOCGroup) {
71                     MappingServiceRLOCGroup locatorsGroup = (MappingServiceRLOCGroup) result;
72                     if (locatorsGroup != null && locatorsGroup.getRecords().size() > 0) {
73                         callback.handleNonProxyMapRequest(request,
74                                 LispNotificationHelper.getTransportAddressFromContainer(locatorsGroup.getRecords().get(0).getLispAddressContainer()));
75                     }
76                 }
77             }
78
79         } else {
80             MapReplyBuilder builder = new MapReplyBuilder();
81             builder.setEchoNonceEnabled(false);
82             builder.setProbe(false);
83             builder.setSecurityEnabled(false);
84             builder.setNonce(request.getNonce());
85             builder.setEidToLocatorRecord(new ArrayList<EidToLocatorRecord>());
86             for (EidRecord eid : request.getEidRecord()) {
87                 EidToLocatorRecordBuilder recordBuilder = new EidToLocatorRecordBuilder();
88                 Entry<IMappingServiceKey, List<MappingServiceRLOCGroup>> mapping = DAOMappingUtil.getMappingForEidRecord(eid, dao);
89                 recordBuilder.setRecordTtl(0);
90                 recordBuilder.setAction(Action.NoAction);
91                 recordBuilder.setAuthoritative(false);
92                 recordBuilder.setMapVersion((short) 0);
93                 recordBuilder.setMaskLength((short) mapping.getKey().getMask());
94                 recordBuilder.setLispAddressContainer(mapping.getKey().getEID());
95                 recordBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
96                 List<MappingServiceRLOCGroup> locators = mapping.getValue();
97                 if (locators != null && locators.size() > 0) {
98                     List<ItrRloc> itrRlocs = request.getItrRloc();
99                     addLocatorGroups(recordBuilder, locators, itrRlocs);
100                     if (itrRlocs != null && itrRlocs.size() > 0) {
101                         LispAddressContainer itrRloc = itrRlocs.get(0).getLispAddressContainer();
102                         MappingServiceSubscriberRLOC subscriberRloc = new MappingServiceSubscriberRLOC(itrRloc);
103                         HashSet<MappingServiceSubscriberRLOC> subscribers = getSubscribers(mapping.getKey().getEID(), mapping.getKey().getMask());
104                         if (subscribers == null) {
105                             subscribers = new HashSet<MappingServiceSubscriberRLOC>();
106                         } else if (subscribers.contains(subscriberRloc)) {
107                             /*
108                              * If there is an entry already for this
109                              * subscriberRloc, remove it, so that it gets the
110                              * new timestamp
111                              */
112                             subscribers.remove(subscriberRloc);
113                         }
114                         if (smr) {
115                             IMappingServiceKey key = MappingServiceKeyUtil.generateMappingServiceKey(mapping.getKey().getEID(),
116                                     mapping.getKey().getMask());
117                             LOG.trace("Adding new subscriber: " + subscriberRloc.toString());
118                             subscribers.add(subscriberRloc);
119                             dao.put(key, new MappingEntry<HashSet<MappingServiceSubscriberRLOC>>(SUBSCRIBERS_SUBKEY, subscribers));
120                         }
121                     }
122                 } else {
123                     recordBuilder
124                             .setAction(org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.eidtolocatorrecords.EidToLocatorRecord.Action.NativelyForward);
125                     if (shouldAuthenticate() && getPassword(eid.getLispAddressContainer(), eid.getMask()) != null) {
126                         recordBuilder.setRecordTtl(TTL_RLOC_TIMED_OUT);
127                     } else {
128                         recordBuilder.setRecordTtl(TTL_NO_RLOC_KNOWN);
129
130                     }
131                 }
132                 builder.getEidToLocatorRecord().add(recordBuilder.build());
133             }
134
135             callback.handleMapReply(builder.build());
136         }
137     }
138
139     private void addLocatorGroups(EidToLocatorRecordBuilder recordBuilder, List<MappingServiceRLOCGroup> rlocs, List<ItrRloc> itrRlocs) {
140         for (MappingServiceRLOCGroup rloc : rlocs) {
141             addLocators(recordBuilder, rloc, itrRlocs);
142             recordBuilder.setRecordTtl(rloc.getTtl());
143         }
144     }
145
146     private void addLocators(EidToLocatorRecordBuilder recordBuilder, MappingServiceRLOCGroup locatorObject, List<ItrRloc> itrRlocs) {
147         if (locatorObject == null) {
148             return;
149         }
150
151         recordBuilder.setAction(locatorObject.getAction());
152         recordBuilder.setAuthoritative(locatorObject.isAuthoritative());
153         recordBuilder.setRecordTtl(locatorObject.getTtl());
154
155         try {
156             for (LocatorRecord record : locatorObject.getRecords()) {
157                 LispAddressContainer container = record.getLispAddressContainer();
158
159                 // For non-ELP RLOCs, or when ELP policy is default, just add the locator and be done
160                 if ((!(container.getAddress() instanceof LcafTrafficEngineeringAddress)) || elpPolicy.equalsIgnoreCase("default")) {
161                     recordBuilder.getLocatorRecord().add(
162                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
163                                     .setWeight(record.getWeight()).setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
164                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
165                                     .setLispAddressContainer(container).build());
166                     continue;
167                 }
168
169                 LispAddressContainer nextHop = getNextELPHop((LcafTrafficEngineeringAddress) container.getAddress(), itrRlocs);
170                 if (nextHop != null) {
171                     java.lang.Short priority = record.getPriority();
172                     if (elpPolicy.equalsIgnoreCase("both")) {
173                         recordBuilder.getLocatorRecord().add(
174                                 new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
175                                         .setWeight(record.getWeight()).setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
176                                         .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
177                                         .setLispAddressContainer(container).build());
178                         // Make the priority of the added simple locator lower so that ELP is used by default if
179                         // the xTR understands ELP.  Exclude 255, since that means don't use for unicast forwarding
180                         // XXX Complex cases like several ELPs with different priorities are not handled
181                         if (priority != 254 || priority !=255) {
182                             priority++;
183                         }
184                     }
185                     // Build and add the simple RLOC
186                     recordBuilder.getLocatorRecord().add(
187                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
188                             .setWeight(record.getWeight()).setPriority(priority).setMulticastWeight(record.getMulticastWeight())
189                             .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
190                             .setLispAddressContainer(nextHop).build());
191                 }
192             }
193         } catch (ClassCastException cce) {
194         }
195     }
196
197     private LispAddressContainer getNextELPHop(LcafTrafficEngineeringAddress elp, List<ItrRloc> itrRlocs) {
198         LispAddressContainer nextHop = null;
199         List<Hops> hops = elp.getHops();
200
201         if (hops != null && hops.size() > 0) {
202             // By default we return the first hop
203             nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(0).getHop().getPrimitiveAddress()));
204             for (Hops hop : hops) {
205                 LispAddressContainer hopContainer = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hop.getHop().getPrimitiveAddress()));
206                 for (ItrRloc itrRloc : itrRlocs) {
207                     if (itrRloc.getLispAddressContainer().equals(hopContainer)) {
208                         int i = hops.indexOf(hop);
209                         if (i < hops.size() - 1) {
210                             nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(i+1).getHop().getPrimitiveAddress()));
211                             return nextHop;
212                         }
213                     }
214                 }
215             }
216         }
217
218         return nextHop;
219     }
220
221 }