16f65591c9062eb6ff1d0ec20fc4de6f0293eee1
[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.interfaces.dao.ILispDAO;
21 import org.opendaylight.lispflowmapping.interfaces.dao.IMappingServiceKey;
22 import org.opendaylight.lispflowmapping.interfaces.dao.MappingEntry;
23 import org.opendaylight.lispflowmapping.interfaces.dao.MappingServiceRLOCGroup;
24 import org.opendaylight.lispflowmapping.interfaces.dao.MappingServiceSubscriberRLOC;
25 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
26 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.EidToLocatorRecord.Action;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.LcafTrafficEngineeringAddress;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.LispAFIAddress;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.MapRequest;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.eidrecords.EidRecord;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.eidtolocatorrecords.EidToLocatorRecord;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.eidtolocatorrecords.EidToLocatorRecordBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.lcaftrafficengineeringaddress.Hops;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.lispaddress.LispAddressContainer;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.lispaddress.lispaddresscontainer.address.LcafTrafficEngineering;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.locatorrecords.LocatorRecord;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.locatorrecords.LocatorRecordBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.mapreplymessage.MapReplyBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.control.plane.rev150314.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
67         LispAFIAddress srcEid = null;
68         if (request.getSourceEid() != null) {
69             srcEid = LispAFIConvertor.toAFI(request.getSourceEid().getLispAddressContainer());
70         }
71         MapReplyBuilder builder = new MapReplyBuilder();
72         builder.setEchoNonceEnabled(false);
73         builder.setProbe(false);
74         builder.setSecurityEnabled(false);
75         builder.setNonce(request.getNonce());
76         builder.setEidToLocatorRecord(new ArrayList<EidToLocatorRecord>());
77         for (EidRecord eid : request.getEidRecord()) {
78             EidToLocatorRecordBuilder recordBuilder = new EidToLocatorRecordBuilder();
79             Entry<IMappingServiceKey, List<MappingServiceRLOCGroup>> mapping = DAOMappingUtil.getMapping(srcEid, eid, dao);
80             recordBuilder.setRecordTtl(0);
81             recordBuilder.setAction(Action.NoAction);
82             recordBuilder.setAuthoritative(false);
83             recordBuilder.setMapVersion((short) 0);
84             recordBuilder.setMaskLength((short) mapping.getKey().getMask());
85             recordBuilder.setLispAddressContainer(mapping.getKey().getEID());
86             recordBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
87             List<MappingServiceRLOCGroup> locators = mapping.getValue();
88             if (locators != null && locators.size() > 0) {
89                 List<ItrRloc> itrRlocs = request.getItrRloc();
90                 addLocatorGroups(recordBuilder, locators, itrRlocs);
91                 if (itrRlocs != null && itrRlocs.size() > 0) {
92                     LispAddressContainer itrRloc = itrRlocs.get(0).getLispAddressContainer();
93                     MappingServiceSubscriberRLOC subscriberRloc = new MappingServiceSubscriberRLOC(itrRloc);
94                     HashSet<MappingServiceSubscriberRLOC> subscribers = getSubscribers(mapping.getKey().getEID(), mapping.getKey().getMask());
95                     if (subscribers == null) {
96                         subscribers = new HashSet<MappingServiceSubscriberRLOC>();
97                     } else if (subscribers.contains(subscriberRloc)) {
98                         /*
99                          * If there is an entry already for this
100                          * subscriberRloc, remove it, so that it gets the
101                          * new timestamp
102                          */
103                         subscribers.remove(subscriberRloc);
104                     }
105                     if (smr) {
106                         IMappingServiceKey key = MappingServiceKeyUtil.generateMappingServiceKey(mapping.getKey().getEID(),
107                                 mapping.getKey().getMask());
108                         LOG.trace("Adding new subscriber: " + subscriberRloc.toString());
109                         subscribers.add(subscriberRloc);
110                         dao.put(key, new MappingEntry<HashSet<MappingServiceSubscriberRLOC>>(SUBSCRIBERS_SUBKEY, subscribers));
111                     }
112                 }
113             } else {
114                 recordBuilder.setAction(Action.NativelyForward);
115                 if (shouldAuthenticate() && getPassword(eid.getLispAddressContainer(), eid.getMask()) != null) {
116                     recordBuilder.setRecordTtl(TTL_RLOC_TIMED_OUT);
117                 } else {
118                     recordBuilder.setRecordTtl(TTL_NO_RLOC_KNOWN);
119
120                 }
121             }
122             builder.getEidToLocatorRecord().add(recordBuilder.build());
123         }
124
125         callback.handleMapReply(builder.build());
126
127     }
128
129     private void addLocatorGroups(EidToLocatorRecordBuilder recordBuilder, List<MappingServiceRLOCGroup> rlocs, List<ItrRloc> itrRlocs) {
130         for (MappingServiceRLOCGroup rloc : rlocs) {
131             addLocators(recordBuilder, rloc, itrRlocs);
132             recordBuilder.setRecordTtl(rloc.getTtl());
133         }
134     }
135
136     private void addLocators(EidToLocatorRecordBuilder recordBuilder, MappingServiceRLOCGroup locatorObject, List<ItrRloc> itrRlocs) {
137         if (locatorObject == null) {
138             return;
139         }
140
141         recordBuilder.setAction(locatorObject.getAction());
142         recordBuilder.setAuthoritative(locatorObject.isAuthoritative());
143         recordBuilder.setRecordTtl(locatorObject.getTtl());
144
145         try {
146             for (LocatorRecord record : locatorObject.getRecords()) {
147                 LispAddressContainer container = record.getLispAddressContainer();
148
149                 // For non-ELP RLOCs, or when ELP policy is default, just add the locator and be done
150                 if ((!(container.getAddress() instanceof LcafTrafficEngineering)) || elpPolicy.equalsIgnoreCase("default")) {
151                     recordBuilder.getLocatorRecord().add(
152                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
153                                     .setWeight(record.getWeight()).setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
154                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
155                                     .setLispAddressContainer(container).setName(record.getName()).build());
156                     continue;
157                 }
158
159                 LcafTrafficEngineeringAddress teAddress = ((LcafTrafficEngineering) container.getAddress()).getLcafTrafficEngineeringAddr();
160                 LispAddressContainer nextHop = getNextELPHop(teAddress, itrRlocs);
161                 if (nextHop != null) {
162                     java.lang.Short priority = record.getPriority();
163                     if (elpPolicy.equalsIgnoreCase("both")) {
164                         recordBuilder.getLocatorRecord().add(
165                                 new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
166                                         .setWeight(record.getWeight()).setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
167                                         .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
168                                         .setLispAddressContainer(container).setName(record.getName()).build());
169                         // Make the priority of the added simple locator lower so that ELP is used by default if
170                         // the xTR understands ELP.  Exclude 255, since that means don't use for unicast forwarding
171                         // XXX Complex cases like several ELPs with different priorities are not handled
172                         if (priority != 254 || priority !=255) {
173                             priority++;
174                         }
175                     }
176                     // Build and add the simple RLOC
177                     recordBuilder.getLocatorRecord().add(
178                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator()).setRlocProbed(record.isRlocProbed())
179                             .setWeight(record.getWeight()).setPriority(priority).setMulticastWeight(record.getMulticastWeight())
180                             .setMulticastPriority(record.getMulticastPriority()).setRouted(true)
181                             .setLispAddressContainer(nextHop).setName(record.getName()).build());
182                 }
183             }
184         } catch (ClassCastException cce) {
185             LOG.error("Class Cast Exception while building EidToLocatorRecord: {}", cce);
186         }
187     }
188
189     private LispAddressContainer getNextELPHop(LcafTrafficEngineeringAddress elp, List<ItrRloc> itrRlocs) {
190         LispAddressContainer nextHop = null;
191         List<Hops> hops = elp.getHops();
192
193         if (hops != null && hops.size() > 0) {
194             // By default we return the first hop
195             nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(0).getHop().getPrimitiveAddress()));
196             for (Hops hop : hops) {
197                 LispAddressContainer hopContainer = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hop.getHop().getPrimitiveAddress()));
198                 for (ItrRloc itrRloc : itrRlocs) {
199                     if (itrRloc.getLispAddressContainer().equals(hopContainer)) {
200                         int i = hops.indexOf(hop);
201                         if (i < hops.size() - 1) {
202                             nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(i+1).getHop().getPrimitiveAddress()));
203                             return nextHop;
204                         }
205                     }
206                 }
207             }
208         }
209
210         return nextHop;
211     }
212
213 }