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.annotations.VisibleForTesting;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableMap;
13 import com.google.common.collect.ImmutableMap.Builder;
14 import com.google.common.util.concurrent.CheckedFuture;
15 import com.google.common.util.concurrent.FutureCallback;
16 import com.google.common.util.concurrent.Futures;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import java.util.Collections;
20 import java.util.Map.Entry;
21 import java.util.Optional;
23 import javax.annotation.Nonnull;
24 import javax.annotation.Nullable;
25 import javax.annotation.concurrent.NotThreadSafe;
26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
27 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
29 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
30 import org.opendaylight.protocol.bgp.rib.impl.ApplicationPeer.RegisterAppPeerListener;
31 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext;
32 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
33 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
34 import org.opendaylight.protocol.bgp.rib.spi.PeerRoleUtil;
35 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.SendReceive;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.SimpleRoutingPolicy;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibOut;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.EffectiveRibIn;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.SupportedTables;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Attributes;
50 import org.opendaylight.yangtools.yang.common.QName;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.InstanceIdentifierBuilder;
53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
55 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
56 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
57 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
58 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
59 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
60 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
61 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
62 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
63 import org.slf4j.Logger;
64 import org.slf4j.LoggerFactory;
66 * Writer of Adjacency-RIB-In for a single peer. An instance of this object
67 * is attached to each {@link BGPPeer} and {@link ApplicationPeer}.
70 final class AdjRibInWriter {
71 private static final Logger LOG = LoggerFactory.getLogger(AdjRibInWriter.class);
73 static final LeafNode<Boolean> ATTRIBUTES_UPTODATE_FALSE = ImmutableNodes.leafNode(QName.create(Attributes.QNAME, "uptodate"), Boolean.FALSE);
74 private static final LeafNode<Boolean> ATTRIBUTES_UPTODATE_TRUE = ImmutableNodes.leafNode(ATTRIBUTES_UPTODATE_FALSE.getNodeType(), Boolean.TRUE);
76 static final QName PEER_ID_QNAME = QName.create(Peer.QNAME, "peer-id").intern();
77 private static final QName PEER_ROLE_QNAME = QName.create(Peer.QNAME, "peer-role").intern();
78 private static final NodeIdentifier ADJRIBIN = new NodeIdentifier(AdjRibIn.QNAME);
79 private static final NodeIdentifier ADJRIBOUT = new NodeIdentifier(AdjRibOut.QNAME);
80 private static final NodeIdentifier EFFRIBIN = new NodeIdentifier(EffectiveRibIn.QNAME);
81 private static final NodeIdentifier PEER_ID = new NodeIdentifier(PEER_ID_QNAME);
82 private static final NodeIdentifier PEER_ROLE = new NodeIdentifier(PEER_ROLE_QNAME);
83 private static final NodeIdentifier PEER_TABLES = new NodeIdentifier(SupportedTables.QNAME);
84 private static final NodeIdentifier TABLES = new NodeIdentifier(Tables.QNAME);
85 private static final QName SEND_RECEIVE = QName.create(SupportedTables.QNAME, "send-receive").intern();
86 private static final NodeIdentifier SIMPLE_ROUTING_POLICY_NID = new NodeIdentifier(QName.create(Peer.QNAME, "simple-routing-policy").intern());
88 // FIXME: is there a utility method to construct this?
89 private static final ContainerNode EMPTY_ADJRIBIN = Builders.containerBuilder().withNodeIdentifier(ADJRIBIN).addChild(ImmutableNodes.mapNodeBuilder(Tables.QNAME).build()).build();
90 private static final ContainerNode EMPTY_EFFRIBIN = Builders.containerBuilder().withNodeIdentifier(EFFRIBIN).addChild(ImmutableNodes.mapNodeBuilder(Tables.QNAME).build()).build();
91 private static final ContainerNode EMPTY_ADJRIBOUT = Builders.containerBuilder().withNodeIdentifier(ADJRIBOUT).addChild(ImmutableNodes.mapNodeBuilder(Tables.QNAME).build()).build();
93 private final Map<TablesKey, TableContext> tables;
94 private final YangInstanceIdentifier peerPath;
95 private final YangInstanceIdentifier ribPath;
96 private final DOMTransactionChain chain;
97 private final PeerRole role;
98 private final Optional<SimpleRoutingPolicy> simpleRoutingPolicy;
100 private AdjRibInWriter(final YangInstanceIdentifier ribPath, final DOMTransactionChain chain, final PeerRole role,
101 final Optional<SimpleRoutingPolicy> simpleRoutingPolicy, final YangInstanceIdentifier peerPath, final Map<TablesKey, TableContext> tables) {
102 this.ribPath = Preconditions.checkNotNull(ribPath);
103 this.chain = Preconditions.checkNotNull(chain);
104 this.tables = Preconditions.checkNotNull(tables);
105 this.role = Preconditions.checkNotNull(role);
106 this.simpleRoutingPolicy = simpleRoutingPolicy;
107 this.peerPath = peerPath;
111 * Create a new writer using a transaction chain.
113 * @param role peer's role
114 * @param simpleRoutingPolicy simple Routing Policy {@link SimpleRoutingPolicy}
115 *@param chain transaction chain @return A fresh writer instance
117 static AdjRibInWriter create(@Nonnull final YangInstanceIdentifier ribId, @Nonnull final PeerRole role,
118 final Optional<SimpleRoutingPolicy> simpleRoutingPolicy, @Nonnull final DOMTransactionChain chain) {
119 return new AdjRibInWriter(ribId, chain, role, simpleRoutingPolicy, null, Collections.emptyMap());
123 * Transform this writer to a new writer, which is in charge of specified tables.
124 * Empty tables are created for new entries and old tables are deleted. Once this
125 * method returns, the old instance must not be reasonably used.
127 * @param newPeerId new peer BGP identifier
128 * @param registry RIB extension registry
129 * @param tableTypes New tables, must not be null
130 * @param addPathTablesType
133 AdjRibInWriter transform(final PeerId newPeerId, final RIBSupportContextRegistry registry,
134 final Set<TablesKey> tableTypes, final Map<TablesKey, SendReceive> addPathTablesType) {
135 return transform(newPeerId, registry, tableTypes, addPathTablesType, null);
138 AdjRibInWriter transform(final PeerId newPeerId, final RIBSupportContextRegistry registry, final Set<TablesKey> tableTypes,
139 final Map<TablesKey, SendReceive> addPathTablesType, @Nullable final RegisterAppPeerListener registerAppPeerListener) {
140 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
142 final YangInstanceIdentifier newPeerPath;
143 newPeerPath = createEmptyPeerStructure(newPeerId, tx);
144 final ImmutableMap<TablesKey, TableContext> tb = createNewTableInstances(newPeerPath, registry, tableTypes,
145 addPathTablesType, tx);
147 Futures.addCallback(tx.submit(), new FutureCallback<Void>() {
149 public void onSuccess(final Void result) {
150 if(registerAppPeerListener != null) {
151 LOG.trace("Application Peer Listener registered");
152 registerAppPeerListener.register();
157 public void onFailure(final Throwable throwable) {
158 if(registerAppPeerListener != null) {
159 LOG.error("Failed to create Empty Structure, Application Peer Listener won't be registered",
162 LOG.error("Failed to create Empty Structure", throwable);
166 return new AdjRibInWriter(this.ribPath, this.chain, this.role, this.simpleRoutingPolicy, newPeerPath, tb);
170 * Create new table instances, potentially creating their empty entries
174 * @param addPathTablesType
178 private ImmutableMap<TablesKey, TableContext> createNewTableInstances(final YangInstanceIdentifier newPeerPath,
179 final RIBSupportContextRegistry registry, final Set<TablesKey> tableTypes, final Map<TablesKey, SendReceive> addPathTablesType,
180 final DOMDataWriteTransaction tx) {
182 final Builder<TablesKey, TableContext> tb = ImmutableMap.builder();
183 for (final TablesKey tableKey : tableTypes) {
184 final RIBSupportContext rs = registry.getRIBSupportContext(tableKey);
185 // TODO: Use returned value once Instance Identifier builder allows for it.
186 final NodeIdentifierWithPredicates instanceIdentifierKey = RibSupportUtils.toYangTablesKey(tableKey);
188 LOG.warn("No support for table type {}, skipping it", tableKey);
191 installAdjRibsOutTables(newPeerPath, rs, instanceIdentifierKey, tableKey, addPathTablesType.get(tableKey), tx);
192 installAdjRibInTables(newPeerPath, tableKey, rs, instanceIdentifierKey, tx, tb);
197 private void installAdjRibInTables(final YangInstanceIdentifier newPeerPath, final TablesKey tableKey, final RIBSupportContext rs,
198 final NodeIdentifierWithPredicates instanceIdentifierKey, final DOMDataWriteTransaction tx, final Builder<TablesKey, TableContext> tb) {
199 // We will use table keys very often, make sure they are optimized
200 final InstanceIdentifierBuilder idb = YangInstanceIdentifier.builder(newPeerPath.node(EMPTY_ADJRIBIN.getIdentifier()).node(TABLES));
201 idb.nodeWithKey(instanceIdentifierKey.getNodeType(), instanceIdentifierKey.getKeyValues());
203 final TableContext ctx = new TableContext(rs, idb.build());
204 ctx.createEmptyTableStructure(tx);
206 tx.merge(LogicalDatastoreType.OPERATIONAL, ctx.getTableId().node(Attributes.QNAME).node(ATTRIBUTES_UPTODATE_FALSE.getNodeType()), ATTRIBUTES_UPTODATE_FALSE);
207 LOG.debug("Created table instance {}", ctx.getTableId());
208 tb.put(tableKey, ctx);
211 private void installAdjRibsOutTables(final YangInstanceIdentifier newPeerPath, final RIBSupportContext rs,
212 final NodeIdentifierWithPredicates instanceIdentifierKey, final TablesKey tableKey, final SendReceive sendReceive,
213 final DOMDataWriteTransaction tx) {
214 if (!isAnnounceNone(this.simpleRoutingPolicy)) {
215 final NodeIdentifierWithPredicates supTablesKey = RibSupportUtils.toYangKey(SupportedTables.QNAME, tableKey);
216 final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> tt = Builders.mapEntryBuilder().withNodeIdentifier(supTablesKey);
217 for (final Entry<QName, Object> e : supTablesKey.getKeyValues().entrySet()) {
218 tt.withChild(ImmutableNodes.leafNode(e.getKey(), e.getValue()));
220 if(sendReceive != null) {
221 tt.withChild(ImmutableNodes.leafNode(SEND_RECEIVE, sendReceive.toString().toLowerCase()));
223 tx.put(LogicalDatastoreType.OPERATIONAL, newPeerPath.node(PEER_TABLES).node(supTablesKey), tt.build());
224 rs.createEmptyTableStructure(tx, newPeerPath.node(EMPTY_ADJRIBOUT.getIdentifier()).node(TABLES).node(instanceIdentifierKey));
228 private YangInstanceIdentifier createEmptyPeerStructure(final PeerId newPeerId, final DOMDataWriteTransaction tx) {
229 final NodeIdentifierWithPredicates peerKey = IdentifierUtils.domPeerId(newPeerId);
230 final YangInstanceIdentifier newPeerPath = this.ribPath.node(Peer.QNAME).node(peerKey);
232 tx.put(LogicalDatastoreType.OPERATIONAL, newPeerPath, peerSkeleton(peerKey, newPeerId.getValue()));
233 LOG.debug("New peer {} structure installed.", newPeerPath);
238 MapEntryNode peerSkeleton(final NodeIdentifierWithPredicates peerKey, final String peerId) {
239 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> pb = Builders.mapEntryBuilder();
240 pb.withNodeIdentifier(peerKey);
241 pb.withChild(ImmutableNodes.leafNode(PEER_ID, peerId));
242 pb.withChild(ImmutableNodes.leafNode(PEER_ROLE, PeerRoleUtil.roleForString(this.role)));
243 if (this.simpleRoutingPolicy.isPresent() && this.role != PeerRole.Internal) {
244 pb.withChild(ImmutableNodes.leafNode(SIMPLE_ROUTING_POLICY_NID, simpleRoutingPolicyString(this.simpleRoutingPolicy.get())));
246 pb.withChild(ImmutableMapNodeBuilder.create().withNodeIdentifier(PEER_TABLES).build());
247 pb.withChild(EMPTY_ADJRIBIN);
248 if(!isLearnNone(this.simpleRoutingPolicy)) {
249 pb.withChild(EMPTY_EFFRIBIN);
251 if (!isAnnounceNone(this.simpleRoutingPolicy)) {
252 pb.withChild(EMPTY_ADJRIBOUT);
257 ListenableFuture<Void> removePeer() {
258 if(this.peerPath != null) {
259 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
260 tx.delete(LogicalDatastoreType.OPERATIONAL, this.peerPath);
261 final CheckedFuture<Void, TransactionCommitFailedException> future = tx.submit();
262 Futures.addCallback(future, new FutureCallback<Void>() {
264 public void onSuccess(final Void result) {
265 LOG.debug("Peer {} removed", AdjRibInWriter.this.peerPath);
269 public void onFailure(final Throwable t) {
270 LOG.warn("Failed to remove Peer {}", AdjRibInWriter.this.peerPath, t);
275 return Futures.immediateFuture(null);
278 void markTableUptodate(final TablesKey tableTypes) {
279 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
280 final TableContext ctx = this.tables.get(tableTypes);
281 tx.merge(LogicalDatastoreType.OPERATIONAL, ctx.getTableId().node(Attributes.QNAME).node(ATTRIBUTES_UPTODATE_TRUE.getNodeType()), ATTRIBUTES_UPTODATE_TRUE);
285 void updateRoutes(final MpReachNlri nlri, final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes attributes) {
286 final TablesKey key = new TablesKey(nlri.getAfi(), nlri.getSafi());
287 final TableContext ctx = this.tables.get(key);
289 LOG.debug("No table for {}, not accepting NLRI {}", key, nlri);
293 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
294 ctx.writeRoutes(tx, nlri, attributes);
295 LOG.trace("Write routes {}", nlri);
299 void removeRoutes(final MpUnreachNlri nlri) {
300 final TablesKey key = new TablesKey(nlri.getAfi(), nlri.getSafi());
301 final TableContext ctx = this.tables.get(key);
303 LOG.debug("No table for {}, not accepting NLRI {}", key, nlri);
306 LOG.trace("Removing routes {}", nlri);
307 final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
308 ctx.removeRoutes(tx, nlri);
312 static boolean isAnnounceNone(final java.util.Optional<SimpleRoutingPolicy> peerStatus) {
313 return peerStatus.isPresent() && peerStatus.get() == SimpleRoutingPolicy.AnnounceNone;
316 static boolean isLearnNone(final java.util.Optional<SimpleRoutingPolicy> peerStatus) {
317 return peerStatus.isPresent() && peerStatus.get() == SimpleRoutingPolicy.LearnNone;
320 private static String simpleRoutingPolicyString(final SimpleRoutingPolicy simpleRoutingPolicy) {
321 switch (simpleRoutingPolicy) {
323 return "announce-none";
327 throw new IllegalArgumentException("Unhandled Simple Routing Policy " + simpleRoutingPolicy);