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;
20 import java.util.Optional;
22 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
24 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
25 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
26 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
27 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
29 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
30 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
31 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
32 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
33 import org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl;
34 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateImpl;
35 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
36 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
37 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
38 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
39 import org.opendaylight.protocol.bgp.rib.spi.state.BGPAfiSafiState;
40 import org.opendaylight.protocol.bgp.rib.spi.state.BGPErrorHandlingState;
41 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
42 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
43 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
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.rib.rev130925.ApplicationRibId;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.SimpleRoutingPolicy;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.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();
97 interface RegisterAppPeerListener {
99 * Register Application Peer Change Listener once AdjRibIn has been successfully initialized.
104 public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIB rib) {
105 super(rib.getInstanceIdentifier(), "application-peers", new IpAddress(ipAddress),
106 rib.getLocalTablesKeys(), Collections.emptySet());
107 this.name = applicationRibId.getValue();
108 final RIB targetRib = requireNonNull(rib);
109 this.rawIdentifier = InetAddresses.forString(ipAddress.getValue()).getAddress();
110 final NodeIdentifierWithPredicates peerId = IdentifierUtils.domPeerId(RouterIds.createPeerId(ipAddress));
111 this.peerIId = targetRib.getYangRibId().node(Peer.QNAME).node(peerId);
112 this.adjRibsInId = this.peerIId.node(AdjRibIn.QNAME).node(Tables.QNAME);
113 this.rib = targetRib;
114 this.ipAddress = ipAddress;
117 public synchronized void instantiateServiceInstance(final DOMDataTreeChangeService dataTreeChangeService,
118 final DOMDataTreeIdentifier appPeerDOMId) {
120 this.chain = this.rib.createPeerChain(this);
121 this.writerChain = this.rib.createPeerChain(this);
123 final Optional<SimpleRoutingPolicy> simpleRoutingPolicy = Optional.of(SimpleRoutingPolicy.AnnounceNone);
124 final PeerId peerId = RouterIds.createPeerId(this.ipAddress);
125 final Set<TablesKey> localTables = this.rib.getLocalTablesKeys();
126 localTables.forEach(tablesKey -> {
127 final ExportPolicyPeerTracker exportTracker = this.rib.getExportPolicyPeerTracker(tablesKey);
128 if (exportTracker != null) {
129 exportTracker.registerPeer(peerId, null, this.peerIId, PeerRole.Internal, simpleRoutingPolicy);
131 this.supportedTables.add(RibSupportUtils.toYangTablesKey(tablesKey));
133 setAdvertizedGracefulRestartTableTypes(Collections.emptyList());
135 this.adjRibInWriter = AdjRibInWriter.create(this.rib.getYangRibId(), PeerRole.Internal, simpleRoutingPolicy,
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(peerId, context, localTables, Collections.emptyMap(),
146 registerAppPeerListener);
147 this.effectiveRibInWriter = EffectiveRibInWriter
148 .create(this.rib.getService(), this.rib.createPeerChain(this), this.peerIId,
149 this.rib.getImportPolicyPeerTracker(), context, PeerRole.Internal,
151 this.bgpSessionState.registerMessagesCounter(this);
155 * Routes come from application RIB that is identified by (configurable) name.
156 * Each route is pushed into AdjRibsInWriter with it's whole context. In this
157 * method, it doesn't matter if the routes are removed or added, this will
158 * be determined in LocRib.
161 public synchronized void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
162 if (this.chain == null) {
163 LOG.trace("Skipping data changed called to Application Peer. Change : {}", changes);
166 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
167 LOG.debug("Received data change to ApplicationRib {}", changes);
168 for (final DataTreeCandidate tc : changes) {
169 LOG.debug("Modification Type {}", tc.getRootNode().getModificationType());
170 final YangInstanceIdentifier path = tc.getRootPath();
171 final PathArgument lastArg = path.getLastPathArgument();
172 Verify.verify(lastArg instanceof NodeIdentifierWithPredicates,
173 "Unexpected type %s in path %s", lastArg.getClass(), path);
174 final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
175 if (!this.supportedTables.contains(tableKey)) {
176 LOG.trace("Skipping received data change for non supported family {}.", tableKey);
179 for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
180 final PathArgument childIdentifier = child.getIdentifier();
181 final YangInstanceIdentifier tableId = this.adjRibsInId.node(tableKey).node(childIdentifier);
182 switch (child.getModificationType()) {
184 LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
185 tx.delete(LogicalDatastoreType.OPERATIONAL, tableId);
190 case SUBTREE_MODIFIED:
191 if (EffectiveRibInWriter.TABLE_ROUTES.equals(childIdentifier)) {
192 processRoutesTable(child, tableId, tx, tableId);
196 if (child.getDataAfter().isPresent()) {
197 final NormalizedNode<?, ?> dataAfter = child.getDataAfter().get();
198 LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
199 LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
200 tx.put(LogicalDatastoreType.OPERATIONAL, tableId, dataAfter);
212 * Applies modification under table routes based on modification type instead of only put. BUG 4438
217 * @param routeTableIdentifier
219 private synchronized void processRoutesTable(final DataTreeCandidateNode node,
220 final YangInstanceIdentifier identifier, final DOMDataWriteTransaction tx,
221 final YangInstanceIdentifier routeTableIdentifier) {
222 for (final DataTreeCandidateNode child : node.getChildNodes()) {
223 final YangInstanceIdentifier childIdentifier = identifier.node(child.getIdentifier());
224 switch (child.getModificationType()) {
226 LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
227 tx.delete(LogicalDatastoreType.OPERATIONAL, childIdentifier);
232 case SUBTREE_MODIFIED:
233 //For be ables to use DELETE when we remove specific routes as we do when we remove the whole routes,
234 // we need to go deeper three levels
235 if (!routeTableIdentifier.equals(childIdentifier.getParent().getParent().getParent())) {
236 processRoutesTable(child, childIdentifier, tx, routeTableIdentifier);
240 if (child.getDataAfter().isPresent()) {
241 final NormalizedNode<?, ?> dataAfter = child.getDataAfter().get();
242 LOG.trace("App peer -> AdjRibsIn path : {}", childIdentifier);
243 LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
244 tx.put(LogicalDatastoreType.OPERATIONAL, childIdentifier, dataAfter);
254 public String getName() {
258 // FIXME ListenableFuture<?> should be used once closeServiceInstance uses wildcard too
260 public synchronized ListenableFuture<Void> close() {
262 if (this.registration != null) {
263 this.registration.close();
264 this.registration = null;
266 if (this.effectiveRibInWriter != null) {
267 this.effectiveRibInWriter.close();
269 final ListenableFuture<Void> future;
270 if (this.adjRibInWriter != null) {
271 future = this.adjRibInWriter.removePeer();
273 future = Futures.immediateFuture(null);
275 if (this.chain != null) {
279 if (this.writerChain != null) {
280 this.writerChain.close();
281 this.writerChain = null;
287 public byte[] getRawIdentifier() {
288 return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
292 public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
293 final AsyncTransaction<?, ?> transaction, final Throwable cause) {
294 LOG.error("Transaction chain {} failed.", transaction != null ? transaction.getIdentifier() : null, cause);
298 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
299 LOG.debug("Transaction chain {} successful.", chain);
303 public BGPErrorHandlingState getBGPErrorHandlingState() {
308 public BGPAfiSafiState getBGPAfiSafiState() {
313 public BGPSessionState getBGPSessionState() {
314 return this.bgpSessionState;
318 public BGPTimersState getBGPTimersState() {
319 return this.bgpSessionState;
323 public BGPTransportState getBGPTransportState() {
324 return this.bgpSessionState;