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 com.google.common.base.Preconditions;
11 import com.google.common.base.Verify;
12 import com.google.common.net.InetAddresses;
13 import java.util.Arrays;
14 import java.util.Collection;
15 import java.util.Collections;
16 import java.util.Optional;
17 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
19 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
20 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
21 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
22 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
23 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
24 import org.opendaylight.protocol.bgp.openconfig.spi.BGPConfigModuleTracker;
25 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
26 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
27 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.SimpleRoutingPolicy;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
40 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
45 * Application Peer is a special case of BGP peer. It serves as an interface
46 * for user to advertise user routes to ODL and through ODL to other BGP peers.
48 * This peer has it's own RIB, where it stores all user routes. This RIB is
49 * located in configurational datastore. Routes are added through RESTCONF.
51 * They are then processed as routes from any other peer, through AdjRib,
52 * EffectiveRib,LocRib and if they are advertised further, through AdjRibOut.
54 * For purposed of import policies such as Best Path Selection, application
55 * peer needs to have a BGP-ID that is configurable.
57 public class ApplicationPeer implements AutoCloseable, org.opendaylight.protocol.bgp.rib.spi.Peer, ClusteredDOMDataTreeChangeListener, TransactionChainListener {
59 private static final Logger LOG = LoggerFactory.getLogger(ApplicationPeer.class);
61 private final byte[] rawIdentifier;
62 private final String name;
63 private final YangInstanceIdentifier adjRibsInId;
64 private final DOMTransactionChain chain;
65 private final DOMTransactionChain writerChain;
66 private final BGPConfigModuleTracker moduleTracker;
67 private final EffectiveRibInWriter effectiveRibInWriter;
68 private AdjRibInWriter writer;
70 public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIB rib,
71 final BGPConfigModuleTracker moduleTracker) {
72 this.name = applicationRibId.getValue().toString();
73 final RIB targetRib = Preconditions.checkNotNull(rib);
74 this.rawIdentifier = InetAddresses.forString(ipAddress.getValue()).getAddress();
75 final NodeIdentifierWithPredicates peerId = IdentifierUtils.domPeerId(RouterIds.createPeerId(ipAddress));
76 final YangInstanceIdentifier peerIId = targetRib.getYangRibId().node(Peer.QNAME).node(peerId);
77 this.adjRibsInId = peerIId.node(AdjRibIn.QNAME).node(Tables.QNAME);
78 this.chain = targetRib.createPeerChain(this);
79 this.writerChain = targetRib.createPeerChain(this);
80 this.writer = AdjRibInWriter.create(targetRib.getYangRibId(), PeerRole.Internal, Optional.of(SimpleRoutingPolicy.AnnounceNone), this.writerChain);
81 this.writer = this.writer.transform(RouterIds.createPeerId(ipAddress), targetRib.getRibSupportContext(), targetRib.getLocalTablesKeys(),
82 Collections.emptyList());
83 //TODO need to create effective rib in writer with route counter here
84 this.effectiveRibInWriter = EffectiveRibInWriter.create(targetRib.getService(), targetRib.createPeerChain(this), peerIId,
85 targetRib.getImportPolicyPeerTracker(), targetRib.getRibSupportContext(), PeerRole.Internal);
86 this.moduleTracker = moduleTracker;
87 if (moduleTracker != null) {
88 moduleTracker.onInstanceCreate();
92 public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address bgpPeerId, final RIB targetRibDependency) {
93 this(applicationRibId, bgpPeerId, targetRibDependency, null);
97 * Routes come from application RIB that is identified by (configurable) name.
98 * Each route is pushed into AdjRibsInWriter with it's whole context. In this
99 * method, it doesn't matter if the routes are removed or added, this will
100 * be determined in LocRib.
103 public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
104 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
105 LOG.debug("Received data change to ApplicationRib {}", changes);
106 for (final DataTreeCandidate tc : changes) {
107 LOG.debug("Modification Type {}", tc.getRootNode().getModificationType());
108 final YangInstanceIdentifier path = tc.getRootPath();
109 final PathArgument lastArg = path.getLastPathArgument();
110 Verify.verify(lastArg instanceof NodeIdentifierWithPredicates, "Unexpected type %s in path %s", lastArg.getClass(), path);
111 final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
112 for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
113 final PathArgument childIdentifier = child.getIdentifier();
114 final YangInstanceIdentifier tableId = this.adjRibsInId.node(tableKey).node(childIdentifier);
115 switch (child.getModificationType()) {
117 LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
118 tx.delete(LogicalDatastoreType.OPERATIONAL, tableId);
123 case SUBTREE_MODIFIED:
124 if (EffectiveRibInWriter.TABLE_ROUTES.equals(childIdentifier)) {
125 processRoutesTable(child, tableId, tx, tableId);
129 if (child.getDataAfter().isPresent()) {
130 final NormalizedNode<?,?> dataAfter = child.getDataAfter().get();
131 LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
132 LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
133 tx.put(LogicalDatastoreType.OPERATIONAL, tableId, dataAfter);
145 * Applies modification under table routes based on modification type instead of only put. BUG 4438
149 * @param routeTableIdentifier
151 private void processRoutesTable(final DataTreeCandidateNode node, final YangInstanceIdentifier identifier,
152 final DOMDataWriteTransaction tx, final YangInstanceIdentifier routeTableIdentifier) {
153 for (final DataTreeCandidateNode child : node.getChildNodes()) {
154 final YangInstanceIdentifier childIdentifier = identifier.node(child.getIdentifier());
155 switch (child.getModificationType()) {
157 LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
158 tx.delete(LogicalDatastoreType.OPERATIONAL, childIdentifier);
163 case SUBTREE_MODIFIED:
164 //For be ables to use DELETE when we remove specific routes as we do when we remove the whole routes,
165 // we need to go deeper three levels
166 if (!routeTableIdentifier.equals(childIdentifier.getParent().getParent().getParent())) {
167 processRoutesTable(child, childIdentifier, tx, routeTableIdentifier);
171 if (child.getDataAfter().isPresent()) {
172 final NormalizedNode<?,?> dataAfter = child.getDataAfter().get();
173 LOG.trace("App peer -> AdjRibsIn path : {}", childIdentifier);
174 LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
175 tx.put(LogicalDatastoreType.OPERATIONAL, childIdentifier, dataAfter);
185 public String getName() {
190 public void close() {
191 this.effectiveRibInWriter.close();
192 this.writer.removePeer();
194 this.writerChain.close();
195 if (this.moduleTracker != null) {
196 this.moduleTracker.onInstanceClose();
201 public byte[] getRawIdentifier() {
202 return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
206 public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction,
207 final Throwable cause) {
208 LOG.error("Transaction chain failed.", cause);
212 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
213 LOG.debug("Transaction chain {} successfull.", chain);