2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.protocol.bgp.rib.impl;
10 import static java.util.Objects.requireNonNull;
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.rev171207.PathId;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Update;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.UpdateBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.Attributes;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.update.message.Nlri;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.update.message.NlriBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.update.message.WithdrawnRoutes;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.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;
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.
63 final class AdjRibOutListener implements ClusteredDOMDataTreeChangeListener, PrefixesSentCounters {
65 private static final Logger LOG = LoggerFactory.getLogger(AdjRibOutListener.class);
67 static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
68 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);
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();
81 private AdjRibOutListener(final PeerId peerId, final TablesKey tablesKey, final YangInstanceIdentifier ribId,
82 final CodecsRegistry registry, final RIBSupport support, final DOMDataTreeChangeService service,
83 final ChannelOutputLimiter session, final boolean mpSupport) {
84 this.session = requireNonNull(session);
85 this.support = requireNonNull(support);
86 this.codecs = registry.getCodecs(this.support);
87 this.mpSupport = mpSupport;
88 final YangInstanceIdentifier adjRibOutId = ribId.node(Peer.QNAME).node(IdentifierUtils.domPeerId(peerId))
89 .node(AdjRibOut.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(tablesKey));
90 this.registerDataTreeChangeListener = service.registerDataTreeChangeListener(
91 new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, adjRibOutId), this);
94 static AdjRibOutListener create(
95 @Nonnull final PeerId peerId,
96 @Nonnull final TablesKey tablesKey,
97 @Nonnull final YangInstanceIdentifier ribId,
98 @Nonnull final CodecsRegistry registry,
99 @Nonnull final RIBSupport support,
100 @Nonnull final DOMDataTreeChangeService service,
101 @Nonnull final ChannelOutputLimiter session,
102 final boolean mpSupport) {
103 return new AdjRibOutListener(peerId, tablesKey, ribId, registry, support, service, session, mpSupport);
107 public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
108 LOG.debug("Data change received for AdjRibOut {}", changes);
109 for (final DataTreeCandidate tc : changes) {
110 LOG.trace("Change {} type {}", tc.getRootNode(), tc.getRootNode().getModificationType());
111 for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
112 processSupportedFamilyRoutes(child);
115 this.session.flush();
118 private void processSupportedFamilyRoutes(final DataTreeCandidateNode child) {
119 final Collection<DataTreeCandidateNode> changedRoutes = this.support.changedRoutes(child);
120 for (final DataTreeCandidateNode route : changedRoutes) {
121 processRouteChange(route);
125 private void processRouteChange(final DataTreeCandidateNode route) {
127 switch (route.getModificationType()) {
129 LOG.debug("Skipping unmodified route {}", route.getIdentifier());
133 // FIXME: we can batch deletions into a single batch
134 update = withdraw((MapEntryNode) route.getDataBefore().get());
135 LOG.debug("Withdrawing routes {}", update);
138 case SUBTREE_MODIFIED:
140 update = advertise((MapEntryNode) route.getDataAfter().get());
141 LOG.debug("Advertising routes {}", update);
144 LOG.warn("Ignoring unhandled modification type {}", route.getModificationType());
147 this.session.write(update);
150 private Attributes routeAttributes(final MapEntryNode route) {
151 if (LOG.isDebugEnabled()) {
152 LOG.debug("AdjRibOut parsing route {}", NormalizedNodes.toStringTree(route));
154 final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(route,
155 this.support.routeAttributesIdentifier()).orElse(null);
156 return this.codecs.deserializeAttributes(advertisedAttrs);
159 private Update withdraw(final MapEntryNode route) {
160 if (!this.mpSupport) {
161 return buildUpdate(Collections.emptyList(), Collections.singleton(route), routeAttributes(route));
163 return this.support.buildUpdate(Collections.emptyList(), Collections.singleton(route), routeAttributes(route));
166 private Update advertise(final MapEntryNode route) {
167 this.prefixesSentCounter.increment();
168 if (!this.mpSupport) {
169 return buildUpdate(Collections.singleton(route), Collections.emptyList(), routeAttributes(route));
171 return this.support.buildUpdate(Collections.singleton(route), Collections.emptyList(), routeAttributes(route));
174 private Update buildUpdate(
175 @Nonnull final Collection<MapEntryNode> advertised,
176 @Nonnull final Collection<MapEntryNode> withdrawn,
177 @Nonnull final Attributes attr) {
178 final UpdateBuilder ub = new UpdateBuilder().setWithdrawnRoutes(extractWithdrawnRoutes(withdrawn))
179 .setNlri(extractNlris(advertised));
180 ub.setAttributes(attr);
184 private List<Nlri> extractNlris(final Collection<MapEntryNode> routes) {
185 return routes.stream().map(ipv4Route -> new NlriBuilder().setPrefix(new Ipv4Prefix(extractPrefix(ipv4Route)))
186 .setPathId(extractPathId(ipv4Route)).build()).collect(Collectors.toList());
189 private List<WithdrawnRoutes> extractWithdrawnRoutes(final Collection<MapEntryNode> routes) {
190 return routes.stream().map(ipv4Route -> new WithdrawnRoutesBuilder()
191 .setPrefix(new Ipv4Prefix(extractPrefix(ipv4Route))).setPathId(extractPathId(ipv4Route)).build())
192 .collect(Collectors.toList());
195 private String extractPrefix(final MapEntryNode ipv4Route) {
196 return (String) ipv4Route.getChild(this.routeKeyPrefixLeaf).get().getValue();
199 private PathId extractPathId(final MapEntryNode ipv4Route) {
200 final Optional<DataContainerChild<? extends PathArgument, ?>> pathId = ipv4Route
201 .getChild(this.routeKeyPathIdLeaf);
202 return pathId.map(dataContainerChild -> new PathId((Long) dataContainerChild.getValue())).orElse(null);
205 public void close() {
206 this.registerDataTreeChangeListener.close();
209 boolean isMpSupported() {
210 return this.mpSupport;
214 public long getPrefixesSentCount() {
215 return this.prefixesSentCounter.longValue();