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.rib.impl;
10 import com.google.common.base.Preconditions;
11 import com.google.common.base.Verify;
12 import java.util.Collection;
13 import javax.annotation.Nonnull;
14 import javax.annotation.concurrent.NotThreadSafe;
15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
16 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
17 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
18 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
19 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
20 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
21 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext;
22 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
23 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.EffectiveRibIn;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
34 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
36 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
37 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
42 * Implementation of the BGP import policy. Listens on all Adj-RIB-In, inspects all inbound
43 * routes in the context of the advertising peer's role and applies the inbound policy.
45 * Inbound policy is applied as follows:
47 * 1) if the peer is an eBGP peer, perform attribute replacement and filtering
48 * 2) check if a route is admissible based on attributes attached to it, as well as the
49 * advertising peer's role
50 * 3) output admitting routes with edited attributes into /bgp-rib/rib/peer/effective-rib-in/tables/routes
52 * Note that we maintain the peer roles using a DCL, even if we could look up our internal
53 * structures. This is done so we maintain causality and loose coupling.
56 final class EffectiveRibInWriter implements AutoCloseable {
57 private static final Logger LOG = LoggerFactory.getLogger(EffectiveRibInWriter.class);
58 private static final NodeIdentifier TABLE_ROUTES = new NodeIdentifier(Routes.QNAME);
59 private static final NodeIdentifier ADJRIBIN_NID = new NodeIdentifier(AdjRibIn.QNAME);
60 private static final NodeIdentifier TABLES_NID = new NodeIdentifier(Tables.QNAME);
63 * Maintains {@link TableRouteListener} instances.
65 private final class AdjInTracker implements AutoCloseable, DOMDataTreeChangeListener {
66 private final RIBSupportContextRegistry registry;
67 private final YangInstanceIdentifier ribId;
68 private final ListenerRegistration<?> reg;
69 private final DOMTransactionChain chain;
71 AdjInTracker(final DOMDataTreeChangeService service, final RIBSupportContextRegistry registry, final DOMTransactionChain chain, final YangInstanceIdentifier ribId) {
72 this.registry = Preconditions.checkNotNull(registry);
73 this.chain = Preconditions.checkNotNull(chain);
74 this.ribId = Preconditions.checkNotNull(ribId);
76 final YangInstanceIdentifier tableId = ribId.node(Peer.QNAME).node(Peer.QNAME);
77 final DOMDataTreeIdentifier treeId = new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, tableId);
78 LOG.debug("Registered Effective RIB on {}", tableId);
79 this.reg = service.registerDataTreeChangeListener(treeId, this);
82 private void processRoute(final DOMDataWriteTransaction tx, final RIBSupport ribSupport, final AbstractImportPolicy policy, final YangInstanceIdentifier routesPath, final DataTreeCandidateNode route) {
83 LOG.debug("Process route {}", route);
84 final YangInstanceIdentifier routeId = ribSupport.routePath(routesPath, route.getIdentifier());
85 switch (route.getModificationType()) {
87 tx.delete(LogicalDatastoreType.OPERATIONAL, routeId);
92 case SUBTREE_MODIFIED:
94 tx.put(LogicalDatastoreType.OPERATIONAL, routeId, route.getDataAfter().get());
95 // Lookup per-table attributes from RIBSupport
96 final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(route.getDataAfter(), ribSupport.routeAttributesIdentifier()).orNull();
97 final ContainerNode effectiveAttrs;
99 if (advertisedAttrs != null) {
100 effectiveAttrs = policy.effectiveAttributes(advertisedAttrs);
102 effectiveAttrs = null;
105 LOG.debug("Route {} effective attributes {} towards {}", route.getIdentifier(), effectiveAttrs, routeId);
107 if (effectiveAttrs != null) {
108 tx.put(LogicalDatastoreType.OPERATIONAL, routeId.node(ribSupport.routeAttributesIdentifier()), effectiveAttrs);
110 LOG.warn("Route {} advertised empty attributes", routeId);
111 tx.delete(LogicalDatastoreType.OPERATIONAL, routeId);
115 LOG.warn("Ignoring unhandled route {}", route);
120 private void processTableChildren(final DOMDataWriteTransaction tx, final RIBSupport ribSupport, final NodeIdentifierWithPredicates peerKey, final YangInstanceIdentifier tablePath, final Collection<DataTreeCandidateNode> children) {
121 final AbstractImportPolicy policy = EffectiveRibInWriter.this.peerPolicyTracker.policyFor(IdentifierUtils.peerId(peerKey));
123 for (final DataTreeCandidateNode child : children) {
124 LOG.debug("Process table {} type {}", child, child.getModificationType());
125 final YangInstanceIdentifier childPath = tablePath.node(child.getIdentifier());
126 switch (child.getModificationType()) {
128 tx.delete(LogicalDatastoreType.OPERATIONAL, tablePath.node(child.getIdentifier()));
133 case SUBTREE_MODIFIED:
134 if (TABLE_ROUTES.equals(child.getIdentifier())) {
135 for (final DataTreeCandidateNode route : ribSupport.changedRoutes(child)) {
136 processRoute(tx, ribSupport, policy, childPath, route);
139 tx.put(LogicalDatastoreType.OPERATIONAL, childPath, child.getDataAfter().get());
143 tx.put(LogicalDatastoreType.OPERATIONAL, childPath, child.getDataAfter().get());
144 // Routes are special, as they may end up being filtered. The previous put conveniently
145 // ensured that we have them in at target, so a subsequent delete will not fail :)
146 if (TABLE_ROUTES.equals(child.getIdentifier())) {
147 for (final DataTreeCandidateNode route : ribSupport.changedRoutes(child)) {
148 processRoute(tx, ribSupport, policy, childPath, route);
153 LOG.warn("Ignoring unhandled child {}", child);
159 private RIBSupportContext getRibSupport(final NodeIdentifierWithPredicates tableKey) {
160 return this.registry.getRIBSupportContext(tableKey);
163 private YangInstanceIdentifier effectiveTablePath(final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey) {
164 return this.ribId.node(Peer.QNAME).node(peerKey).node(EffectiveRibIn.QNAME).node(Tables.QNAME).node(tableKey);
167 private void modifyTable(final DOMDataWriteTransaction tx, final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey, final DataTreeCandidateNode table) {
168 final RIBSupportContext ribSupport = getRibSupport(tableKey);
169 final YangInstanceIdentifier tablePath = effectiveTablePath(peerKey, tableKey);
171 processTableChildren(tx, ribSupport.getRibSupport(), peerKey, tablePath, table.getChildNodes());
174 private void writeTable(final DOMDataWriteTransaction tx, final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey, final DataTreeCandidateNode table) {
175 final RIBSupportContext ribSupport = getRibSupport(tableKey);
176 final YangInstanceIdentifier tablePath = effectiveTablePath(peerKey, tableKey);
178 // Create an empty table
179 ribSupport.clearTable(tx,tablePath);
181 processTableChildren(tx, ribSupport.getRibSupport(), peerKey, tablePath, table.getChildNodes());
185 public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
186 LOG.trace("Data changed called to effective RIB. Change : {}", changes);
187 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
188 for (final DataTreeCandidate tc : changes) {
189 final YangInstanceIdentifier rootPath = tc.getRootPath();
191 // Obtain the peer's key
192 final NodeIdentifierWithPredicates peerKey = IdentifierUtils.peerKey(rootPath);
193 final DataTreeCandidateNode root = tc.getRootNode();
195 // call out peer-role has changed
196 final DataTreeCandidateNode roleChange = root.getModifiedChild(AbstractPeerRoleTracker.PEER_ROLE_NID);
197 if (roleChange != null) {
198 EffectiveRibInWriter.this.peerPolicyTracker.onDataTreeChanged(roleChange, IdentifierUtils.peerPath(rootPath));
201 // filter out any change outside AdjRibsIn
202 final DataTreeCandidateNode ribIn = root.getModifiedChild(ADJRIBIN_NID);
204 LOG.debug("Skipping change {}", tc.getRootNode());
207 final DataTreeCandidateNode tables = ribIn.getModifiedChild(TABLES_NID);
208 if (tables == null) {
209 LOG.debug("Skipping change {}", tc.getRootNode());
212 for (final DataTreeCandidateNode table : tables.getChildNodes()) {
213 changeDataTree(tx, rootPath, root, peerKey, table);
219 private void changeDataTree(final DOMDataWriteTransaction tx, final YangInstanceIdentifier rootPath,
220 final DataTreeCandidateNode root, final NodeIdentifierWithPredicates peerKey, final DataTreeCandidateNode table) {
221 final PathArgument lastArg = table.getIdentifier();
222 Verify.verify(lastArg instanceof NodeIdentifierWithPredicates, "Unexpected type %s in path %s", lastArg.getClass(), rootPath);
223 final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
225 switch (root.getModificationType()) {
227 // delete the corresponding effective table
228 tx.delete(LogicalDatastoreType.OPERATIONAL, effectiveTablePath(peerKey, tableKey));
230 case SUBTREE_MODIFIED:
231 modifyTable(tx, peerKey, tableKey, table);
234 LOG.info("Ignoring spurious notification on {} data {}", rootPath, table);
237 writeTable(tx, peerKey, tableKey, table);
240 LOG.warn("Ignoring unhandled root {}", root);
246 public void close() {
247 // FIXME: wipe all effective routes?
252 private final ImportPolicyPeerTracker peerPolicyTracker;
253 private final AdjInTracker adjInTracker;
255 static EffectiveRibInWriter create(@Nonnull final DOMDataTreeChangeService service, @Nonnull final DOMTransactionChain chain,
256 @Nonnull final YangInstanceIdentifier ribId, @Nonnull final PolicyDatabase pd, @Nonnull final RIBSupportContextRegistry registry) {
257 return new EffectiveRibInWriter(service, chain, ribId, pd, registry);
260 private EffectiveRibInWriter(final DOMDataTreeChangeService service, final DOMTransactionChain chain, final YangInstanceIdentifier ribId,
261 final PolicyDatabase pd, final RIBSupportContextRegistry registry) {
262 this.peerPolicyTracker = new ImportPolicyPeerTracker(pd);
263 this.adjInTracker = new AdjInTracker(service, registry, chain, ribId);
267 public void close() {
268 this.adjInTracker.close();