*/
package org.opendaylight.protocol.bgp.rib.impl;
+import static com.google.common.base.Verify.verifyNotNull;
+import static java.util.Objects.requireNonNull;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.BGPRIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.LOCRIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.PEER_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.RIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.TABLES_NID;
+
import com.google.common.base.MoreObjects;
-import com.google.common.base.MoreObjects.ToStringHelper;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableSet;
+import com.google.common.util.concurrent.FluentFuture;
import com.google.common.util.concurrent.FutureCallback;
-import com.google.common.util.concurrent.Futures;
-import java.util.ArrayList;
-import java.util.Collections;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
+import java.util.Map;
import java.util.Set;
-import java.util.concurrent.BlockingQueue;
-import java.util.concurrent.ConcurrentHashMap;
-import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.ExecutionException;
-import java.util.concurrent.LinkedBlockingQueue;
-import javax.annotation.concurrent.ThreadSafe;
-import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
-import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
-import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
-import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
-import org.opendaylight.protocol.bgp.rib.DefaultRibReference;
-import org.opendaylight.protocol.bgp.rib.impl.spi.AdjRIBsOut;
-import org.opendaylight.protocol.bgp.rib.impl.spi.AdjRIBsOutRegistration;
+import java.util.stream.Collectors;
+import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.opendaylight.mdsal.common.api.CommitInfo;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.dom.api.DOMDataBroker;
+import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
+import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
+import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
+import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
+import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
+import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
+import org.opendaylight.protocol.bgp.rib.impl.spi.CodecsRegistry;
import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
-import org.opendaylight.protocol.bgp.rib.spi.AbstractAdjRIBs;
-import org.opendaylight.protocol.bgp.rib.spi.AdjRIBsIn;
-import org.opendaylight.protocol.bgp.rib.spi.BGPObjectComparator;
-import org.opendaylight.protocol.bgp.rib.spi.Peer;
+import org.opendaylight.protocol.bgp.rib.impl.spi.RibOutRefresh;
+import org.opendaylight.protocol.bgp.rib.impl.state.BGPRibStateImpl;
+import org.opendaylight.protocol.bgp.rib.spi.BGPPeerTracker;
import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
-import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.bgp.rib.rib.loc.rib.tables.routes.Ipv4RoutesCase;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.bgp.rib.rib.loc.rib.tables.routes.Ipv6RoutesCase;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4Builder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationIpv4CaseBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.Nlri;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.WithdrawnRoutes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes1;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.RibBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.RibKey;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRibBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
-import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeFactory;
-import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
+import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
+import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRibRoutingPolicy;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpId;
+import org.opendaylight.yangtools.yang.binding.ChildOf;
+import org.opendaylight.yangtools.yang.binding.ChoiceIn;
+import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.InstanceIdentifierBuilder;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
+import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-@ThreadSafe
-public final class RIBImpl extends DefaultRibReference implements AutoCloseable, RIB, TransactionChainListener, SchemaContextListener {
+// This class is thread-safe
+public final class RIBImpl extends BGPRibStateImpl implements RIB, DOMTransactionChainListener {
private static final Logger LOG = LoggerFactory.getLogger(RIBImpl.class);
- private static final Update EOR = new UpdateBuilder().build();
- private static final TablesKey IPV4_UNICAST_TABLE = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
- private static final QName RIB_ID_QNAME = QName.cachedReference(QName.create(Rib.QNAME, "id"));
-
- /*
- * FIXME: performance: this needs to be turned into a Peer->offset map.
- * The offset is used to locate a the per-peer state entry in the
- * RIB tables.
- *
- * For the first release, that map is updated whenever configuration
- * changes and remains constant on peer flaps. On re-configuration
- * a resize task is scheduled, so large tables may take some time
- * before they continue reacting to updates.
- *
- * For subsequent releases, if we make the reformat process concurrent,
- * we can trigger reformats when Graceful Restart Time expires for a
- * particular peer.
- */
- private final ConcurrentMap<Peer, AdjRIBsOut> ribOuts = new ConcurrentHashMap<>();
- private final ReconnectStrategyFactory tcpStrategyFactory;
- private final ReconnectStrategyFactory sessionStrategyFactory;
-
- /**
- * BGP Best Path selection comparator for ingress best path selection.
- */
- private final BGPObjectComparator comparator;
+ private static final QName RIB_ID_QNAME = QName.create(Rib.QNAME, "id").intern();
+
private final BGPDispatcher dispatcher;
- private final BindingTransactionChain chain;
private final AsNumber localAs;
- private final Ipv4Address bgpIdentifier;
- private final ClusterIdentifier clusterId;
+ private final BgpId bgpIdentifier;
private final Set<BgpTableType> localTables;
private final Set<TablesKey> localTablesKeys;
- private final RIBTables tables;
- private final BlockingQueue<Peer> peers;
- private final DataBroker dataBroker;
private final DOMDataBroker domDataBroker;
private final RIBExtensionConsumerContext extensions;
private final YangInstanceIdentifier yangRibId;
private final RIBSupportContextRegistryImpl ribContextRegistry;
- private final EffectiveRibInWriter efWriter;
+ private final CodecsRegistry codecsRegistry;
+ private final BGPTableTypeRegistryConsumer tableTypeRegistry;
+ private final DOMDataBrokerExtension domService;
+ private final Map<DOMTransactionChain, LocRibWriter<?, ?>> txChainToLocRibWriter = new HashMap<>();
+ private final Map<TablesKey, RibOutRefresh> vpnTableRefresher = new HashMap<>();
+ private final Map<TablesKey, PathSelectionMode> bestPathSelectionStrategies;
+ private final RibId ribId;
+ private final BGPPeerTracker peerTracker = new BGPPeerTrackerImpl();
+ private final BGPRibRoutingPolicy ribPolicies;
+ @GuardedBy("this")
+ private DOMTransactionChain domChain;
+ @GuardedBy("this")
+ private boolean isServiceInstantiated;
+
+ public RIBImpl(
+ final BGPTableTypeRegistryConsumer tableTypeRegistry,
+ final RibId ribId,
+ final AsNumber localAs,
+ final BgpId localBgpId,
+ final RIBExtensionConsumerContext extensions,
+ final BGPDispatcher dispatcher,
+ final CodecsRegistry codecsRegistry,
+ final DOMDataBroker domDataBroker,
+ final BGPRibRoutingPolicy ribPolicies,
+ final List<BgpTableType> localTables,
+ final Map<TablesKey, PathSelectionMode> bestPathSelectionStrategies
+ ) {
+ super(InstanceIdentifier.create(BgpRib.class).child(Rib.class, new RibKey(requireNonNull(ribId))),
+ localBgpId, localAs);
+ this.tableTypeRegistry = requireNonNull(tableTypeRegistry);
+ this.localAs = requireNonNull(localAs);
+ bgpIdentifier = requireNonNull(localBgpId);
+ this.dispatcher = requireNonNull(dispatcher);
- private final Runnable scheduler = new Runnable() {
- @Override
- public void run() {
- try {
- final Peer peer = RIBImpl.this.peers.take();
- LOG.debug("Advertizing loc-rib to new peer {}.", peer);
- for (final BgpTableType key : RIBImpl.this.localTables) {
-
- synchronized (RIBImpl.this) {
- final AdjRIBsTransactionImpl trans = new AdjRIBsTransactionImpl(RIBImpl.this.ribOuts, RIBImpl.this.comparator, RIBImpl.this.chain.newWriteOnlyTransaction());
- final AbstractAdjRIBs<?, ?, ?> adj = (AbstractAdjRIBs<?, ?, ?>) RIBImpl.this.tables.get(new TablesKey(key.getAfi(), key.getSafi()));
- adj.addAllEntries(trans);
- Futures.addCallback(trans.commit(), new FutureCallback<Void>() {
- @Override
- public void onSuccess(final Void result) {
- LOG.trace("Advertizing {} to peer {} committed successfully", key.getAfi(), peer);
- }
- @Override
- public void onFailure(final Throwable t) {
- LOG.error("Failed to update peer {} with RIB {}", peer, t);
- }
- });
- }
- }
- } catch (final InterruptedException e) {
- LOG.info("Scheduler thread was interrupted.", e);
- }
- }
- };
-
- public RIBImpl(final RibId ribId, final AsNumber localAs, final Ipv4Address localBgpId, final Ipv4Address clusterId, final RIBExtensionConsumerContext extensions,
- final BGPDispatcher dispatcher, final ReconnectStrategyFactory tcpStrategyFactory, final BindingCodecTreeFactory codecFactory,
- final ReconnectStrategyFactory sessionStrategyFactory, final DataBroker dps, final DOMDataBroker domDataBroker, final List<BgpTableType> localTables, final GeneratedClassLoadingStrategy classStrategy) {
- super(InstanceIdentifier.create(BgpRib.class).child(Rib.class, new RibKey(Preconditions.checkNotNull(ribId))));
- this.chain = dps.createTransactionChain(this);
- this.localAs = Preconditions.checkNotNull(localAs);
- this.comparator = new BGPObjectComparator(localAs);
- this.bgpIdentifier = Preconditions.checkNotNull(localBgpId);
- this.clusterId = (clusterId == null) ? new ClusterIdentifier(localBgpId) : new ClusterIdentifier(clusterId);
- this.dispatcher = Preconditions.checkNotNull(dispatcher);
- this.sessionStrategyFactory = Preconditions.checkNotNull(sessionStrategyFactory);
- this.tcpStrategyFactory = Preconditions.checkNotNull(tcpStrategyFactory);
this.localTables = ImmutableSet.copyOf(localTables);
- this.localTablesKeys = new HashSet<TablesKey>();
- this.tables = new RIBTables(extensions);
- this.peers = new LinkedBlockingQueue<>();
- this.dataBroker = dps;
- this.domDataBroker = Preconditions.checkNotNull(domDataBroker);
- this.extensions = Preconditions.checkNotNull(extensions);
- this.ribContextRegistry = RIBSupportContextRegistryImpl.create(extensions, codecFactory, classStrategy);
- this.yangRibId = YangInstanceIdentifier.builder().node(BgpRib.QNAME).node(Rib.QNAME).nodeWithKey(Rib.QNAME, RIB_ID_QNAME, ribId.getValue()).build();
-
- LOG.debug("Instantiating RIB table {} at {}", ribId, getInstanceIdentifier());
-
- final WriteTransaction trans = this.chain.newWriteOnlyTransaction();
-
- // put empty BgpRib if not exists
- trans.put(LogicalDatastoreType.OPERATIONAL, getInstanceIdentifier(),
- new RibBuilder().setKey(new RibKey(ribId)).setPeer(Collections.<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer> emptyList()).setId(ribId).setLocRib(
- new LocRibBuilder().setTables(Collections.<Tables> emptyList()).build()).build(), true);
-
- for (final BgpTableType t : localTables) {
- final TablesKey key = new TablesKey(t.getAfi(), t.getSafi());
- this.localTablesKeys.add(key);
- if (this.tables.create(trans, this, key) == null) {
- LOG.debug("Did not create local table for unhandled table type {}", t);
- }
- }
-
- Futures.addCallback(trans.submit(), new FutureCallback<Void>() {
- @Override
- public void onSuccess(final Void result) {
- LOG.trace("Change committed successfully");
- }
-
- @Override
- public void onFailure(final Throwable t) {
- LOG.error("Failed to initiate RIB {}", getInstanceIdentifier(), t);
- }
-
- });
-
- final PolicyDatabase pd = new PolicyDatabase(localAs.getValue(), localBgpId, this.clusterId);
-
- final DOMDataBrokerExtension service = this.domDataBroker.getSupportedExtensions().get(DOMDataTreeChangeService.class);
- final DOMTransactionChain domChain = this.createPeerChain(this);
- this.efWriter = EffectiveRibInWriter.create((DOMDataTreeChangeService) service, this.createPeerChain(this), getYangRibId(), pd, this.ribContextRegistry);
- LOG.debug("Effective RIB created.");
-
- for (final BgpTableType t : localTables) {
- final TablesKey key = new TablesKey(t.getAfi(), t.getSafi());
- // create locRibWriter for each table
- LocRibWriter.create(this.ribContextRegistry, key, this.createPeerChain(this), getYangRibId(), localAs, (DOMDataTreeChangeService) service, pd);
- }
+ // FIXME: can this be immutable?
+ localTablesKeys = localTables.stream()
+ .map(t -> new TablesKey(t.getAfi(), t.getSafi()))
+ .collect(Collectors.toCollection(HashSet::new));
+
+ this.domDataBroker = requireNonNull(domDataBroker);
+ domService = domDataBroker.getExtensions().get(DOMDataTreeChangeService.class);
+ this.extensions = requireNonNull(extensions);
+ this.ribPolicies = requireNonNull(ribPolicies);
+ this.codecsRegistry = codecsRegistry;
+ ribContextRegistry = RIBSupportContextRegistryImpl.create(extensions, codecsRegistry);
+ yangRibId = YangInstanceIdentifier.builder().node(BGPRIB_NID).node(RIB_NID)
+ .nodeWithKey(Rib.QNAME, RIB_ID_QNAME, ribId.getValue()).build();
+ this.bestPathSelectionStrategies = requireNonNull(bestPathSelectionStrategies);
+ this.ribId = ribId;
}
- @Deprecated
- synchronized void initTables(final byte[] remoteBgpId) {
- }
+ // FIXME: make this asynchronous?
+ private synchronized void startLocRib(final TablesKey key) {
+ LOG.debug("Creating LocRib table for {}", key);
+ // create locRibWriter for each table
+ final DOMDataTreeWriteTransaction tx = domChain.newWriteOnlyTransaction();
- @Override
- @Deprecated
- public synchronized void updateTables(final Peer peer, final Update message) {
- final AdjRIBsTransactionImpl trans = new AdjRIBsTransactionImpl(this.ribOuts, this.comparator, this.chain.newWriteOnlyTransaction());
-
- if (!EOR.equals(message)) {
- final WithdrawnRoutes wr = message.getWithdrawnRoutes();
- if (wr != null) {
- final AdjRIBsIn<?, ?> ari = this.tables.get(IPV4_UNICAST_TABLE);
- if (ari != null) {
- /*
- * create MPUnreach for the routes to be handled in the same way as linkstate routes
- */
- final List<Ipv4Prefixes> prefixes = new ArrayList<>();
- for (final Ipv4Prefix p : wr.getWithdrawnRoutes()) {
- prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
- }
- ari.removeRoutes(
- trans,
- peer,
- new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setWithdrawnRoutes(
- new WithdrawnRoutesBuilder().setDestinationType(
- new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4(
- new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build());
- } else {
- LOG.debug("Not removing objects from unhandled IPv4 Unicast");
- }
- }
-
- final Attributes attrs = message.getAttributes();
- if (attrs != null) {
- final Attributes2 mpu = attrs.getAugmentation(Attributes2.class);
- if (mpu != null) {
- final MpUnreachNlri nlri = mpu.getMpUnreachNlri();
- final AdjRIBsIn<?, ?> ari = this.tables.get(new TablesKey(nlri.getAfi(), nlri.getSafi()));
- // EOR messages do not contain withdrawn routes
- if (nlri.getWithdrawnRoutes() != null) {
- if (ari != null) {
- ari.removeRoutes(trans, peer, nlri);
- } else {
- LOG.debug("Not removing objects from unhandled NLRI {}", nlri);
- }
- } else {
- ari.markUptodate(trans, peer);
- }
- }
- }
-
- final Nlri ar = message.getNlri();
- if (ar != null) {
- final AdjRIBsIn<?, ?> ari = this.tables.get(IPV4_UNICAST_TABLE);
- if (ari != null) {
- /*
- * create MPReach for the routes to be handled in the same way as linkstate routes
- */
- final List<Ipv4Prefixes> prefixes = new ArrayList<>();
- for (final Ipv4Prefix p : ar.getNlri()) {
- prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
- }
- final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
- UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
- new AdvertizedRoutesBuilder().setDestinationType(
- new DestinationIpv4CaseBuilder().setDestinationIpv4(
- new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
- if (attrs != null) {
- b.setCNextHop(attrs.getCNextHop());
- }
-
- ari.addRoutes(trans, peer, b.build(), attrs);
- } else {
- LOG.debug("Not adding objects from unhandled IPv4 Unicast");
- }
- }
+ final RIBSupport<? extends Routes, ?> ribSupport = ribContextRegistry.getRIBSupport(key);
+ if (ribSupport != null) {
+ final MapEntryNode emptyTable = ribSupport.emptyTable();
+ final InstanceIdentifierBuilder tableId = YangInstanceIdentifier
+ .builder(yangRibId.node(LOCRIB_NID).node(TABLES_NID)).node(emptyTable.name());
- if (attrs != null) {
- final Attributes1 mpr = attrs.getAugmentation(Attributes1.class);
- if (mpr != null) {
- final MpReachNlri nlri = mpr.getMpReachNlri();
-
- final AdjRIBsIn<?, ?> ari = this.tables.get(new TablesKey(nlri.getAfi(), nlri.getSafi()));
- if (ari != null) {
- if (message.equals(ari.endOfRib())) {
- ari.markUptodate(trans, peer);
- } else {
- ari.addRoutes(trans, peer, nlri, attrs);
- }
- } else {
- LOG.debug("Not adding objects from unhandled NLRI {}", nlri);
- }
- }
+ tx.put(LogicalDatastoreType.OPERATIONAL, tableId.build(), emptyTable);
+ try {
+ tx.commit().get();
+ } catch (final InterruptedException | ExecutionException e) {
+ LOG.error("Failed to initiate LocRIB for key {}", key, e);
}
} else {
- final AdjRIBsIn<?, ?> ari = this.tables.get(IPV4_UNICAST_TABLE);
- if (ari != null) {
- ari.markUptodate(trans, peer);
- } else {
- LOG.debug("End-of-RIB for IPv4 Unicast ignored");
- }
+ LOG.warn("There's no registered RIB Context for {}", key.getAfi());
}
-
- Futures.addCallback(trans.commit(), new FutureCallback<Void>() {
- @Override
- public void onSuccess(final Void result) {
- LOG.debug("RIB modification successfully committed.");
- }
-
- @Override
- public void onFailure(final Throwable t) {
- LOG.error("Failed to commit RIB modification", t);
- }
- });
}
- @Deprecated
- @Override
- public synchronized void clearTable(final Peer peer, final TablesKey key) {
- final AdjRIBsIn<?, ?> ari = this.tables.get(key);
- if (ari != null) {
- final AdjRIBsTransactionImpl trans = new AdjRIBsTransactionImpl(this.ribOuts, this.comparator, this.chain.newWriteOnlyTransaction());
- ari.clear(trans, peer);
-
- Futures.addCallback(trans.commit(), new FutureCallback<Void>() {
- @Override
- public void onSuccess(final Void result) {
- LOG.trace("Table {} cleared successfully", key);
- }
-
- @Override
- public void onFailure(final Throwable t) {
- LOG.error("Failed to clear table {}", key, t);
- }
- });
+ private synchronized <C extends Routes & DataObject & ChoiceIn<Tables>, S extends ChildOf<? super C>>
+ void createLocRibWriter(final TablesKey key) {
+ final RIBSupport<C, S> ribSupport = ribContextRegistry.getRIBSupport(key);
+ if (ribSupport == null) {
+ return;
+ }
+ LOG.debug("Creating LocRIB writer for key {}", key);
+ final DOMTransactionChain txChain = createPeerDOMChain(this);
+ PathSelectionMode pathSelectionStrategy = bestPathSelectionStrategies.get(key);
+ if (pathSelectionStrategy == null) {
+ pathSelectionStrategy = BasePathSelectionModeFactory.createBestPathSelectionStrategy();
}
- }
-
- @Override
- public String toString() {
- return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
- }
-
- protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
- return toStringHelper;
- }
- @SuppressWarnings("unchecked")
- @Deprecated
- protected <K, V extends Route> AdjRIBsIn<K, V> getTable(final TablesKey key) {
- return (AdjRIBsIn<K, V>) this.tables.get(key);
+ final LocRibWriter<C, S> locRibWriter = LocRibWriter.create(
+ ribSupport,
+ verifyNotNull(tableTypeRegistry.getAfiSafiType(key)),
+ txChain,
+ yangRibId,
+ localAs,
+ getService(),
+ ribPolicies,
+ peerTracker,
+ pathSelectionStrategy);
+ vpnTableRefresher.put(key, locRibWriter);
+ registerTotalPathCounter(key, locRibWriter);
+ registerTotalPrefixesCounter(key, locRibWriter);
+ txChainToLocRibWriter.put(txChain, locRibWriter);
}
@Override
- public synchronized void close() throws InterruptedException, ExecutionException {
- final WriteTransaction t = this.chain.newWriteOnlyTransaction();
- t.delete(LogicalDatastoreType.OPERATIONAL, getInstanceIdentifier());
- t.submit().get();
- this.chain.close();
+ public String toString() {
+ return MoreObjects.toStringHelper(this).add("bgpId", bgpIdentifier).add("localTables", localTables).toString();
}
@Override
public AsNumber getLocalAs() {
- return this.localAs;
+ return localAs;
}
@Override
- public Ipv4Address getBgpIdentifier() {
- return this.bgpIdentifier;
+ public BgpId getBgpIdentifier() {
+ return bgpIdentifier;
}
@Override
public Set<? extends BgpTableType> getLocalTables() {
- return this.localTables;
+ return localTables;
}
@Override
- public ReconnectStrategyFactory getTcpStrategyFactory() {
- return this.tcpStrategyFactory;
+ public BGPDispatcher getDispatcher() {
+ return dispatcher;
}
@Override
- public ReconnectStrategyFactory getSessionStrategyFactory() {
- return this.sessionStrategyFactory;
+ public synchronized void onTransactionChainFailed(final DOMTransactionChain chain,
+ final DOMDataTreeTransaction transaction, final Throwable cause) {
+ LOG.error("Broken chain in RIB {} transaction {}",
+ getInstanceIdentifier(), transaction != null ? transaction.getIdentifier() : null, cause);
+ final LocRibWriter<?, ?> locRibWriter = txChainToLocRibWriter.remove(chain);
+ if (locRibWriter != null) {
+ final DOMTransactionChain newChain = createPeerDOMChain(this);
+ startLocRib(locRibWriter.getTableKey());
+ locRibWriter.restart(newChain);
+ txChainToLocRibWriter.put(newChain, locRibWriter);
+ }
}
@Override
- public BGPDispatcher getDispatcher() {
- return this.dispatcher;
+ public void onTransactionChainSuccessful(final DOMTransactionChain chain) {
+ LOG.info("RIB {} closed successfully", getInstanceIdentifier());
}
- @Deprecated
@Override
- public void initTable(final Peer bgpPeer, final TablesKey key) {
- // FIXME: BUG-196: support graceful restart
+ public Set<TablesKey> getLocalTablesKeys() {
+ return localTablesKeys;
}
@Override
- public AdjRIBsOutRegistration registerRIBsOut(final Peer peer, final AdjRIBsOut aro) {
- final AdjRIBsOutRegistration reg = new AdjRIBsOutRegistration(aro) {
- @Override
- protected void removeRegistration() {
- RIBImpl.this.ribOuts.remove(peer, aro);
- }
- };
-
- this.ribOuts.put(peer, aro);
- LOG.debug("Registering this peer {} to RIB-Out {}", peer, this.ribOuts);
- try {
- this.peers.put(peer);
- new Thread(this.scheduler).start();
- } catch (final InterruptedException e) {
- //
- }
- return reg;
+ public boolean supportsTable(final TablesKey tableKey) {
+ return localTablesKeys.contains(tableKey);
}
@Override
- public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
- LOG.error("Broken chain in RIB {} transaction {}", getInstanceIdentifier(), transaction.getIdentifier(), cause);
+ public BGPRibRoutingPolicy getRibPolicies() {
+ return ribPolicies;
}
@Override
- public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
- LOG.info("RIB {} closed successfully", getInstanceIdentifier());
+ public BGPPeerTracker getPeerTracker() {
+ return peerTracker;
}
@Override
- public long getRoutesCount(final TablesKey key) {
- try {
- final Optional<Tables> tableMaybe = this.dataBroker.newReadOnlyTransaction().read(LogicalDatastoreType.OPERATIONAL,
- getInstanceIdentifier().child(LocRib.class).child(Tables.class, key)).checkedGet();
- if (tableMaybe.isPresent()) {
- final Tables table = tableMaybe.get();
- if (table.getRoutes() instanceof Ipv4RoutesCase) {
- final Ipv4RoutesCase routesCase = (Ipv4RoutesCase) table.getRoutes();
- if (routesCase.getIpv4Routes() != null && routesCase.getIpv4Routes().getIpv4Route() != null) {
- return routesCase.getIpv4Routes().getIpv4Route().size();
- }
- } else if (table.getRoutes() instanceof Ipv6RoutesCase) {
- final Ipv6RoutesCase routesCase = (Ipv6RoutesCase) table.getRoutes();
- if (routesCase.getIpv6Routes() != null && routesCase.getIpv6Routes().getIpv6Route() != null) {
- return routesCase.getIpv6Routes().getIpv6Route().size();
- }
- }
- }
- } catch (final ReadFailedException e) {
- //no-op
+ public void refreshTable(final TablesKey tk, final PeerId peerId) {
+ final RibOutRefresh table = vpnTableRefresher.get(tk);
+ if (table != null) {
+ table.refreshTable(tk, peerId);
}
- return 0;
}
- public Set<TablesKey> getLocalTablesKeys() {
- return this.localTablesKeys;
+ @Override
+ public DOMDataTreeChangeService getService() {
+ return (DOMDataTreeChangeService) domService;
}
@Override
public YangInstanceIdentifier getYangRibId() {
- return this.yangRibId;
+ return yangRibId;
}
@Override
- public DOMTransactionChain createPeerChain(final TransactionChainListener listener) {
- return this.domDataBroker.createTransactionChain(listener);
+ public DOMTransactionChain createPeerDOMChain(final DOMTransactionChainListener listener) {
+ return domDataBroker.createMergingTransactionChain(listener);
}
@Override
public RIBExtensionConsumerContext getRibExtensions() {
- return this.extensions;
+ return extensions;
}
@Override
public RIBSupportContextRegistry getRibSupportContext() {
- return this.ribContextRegistry;
+ return ribContextRegistry;
}
@Override
- public void onGlobalContextUpdated(final SchemaContext context) {
- this.ribContextRegistry.onSchemaContextUpdated(context);
+ public CodecsRegistry getCodecsRegistry() {
+ return codecsRegistry;
+ }
+
+ public synchronized void instantiateServiceInstance() {
+ isServiceInstantiated = true;
+ setActive(true);
+ domChain = domDataBroker.createMergingTransactionChain(this);
+ LOG.debug("Instantiating RIB table {} at {}", ribId, yangRibId);
+
+ final ContainerNode bgpRib = Builders.containerBuilder().withNodeIdentifier(BGPRIB_NID)
+ .addChild(ImmutableNodes.mapNodeBuilder(RIB_NID).build()).build();
+
+ final MapEntryNode ribInstance = Builders.mapEntryBuilder().withNodeIdentifier(
+ NodeIdentifierWithPredicates.of(Rib.QNAME, RIB_ID_QNAME, ribId.getValue()))
+ .addChild(ImmutableNodes.leafNode(RIB_ID_QNAME, ribId.getValue()))
+ .addChild(ImmutableNodes.mapNodeBuilder(PEER_NID).build())
+ .addChild(Builders.containerBuilder().withNodeIdentifier(LOCRIB_NID)
+ .addChild(ImmutableNodes.mapNodeBuilder(TABLES_NID).build())
+ .build()).build();
+
+ final DOMDataTreeWriteTransaction trans = domChain.newWriteOnlyTransaction();
+
+ // merge empty BgpRib + Rib, to make sure the top-level parent structure is present
+ trans.merge(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.create(BGPRIB_NID), bgpRib);
+ trans.put(LogicalDatastoreType.OPERATIONAL, yangRibId, ribInstance);
+
+ try {
+ trans.commit().get();
+ } catch (final InterruptedException | ExecutionException e) {
+ LOG.error("Failed to initiate RIB {}", yangRibId, e);
+ }
+
+ LOG.debug("Effective RIB created.");
+
+ localTablesKeys.forEach(this::startLocRib);
+ localTablesKeys.forEach(this::createLocRibWriter);
+ }
+
+ public synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
+ if (!isServiceInstantiated) {
+ LOG.trace("RIB {} already closed", ribId.getValue());
+ return CommitInfo.emptyFluentFuture();
+ }
+ LOG.info("Close RIB {}", ribId.getValue());
+ isServiceInstantiated = false;
+ setActive(false);
+
+ txChainToLocRibWriter.values().forEach(LocRibWriter::close);
+ txChainToLocRibWriter.clear();
+
+ final DOMDataTreeWriteTransaction t = domChain.newWriteOnlyTransaction();
+ t.delete(LogicalDatastoreType.OPERATIONAL, getYangRibId());
+ final FluentFuture<? extends CommitInfo> cleanFuture = t.commit();
+ cleanFuture.addCallback(new FutureCallback<CommitInfo>() {
+ @Override
+ public void onSuccess(final CommitInfo result) {
+ LOG.info("RIB cleaned {}", ribId.getValue());
+ }
+
+ @Override
+ public void onFailure(final Throwable throwable) {
+ LOG.error("Failed to clean RIB {}",
+ ribId.getValue(), throwable);
+ }
+ }, MoreExecutors.directExecutor());
+ domChain.close();
+ return cleanFuture;
}
}