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.multiprotocol.rev130919.open.bgp.parameters.optional.capabilities.c.parameters.graceful.restart._case.graceful.restart.capability.Tables;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.EffectiveRibIn;
  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
  60     /**
  61      * Maintains {@link TableRouteListener} instances.
  62      */
  63     private final class AdjInTracker implements AutoCloseable, DOMDataTreeChangeListener {
  64         private final RIBSupportContextRegistry registry;
  65         private final YangInstanceIdentifier ribId;
  66         private final ListenerRegistration<?> reg;
  67         private final DOMTransactionChain chain;
  68
  69         AdjInTracker(final DOMDataTreeChangeService service, final RIBSupportContextRegistry registry, final DOMTransactionChain chain, final YangInstanceIdentifier ribId) {
  70             this.registry = Preconditions.checkNotNull(registry);
  71             this.chain = Preconditions.checkNotNull(chain);
  72             this.ribId = Preconditions.checkNotNull(ribId);
  73
  74             final YangInstanceIdentifier tableId = ribId.node(Peer.QNAME).node(AdjRibIn.QNAME).node(Tables.QNAME);
  75             final DOMDataTreeIdentifier treeId = new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, tableId);
  76             this.reg = service.registerDataTreeChangeListener(treeId, this);
  77         }
  78
  79         private void processRoute(final DOMDataWriteTransaction tx, final RIBSupport ribSupport, final AbstractImportPolicy policy, final YangInstanceIdentifier routesPath, final DataTreeCandidateNode route) {
  80             LOG.debug("Process route {}", route);
  81             switch (route.getModificationType()) {
  82             case DELETE:
  83                 // Delete has already been affected by the store in caller, so this is a no-op.
  84                 break;
  85             case MERGE:
  86                 LOG.info("Merge on {} reported, this should never have happened, ignoring", route);
  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 adverisedAttrs = (ContainerNode) NormalizedNodes.findNode(route.getDataAfter(), ribSupport.routeAttributesIdentifier()).orNull();
  95                 final ContainerNode effectiveAttrs;
  96
  97                 if (adverisedAttrs != null) {
  98                     effectiveAttrs = policy.effectiveAttributes(adverisedAttrs);
  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 == adverisedAttrs) {
 110                         return;
 111                     }
 112                 } else {
 113                     effectiveAttrs = null;
 114                 }
 115
 116                 final YangInstanceIdentifier routeId = ribSupport.routePath(routesPath, route.getIdentifier());
 117                 LOG.debug("Route {} effective attributes {} towards {}", route.getIdentifier(), effectiveAttrs, routeId);
 118
 119                 if (effectiveAttrs != null) {
 120                     tx.put(LogicalDatastoreType.OPERATIONAL, routeId.node(ribSupport.routeAttributesIdentifier()), effectiveAttrs);
 121                 } else {
 122                     LOG.warn("Route {} advertised empty attributes", route.getDataAfter());
 123                     tx.delete(LogicalDatastoreType.OPERATIONAL,  routeId);
 124                 }
 125                 break;
 126             default:
 127                 LOG.warn("Ignoring unhandled route {}", route);
 128                 break;
 129             }
 130         }
 131
 132         private void processTableChildren(final DOMDataWriteTransaction tx, final RIBSupport ribSupport, final NodeIdentifierWithPredicates peerKey, final YangInstanceIdentifier tablePath, final Collection<DataTreeCandidateNode> children) {
 133             final AbstractImportPolicy policy = EffectiveRibInWriter.this.peerPolicyTracker.policyFor(IdentifierUtils.peerId(peerKey));
 134
 135             for (final DataTreeCandidateNode child : children) {
 136                 switch (child.getModificationType()) {
 137                 case DELETE:
 138                     tx.delete(LogicalDatastoreType.OPERATIONAL, tablePath.node(child.getIdentifier()));
 139                     break;
 140                 case MERGE:
 141                     LOG.info("Merge on {} reported, this should never have happened, ignoring", child);
 142                     break;
 143                 case UNMODIFIED:
 144                     // No-op
 145                     break;
 146                 case SUBTREE_MODIFIED:
 147                 case WRITE:
 148                     tx.put(LogicalDatastoreType.OPERATIONAL, tablePath.node(child.getIdentifier()), 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                         final YangInstanceIdentifier routesPath = tablePath.node(Routes.QNAME);
 154                         for (final DataTreeCandidateNode route : ribSupport.changedRoutes(child)) {
 155                             processRoute(tx, ribSupport, policy, routesPath, route);
 156                         }
 157                     }
 158                     break;
 159                 default:
 160                     LOG.warn("Ignoring unhandled child {}", child);
 161                     break;
 162                 }
 163             }
 164         }
 165
 166         private RIBSupportContext getRibSupport(final NodeIdentifierWithPredicates tableKey) {
 167             // FIXME: use codec to translate tableKey
 168             return this.registry.getRIBSupportContext(null);
 169         }
 170
 171         private YangInstanceIdentifier effectiveTablePath(final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey) {
 172             return this.ribId.node(Peer.QNAME).node(peerKey).node(EffectiveRibIn.QNAME).node(tableKey);
 173         }
 174
 175         private void modifyTable(final DOMDataWriteTransaction tx, final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey, final DataTreeCandidateNode table) {
 176             final RIBSupportContext ribSupport = getRibSupport(tableKey);
 177             final YangInstanceIdentifier tablePath = effectiveTablePath(peerKey, tableKey);
 178
 179             processTableChildren(tx, ribSupport.getRibSupport(), peerKey, tablePath, table.getChildNodes());
 180         }
 181
 182         private void writeTable(final DOMDataWriteTransaction tx, final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey, final DataTreeCandidateNode table) {
 183             final RIBSupportContext ribSupport = getRibSupport(tableKey);
 184             final YangInstanceIdentifier tablePath = effectiveTablePath(peerKey, tableKey);
 185
 186             // Create an empty table
 187             ribSupport.clearTable(tx,tablePath);
 188
 189             processTableChildren(tx, ribSupport.getRibSupport(), peerKey, tablePath, table.getChildNodes());
 190         }
 191
 192         @Override
 193         public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
 194             LOG.trace("Data changed called to effective RIB. Change : {}", changes);
 195             final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
 196
 197             for (final DataTreeCandidate tc : changes) {
 198                 final YangInstanceIdentifier rootPath = tc.getRootPath();
 199
 200                 // Obtain the peer's key
 201                 final NodeIdentifierWithPredicates peerKey = IdentifierUtils.peerKey(rootPath);
 202
 203                 // Extract the table key, this should be safe based on the path where we subscribed,
 204                 // but let's verify explicitly.
 205                 final PathArgument lastArg = rootPath.getLastPathArgument();
 206                 Verify.verify(lastArg instanceof NodeIdentifierWithPredicates, "Unexpected type %s in path %s", lastArg.getClass(), rootPath);
 207                 final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
 208
 209                 final DataTreeCandidateNode root = tc.getRootNode();
 210                 switch (root.getModificationType()) {
 211                 case DELETE:
 212                     // delete the corresponding effective table
 213                     tx.delete(LogicalDatastoreType.OPERATIONAL, effectiveTablePath(peerKey, tableKey));
 214                     break;
 215                 case MERGE:
 216                     // TODO: upstream API should never give us this, as it leaks how the delta was created.
 217                     LOG.info("Merge on {} reported, this should never have happened, but attempting to cope", rootPath);
 218                     modifyTable(tx, peerKey, tableKey, root);
 219                     break;
 220                 case SUBTREE_MODIFIED:
 221                     modifyTable(tx, peerKey, tableKey, root);
 222                     break;
 223                 case UNMODIFIED:
 224                     LOG.info("Ignoring spurious notification on {} data {}", rootPath, root);
 225                     break;
 226                 case WRITE:
 227                     writeTable(tx, peerKey, tableKey, root);
 228                     break;
 229                 default:
 230                     LOG.warn("Ignoring unhandled root {}", root);
 231                     break;
 232                 }
 233             }
 234
 235             tx.submit();
 236         }
 237
 238         @Override
 239         public void close() {
 240             // FIXME: wipe all effective routes?
 241             this.reg.close();
 242         }
 243     }
 244
 245     private final ImportPolicyPeerTracker peerPolicyTracker;
 246     private final AdjInTracker adjInTracker;
 247
 248     static EffectiveRibInWriter create(@Nonnull final DOMDataTreeChangeService service, @Nonnull final DOMTransactionChain chain,
 249         @Nonnull final YangInstanceIdentifier ribId, @Nonnull final PolicyDatabase pd, @Nonnull final RIBSupportContextRegistry registry) {
 250         return new EffectiveRibInWriter(service, chain, ribId, pd, registry);
 251     }
 252
 253     private EffectiveRibInWriter(final DOMDataTreeChangeService service, final DOMTransactionChain chain, final YangInstanceIdentifier ribId,
 254         final PolicyDatabase pd, final RIBSupportContextRegistry registry) {
 255
 256         this.peerPolicyTracker = new ImportPolicyPeerTracker(service, ribId, pd);
 257         this.adjInTracker = new AdjInTracker(service, registry, chain, ribId);
 258     }
 259
 260     @Override
 261     public void close() {
 262         this.adjInTracker.close();
 263         this.peerPolicyTracker.close();
 264     }
 265 }