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.Collection;
  13 import java.util.Collections;
  14 import java.util.List;
  15 import java.util.Optional;
  16 import java.util.concurrent.atomic.LongAdder;
  17 import java.util.stream.Collectors;
  18 import javax.annotation.Nonnull;
  19 import javax.annotation.concurrent.NotThreadSafe;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
  24 import org.opendaylight.protocol.bgp.rib.impl.spi.Codecs;
  25 import org.opendaylight.protocol.bgp.rib.impl.spi.CodecsRegistry;
  26 import org.opendaylight.protocol.bgp.rib.impl.state.peer.PrefixesSentCounters;
  27 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
  28 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  29 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Update;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.UpdateBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.Nlri;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.NlriBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.WithdrawnRoutes;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.WithdrawnRoutesBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerId;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.Peer;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.peer.AdjRibOut;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  45 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  46 import org.opendaylight.yangtools.yang.common.QName;
  47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  49 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  51 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  53 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  54 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 /**
  59  * Instantiated for each peer and table, listens on a particular peer's adj-rib-out,
  60  * performs transcoding to BA form (message) and sends it down the channel.
  61  */
  62 @NotThreadSafe
  63 final class AdjRibOutListener implements ClusteredDOMDataTreeChangeListener, PrefixesSentCounters {
  64
  65     private static final Logger LOG = LoggerFactory.getLogger(AdjRibOutListener.class);
  66
  67     private static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
  68     private static final QName PATHID_QNAME = QName.create(Ipv4Route.QNAME, "path-id").intern();
  69     private final YangInstanceIdentifier.NodeIdentifier routeKeyPrefixLeaf = new YangInstanceIdentifier
  70             .NodeIdentifier(PREFIX_QNAME);
  71     private final YangInstanceIdentifier.NodeIdentifier routeKeyPathIdLeaf = new YangInstanceIdentifier
  72             .NodeIdentifier(PATHID_QNAME);
  73
  74     private final ChannelOutputLimiter session;
  75     private final Codecs codecs;
  76     private final RIBSupport<?, ?, ?, ?> support;
  77     private final boolean mpSupport;
  78     private final ListenerRegistration<AdjRibOutListener> registerDataTreeChangeListener;
  79     private final LongAdder prefixesSentCounter = new LongAdder();
  80     private final TablesKey tablesKey;
  81     private boolean initalState;
  82
  83     private AdjRibOutListener(final PeerId peerId, final TablesKey tablesKey, final YangInstanceIdentifier ribId,
  84             final CodecsRegistry registry, final RIBSupport<?, ?, ?, ?> support, final DOMDataTreeChangeService service,
  85             final ChannelOutputLimiter session, final boolean mpSupport) {
  86         this.session = requireNonNull(session);
  87         this.support = requireNonNull(support);
  88         this.codecs = registry.getCodecs(this.support);
  89         this.mpSupport = mpSupport;
  90         this.tablesKey = requireNonNull(tablesKey);
  91         final YangInstanceIdentifier adjRibOutId = ribId.node(Peer.QNAME).node(IdentifierUtils.domPeerId(peerId))
  92                 .node(AdjRibOut.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(tablesKey));
  93         /*
  94          *  After listener registration should always be executed ODTC. Even when empty table is present
  95          *  in data store. Within this first ODTC execution we should advertise present routes and than
  96          *  send EOR marker. initialState flag is distinguishing between first ODTC execution and the rest.
  97          */
  98         this.initalState = true;
  99         this.registerDataTreeChangeListener = service.registerDataTreeChangeListener(
 100                 new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, adjRibOutId), this);
 101     }
 102
 103     static AdjRibOutListener create(
 104             @Nonnull final PeerId peerId,
 105             @Nonnull final TablesKey tablesKey,
 106             @Nonnull final YangInstanceIdentifier ribId,
 107             @Nonnull final CodecsRegistry registry,
 108             @Nonnull final RIBSupport<?, ?, ?, ?> support,
 109             @Nonnull final DOMDataTreeChangeService service,
 110             @Nonnull final ChannelOutputLimiter session,
 111             final boolean mpSupport) {
 112         return new AdjRibOutListener(peerId, tablesKey, ribId, registry, support, service, session, mpSupport);
 113     }
 114
 115     @Override
 116     public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
 117         LOG.debug("Data change received for AdjRibOut {}", changes);
 118         for (final DataTreeCandidate tc : changes) {
 119             LOG.trace("Change {} type {}", tc.getRootNode(), tc.getRootNode().getModificationType());
 120             for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
 121                 processSupportedFamilyRoutes(child);
 122             }
 123         }
 124         if (initalState) {
 125             final Update endOfRib = BgpPeerUtil.createEndOfRib(this.tablesKey);
 126             this.session.write(endOfRib);
 127             this.initalState = false;
 128         }
 129         this.session.flush();
 130     }
 131
 132     private void processSupportedFamilyRoutes(final DataTreeCandidateNode child) {
 133         final Collection<DataTreeCandidateNode> changedRoutes = this.support.changedRoutes(child);
 134         for (final DataTreeCandidateNode route : changedRoutes) {
 135             processRouteChange(route);
 136         }
 137     }
 138
 139     private void processRouteChange(final DataTreeCandidateNode route) {
 140         final Update update;
 141         switch (route.getModificationType()) {
 142             case UNMODIFIED:
 143                 LOG.debug("Skipping unmodified route {}", route.getIdentifier());
 144                 return;
 145             case DELETE:
 146             case DISAPPEARED:
 147                 // FIXME: we can batch deletions into a single batch
 148                 update = withdraw((MapEntryNode) route.getDataBefore().get());
 149                 LOG.debug("Withdrawing routes {}", update);
 150                 break;
 151             case APPEARED:
 152             case SUBTREE_MODIFIED:
 153             case WRITE:
 154                 update = advertise((MapEntryNode) route.getDataAfter().get());
 155                 LOG.debug("Advertising routes {}", update);
 156                 break;
 157             default:
 158                 LOG.warn("Ignoring unhandled modification type {}", route.getModificationType());
 159                 return;
 160         }
 161         this.session.write(update);
 162     }
 163
 164     private Attributes routeAttributes(final MapEntryNode route) {
 165         if (LOG.isDebugEnabled()) {
 166             LOG.debug("AdjRibOut parsing route {}", NormalizedNodes.toStringTree(route));
 167         }
 168         final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(route,
 169                 this.support.routeAttributesIdentifier()).orElse(null);
 170         return this.codecs.deserializeAttributes(advertisedAttrs);
 171     }
 172
 173     private Update withdraw(final MapEntryNode route) {
 174         if (!this.mpSupport) {
 175             return buildUpdate(Collections.emptyList(), Collections.singleton(route), routeAttributes(route));
 176         }
 177         return this.support.buildUpdate(Collections.emptyList(), Collections.singleton(route), routeAttributes(route));
 178     }
 179
 180     private Update advertise(final MapEntryNode route) {
 181         this.prefixesSentCounter.increment();
 182         if (!this.mpSupport) {
 183             return buildUpdate(Collections.singleton(route), Collections.emptyList(), routeAttributes(route));
 184         }
 185         return this.support.buildUpdate(Collections.singleton(route), Collections.emptyList(), routeAttributes(route));
 186     }
 187
 188     private Update buildUpdate(
 189             @Nonnull final Collection<MapEntryNode> advertised,
 190             @Nonnull final Collection<MapEntryNode> withdrawn,
 191             @Nonnull final Attributes attr) {
 192         final UpdateBuilder ub = new UpdateBuilder().setWithdrawnRoutes(extractWithdrawnRoutes(withdrawn))
 193                 .setNlri(extractNlris(advertised));
 194         ub.setAttributes(attr);
 195         return ub.build();
 196     }
 197
 198     private List<Nlri> extractNlris(final Collection<MapEntryNode> routes) {
 199         return routes.stream().map(ipv4Route -> new NlriBuilder().setPrefix(new Ipv4Prefix(extractPrefix(ipv4Route)))
 200                 .setPathId(extractPathId(ipv4Route)).build()).collect(Collectors.toList());
 201     }
 202
 203     private List<WithdrawnRoutes> extractWithdrawnRoutes(final Collection<MapEntryNode> routes) {
 204         return routes.stream().map(ipv4Route -> new WithdrawnRoutesBuilder()
 205                 .setPrefix(new Ipv4Prefix(extractPrefix(ipv4Route))).setPathId(extractPathId(ipv4Route)).build())
 206                 .collect(Collectors.toList());
 207     }
 208
 209     private String extractPrefix(final MapEntryNode ipv4Route) {
 210         return (String) ipv4Route.getChild(this.routeKeyPrefixLeaf).get().getValue();
 211     }
 212
 213     private PathId extractPathId(final MapEntryNode ipv4Route) {
 214         final Optional<DataContainerChild<? extends PathArgument, ?>> pathId = ipv4Route
 215                 .getChild(this.routeKeyPathIdLeaf);
 216         return pathId.map(dataContainerChild -> new PathId((Long) dataContainerChild.getValue())).orElse(null);
 217     }
 218
 219     public void close() {
 220         this.registerDataTreeChangeListener.close();
 221     }
 222
 223     boolean isMpSupported() {
 224         return this.mpSupport;
 225     }
 226
 227     @Override
 228     public long getPrefixesSentCount() {
 229         return this.prefixesSentCounter.longValue();
 230     }
 231 }