Update DAO API
[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.List;
13 import java.util.Set;
14
15 import org.apache.commons.lang3.exception.ExceptionUtils;
16 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
17 import org.opendaylight.lispflowmapping.implementation.mapcache.TopologyMapCache;
18 import org.opendaylight.lispflowmapping.interfaces.dao.ILispDAO;
19 import org.opendaylight.lispflowmapping.interfaces.dao.SubscriberRLOC;
20 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
21 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
22 import org.opendaylight.lispflowmapping.lisp.util.LispAFIConvertor;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.EidToLocatorRecord.Action;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.LcafTrafficEngineeringAddress;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.MapRequest;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.eidrecords.EidRecord;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.eidtolocatorrecords.EidToLocatorRecord;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.eidtolocatorrecords.EidToLocatorRecordBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.lcaftrafficengineeringaddress.Hops;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.lispaddress.LispAddressContainer;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.lispaddress.lispaddresscontainer.address.LcafTrafficEngineering;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.locatorrecords.LocatorRecord;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.locatorrecords.LocatorRecordBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.mapreplymessage.MapReplyBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev150820.maprequest.ItrRloc;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
38
39 import com.google.common.base.Preconditions;
40 import com.google.common.collect.Sets;
41
42 public class MapResolver extends AbstractLispComponent implements IMapResolverAsync {
43
44     private static final int TTL_RLOC_TIMED_OUT = 1;
45     private static final int TTL_NO_RLOC_KNOWN = 15;
46     protected static final Logger LOG = LoggerFactory.getLogger(MapResolver.class);
47
48     private static final ConfigIni configIni = new ConfigIni();
49     private static final String elpPolicy = configIni.getElpPolicy();
50
51     public MapResolver(ILispDAO dao) {
52         this(dao, true, true);
53     }
54
55     public MapResolver(ILispDAO dao, boolean authenticate, boolean iterateMask) {
56         super(dao, authenticate, iterateMask);
57     }
58
59     public void handleMapRequest(MapRequest request, boolean smr, IMapRequestResultHandler callback) {
60         Preconditions.checkNotNull(dao);
61
62         LispAddressContainer srcEid = null;
63         if (request.getSourceEid() != null) {
64             srcEid = request.getSourceEid().getLispAddressContainer();
65         }
66         MapReplyBuilder builder = new MapReplyBuilder();
67         builder.setEchoNonceEnabled(false);
68         builder.setProbe(false);
69         builder.setSecurityEnabled(false);
70         builder.setNonce(request.getNonce());
71         builder.setEidToLocatorRecord(new ArrayList<EidToLocatorRecord>());
72         for (EidRecord eidRecord : request.getEidRecord()) {
73             EidToLocatorRecord mapping = TopologyMapCache.getMapping(srcEid, eidRecord.getLispAddressContainer(), dao);
74             EidToLocatorRecordBuilder recordBuilder;
75             if (mapping != null) {
76                 recordBuilder = new EidToLocatorRecordBuilder(mapping);
77                 List<ItrRloc> itrRlocs = request.getItrRloc();
78                 if (itrRlocs != null && itrRlocs.size() != 0) {
79                     updateLocators(recordBuilder, itrRlocs);
80                     LispAddressContainer itrRloc = itrRlocs.get(0).getLispAddressContainer();
81                     SubscriberRLOC subscriberRloc = new SubscriberRLOC(itrRloc, srcEid);
82                     Set<SubscriberRLOC> subscribers = TopologyMapCache.getSubscribers(mapping.getLispAddressContainer(), dao);
83                     if (subscribers == null) {
84                         subscribers = Sets.newConcurrentHashSet();
85                     } else if (subscribers.contains(subscriberRloc)) {
86                         // If there is an entry already for this subscriberRloc, remove it, so that it gets the new
87                         // timestamp
88                         subscribers.remove(subscriberRloc);
89                     }
90                     if (smr) {
91                         LOG.trace("Adding new subscriber: " + subscriberRloc.toString());
92                         subscribers.add(subscriberRloc);
93                         TopologyMapCache.addSubscribers(mapping.getLispAddressContainer(), subscribers, dao);
94                     }
95                 }
96             } else {
97                 recordBuilder = new EidToLocatorRecordBuilder();
98                 recordBuilder.setAuthoritative(false);
99                 recordBuilder.setMapVersion((short) 0);
100                 recordBuilder.setMaskLength(eidRecord.getMask());
101                 recordBuilder.setLispAddressContainer(eidRecord.getLispAddressContainer());
102                 recordBuilder.setAction(Action.NativelyForward);
103                 if (shouldAuthenticate() && TopologyMapCache.getAuthenticationKey(eidRecord.getLispAddressContainer(),
104                         dao, shouldIterateMask()) != null) {
105                     recordBuilder.setRecordTtl(TTL_RLOC_TIMED_OUT);
106                 } else {
107                     recordBuilder.setRecordTtl(TTL_NO_RLOC_KNOWN);
108
109                 }
110             }
111             builder.getEidToLocatorRecord().add(recordBuilder.build());
112         }
113         callback.handleMapReply(builder.build());
114     }
115
116     // Process locators according to configured policy
117     private void updateLocators(EidToLocatorRecordBuilder recordBuilder, List<ItrRloc> itrRlocs) {
118         List<LocatorRecord> locatorRecords = recordBuilder.getLocatorRecord();
119         recordBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
120         try {
121             for (LocatorRecord record : locatorRecords) {
122                 LispAddressContainer container = record.getLispAddressContainer();
123
124                 // For non-ELP RLOCs, or when ELP policy is default, or itrRlocs is null, just add the locator and be
125                 // done
126                 if ((!(container.getAddress() instanceof LcafTrafficEngineering))
127                         || elpPolicy.equalsIgnoreCase("default") || itrRlocs == null) {
128                     recordBuilder.getLocatorRecord().add(
129                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
130                                     .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
131                                     .setPriority(record.getPriority()).setMulticastWeight(record.getMulticastWeight())
132                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
133                                     .setLispAddressContainer(container).setName(record.getName()).build());
134                     continue;
135                 }
136
137                 LcafTrafficEngineeringAddress teAddress = ((LcafTrafficEngineering) container.getAddress())
138                         .getLcafTrafficEngineeringAddr();
139                 LispAddressContainer nextHop = getNextELPHop(teAddress, itrRlocs);
140                 if (nextHop != null) {
141                     java.lang.Short priority = record.getPriority();
142                     if (elpPolicy.equalsIgnoreCase("both")) {
143                         recordBuilder.getLocatorRecord().add(
144                                 new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
145                                         .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
146                                         .setPriority(record.getPriority())
147                                         .setMulticastWeight(record.getMulticastWeight())
148                                         .setMulticastPriority(record.getMulticastPriority())
149                                         .setRouted(record.isRouted()).setLispAddressContainer(container)
150                                         .setName(record.getName()).build());
151                         // Make the priority of the added simple locator lower so that ELP is used by default if
152                         // the xTR understands ELP.  Exclude 255, since that means don't use for unicast forwarding
153                         // XXX Complex cases like several ELPs with different priorities are not handled
154                         if (priority != 254 || priority !=255) {
155                             priority++;
156                         }
157                     }
158                     // Build and add the simple RLOC
159                     recordBuilder.getLocatorRecord().add(
160                             new LocatorRecordBuilder().setLocalLocator(record.isLocalLocator())
161                                     .setRlocProbed(record.isRlocProbed()).setWeight(record.getWeight())
162                                     .setPriority(priority).setMulticastWeight(record.getMulticastWeight())
163                                     .setMulticastPriority(record.getMulticastPriority()).setRouted(record.isRouted())
164                                     .setLispAddressContainer(nextHop).setName(record.getName()).build());
165                 }
166             }
167         } catch (ClassCastException cce) {
168             LOG.error("Class Cast Exception while building EidToLocatorRecord: {}", ExceptionUtils.getStackTrace(cce));
169         }
170     }
171
172     private LispAddressContainer getNextELPHop(LcafTrafficEngineeringAddress elp, List<ItrRloc> itrRlocs) {
173         LispAddressContainer nextHop = null;
174         List<Hops> hops = elp.getHops();
175
176         if (hops != null && hops.size() > 0) {
177             // By default we return the first hop
178             nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(0).getHop()
179                     .getPrimitiveAddress()));
180             for (Hops hop : hops) {
181                 LispAddressContainer hopContainer = LispAFIConvertor.toContainer(LispAFIConvertor
182                         .toAFIfromPrimitive(hop.getHop().getPrimitiveAddress()));
183                 for (ItrRloc itrRloc : itrRlocs) {
184                     if (itrRloc.getLispAddressContainer().equals(hopContainer)) {
185                         int i = hops.indexOf(hop);
186                         if (i < hops.size() - 1) {
187                             nextHop = LispAFIConvertor.toContainer(LispAFIConvertor.toAFIfromPrimitive(hops.get(i + 1)
188                                     .getHop().getPrimitiveAddress()));
189                             return nextHop;
190                         }
191                     }
192                 }
193             }
194         }
195
196         return nextHop;
197     }
198
199 }