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.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;
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.
57 final class AdjRibOutListener implements ClusteredDOMDataTreeChangeListener, PrefixesSentCounters {
59 private static final Logger LOG = LoggerFactory.getLogger(AdjRibOutListener.class);
61 static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
62 private final YangInstanceIdentifier.NodeIdentifier routeKeyLeaf = new YangInstanceIdentifier.NodeIdentifier(PREFIX_QNAME);
64 private final ChannelOutputLimiter session;
65 private final Codecs codecs;
66 private final RIBSupport support;
67 private final boolean mpSupport;
68 private final ListenerRegistration<AdjRibOutListener> registerDataTreeChangeListener;
69 private final LongAdder routeCounter;
70 private final LongAdder prefixesSentCounter = new LongAdder();
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, final LongAdder routeCounter) {
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)).node(AdjRibOut.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(tablesKey));
80 this.registerDataTreeChangeListener = service.registerDataTreeChangeListener(new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, adjRibOutId), this);
81 this.routeCounter = routeCounter;
84 static AdjRibOutListener create(@Nonnull final PeerId peerId, @Nonnull final TablesKey tablesKey, @Nonnull final YangInstanceIdentifier ribId,
85 @Nonnull final CodecsRegistry registry, @Nonnull final RIBSupport support, @Nonnull final DOMDataTreeChangeService service,
86 @Nonnull final ChannelOutputLimiter session, final boolean mpSupport, @Nonnull final LongAdder routeCounter
88 return new AdjRibOutListener(peerId, tablesKey, ribId, registry, support, service, session, mpSupport, routeCounter);
92 public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
93 LOG.debug("Data change received for AdjRibOut {}", changes);
94 for (final DataTreeCandidate tc : changes) {
95 LOG.trace("Change {} type {}", tc.getRootNode(), tc.getRootNode().getModificationType());
96 for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
97 processSupportedFamilyRoutes(child);
100 this.session.flush();
103 private void processSupportedFamilyRoutes(final DataTreeCandidateNode child) {
104 for (final DataTreeCandidateNode route : this.support.changedRoutes(child)) {
105 processRouteChange(route);
109 private void processRouteChange(final DataTreeCandidateNode route) {
111 switch (route.getModificationType()) {
113 LOG.debug("Skipping unmodified route {}", route.getIdentifier());
117 // FIXME: we can batch deletions into a single batch
118 update = withdraw((MapEntryNode) route.getDataBefore().get());
119 LOG.debug("Withdrawing routes {}", update);
122 case SUBTREE_MODIFIED:
124 update = advertise((MapEntryNode) route.getDataAfter().get());
125 LOG.debug("Advertising routes {}", update);
128 LOG.warn("Ignoring unhandled modification type {}", route.getModificationType());
131 this.session.write(update);
134 private Attributes routeAttributes(final MapEntryNode route) {
135 if (LOG.isDebugEnabled()) {
136 LOG.debug("AdjRibOut parsing route {}", NormalizedNodes.toStringTree(route));
138 final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(route, this.support.routeAttributesIdentifier()).orNull();
139 return this.codecs.deserializeAttributes(advertisedAttrs);
142 private Update withdraw(final MapEntryNode route) {
143 this.routeCounter.decrement();
144 if (!this.mpSupport) {
145 return buildUpdate(Collections.emptyList(), Collections.singleton(route), routeAttributes(route));
147 return this.support.buildUpdate(Collections.emptyList(), Collections.singleton(route), routeAttributes(route));
150 private Update advertise(final MapEntryNode route) {
151 this.routeCounter.increment();
152 this.prefixesSentCounter.increment();
153 if (!this.mpSupport) {
154 return buildUpdate(Collections.singleton(route), Collections.emptyList(), routeAttributes(route));
156 return this.support.buildUpdate(Collections.singleton(route), Collections.emptyList(), routeAttributes(route));
159 private Update buildUpdate(@Nonnull final Collection<MapEntryNode> advertised, @Nonnull final Collection<MapEntryNode> withdrawn, @Nonnull final Attributes attr) {
160 final UpdateBuilder ub = new UpdateBuilder()
161 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setWithdrawnRoutes(extractPrefixes(withdrawn)).build())
162 .setNlri(new NlriBuilder().setNlri(extractPrefixes(advertised)).build());
163 ub.setAttributes(attr);
167 private List<Ipv4Prefix> extractPrefixes(final Collection<MapEntryNode> routes) {
168 final List<Ipv4Prefix> prefs = new ArrayList<>(routes.size());
169 for (final MapEntryNode ipv4Route : routes) {
170 final String prefix = (String) ipv4Route.getChild(this.routeKeyLeaf).get().getValue();
171 prefs.add(new Ipv4Prefix(prefix));
176 public void close() {
177 this.registerDataTreeChangeListener.close();
180 boolean isMpSupported() {
181 return this.mpSupport;
185 public long getPrefixesSentCount() {
186 return this.prefixesSentCounter.longValue();