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 java.util.Objects.requireNonNull;
12 import com.google.common.base.Verify;
13 import com.google.common.net.InetAddresses;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import java.util.Arrays;
17 import java.util.Collection;
18 import java.util.Collections;
19 import java.util.HashSet;
21 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
23 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
24 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
25 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
26 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
27 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
29 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
30 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
31 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
32 import org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl;
33 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateImpl;
34 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
35 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
36 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
37 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
38 import org.opendaylight.protocol.bgp.rib.spi.state.BGPAfiSafiState;
39 import org.opendaylight.protocol.bgp.rib.spi.state.BGPErrorHandlingState;
40 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
41 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
42 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
43 import org.opendaylight.protocol.concepts.AbstractRegistration;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.SendReceive;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.ApplicationRibId;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerId;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.Peer;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.peer.AdjRibIn;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.Tables;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
54 import org.opendaylight.yangtools.concepts.ListenerRegistration;
55 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
58 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
59 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
60 import org.opendaylight.yangtools.yang.data.api.schema.tree.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.
68 * This peer has it's own RIB, where it stores all user routes. This RIB is
69 * located in configurational datastore. Routes are added through RESTCONF.
71 * They are then processed as routes from any other peer, through AdjRib,
72 * EffectiveRib,LocRib and if they are advertised further, through AdjRibOut.
74 * For purposed of import policies such as Best Path Selection, application
75 * peer needs to have a BGP-ID that is configurable.
77 public class ApplicationPeer extends BGPPeerStateImpl implements org.opendaylight.protocol.bgp.rib.spi.Peer,
78 ClusteredDOMDataTreeChangeListener, TransactionChainListener {
80 private static final Logger LOG = LoggerFactory.getLogger(ApplicationPeer.class);
82 private final byte[] rawIdentifier;
83 private final String name;
84 private final YangInstanceIdentifier adjRibsInId;
85 private final Ipv4Address ipAddress;
86 private final RIB rib;
87 private final YangInstanceIdentifier peerIId;
88 private DOMTransactionChain chain;
89 private DOMTransactionChain writerChain;
90 private EffectiveRibInWriter effectiveRibInWriter;
91 private AdjRibInWriter adjRibInWriter;
92 private ListenerRegistration<ApplicationPeer> registration;
93 private final Set<NodeIdentifierWithPredicates> supportedTables = new HashSet<>();
94 private final BGPSessionStateImpl bgpSessionState = new BGPSessionStateImpl();
95 private PeerId peerId;
96 private AbstractRegistration trackerRegistration;
99 interface RegisterAppPeerListener {
101 * Register Application Peer Change Listener once AdjRibIn has been successfully initialized.
106 public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIB rib) {
107 super(rib.getInstanceIdentifier(), "application-peers", new IpAddress(ipAddress),
108 rib.getLocalTablesKeys(), Collections.emptySet());
109 this.name = applicationRibId.getValue();
110 final RIB targetRib = requireNonNull(rib);
111 this.rawIdentifier = InetAddresses.forString(ipAddress.getValue()).getAddress();
112 final NodeIdentifierWithPredicates peerIId = IdentifierUtils.domPeerId(RouterIds.createPeerId(ipAddress));
113 this.peerIId = targetRib.getYangRibId().node(Peer.QNAME).node(peerIId);
114 this.adjRibsInId = this.peerIId.node(AdjRibIn.QNAME).node(Tables.QNAME);
115 this.rib = targetRib;
116 this.ipAddress = ipAddress;
119 public synchronized void instantiateServiceInstance(final DOMDataTreeChangeService dataTreeChangeService,
120 final DOMDataTreeIdentifier appPeerDOMId) {
122 this.chain = this.rib.createPeerChain(this);
123 this.writerChain = this.rib.createPeerChain(this);
125 this.peerId = RouterIds.createPeerId(this.ipAddress);
126 final Set<TablesKey> localTables = this.rib.getLocalTablesKeys();
127 localTables.forEach(tablesKey -> {
128 final ExportPolicyPeerTracker exportTracker = this.rib.getExportPolicyPeerTracker(tablesKey);
129 if (exportTracker != null) {
130 exportTracker.registerPeer(this.peerId, null, this.peerIId, PeerRole.Internal);
132 this.supportedTables.add(RibSupportUtils.toYangTablesKey(tablesKey));
134 setAdvertizedGracefulRestartTableTypes(Collections.emptyList());
136 this.adjRibInWriter = AdjRibInWriter.create(this.rib.getYangRibId(), PeerRole.Internal, this.writerChain);
137 final RIBSupportContextRegistry context = this.rib.getRibSupportContext();
138 final RegisterAppPeerListener registerAppPeerListener = () -> {
139 synchronized (this) {
140 if (this.chain != null) {
141 this.registration = dataTreeChangeService.registerDataTreeChangeListener(appPeerDOMId, this);
145 this.adjRibInWriter = this.adjRibInWriter.transform(this.peerId, context, localTables, Collections.emptyMap(),
146 registerAppPeerListener);
147 this.effectiveRibInWriter = EffectiveRibInWriter
148 .create(this.rib, this.rib.createPeerChain(this), this.peerIId, localTables);
149 this.bgpSessionState.registerMessagesCounter(this);
150 this.trackerRegistration = this.rib.getPeerTracker().registerPeer(this);
154 * Routes come from application RIB that is identified by (configurable) name.
155 * Each route is pushed into AdjRibsInWriter with it's whole context. In this
156 * method, it doesn't matter if the routes are removed or added, this will
157 * be determined in LocRib.
160 public synchronized void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
161 if (this.chain == null) {
162 LOG.trace("Skipping data changed called to Application Peer. Change : {}", changes);
165 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
166 LOG.debug("Received data change to ApplicationRib {}", changes);
167 for (final DataTreeCandidate tc : changes) {
168 LOG.debug("Modification Type {}", tc.getRootNode().getModificationType());
169 final YangInstanceIdentifier path = tc.getRootPath();
170 final PathArgument lastArg = path.getLastPathArgument();
171 Verify.verify(lastArg instanceof NodeIdentifierWithPredicates,
172 "Unexpected type %s in path %s", lastArg.getClass(), path);
173 final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
174 if (!this.supportedTables.contains(tableKey)) {
175 LOG.trace("Skipping received data change for non supported family {}.", tableKey);
178 for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
179 final PathArgument childIdentifier = child.getIdentifier();
180 final YangInstanceIdentifier tableId = this.adjRibsInId.node(tableKey).node(childIdentifier);
181 switch (child.getModificationType()) {
183 LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
184 tx.delete(LogicalDatastoreType.OPERATIONAL, tableId);
189 case SUBTREE_MODIFIED:
190 if (EffectiveRibInWriter.TABLE_ROUTES.equals(childIdentifier)) {
191 processRoutesTable(child, tableId, tx, tableId);
195 if (child.getDataAfter().isPresent()) {
196 final NormalizedNode<?, ?> dataAfter = child.getDataAfter().get();
197 LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
198 LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
199 tx.put(LogicalDatastoreType.OPERATIONAL, tableId, dataAfter);
210 private synchronized void processRoutesTable(final DataTreeCandidateNode node,
211 final YangInstanceIdentifier identifier, final DOMDataWriteTransaction tx,
212 final YangInstanceIdentifier routeTableIdentifier) {
213 for (final DataTreeCandidateNode child : node.getChildNodes()) {
214 final YangInstanceIdentifier childIdentifier = identifier.node(child.getIdentifier());
215 switch (child.getModificationType()) {
217 LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
218 tx.delete(LogicalDatastoreType.OPERATIONAL, childIdentifier);
223 case SUBTREE_MODIFIED:
224 //For be ables to use DELETE when we remove specific routes as we do when we remove the whole routes,
225 // we need to go deeper three levels
226 if (!routeTableIdentifier.equals(childIdentifier.getParent().getParent().getParent())) {
227 processRoutesTable(child, childIdentifier, tx, routeTableIdentifier);
231 if (child.getDataAfter().isPresent()) {
232 final NormalizedNode<?, ?> dataAfter = child.getDataAfter().get();
233 LOG.trace("App peer -> AdjRibsIn path : {}", childIdentifier);
234 LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
235 tx.put(LogicalDatastoreType.OPERATIONAL, childIdentifier, dataAfter);
245 public String getName() {
249 // FIXME ListenableFuture<?> should be used once closeServiceInstance uses wildcard too
251 public synchronized ListenableFuture<Void> close() {
253 if (this.registration != null) {
254 this.registration.close();
255 this.registration = null;
257 if (this.effectiveRibInWriter != null) {
258 this.effectiveRibInWriter.close();
260 final ListenableFuture<Void> future;
261 if (this.adjRibInWriter != null) {
262 future = this.adjRibInWriter.removePeer();
264 future = Futures.immediateFuture(null);
266 if (this.chain != null) {
270 if (this.writerChain != null) {
271 this.writerChain.close();
272 this.writerChain = null;
274 if (this.trackerRegistration != null) {
275 this.trackerRegistration.close();
276 this.trackerRegistration = null;
282 public byte[] getRawIdentifier() {
283 return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
287 public PeerId getPeerId() {
292 public boolean supportsAddPathSupported(final TablesKey tableKey) {
297 public SendReceive getSupportedAddPathTables(final TablesKey tableKey) {
302 public boolean supportsTable(final TablesKey tableKey) {
303 return this.rib.supportsTable(tableKey);
307 public YangInstanceIdentifier getPeerRibInstanceIdentifier() {
312 public PeerRole getRole() {
313 return PeerRole.Internal;
317 public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
318 final AsyncTransaction<?, ?> transaction, final Throwable cause) {
319 LOG.error("Transaction chain {} failed.", transaction != null ? transaction.getIdentifier() : null, cause);
323 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
324 LOG.debug("Transaction chain {} successful.", chain);
328 public BGPErrorHandlingState getBGPErrorHandlingState() {
333 public BGPAfiSafiState getBGPAfiSafiState() {
338 public BGPSessionState getBGPSessionState() {
339 return this.bgpSessionState;
343 public BGPTimersState getBGPTimersState() {
344 return this.bgpSessionState;
348 public BGPTransportState getBGPTransportState() {
349 return this.bgpSessionState;