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