2 * Copyright (c) 2015 Cisco Systems, 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
8 package org.opendaylight.protocol.bgp.mode.impl.add;
10 import com.google.common.collect.Lists;
11 import com.google.common.primitives.UnsignedInteger;
12 import java.util.ArrayList;
13 import java.util.List;
15 import java.util.Optional;
16 import javax.annotation.concurrent.NotThreadSafe;
17 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
18 import org.opendaylight.protocol.bgp.mode.api.BestPath;
19 import org.opendaylight.protocol.bgp.mode.spi.AbstractRouteEntry;
20 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
21 import org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup;
22 import org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup.PeerExporTuple;
23 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
24 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
31 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
39 * A single route entry inside a route table. Maintains the attributes of
40 * from all contributing peers. The information is stored in arrays with a
41 * shared map of offsets for peers to allow lookups. This is needed to
42 * maintain low memory overhead in face of large number of routes and peers,
43 * where individual object overhead becomes the dominating factor.
46 public abstract class AddPathAbstractRouteEntry extends AbstractRouteEntry {
48 private static final Logger LOG = LoggerFactory.getLogger(AddPathAbstractRouteEntry.class);
49 private List<AddPathBestPath> bestPath;
50 private List<AddPathBestPath> bestPathRemoved;
51 protected OffsetMap offsets = OffsetMap.EMPTY;
52 protected ContainerNode[] values = new ContainerNode[0];
53 protected Long[] pathsId = new Long[0];
54 private long pathIdCounter = 0L;
55 private boolean oldNonAddPathBestPathTheSame;
56 private List<AddPathBestPath> newBestPathToBeAdvertised;
57 private List<RemovedPath> removedPaths;
59 private static final class RemovedPath {
60 private final RouteKey key;
61 private final Long pathId;
63 RemovedPath(final RouteKey key, final Long pathId) {
72 UnsignedInteger getRouteId() {
73 return this.key.getRouteId();
77 private int addRoute(final RouteKey key, final ContainerNode attributes) {
78 int offset = this.offsets.offsetOf(key);
80 final OffsetMap newOffsets = this.offsets.with(key);
81 offset = newOffsets.offsetOf(key);
82 final ContainerNode[] newAttributes = newOffsets.expand(this.offsets, this.values, offset);
83 final Long[] newPathsId = newOffsets.expand(this.offsets, this.pathsId, offset);
84 this.values = newAttributes;
85 this.offsets = newOffsets;
86 this.pathsId = newPathsId;
87 this.offsets.setValue(this.pathsId, offset, ++this.pathIdCounter);
89 this.offsets.setValue(this.values, offset, attributes);
90 LOG.trace("Added route from {} attributes {}", key.getRouteId(), attributes);
94 protected int addRoute(final RouteKey key, final NodeIdentifier attributesIdentifier, final NormalizedNode<?, ?> data) {
95 LOG.trace("Find {} in {}", attributesIdentifier, data);
96 final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(data, attributesIdentifier).orNull();
97 return addRoute(key, advertisedAttrs);
103 * @param key RouteKey of removed route
104 * @param offset Offset of removed route
105 * @return true if it was the last route
107 protected final boolean removeRoute(final RouteKey key, final int offset) {
108 final Long pathId = this.offsets.getValue(this.pathsId, offset);
109 this.values = this.offsets.removeValue(this.values, offset);
110 this.pathsId = this.offsets.removeValue(this.pathsId, offset);
111 this.offsets = this.offsets.without(key);
112 if(this.removedPaths == null) {
113 this.removedPaths = new ArrayList<>();
115 this.removedPaths.add(new RemovedPath(key, pathId));
120 public void updateRoute(final TablesKey localTK, final ExportPolicyPeerTracker peerPT, final YangInstanceIdentifier locRibTarget,
121 final RIBSupport ribSupport, final DOMDataWriteTransaction tx, final PathArgument routeIdPA) {
122 if(this.bestPathRemoved != null) {
123 this.bestPathRemoved.forEach(path -> {
124 final PathArgument routeIdAddPath = ribSupport.getRouteIdAddPath(path.getPathId(), routeIdPA);
125 final YangInstanceIdentifier pathAddPathTarget = ribSupport.routePath(locRibTarget.node(ROUTES_IDENTIFIER), routeIdAddPath);
126 fillLocRib(pathAddPathTarget, null, tx);
128 this.bestPathRemoved = null;
130 if(this.removedPaths != null) {
131 this.removedPaths.forEach(removedPath -> {
132 final PathArgument routeIdAddPath = ribSupport.getRouteIdAddPath(removedPath.getPathId(), routeIdPA);
133 fillAdjRibsOut(true, null, null, null, routeIdPA, routeIdAddPath, RouterIds.createPeerId(removedPath.getRouteId()),
134 peerPT, localTK, ribSupport, tx);
136 this.removedPaths = null;
139 if(this.newBestPathToBeAdvertised != null) {
140 this.newBestPathToBeAdvertised.forEach(path -> addPathToDataStore(path, isFirstBestPath(this.bestPath.indexOf(path)), routeIdPA,
141 locRibTarget, ribSupport, peerPT, localTK, tx));
142 this.newBestPathToBeAdvertised = null;
147 public void writeRoute(final PeerId destPeer, final PathArgument routeId, final YangInstanceIdentifier rootPath, final PeerExportGroup peerGroup,
148 final TablesKey localTK, final ExportPolicyPeerTracker peerPT, final RIBSupport ribSup, final DOMDataWriteTransaction tx) {
149 final boolean destPeerSupAddPath = peerPT.isAddPathSupportedByPeer(destPeer);
150 if(this.bestPath != null) {
151 final PeerRole destPeerRole = getRoutePeerIdRole(peerPT, destPeer);
152 this.bestPath.stream().filter(path -> filterRoutes(path.getPeerId(), destPeer, peerPT, localTK, destPeerRole) &&
153 peersSupportsAddPathOrIsFirstBestPath(destPeerSupAddPath, isFirstBestPath(this.bestPath.indexOf(path))))
154 .forEach(path -> writeRoutePath(destPeer, routeId, peerPT, peerGroup, destPeerSupAddPath, path, rootPath, localTK, ribSup, tx));
158 private void writeRoutePath(final PeerId destPeer, final PathArgument routeId, final ExportPolicyPeerTracker peerPT,
159 final PeerExportGroup peerGroup, final boolean destPeerSupAddPath,
160 final BestPath path, final YangInstanceIdentifier rootPath, final TablesKey localTK, final RIBSupport ribSup, final DOMDataWriteTransaction tx) {
161 final PathArgument routeIdAddPath = ribSup.getRouteIdAddPath(path.getPathId(), routeId);
162 final ContainerNode effectiveAttributes = peerGroup.effectiveAttributes(getRoutePeerIdRole(peerPT,path.getPeerId()), path.getAttributes());
163 if (destPeerSupAddPath) {
164 writeRoute(destPeer, getAdjRibOutYII(ribSup, rootPath, routeIdAddPath, localTK), effectiveAttributes, createValue(routeIdAddPath, path), ribSup, tx);
166 writeRoute(destPeer, getAdjRibOutYII(ribSup, rootPath, routeId, localTK), effectiveAttributes, createValue(routeId, path), ribSup, tx);
170 private void addPathToDataStore(final BestPath path, final boolean isFirstBestPath, final PathArgument routeIdPA, final YangInstanceIdentifier locRibTarget,
171 final RIBSupport ribSup, final ExportPolicyPeerTracker peerPT, final TablesKey localTK, final DOMDataWriteTransaction tx) {
172 final PathArgument routeIdAddPath = ribSup.getRouteIdAddPath(path.getPathId(), routeIdPA);
173 final YangInstanceIdentifier pathAddPathTarget = ribSup.routePath(locRibTarget.node(ROUTES_IDENTIFIER), routeIdAddPath);
174 final MapEntryNode addPathValue = createValue(routeIdAddPath, path);
175 final MapEntryNode value = createValue(routeIdPA, path);
176 LOG.trace("Selected best value {}", addPathValue);
177 fillLocRib(pathAddPathTarget, addPathValue, tx);
178 fillAdjRibsOut(isFirstBestPath, path.getAttributes(), value, addPathValue, routeIdPA, routeIdAddPath, path.getPeerId(), peerPT, localTK,
182 private void fillAdjRibsOut(final boolean isFirstBestPath, final ContainerNode attributes, final NormalizedNode<?, ?> value, final MapEntryNode addPathValue,
183 final PathArgument routeId, final PathArgument routeIdAddPath, final PeerId routePeerId, final ExportPolicyPeerTracker peerPT, final TablesKey
184 localTK, final RIBSupport ribSup, final DOMDataWriteTransaction tx) {
186 * We need to keep track of routers and populate adj-ribs-out, too. If we do not, we need to
187 * expose from which client a particular route was learned from in the local RIB, and have
188 * the listener perform filtering.
190 * We walk the policy set in order to minimize the amount of work we do for multiple peers:
191 * if we have two eBGP peers, for example, there is no reason why we should perform the translation
194 for (final PeerRole role : PeerRole.values()) {
195 final PeerExportGroup peerGroup = peerPT.getPeerGroup(role);
196 if (peerGroup != null) {
197 final ContainerNode effectiveAttributes = peerGroup.effectiveAttributes(getRoutePeerIdRole(peerPT, routePeerId), attributes);
198 peerGroup.forEach((destPeer, rootPath) -> {
199 final boolean destPeerSupAddPath = peerPT.isAddPathSupportedByPeer(destPeer);
200 if (filterRoutes(routePeerId, destPeer, peerPT, localTK, role) &&
201 peersSupportsAddPathOrIsFirstBestPath(destPeerSupAddPath, isFirstBestPath)) {
202 if (destPeerSupAddPath) {
203 update(destPeer, getAdjRibOutYII(ribSup, rootPath, routeIdAddPath, localTK), effectiveAttributes,
204 addPathValue, ribSup, tx);
205 } else if(!this.oldNonAddPathBestPathTheSame){
206 update(destPeer, getAdjRibOutYII(ribSup, rootPath, routeId, localTK), effectiveAttributes, value, ribSup, tx);
215 protected final OffsetMap getOffsets() {
219 public final boolean isEmpty() {
220 return this.offsets.isEmpty();
223 private void selectBest(final RouteKey key, final AddPathSelector selector) {
224 final int offset = this.offsets.offsetOf(key);
225 final ContainerNode attributes = this.offsets.getValue(this.values, offset);
226 final Long pathId = this.offsets.getValue(this.pathsId, offset);
227 LOG.trace("Processing router key {} attributes {}", key, attributes);
228 selector.processPath(attributes, key, offset, pathId);
232 * Process best path selection
234 * @param localAs The local autonomous system number
235 * @param keyList List of RouteKey
236 * @return the best path inside offset map passed
238 protected AddPathBestPath selectBest(final long localAs, final List<RouteKey> keyList) {
240 * FIXME: optimize flaps by making sure we consider stability of currently-selected route.
242 final AddPathSelector selector = new AddPathSelector(localAs);
243 Lists.reverse(keyList).forEach(key -> selectBest(key, selector));
244 LOG.trace("Best path selected {}", this.bestPath);
245 return selector.result();
248 private boolean isFirstBestPath(final int bestPathPosition) {
249 return bestPathPosition == 0;
252 private boolean peersSupportsAddPathOrIsFirstBestPath(final boolean peerSupportsAddPath, final boolean isFirstBestPath) {
253 return !(!peerSupportsAddPath && !isFirstBestPath);
256 protected boolean isBestPathNew(final List<AddPathBestPath> newBestPathList) {
257 this.oldNonAddPathBestPathTheSame = isNonAddPathBestPathTheSame(newBestPathList);
258 filterRemovedPaths(newBestPathList);
259 if (this.bestPathRemoved != null && !this.bestPathRemoved.isEmpty() || newBestPathList != null && !newBestPathList.equals(this.bestPath)) {
260 this.newBestPathToBeAdvertised = new ArrayList<>(newBestPathList);
261 if(this.bestPath != null) {
262 this.newBestPathToBeAdvertised.removeAll(this.bestPath);
264 this.bestPath = newBestPathList;
265 LOG.trace("Actual Best {}, removed best {}", this.bestPath, this.bestPathRemoved);
271 private boolean isNonAddPathBestPathTheSame(final List<AddPathBestPath> newBestPathList) {
272 return !(this.bestPath == null || newBestPathList == null || this.bestPath.isEmpty() || newBestPathList.isEmpty()) &&
273 this.bestPath.get(0).equals(newBestPathList.get(0));
276 private void filterRemovedPaths(final List<AddPathBestPath> newBestPathList) {
277 if(this.bestPath == null) {
280 this.bestPathRemoved = new ArrayList<>(this.bestPath);
281 this.bestPath.forEach(oldBest -> {
282 final Optional<AddPathBestPath> present = newBestPathList.stream()
283 .filter(newBest -> newBest.getPathId() == oldBest.getPathId() && newBest.getRouteKey() == oldBest.getRouteKey()).findAny();
284 present.ifPresent(addPathBestPath -> this.bestPathRemoved.remove(oldBest));