bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/LocRibWriter.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.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.primitives.UnsignedInteger;
  13 import java.util.Collection;
  14 import java.util.HashMap;
  15 import java.util.Map;
  16 import java.util.Map.Entry;
  17 import javax.annotation.Nonnull;
  18 import javax.annotation.concurrent.NotThreadSafe;
  19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  25 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
  26 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  27 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
  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.bgp.rib.rib.LocRib;
  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.AdjRibOut;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.EffectiveRibIn;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Attributes;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
  39 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  40 import org.opendaylight.yangtools.yang.common.QName;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  45 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  49 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 @NotThreadSafe
  55 final class LocRibWriter implements AutoCloseable, DOMDataTreeChangeListener {
  56
  57     private static final Logger LOG = LoggerFactory.getLogger(LocRibWriter.class);
  58
  59     private static final LeafNode<Boolean> ATTRIBUTES_UPTODATE_TRUE = ImmutableNodes.leafNode(QName.create(Attributes.QNAME, "uptodate"), Boolean.TRUE);
  60     private static final NodeIdentifier ROUTES_IDENTIFIER = new NodeIdentifier(Routes.QNAME);
  61     private static final NodeIdentifier EFFRIBIN_NID = new NodeIdentifier(EffectiveRibIn.QNAME);
  62     private static final NodeIdentifier TABLES_NID = new NodeIdentifier(Tables.QNAME);
  63
  64     private final Map<PathArgument, AbstractRouteEntry> routeEntries = new HashMap<>();
  65     private final YangInstanceIdentifier locRibTarget;
  66     private final DOMTransactionChain chain;
  67     private final ExportPolicyPeerTracker peerPolicyTracker;
  68     private final NodeIdentifier attributesIdentifier;
  69     private final Long ourAs;
  70     private final RIBSupport ribSupport;
  71     private final NodeIdentifierWithPredicates tableKey;
  72     private final RIBSupportContextRegistry registry;
  73     private final ListenerRegistration<LocRibWriter> reg;
  74
  75     LocRibWriter(final RIBSupportContextRegistry registry, final DOMTransactionChain chain, final YangInstanceIdentifier target, final Long ourAs,
  76         final DOMDataTreeChangeService service, final PolicyDatabase pd, final TablesKey tablesKey) {
  77         this.chain = Preconditions.checkNotNull(chain);
  78         this.tableKey = RibSupportUtils.toYangTablesKey(tablesKey);
  79         this.locRibTarget = YangInstanceIdentifier.create(target.node(LocRib.QNAME).node(Tables.QNAME).node(this.tableKey).getPathArguments());
  80         this.ourAs = Preconditions.checkNotNull(ourAs);
  81         this.registry = registry;
  82         this.ribSupport = this.registry.getRIBSupportContext(tablesKey).getRibSupport();
  83         this.attributesIdentifier = this.ribSupport.routeAttributesIdentifier();
  84         this.peerPolicyTracker = new ExportPolicyPeerTracker(pd);
  85
  86         final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
  87         tx.merge(LogicalDatastoreType.OPERATIONAL, this.locRibTarget.node(Routes.QNAME), this.ribSupport.emptyRoutes());
  88         tx.merge(LogicalDatastoreType.OPERATIONAL, this.locRibTarget.node(Attributes.QNAME).node(ATTRIBUTES_UPTODATE_TRUE.getNodeType()), ATTRIBUTES_UPTODATE_TRUE);
  89         tx.submit();
  90
  91         final YangInstanceIdentifier tableId = target.node(Peer.QNAME).node(Peer.QNAME);
  92
  93         this.reg = service.registerDataTreeChangeListener(new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, tableId), this);
  94     }
  95
  96     public static LocRibWriter create(@Nonnull final RIBSupportContextRegistry registry, @Nonnull final TablesKey tablesKey, @Nonnull final DOMTransactionChain chain, @Nonnull final YangInstanceIdentifier target,
  97         @Nonnull final AsNumber ourAs, @Nonnull final DOMDataTreeChangeService service, @Nonnull final PolicyDatabase pd) {
  98         return new LocRibWriter(registry, chain, target, ourAs.getValue(), service, pd, tablesKey);
  99     }
 100
 101     @Override
 102     public void close() {
 103         this.reg.close();
 104         // FIXME: wipe the local rib
 105         // FIXME: wait for the chain to close? unfortunately RIBImpl is the listener, so that may require some work
 106         this.chain.close();
 107     }
 108
 109     @Nonnull private AbstractRouteEntry createEntry(final PathArgument routeId) {
 110         final AbstractRouteEntry ret = this.ribSupport.isComplexRoute() ? new ComplexRouteEntry() : new SimpleRouteEntry();
 111
 112         this.routeEntries.put(routeId, ret);
 113         LOG.trace("Created new entry for {}", routeId);
 114         return ret;
 115     }
 116
 117     @Override
 118     public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
 119         LOG.trace("Received data change to LocRib {}", changes);
 120
 121         final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
 122         try {
 123             /*
 124              * We use two-stage processing here in hopes that we avoid duplicate
 125              * calculations when multiple peers have changed a particular entry.
 126              */
 127             final Map<RouteUpdateKey, AbstractRouteEntry> toUpdate = update(tx, changes);
 128
 129             // Now walk all updated entries
 130             walkThrough(tx, toUpdate);
 131         } catch (final Exception e) {
 132             LOG.error("Failed to completely propagate updates {}, state is undefined", changes, e);
 133         } finally {
 134             tx.submit();
 135         }
 136     }
 137
 138     private Map<RouteUpdateKey, AbstractRouteEntry> update(final DOMDataWriteTransaction tx,
 139         final Collection<DataTreeCandidate> changes) {
 140         final Map<RouteUpdateKey, AbstractRouteEntry> ret = new HashMap<>();
 141
 142         for (final DataTreeCandidate tc : changes) {
 143             final YangInstanceIdentifier rootPath = tc.getRootPath();
 144             final DataTreeCandidateNode rootNode = tc.getRootNode();
 145             final DataTreeCandidateNode roleChange =  rootNode.getModifiedChild(AbstractPeerRoleTracker.PEER_ROLE_NID);
 146             if (roleChange != null) {
 147                 this.peerPolicyTracker.onDataTreeChanged(roleChange, IdentifierUtils.peerPath(rootPath));
 148             }
 149             // filter out any change outside EffRibsIn
 150             final DataTreeCandidateNode ribIn = rootNode.getModifiedChild(EFFRIBIN_NID);
 151             if (ribIn == null) {
 152                 LOG.debug("Skipping change {}", tc.getRootNode());
 153                 continue;
 154             }
 155             final DataTreeCandidateNode table = ribIn.getModifiedChild(TABLES_NID).getModifiedChild(this.tableKey);
 156             if (table == null) {
 157                 LOG.debug("Skipping change {}", tc.getRootNode());
 158                 continue;
 159             }
 160             final NodeIdentifierWithPredicates peerKey = IdentifierUtils.peerKey(rootPath);
 161             final PeerId peerId = IdentifierUtils.peerId(peerKey);
 162             updateNodes(table, peerId, tx, ret);
 163         }
 164
 165         return ret;
 166     }
 167
 168     private void updateNodes(final DataTreeCandidateNode table, final PeerId peerId, final DOMDataWriteTransaction tx, final Map<RouteUpdateKey, AbstractRouteEntry> routes) {
 169         for (final DataTreeCandidateNode child : table.getChildNodes()) {
 170             LOG.debug("Modification type {}", child.getModificationType());
 171             if ((Attributes.QNAME).equals(child.getIdentifier().getNodeType())) {
 172                 if (child.getDataAfter().isPresent()) {
 173                     // putting uptodate attribute in
 174                     LOG.trace("Uptodate found for {}", child.getDataAfter());
 175                     tx.put(LogicalDatastoreType.OPERATIONAL, this.locRibTarget.node(child.getIdentifier()), child.getDataAfter().get());
 176                 }
 177                 continue;
 178             }
 179             updateRoutesEntries(child, peerId, routes);
 180         }
 181     }
 182
 183     private void updateRoutesEntries(final DataTreeCandidateNode child, final PeerId peerId, final Map<RouteUpdateKey, AbstractRouteEntry> routes) {
 184         final UnsignedInteger routerId = RouterIds.routerIdForPeerId(peerId);
 185         for (final DataTreeCandidateNode route : this.ribSupport.changedRoutes(child)) {
 186             final PathArgument routeId = route.getIdentifier();
 187             AbstractRouteEntry entry = this.routeEntries.get(routeId);
 188
 189             final Optional<NormalizedNode<?, ?>> maybeData = route.getDataAfter();
 190             if (maybeData.isPresent()) {
 191                 if (entry == null) {
 192                     entry = createEntry(routeId);
 193                 }
 194                 entry.addRoute(routerId, this.attributesIdentifier, maybeData.get());
 195             } else if (entry != null && entry.removeRoute(routerId)) {
 196                 this.routeEntries.remove(routeId);
 197                 entry = null;
 198                 LOG.trace("Removed route from {}", routerId);
 199             }
 200             LOG.debug("Updated route {} entry {}", routeId, entry);
 201             routes.put(new RouteUpdateKey(peerId, routeId), entry);
 202         }
 203     }
 204
 205     private void walkThrough(final DOMDataWriteTransaction tx, final Map<RouteUpdateKey, AbstractRouteEntry> toUpdate) {
 206         for (final Entry<RouteUpdateKey, AbstractRouteEntry> e : toUpdate.entrySet()) {
 207             LOG.trace("Walking through {}", e);
 208             final AbstractRouteEntry entry = e.getValue();
 209             final RouteUpdateKey key = e.getKey();
 210             final NormalizedNode<?, ?> value;
 211
 212             if (entry != null) {
 213                 if (!entry.selectBest(this.ourAs)) {
 214                     // Best path has not changed, no need to do anything else. Proceed to next route.
 215                     LOG.trace("Continuing");
 216                     continue;
 217                 }
 218                 value = entry.createValue(key.getRouteId());
 219                 LOG.trace("Selected best value {}", value);
 220             } else {
 221                 value = null;
 222             }
 223
 224             final YangInstanceIdentifier writePath = this.ribSupport.routePath(this.locRibTarget.node(ROUTES_IDENTIFIER), key.getRouteId());
 225             if (value != null) {
 226                 LOG.debug("Write route to LocRib {}", value);
 227                 tx.put(LogicalDatastoreType.OPERATIONAL, writePath, value);
 228             } else {
 229                 LOG.debug("Delete route from LocRib {}", entry);
 230                 tx.delete(LogicalDatastoreType.OPERATIONAL, writePath);
 231             }
 232             fillAdjRibsOut(tx, entry, value, key);
 233         }
 234     }
 235
 236     private void fillAdjRibsOut(final DOMDataWriteTransaction tx, final AbstractRouteEntry entry, final NormalizedNode<?, ?> value, final RouteUpdateKey key) {
 237         /*
 238          * We need to keep track of routers and populate adj-ribs-out, too. If we do not, we need to
 239          * expose from which client a particular route was learned from in the local RIB, and have
 240          * the listener perform filtering.
 241          *
 242          * We walk the policy set in order to minimize the amount of work we do for multiple peers:
 243          * if we have two eBGP peers, for example, there is no reason why we should perform the translation
 244          * multiple times.
 245          */
 246         for (final PeerRole role : PeerRole.values()) {
 247             final PeerExportGroup peerGroup = this.peerPolicyTracker.getPeerGroup(role);
 248             if (peerGroup != null) {
 249                 final ContainerNode attributes = entry == null ? null : entry.attributes();
 250                 final PeerId peerId = key.getPeerId();
 251                 final ContainerNode effectiveAttributes = peerGroup.effectiveAttributes(peerId, attributes);
 252                 for (final Entry<PeerId, YangInstanceIdentifier> pid : peerGroup.getPeers()) {
 253                     final YangInstanceIdentifier routeTarget = this.ribSupport.routePath(pid.getValue().node(AdjRibOut.QNAME).node(Tables.QNAME).node(this.tableKey).node(ROUTES_IDENTIFIER), key.getRouteId());
 254                     if (effectiveAttributes != null && value != null && !peerId.equals(pid.getKey())) {
 255                         LOG.debug("Write route {} to peers AdjRibsOut {}", value, pid.getKey());
 256                         tx.put(LogicalDatastoreType.OPERATIONAL, routeTarget, value);
 257                         tx.put(LogicalDatastoreType.OPERATIONAL, routeTarget.node(this.attributesIdentifier), effectiveAttributes);
 258                     } else {
 259                         LOG.trace("Removing {} from transaction for peer {}", routeTarget, pid.getKey());
 260                         tx.delete(LogicalDatastoreType.OPERATIONAL, routeTarget);
 261                     }
 262                 }
 263             }
 264         }
 265     }
 266 }