2 * Copyright (c) 2014 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.rib.impl;
10 import static com.google.common.base.Verify.verify;
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ADJRIBIN_NID;
13 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ADJRIBOUT_NID;
14 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.PEER_NID;
15 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ROUTES_NID;
16 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.TABLES_NID;
18 import com.google.common.cache.CacheBuilder;
19 import com.google.common.cache.CacheLoader;
20 import com.google.common.cache.LoadingCache;
21 import com.google.common.util.concurrent.FluentFuture;
22 import com.google.common.util.concurrent.FutureCallback;
23 import com.google.common.util.concurrent.MoreExecutors;
24 import java.util.ArrayList;
25 import java.util.HashSet;
26 import java.util.List;
29 import org.opendaylight.mdsal.common.api.CommitInfo;
30 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
31 import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener;
32 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
33 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
34 import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
35 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
36 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
37 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
38 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
39 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
40 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateImpl;
41 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
42 import org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers;
43 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
44 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
45 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
46 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.SendReceive;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibId;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteTarget;
54 import org.opendaylight.yangtools.concepts.ListenerRegistration;
55 import org.opendaylight.yangtools.concepts.Registration;
56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
59 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
60 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
65 * Application Peer is a special case of BGP peer. It serves as an interface
66 * for user to advertise user routes to ODL and through ODL to other BGP peers.
69 * This peer has it's own RIB, where it stores all user routes. This RIB is
70 * located in configurational datastore. Routes are added through RESTCONF.
73 * They are then processed as routes from any other peer, through AdjRib,
74 * EffectiveRib,LocRib and if they are advertised further, through AdjRibOut.
77 * For purposed of import policies such as Best Path Selection, application
78 * peer needs to have a BGP-ID that is configurable.
80 public class ApplicationPeer extends AbstractPeer implements ClusteredDOMDataTreeChangeListener {
81 private static final Logger LOG = LoggerFactory.getLogger(ApplicationPeer.class);
82 private static final String APP_PEER_GROUP = "application-peers";
84 private final LoadingCache<NodeIdentifierWithPredicates, YangInstanceIdentifier> tablesIId =
85 CacheBuilder.newBuilder().build(new CacheLoader<NodeIdentifierWithPredicates, YangInstanceIdentifier>() {
87 public YangInstanceIdentifier load(final NodeIdentifierWithPredicates key) {
88 return peerRibOutIId.node(RIBNodeIdentifiers.TABLES_NID).node(key);
92 private final YangInstanceIdentifier adjRibsInId;
93 private final YangInstanceIdentifier peerRibOutIId;
94 private final BGPTableTypeRegistryConsumer tableTypeRegistry;
95 private EffectiveRibInWriter effectiveRibInWriter;
96 private AdjRibInWriter adjRibInWriter;
97 private ListenerRegistration<ApplicationPeer> registration;
98 private final Set<NodeIdentifierWithPredicates> supportedTables = new HashSet<>();
99 private final BGPSessionStateImpl bgpSessionState = new BGPSessionStateImpl();
100 private Registration trackerRegistration;
101 private YangInstanceIdentifier peerPath;
104 public List<RouteTarget> getMemberships() {
109 interface RegisterAppPeerListener {
111 * Register Application Peer Change Listener once AdjRibIn has been successfully initialized.
116 public ApplicationPeer(
117 final BGPTableTypeRegistryConsumer tableTypeRegistry,
118 final ApplicationRibId applicationRibId, final Ipv4AddressNoZone ipAddress, final RIB rib) {
119 super(rib, applicationRibId.getValue(), APP_PEER_GROUP, PeerRole.Internal,
120 new IpAddressNoZone(ipAddress), Set.of());
121 this.tableTypeRegistry = requireNonNull(tableTypeRegistry);
122 final RIB targetRib = requireNonNull(rib);
123 peerId = RouterIds.createPeerId(ipAddress);
125 final YangInstanceIdentifier peerRib = targetRib.getYangRibId().node(PEER_NID)
126 .node(IdentifierUtils.domPeerId(peerId));
127 adjRibsInId = peerRib.node(ADJRIBIN_NID).node(TABLES_NID).toOptimized();
128 peerRibOutIId = peerRib.node(ADJRIBOUT_NID).node(TABLES_NID).toOptimized();
131 public synchronized void instantiateServiceInstance(final DOMDataTreeChangeService dataTreeChangeService,
132 final DOMDataTreeIdentifier appPeerDOMId) {
134 final var localTables = rib.getLocalTablesKeys();
135 for (var localTable : localTables) {
136 final var tableSupport = rib.getRibSupportContext().getRIBSupport(localTable);
137 if (tableSupport != null) {
138 supportedTables.add(tableSupport.tablesKey());
140 LOG.warn("Ignoring unsupported table {}", localTable);
143 setAdvertizedGracefulRestartTableTypes(List.of());
146 adjRibInWriter = AdjRibInWriter.create(rib.getYangRibId(), PeerRole.Internal, this);
147 final RIBSupportContextRegistry context = rib.getRibSupportContext();
148 final RegisterAppPeerListener registerAppPeerListener = () -> {
149 synchronized (this) {
150 if (getDomChain() != null) {
151 registration = dataTreeChangeService.registerDataTreeChangeListener(appPeerDOMId, this);
155 peerPath = createPeerPath(peerId);
156 adjRibInWriter = adjRibInWriter.transform(peerId, peerPath, context, localTables,
157 Map.of(), registerAppPeerListener);
158 effectiveRibInWriter = new EffectiveRibInWriter(this, rib,
159 rib.createPeerDOMChain(this), peerPath, localTables, tableTypeRegistry,
160 new ArrayList<>(), rtCache);
161 effectiveRibInWriter.init();
162 bgpSessionState.registerMessagesCounter(this);
163 trackerRegistration = rib.getPeerTracker().registerPeer(this);
167 public void onInitialData() {
168 // FIXME: we really want to (under a synchronized block) to ensure adj-rib-in is completely empty here.
169 // Unfortunately that bit is already being done somewhere else. The entire the tables are being created
170 // elsewhere and therefore we need to reign in lifecycle first
174 * Routes come from application RIB that is identified by (configurable) name.
175 * Each route is pushed into AdjRibsInWriter with it's whole context. In this
176 * method, it doesn't matter if the routes are removed or added, this will
177 * be determined in LocRib.
180 public synchronized void onDataTreeChanged(final List<DataTreeCandidate> changes) {
181 final DOMTransactionChain chain = getDomChain();
183 LOG.trace("Skipping data changed called to Application Peer. Change : {}", changes);
186 final DOMDataTreeWriteTransaction tx = chain.newWriteOnlyTransaction();
187 LOG.debug("Received data change to ApplicationRib {}", changes);
188 for (final DataTreeCandidate tc : changes) {
189 LOG.debug("Modification Type {}", tc.getRootNode().modificationType());
190 final YangInstanceIdentifier path = tc.getRootPath();
191 final PathArgument lastArg = path.getLastPathArgument();
192 verify(lastArg instanceof NodeIdentifierWithPredicates,
193 "Unexpected type %s in path %s", lastArg.getClass(), path);
194 final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
195 if (!supportedTables.contains(tableKey)) {
196 LOG.trace("Skipping received data change for non supported family {}.", tableKey);
199 for (final DataTreeCandidateNode child : tc.getRootNode().childNodes()) {
200 final PathArgument childIdentifier = child.name();
201 final YangInstanceIdentifier tableId = adjRibsInId.node(tableKey).node(childIdentifier);
202 switch (child.modificationType()) {
205 LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
206 tx.delete(LogicalDatastoreType.OPERATIONAL, tableId);
211 case SUBTREE_MODIFIED:
212 if (ROUTES_NID.equals(childIdentifier)) {
213 processRoutesTable(child, tableId, tx, tableId);
215 processWrite(child, tableId, tx);
220 processWrite(child, tableId, tx);
227 tx.commit().addCallback(new FutureCallback<CommitInfo>() {
229 public void onSuccess(final CommitInfo result) {
230 LOG.trace("Successful commit");
234 public void onFailure(final Throwable trw) {
235 LOG.error("Failed commit", trw);
237 }, MoreExecutors.directExecutor());
240 private static void processWrite(final DataTreeCandidateNode child, final YangInstanceIdentifier tableId,
241 final DOMDataTreeWriteTransaction tx) {
242 final var dataAfter = child.dataAfter();
243 if (dataAfter != null) {
244 LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
245 LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
246 tx.put(LogicalDatastoreType.OPERATIONAL, tableId, dataAfter);
250 private synchronized void processRoutesTable(final DataTreeCandidateNode node,
251 final YangInstanceIdentifier identifier, final DOMDataTreeWriteTransaction tx,
252 final YangInstanceIdentifier routeTableIdentifier) {
253 for (var child : node.childNodes()) {
254 final YangInstanceIdentifier childIdentifier = identifier.node(child.name());
255 switch (child.modificationType()) {
257 LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
258 tx.delete(LogicalDatastoreType.OPERATIONAL, childIdentifier);
263 case SUBTREE_MODIFIED:
264 // For be ables to use DELETE when we remove specific routes as we do when we remove the whole
265 // routes, we need to go deeper three levels
266 if (!routeTableIdentifier.equals(childIdentifier.getParent().getParent().getParent())) {
267 processRoutesTable(child, childIdentifier, tx, routeTableIdentifier);
269 processRouteWrite(child, childIdentifier, tx);
273 processRouteWrite(child, childIdentifier, tx);
281 private static void processRouteWrite(final DataTreeCandidateNode child,
282 final YangInstanceIdentifier childIdentifier, final DOMDataTreeWriteTransaction tx) {
283 final var dataAfter = child.dataAfter();
284 if (dataAfter != null) {
285 LOG.trace("App peer -> AdjRibsIn path : {}", childIdentifier);
286 LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
287 tx.put(LogicalDatastoreType.OPERATIONAL, childIdentifier, dataAfter);
292 public synchronized FluentFuture<? extends CommitInfo> close() {
294 if (registration != null) {
295 registration.close();
298 if (adjRibInWriter != null) {
299 adjRibInWriter.releaseChain();
301 if (effectiveRibInWriter != null) {
302 effectiveRibInWriter.close();
304 final FluentFuture<? extends CommitInfo> future = removePeer(peerPath);
306 if (trackerRegistration != null) {
307 trackerRegistration.close();
308 trackerRegistration = null;
314 public boolean supportsAddPathSupported(final TablesKey tableKey) {
319 public SendReceive getSupportedAddPathTables(final TablesKey tableKey) {
324 public boolean supportsTable(final TablesKey tableKey) {
325 return rib.supportsTable(tableKey);
329 public YangInstanceIdentifier getRibOutIId(final NodeIdentifierWithPredicates tablekey) {
330 return tablesIId.getUnchecked(tablekey);
334 public void onTransactionChainFailed(final DOMTransactionChain chain, final DOMDataTreeTransaction transaction,
335 final Throwable cause) {
336 LOG.error("Transaction chain {} failed.", transaction != null ? transaction.getIdentifier() : null, cause);
340 public BGPSessionState getBGPSessionState() {
341 return bgpSessionState;
345 public BGPTimersState getBGPTimersState() {
346 return bgpSessionState;
350 public BGPTransportState getBGPTransportState() {
351 return bgpSessionState;