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