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