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 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.ClusteredDOMDataTreeChangeListener;
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.Codecs;
22 import org.opendaylight.protocol.bgp.rib.impl.spi.CodecsRegistry;
23 import org.opendaylight.protocol.bgp.rib.impl.stats.UnsignedInt32Counter;
24 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
25 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
26 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.NlriBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.WithdrawnRoutesBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibOut;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
39 import org.opendaylight.yangtools.concepts.ListenerRegistration;
40 import org.opendaylight.yangtools.yang.common.QName;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
43 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
45 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
46 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
51 * Instantiated for each peer and table, listens on a particular peer's adj-rib-out,
52 * performs transcoding to BA form (message) and sends it down the channel.
55 final class AdjRibOutListener implements ClusteredDOMDataTreeChangeListener {
57 private static final Logger LOG = LoggerFactory.getLogger(AdjRibOutListener.class);
59 static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
60 private final YangInstanceIdentifier.NodeIdentifier routeKeyLeaf = new YangInstanceIdentifier.NodeIdentifier(PREFIX_QNAME);
62 private final ChannelOutputLimiter session;
63 private final Codecs codecs;
64 private final RIBSupport support;
65 private final boolean mpSupport;
66 private final ListenerRegistration<AdjRibOutListener> registerDataTreeChangeListener;
67 private final UnsignedInt32Counter routeCounter;
69 private AdjRibOutListener(final PeerId peerId, final TablesKey tablesKey, final YangInstanceIdentifier ribId,
70 final CodecsRegistry registry, final RIBSupport support, final DOMDataTreeChangeService service,
71 final ChannelOutputLimiter session, final boolean mpSupport, final UnsignedInt32Counter routeCounter) {
72 this.session = Preconditions.checkNotNull(session);
73 this.support = Preconditions.checkNotNull(support);
74 this.codecs = registry.getCodecs(this.support);
75 this.mpSupport = mpSupport;
76 final YangInstanceIdentifier adjRibOutId = ribId.node(Peer.QNAME).node(IdentifierUtils.domPeerId(peerId)).node(AdjRibOut.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(tablesKey));
77 this.registerDataTreeChangeListener = service.registerDataTreeChangeListener(new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, adjRibOutId), this);
78 this.routeCounter = routeCounter;
81 static AdjRibOutListener create(@Nonnull final PeerId peerId, @Nonnull final TablesKey tablesKey, @Nonnull final YangInstanceIdentifier ribId,
82 @Nonnull final CodecsRegistry registry, @Nonnull final RIBSupport support, @Nonnull final DOMDataTreeChangeService service,
83 @Nonnull final ChannelOutputLimiter session, @Nonnull final boolean mpSupport, @Nonnull final UnsignedInt32Counter routeCounter
85 return new AdjRibOutListener(peerId, tablesKey, ribId, registry, support, service, session, mpSupport, routeCounter);
89 public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
90 LOG.debug("Data change received for AdjRibOut {}", changes);
91 for (final DataTreeCandidate tc : changes) {
92 LOG.trace("Change {} type {}", tc.getRootNode(), tc.getRootNode().getModificationType());
93 for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
94 processSupportedFamilyRoutes(child);
100 private void processSupportedFamilyRoutes(final DataTreeCandidateNode child) {
101 for (final DataTreeCandidateNode route : this.support.changedRoutes(child)) {
102 processRouteChange(route);
106 private void processRouteChange(final DataTreeCandidateNode route) {
108 switch (route.getModificationType()) {
110 LOG.debug("Skipping unmodified route {}", route.getIdentifier());
114 // FIXME: we can batch deletions into a single batch
115 update = withdraw((MapEntryNode) route.getDataBefore().get());
116 LOG.debug("Withdrawing routes {}", update);
119 case SUBTREE_MODIFIED:
121 update = advertise((MapEntryNode) route.getDataAfter().get());
122 LOG.debug("Advertising routes {}", update);
125 LOG.warn("Ignoring unhandled modification type {}", route.getModificationType());
128 this.session.write(update);
131 private Attributes routeAttributes(final MapEntryNode route) {
132 if (LOG.isDebugEnabled()) {
133 LOG.debug("AdjRibOut parsing route {}", NormalizedNodes.toStringTree(route));
135 final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(route, this.support.routeAttributesIdentifier()).orNull();
136 return this.codecs.deserializeAttributes(advertisedAttrs);
139 private Update withdraw(final MapEntryNode route) {
140 this.routeCounter.decreaseCount();
141 if (!this.mpSupport) {
142 return buildUpdate(Collections.<MapEntryNode>emptyList(), Collections.singleton(route), routeAttributes(route));
144 return this.support.buildUpdate(Collections.<MapEntryNode>emptyList(), Collections.singleton(route), routeAttributes(route));
147 private Update advertise(final MapEntryNode route) {
148 this.routeCounter.increaseCount();
149 if (!this.mpSupport) {
150 return buildUpdate(Collections.singleton(route), Collections.<MapEntryNode>emptyList(), routeAttributes(route));
152 return this.support.buildUpdate(Collections.singleton(route), Collections.<MapEntryNode>emptyList(), routeAttributes(route));
155 private Update buildUpdate(@Nonnull final Collection<MapEntryNode> advertised, @Nonnull final Collection<MapEntryNode> withdrawn, @Nonnull final Attributes attr) {
156 final UpdateBuilder ub = new UpdateBuilder()
157 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setWithdrawnRoutes(extractPrefixes(withdrawn)).build())
158 .setNlri(new NlriBuilder().setNlri(extractPrefixes(advertised)).build());
159 ub.setAttributes(attr);
163 private List<Ipv4Prefix> extractPrefixes(final Collection<MapEntryNode> routes) {
164 final List<Ipv4Prefix> prefs = new ArrayList<>(routes.size());
165 for (final MapEntryNode ipv4Route : routes) {
166 final String prefix = (String) ipv4Route.getChild(this.routeKeyLeaf).get().getValue();
167 prefs.add(new Ipv4Prefix(prefix));
172 public void close() {
173 this.registerDataTreeChangeListener.close();
176 boolean isMpSupported() {
177 return this.mpSupport;