bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/EffectiveRibInWriter.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.protocol.bgp.rib.impl;
   9
  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;
  40
  41 /**
  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.
  44  *
  45  * Inbound policy is applied as follows:
  46  *
  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
  51  *
  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.
  54  */
  55 @NotThreadSafe
  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);
  61
  62     /**
  63      * Maintains {@link TableRouteListener} instances.
  64      */
  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;
  70
  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);
  75
  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);
  80         }
  81
  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             switch (route.getModificationType()) {
  85             case DELETE:
  86                 // Delete has already been affected by the store in caller, so this is a no-op.
  87                 break;
  88             case UNMODIFIED:
  89                 // No-op
  90                 break;
  91             case SUBTREE_MODIFIED:
  92             case WRITE:
  93                 // Lookup per-table attributes from RIBSupport
  94                 final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(route.getDataAfter(), ribSupport.routeAttributesIdentifier()).orNull();
  95                 final ContainerNode effectiveAttrs;
  96
  97                 if (advertisedAttrs != null) {
  98                     effectiveAttrs = policy.effectiveAttributes(advertisedAttrs);
  99
 100                     /*
 101                      * Speed hack: if we determine that the policy has passed the attributes
 102                      * back unmodified, the corresponding change has already been written in
 103                      * our caller. There is no need to perform any further processing.
 104                      *
 105                      * We also use direct object comparison to make the check very fast, as
 106                      * it may not be that common, in which case it does not make sense to pay
 107                      * the full equals price.
 108                      */
 109                     if (effectiveAttrs == advertisedAttrs) {
 110                         LOG.trace("Effective and local attributes are equal. Quit processing route {}", route);
 111                         return;
 112                     }
 113                 } else {
 114                     effectiveAttrs = null;
 115                 }
 116
 117                 final YangInstanceIdentifier routeId = ribSupport.routePath(routesPath, route.getIdentifier());
 118                 LOG.debug("Route {} effective attributes {} towards {}", route.getIdentifier(), effectiveAttrs, routeId);
 119
 120                 if (effectiveAttrs != null) {
 121                     tx.put(LogicalDatastoreType.OPERATIONAL, routeId.node(ribSupport.routeAttributesIdentifier()), effectiveAttrs);
 122                 } else {
 123                     LOG.warn("Route {} advertised empty attributes", routeId);
 124                     tx.delete(LogicalDatastoreType.OPERATIONAL,  routeId);
 125                 }
 126                 break;
 127             default:
 128                 LOG.warn("Ignoring unhandled route {}", route);
 129                 break;
 130             }
 131         }
 132
 133         private void processTableChildren(final DOMDataWriteTransaction tx, final RIBSupport ribSupport, final NodeIdentifierWithPredicates peerKey, final YangInstanceIdentifier tablePath, final Collection<DataTreeCandidateNode> children) {
 134             final AbstractImportPolicy policy = EffectiveRibInWriter.this.peerPolicyTracker.policyFor(IdentifierUtils.peerId(peerKey));
 135
 136             for (final DataTreeCandidateNode child : children) {
 137                 LOG.debug("Process table children {}", child);
 138                 switch (child.getModificationType()) {
 139                 case DELETE:
 140                     tx.delete(LogicalDatastoreType.OPERATIONAL, tablePath.node(child.getIdentifier()));
 141                     break;
 142                 case UNMODIFIED:
 143                     // No-op
 144                     break;
 145                 case SUBTREE_MODIFIED:
 146                 case WRITE:
 147                     final YangInstanceIdentifier childPath = tablePath.node(child.getIdentifier());
 148                     tx.put(LogicalDatastoreType.OPERATIONAL, childPath, child.getDataAfter().get());
 149
 150                     // Routes are special, as they may end up being filtered. The previous put conveniently
 151                     // ensured that we have them in at target, so a subsequent delete will not fail :)
 152                     if (TABLE_ROUTES.equals(child.getIdentifier())) {
 153                         for (final DataTreeCandidateNode route : ribSupport.changedRoutes(child)) {
 154                             processRoute(tx, ribSupport, policy, childPath, route);
 155                         }
 156                     }
 157                     break;
 158                 default:
 159                     LOG.warn("Ignoring unhandled child {}", child);
 160                     break;
 161                 }
 162             }
 163         }
 164
 165         private RIBSupportContext getRibSupport(final NodeIdentifierWithPredicates tableKey) {
 166             return this.registry.getRIBSupportContext(tableKey);
 167         }
 168
 169         private YangInstanceIdentifier effectiveTablePath(final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey) {
 170             return this.ribId.node(Peer.QNAME).node(peerKey).node(EffectiveRibIn.QNAME).node(Tables.QNAME).node(tableKey);
 171         }
 172
 173         private void modifyTable(final DOMDataWriteTransaction tx, final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey, final DataTreeCandidateNode table) {
 174             final RIBSupportContext ribSupport = getRibSupport(tableKey);
 175             final YangInstanceIdentifier tablePath = effectiveTablePath(peerKey, tableKey);
 176
 177             processTableChildren(tx, ribSupport.getRibSupport(), peerKey, tablePath, table.getChildNodes());
 178         }
 179
 180         private void writeTable(final DOMDataWriteTransaction tx, final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey, final DataTreeCandidateNode table) {
 181             final RIBSupportContext ribSupport = getRibSupport(tableKey);
 182             final YangInstanceIdentifier tablePath = effectiveTablePath(peerKey, tableKey);
 183
 184             // Create an empty table
 185             ribSupport.clearTable(tx,tablePath);
 186
 187             processTableChildren(tx, ribSupport.getRibSupport(), peerKey, tablePath, table.getChildNodes());
 188         }
 189
 190         @Override
 191         public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
 192             LOG.trace("Data changed called to effective RIB. Change : {}", changes);
 193             final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
 194
 195             for (final DataTreeCandidate tc : changes) {
 196                 final YangInstanceIdentifier rootPath = tc.getRootPath();
 197
 198                 // Obtain the peer's key
 199                 final NodeIdentifierWithPredicates peerKey = IdentifierUtils.peerKey(rootPath);
 200                 final DataTreeCandidateNode root = tc.getRootNode();
 201
 202                 // call out peer-role has changed
 203                 final DataTreeCandidateNode roleChange =  root.getModifiedChild(AbstractPeerRoleTracker.PEER_ROLE_NID);
 204                 if (roleChange != null) {
 205                     EffectiveRibInWriter.this.peerPolicyTracker.onDataTreeChanged(roleChange, IdentifierUtils.peerPath(rootPath));
 206                 }
 207
 208                 // filter out any change outside AdjRibsIn
 209                 final DataTreeCandidateNode ribIn =  root.getModifiedChild(ADJRIBIN_NID);
 210                 if (ribIn == null) {
 211                     LOG.debug("Skipping change {}", tc.getRootNode());
 212                     continue;
 213                 }
 214                 final DataTreeCandidateNode tables = ribIn.getModifiedChild(TABLES_NID);
 215                 if (tables == null) {
 216                     LOG.debug("Skipping change {}", tc.getRootNode());
 217                     continue;
 218                 }
 219                 for (final DataTreeCandidateNode table : tables.getChildNodes()) {
 220                     changeDataTree(tx, rootPath, root, peerKey, table);
 221                 }
 222             }
 223             tx.submit();
 224         }
 225
 226         private void changeDataTree(final DOMDataWriteTransaction tx, final YangInstanceIdentifier rootPath,
 227             final DataTreeCandidateNode root, final NodeIdentifierWithPredicates peerKey, final DataTreeCandidateNode table) {
 228
 229             final PathArgument lastArg = table.getIdentifier();
 230             Verify.verify(lastArg instanceof NodeIdentifierWithPredicates, "Unexpected type %s in path %s", lastArg.getClass(), rootPath);
 231             final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
 232
 233             switch (root.getModificationType()) {
 234             case DELETE:
 235                 // delete the corresponding effective table
 236                 tx.delete(LogicalDatastoreType.OPERATIONAL, effectiveTablePath(peerKey, tableKey));
 237                 break;
 238             case MERGE:
 239                 // TODO: upstream API should never give us this, as it leaks how the delta was created.
 240                 LOG.info("Merge on {} reported, this should never have happened, but attempting to cope", rootPath);
 241                 modifyTable(tx, peerKey, tableKey, table);
 242                 break;
 243             case SUBTREE_MODIFIED:
 244                 modifyTable(tx, peerKey, tableKey, table);
 245                 break;
 246             case UNMODIFIED:
 247                 LOG.info("Ignoring spurious notification on {} data {}", rootPath, table);
 248                 break;
 249             case WRITE:
 250                 writeTable(tx, peerKey, tableKey, table);
 251                 break;
 252             default:
 253                 LOG.warn("Ignoring unhandled root {}", root);
 254                 break;
 255             }
 256         }
 257
 258         @Override
 259         public void close() {
 260             // FIXME: wipe all effective routes?
 261             this.reg.close();
 262         }
 263     }
 264
 265     private final ImportPolicyPeerTracker peerPolicyTracker;
 266     private final AdjInTracker adjInTracker;
 267
 268     static EffectiveRibInWriter create(@Nonnull final DOMDataTreeChangeService service, @Nonnull final DOMTransactionChain chain,
 269         @Nonnull final YangInstanceIdentifier ribId, @Nonnull final PolicyDatabase pd, @Nonnull final RIBSupportContextRegistry registry) {
 270         return new EffectiveRibInWriter(service, chain, ribId, pd, registry);
 271     }
 272
 273     private EffectiveRibInWriter(final DOMDataTreeChangeService service, final DOMTransactionChain chain, final YangInstanceIdentifier ribId,
 274         final PolicyDatabase pd, final RIBSupportContextRegistry registry) {
 275         this.peerPolicyTracker = new ImportPolicyPeerTracker(pd);
 276         this.adjInTracker = new AdjInTracker(service, registry, chain, ribId);
 277     }
 278
 279     @Override
 280     public void close() {
 281         this.adjInTracker.close();
 282     }
 283 }