bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/AdjRibOutListener.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 java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Collections;
  14 import java.util.List;
  15 import javax.annotation.Nonnull;
  16 import javax.annotation.concurrent.NotThreadSafe;
  17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
  21 import org.opendaylight.protocol.bgp.rib.impl.spi.Codecs;
  22 import org.opendaylight.protocol.bgp.rib.impl.spi.CodecsRegistry;
  23 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  24 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.NlriBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.WithdrawnRoutesBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibOut;
  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.yangtools.yang.common.QName;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  42 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  43 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * Instantiated for each peer and table, listens on a particular peer's adj-rib-out,
  49  * performs transcoding to BA form (message) and sends it down the channel.
  50  */
  51 @NotThreadSafe
  52 final class AdjRibOutListener implements DOMDataTreeChangeListener {
  53
  54     private static final Logger LOG = LoggerFactory.getLogger(AdjRibOutListener.class);
  55
  56     static final QName PREFIX_QNAME = QName.cachedReference(QName.create(Ipv4Route.QNAME, "prefix"));
  57     private final YangInstanceIdentifier.NodeIdentifier routeKeyLeaf = new YangInstanceIdentifier.NodeIdentifier(PREFIX_QNAME);
  58
  59     private final ChannelOutputLimiter session;
  60     private final Codecs codecs;
  61     private final RIBSupport support;
  62     private final boolean mpSupport;
  63
  64     private AdjRibOutListener(final PeerId peerId, final TablesKey tablesKey, final YangInstanceIdentifier ribId,
  65         final CodecsRegistry registry, final RIBSupport support, final DOMDataTreeChangeService service,
  66         final ChannelOutputLimiter session, final boolean mpSupport) {
  67         this.session = Preconditions.checkNotNull(session);
  68         this.support = Preconditions.checkNotNull(support);
  69         this.codecs = registry.getCodecs(this.support);
  70         this.mpSupport = mpSupport;
  71         final YangInstanceIdentifier adjRibOutId =  ribId.node(Peer.QNAME).node(IdentifierUtils.domPeerId(peerId)).node(AdjRibOut.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(tablesKey));
  72         service.registerDataTreeChangeListener(new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, adjRibOutId), this);
  73     }
  74
  75     static AdjRibOutListener create(@Nonnull final PeerId peerId, @Nonnull final TablesKey tablesKey, @Nonnull final YangInstanceIdentifier ribId, @Nonnull final CodecsRegistry registry, @Nonnull final RIBSupport support, @Nonnull final DOMDataTreeChangeService service, @Nonnull final ChannelOutputLimiter session, @Nonnull final boolean mpSupport) {
  76         return new AdjRibOutListener(peerId, tablesKey, ribId, registry, support, service, session, mpSupport);
  77     }
  78
  79     @Override
  80     public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
  81         LOG.debug("Data change received for AdjRibOut {}", changes);
  82         for (final DataTreeCandidate tc : changes) {
  83             LOG.trace("Change {} type {}", tc.getRootNode(), tc.getRootNode().getModificationType());
  84             for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
  85                 for (final DataTreeCandidateNode route : this.support.changedRoutes(child)) {
  86                     final Update update;
  87
  88                     switch (route.getModificationType()) {
  89                     case UNMODIFIED:
  90                         LOG.debug("Skipping unmodified route {}", route.getIdentifier());
  91                         continue;
  92                     case DELETE:
  93                     case DISAPPEARED:
  94                         // FIXME: we can batch deletions into a single batch
  95                         update = withdraw((MapEntryNode) route.getDataBefore().get());
  96                         break;
  97                     case APPEARED:
  98                     case SUBTREE_MODIFIED:
  99                     case WRITE:
 100                         update = advertise((MapEntryNode) route.getDataAfter().get());
 101                         break;
 102                     default:
 103                         LOG.warn("Ignoring unhandled modification type {}", route.getModificationType());
 104                         continue;
 105                     }
 106
 107                     LOG.debug("Writing update {}", update);
 108                     this.session.write(update);
 109                 }
 110             }
 111         }
 112         this.session.flush();
 113     }
 114
 115     private Attributes routeAttributes(final MapEntryNode route) {
 116         if (LOG.isDebugEnabled()) {
 117             LOG.debug("AdjRibOut parsing route {}", NormalizedNodes.toStringTree(route));
 118         }
 119         final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(route, this.support.routeAttributesIdentifier()).orNull();
 120         return this.codecs.deserializeAttributes(advertisedAttrs);
 121     }
 122
 123     private Update withdraw(final MapEntryNode route) {
 124         return this.support.buildUpdate(Collections.<MapEntryNode>emptyList(), Collections.singleton(route), routeAttributes(route));
 125     }
 126
 127     private Update advertise(final MapEntryNode route) {
 128         if (!this.mpSupport) {
 129             return buildUpdate(Collections.singleton(route), Collections.<MapEntryNode>emptyList(), routeAttributes(route));
 130         }
 131         return this.support.buildUpdate(Collections.singleton(route), Collections.<MapEntryNode>emptyList(), routeAttributes(route));
 132     }
 133
 134     private Update buildUpdate(@Nonnull final Collection<MapEntryNode> advertised, @Nonnull final Collection<MapEntryNode> withdrawn, @Nonnull final Attributes attr) {
 135         final UpdateBuilder ub = new UpdateBuilder()
 136             .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setWithdrawnRoutes(extractPrefixes(withdrawn)).build())
 137             .setNlri(new NlriBuilder().setNlri(extractPrefixes(advertised)).build());
 138         ub.setAttributes(attr);
 139         return ub.build();
 140     }
 141
 142     private List<Ipv4Prefix> extractPrefixes(final Collection<MapEntryNode> routes) {
 143         final List<Ipv4Prefix> prefs = new ArrayList<>(routes.size());
 144         for (final MapEntryNode ipv4Route : routes) {
 145             final String prefix = (String) ipv4Route.getChild(this.routeKeyLeaf).get().getValue();
 146             prefs.add(new Ipv4Prefix(prefix));
 147         }
 148         return prefs;
 149     }
 150 }