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