X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=bgp%2Frib-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fprotocol%2Fbgp%2Frib%2Fimpl%2FBGPPeer.java;h=eb7a3aa71aef61d87d4c53c3ad23505ff51ad3ef;hb=0903ae978349d82e076b999965aaad58f0318393;hp=375b577aa58249f3cdb4ce5efd7a664d292576af;hpb=e33bcbbb4e78dd57bc9b6ff3c56f9cae3d59ea34;p=bgpcep.git diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/BGPPeer.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/BGPPeer.java index 375b577aa5..eb7a3aa71a 100644 --- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/BGPPeer.java +++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/BGPPeer.java @@ -8,17 +8,20 @@ package org.opendaylight.protocol.bgp.rib.impl; import static java.util.Objects.requireNonNull; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ADJRIBOUT_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.Objects; +import com.google.common.base.Stopwatch; import com.google.common.cache.CacheBuilder; import com.google.common.cache.CacheLoader; import com.google.common.cache.LoadingCache; import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; -import com.google.common.net.InetAddresses; +import com.google.common.collect.Sets; import com.google.common.util.concurrent.FluentFuture; +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.ListenableFuture; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.util.ArrayList; import java.util.Collections; @@ -26,20 +29,28 @@ import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; +import java.util.Objects; import java.util.Optional; import java.util.Set; +import java.util.concurrent.TimeUnit; import java.util.stream.Collectors; -import javax.annotation.concurrent.GuardedBy; -import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction; -import org.opendaylight.controller.md.sal.common.api.data.TransactionChain; -import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain; -import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration; -import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry; +import org.checkerframework.checker.lock.qual.GuardedBy; +import org.checkerframework.checker.lock.qual.Holding; +import org.eclipse.jdt.annotation.NonNull; +import org.opendaylight.mdsal.binding.api.RpcProviderService; import org.opendaylight.mdsal.common.api.CommitInfo; +import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction; +import org.opendaylight.mdsal.dom.api.DOMTransactionChain; +import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener; +import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer; import org.opendaylight.protocol.bgp.parser.BGPDocumentedException; import org.opendaylight.protocol.bgp.parser.BGPError; import org.opendaylight.protocol.bgp.parser.impl.message.update.LocalPreferenceAttributeParser; import org.opendaylight.protocol.bgp.parser.spi.MessageUtil; +import org.opendaylight.protocol.bgp.parser.spi.RevisedErrorHandlingSupport; +import org.opendaylight.protocol.bgp.rib.impl.config.BgpPeer; +import org.opendaylight.protocol.bgp.rib.impl.config.GracefulRestartUtil; +import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences; import org.opendaylight.protocol.bgp.rib.impl.spi.RIB; import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateProvider; import org.opendaylight.protocol.bgp.rib.spi.BGPSession; @@ -50,45 +61,46 @@ import org.opendaylight.protocol.bgp.rib.spi.RouterIds; import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState; import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState; import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState; -import org.opendaylight.protocol.concepts.AbstractRegistration; import org.opendaylight.protocol.util.Ipv4Util; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber; -import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress; +import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.prefixes.DestinationIpv4Builder; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.prefixes.destination.ipv4.Ipv4Prefixes; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationIpv4CaseBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Update; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.Nlri; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.BgpParameters; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.update.message.Nlri; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpAddPathTableType; 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.multiprotocol.rev180329.RouteRefresh; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.SendReceive; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlri; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlriBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.mp.reach.nlri.AdvertizedRoutesBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlri; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlriBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.mp.unreach.nlri.WithdrawnRoutesBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapability; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.add.path.capability.AddressFamilies; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev180329.BgpPeerRpcService; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev180329.PeerContext; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.PeerKey; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.peer.AdjRibOut; -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.types.rev180329.AddressFamily; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.ClusterIdentifier; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.AddressFamily; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.ClusterIdentifier; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteTarget; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.SubsequentAddressFamily; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.UnicastSubsequentAddressFamily; +import org.opendaylight.yangtools.concepts.ObjectRegistration; +import org.opendaylight.yangtools.concepts.Registration; import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier; import org.opendaylight.yangtools.yang.binding.Notification; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -98,65 +110,73 @@ import org.slf4j.LoggerFactory; */ public class BGPPeer extends AbstractPeer implements BGPSessionListener { private static final Logger LOG = LoggerFactory.getLogger(BGPPeer.class); + private static final TablesKey IPV4_UCAST_TABLE_KEY = new TablesKey(Ipv4AddressFamily.class, + UnicastSubsequentAddressFamily.class); - private Set tables = Collections.emptySet(); private final RIB rib; + + // FIXME: Alright, this right here is a ton of state which has intertwined initialization and dependencies Split + // these out into separate behavior objects. This also has relationship with state in AbstractPeer -- which + // hints at an obvious layer of indirection. Yeah, yeah, we can always add one of those, but the point + // is that this class is a mutable meeting point, whereas the behaviour has captured invariants. + private final LoadingCache tablesIId = + CacheBuilder.newBuilder().build(new CacheLoader() { + @Override + public YangInstanceIdentifier load(final NodeIdentifierWithPredicates key) { + return peerRibOutIId.node(TABLES_NID).node(key).toOptimized(); + } + }); + + private ImmutableSet tables = ImmutableSet.of(); private final Map adjRibOutListenerSet = new HashMap<>(); - private final RpcProviderRegistry rpcRegistry; - private InstanceIdentifier peerRibOutIId; - @GuardedBy("this") - private AbstractRegistration trackerRegistration; - private final LoadingCache> tablesIId - = CacheBuilder.newBuilder() - .build(new CacheLoader>() { - @Override - public KeyedInstanceIdentifier load(final TablesKey tablesKey) { - return BGPPeer.this.peerRibOutIId.child(Tables.class, tablesKey); - } - }); + private final List rtMemberships = new ArrayList<>(); + private final RpcProviderService rpcRegistry; + private final BGPTableTypeRegistryConsumer tableTypeRegistry; + private final BgpPeer bgpPeer; + // FIXME: This should be a constant co-located with ApplicationPeer.peerId + private YangInstanceIdentifier peerRibOutIId; @GuardedBy("this") - private BGPSession session; + private Registration trackerRegistration; + @GuardedBy("this") - private DOMTransactionChain chain; + private BGPSession currentSession; @GuardedBy("this") private AdjRibInWriter ribWriter; @GuardedBy("this") private EffectiveRibInWriter effRibInWriter; - private RoutedRpcRegistration rpcRegistration; + private ObjectRegistration rpcRegistration; private Map addPathTableMaps = Collections.emptyMap(); + // FIXME: This should be a constant co-located with ApplicationPeer.peerId private YangInstanceIdentifier peerPath; + // FIXME: This is for supportsTable() -- a trivial behavior thing, where 'peer-down' type states always return false private boolean sessionUp; + private boolean llgrSupport; + private Stopwatch peerRestartStopwatch; + private long currentSelectionDeferralTimerSeconds; + private final List missingEOT = new ArrayList<>(); public BGPPeer( - final IpAddress neighborAddress, + final BGPTableTypeRegistryConsumer tableTypeRegistry, + final IpAddressNoZone neighborAddress, final String peerGroupName, final RIB rib, final PeerRole role, final ClusterIdentifier clusterId, final AsNumber localAs, - final RpcProviderRegistry rpcRegistry, + final RpcProviderService rpcRegistry, final Set afiSafisAdvertized, - final Set afiSafisGracefulAdvertized) { + final Set afiSafisGracefulAdvertized, + final Map llGracefulTablesAdvertised, + final BgpPeer bgpPeer) { super(rib, Ipv4Util.toStringIP(neighborAddress), peerGroupName, role, clusterId, - localAs, neighborAddress, afiSafisAdvertized, afiSafisGracefulAdvertized); + localAs, neighborAddress, afiSafisAdvertized, afiSafisGracefulAdvertized, llGracefulTablesAdvertised); + this.tableTypeRegistry = requireNonNull(tableTypeRegistry); this.rib = requireNonNull(rib); this.rpcRegistry = rpcRegistry; - this.chain = rib.createPeerDOMChain(this); + this.bgpPeer = bgpPeer; } - BGPPeer( - final IpAddress neighborAddress, - final RIB rib, - final PeerRole role, - final RpcProviderRegistry rpcRegistry, - final Set afiSafisAdvertized, - final Set afiSafisGracefulAdvertized) { - this(neighborAddress, null, rib, role, null, null, rpcRegistry, afiSafisAdvertized, - afiSafisGracefulAdvertized); - } - - private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) { if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) { final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs); @@ -178,7 +198,7 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { .collect(Collectors.toList()); final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi( UnicastSubsequentAddressFamily.class).setAdvertizedRoutes( - new AdvertizedRoutesBuilder().setDestinationType( + new AdvertizedRoutesBuilder().setDestinationType( new DestinationIpv4CaseBuilder().setDestinationIpv4( new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()); if (message.getAttributes() != null) { @@ -200,8 +220,8 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { Optional nlriAnounced = Optional.empty(); if (isAnyNlriAnnounced) { - nlriAnounced = message.getNlri().stream().filter(n -> Objects.equal(n.getPrefix(), w.getPrefix()) - && Objects.equal(n.getPathId(), w.getPathId())) + nlriAnounced = message.getNlri().stream().filter(n -> Objects.equals(n.getPrefix(), w.getPrefix()) + && Objects.equals(n.getPathId(), w.getPathId())) .findAny(); } if (!nlriAnounced.isPresent()) { @@ -212,37 +232,36 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(new org.opendaylight.yang.gen.v1 .urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.update.attributes.mp.unreach.nlri .withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4( - new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build(); + new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build(); } private static Map mapTableTypesFamilies(final List addPathTablesType) { - return ImmutableMap.copyOf(addPathTablesType.stream().collect(Collectors.toMap(af -> new TablesKey(af.getAfi(), - af.getSafi()), BgpAddPathTableType::getSendReceive))); + return addPathTablesType.stream().collect(ImmutableMap.toImmutableMap( + af -> new TablesKey(af.getAfi(), af.getSafi()), BgpAddPathTableType::getSendReceive)); } public synchronized void instantiateServiceInstance() { - this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this.chain); + createDomChain(); + this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), getRole(), this); setActive(true); } @Override public synchronized FluentFuture close() { - final FluentFuture future = releaseConnection(); - this.chain.close(); + final FluentFuture future = releaseConnection(true); + closeDomChain(); setActive(false); return future; } @Override public void onMessage(final BGPSession session, final Notification msg) throws BGPDocumentedException { - if (!(msg instanceof Update) && !(msg instanceof RouteRefresh)) { - LOG.info("Ignoring unhandled message class {}", msg.getClass()); - return; - } if (msg instanceof Update) { onUpdateMessage((Update) msg); - } else { + } else if (msg instanceof RouteRefresh) { onRouteRefreshMessage((RouteRefresh) msg); + } else { + LOG.info("Ignoring unhandled message class {}", msg.getClass()); } } @@ -251,13 +270,14 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { final Class rrSafi = message.getSafi(); final TablesKey key = new TablesKey(rrAfi, rrSafi); - final AdjRibOutListener listener = this.adjRibOutListenerSet.get(key); - if (listener != null) { - listener.close(); - this.adjRibOutListenerSet.remove(key); - createAdjRibOutListener(key, listener.isMpSupported()); - } else { - LOG.info("Ignoring RouteRefresh message. Afi/Safi is not supported: {}, {}.", rrAfi, rrSafi); + synchronized (this) { + final AdjRibOutListener listener = this.adjRibOutListenerSet.remove(key); + if (listener != null) { + listener.close(); + createAdjRibOutListener(key, listener.isMpSupported()); + } else { + LOG.info("Ignoring RouteRefresh message. Afi/Safi is not supported: {}, {}.", rrAfi, rrSafi); + } } } @@ -269,7 +289,7 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { private void checkMandatoryAttributesPresence(final Update message) throws BGPDocumentedException { if (MessageUtil.isAnyNlriPresent(message)) { final Attributes attrs = message.getAttributes(); - if (this.peerRole == PeerRole.Ibgp && (attrs == null || attrs.getLocalPref() == null)) { + if (getRole() == PeerRole.Ibgp && (attrs == null || attrs.getLocalPref() == null)) { throw new BGPDocumentedException(BGPError.MANDATORY_ATTR_MISSING_MSG + "LOCAL_PREF", BGPError.WELL_KNOWN_ATTR_MISSING, new byte[]{LocalPreferenceAttributeParser.TYPE}); @@ -298,88 +318,200 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { if (mpReach != null) { this.ribWriter.updateRoutes(mpReach, nextHopToAttribute(attrs, mpReach)); } - MpUnreachNlri mpUnreach; + final MpUnreachNlri mpUnreach; if (message.getWithdrawnRoutes() != null) { mpUnreach = prefixesToMpUnreach(message, isAnyNlriAnnounced); } else { mpUnreach = MessageUtil.getMpUnreachNlri(attrs); } + final boolean endOfRib = BgpPeerUtil.isEndOfRib(message); if (mpUnreach != null) { - this.ribWriter.removeRoutes(mpUnreach); + if (endOfRib) { + final TablesKey tablesKey = new TablesKey(mpUnreach.getAfi(), mpUnreach.getSafi()); + this.ribWriter.removeStaleRoutes(tablesKey); + this.missingEOT.remove(tablesKey); + handleGracefulEndOfRib(); + } else { + this.ribWriter.removeRoutes(mpUnreach); + } + } else if (endOfRib) { + this.ribWriter.removeStaleRoutes(IPV4_UCAST_TABLE_KEY); + this.missingEOT.remove(IPV4_UCAST_TABLE_KEY); + handleGracefulEndOfRib(); + } + } + + @Holding("this") + private void handleGracefulEndOfRib() { + if (isLocalRestarting()) { + if (this.missingEOT.isEmpty()) { + createEffRibInWriter(); + this.effRibInWriter.init(); + registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter); + for (final TablesKey key : getAfiSafisAdvertized()) { + createAdjRibOutListener(key, true); + } + setLocalRestartingState(false); + setGracefulPreferences(false, Collections.emptySet()); + } } } @Override public synchronized void onSessionUp(final BGPSession session) { - this.session = session; + this.currentSession = session; this.sessionUp = true; - if (this.session instanceof BGPSessionStateProvider) { - ((BGPSessionStateProvider) this.session).registerMessagesCounter(this); + + this.ribOutChain = this.rib.createPeerDOMChain(new DOMTransactionChainListener() { + @Override + public void onTransactionChainSuccessful(final DOMTransactionChain chain) { + LOG.debug("RibOut transaction chain {} successful.", chain); + } + + @Override + public void onTransactionChainFailed(final DOMTransactionChain chain, + final DOMDataTreeTransaction transaction, final Throwable cause) { + onRibOutChainFailed(cause); + } + }); + + if (this.currentSession instanceof BGPSessionStateProvider) { + ((BGPSessionStateProvider) this.currentSession).registerMessagesCounter(this); } + final GracefulRestartCapability advertisedGracefulRestartCapability = + session.getAdvertisedGracefulRestartCapability(); + final var advertisedTables = advertisedGracefulRestartCapability.getTables(); + final var advertisedLLTables = session.getAdvertisedLlGracefulRestartCapability().getTables(); final List addPathTablesType = session.getAdvertisedAddPathTableTypes(); final Set advertizedTableTypes = session.getAdvertisedTableTypes(); - final List advertizedGracefulRestartTableTypes = session.getAdvertisedGracefulRestartTableTypes(); - LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", this.name, + LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", getName(), advertizedTableTypes, addPathTablesType); - this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress(); - this.peerId = RouterIds.createPeerId(session.getBgpId()); - final KeyedInstanceIdentifier peerIId = - getInstanceIdentifier().child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns - .yang.bgp.rib.rev180329.bgp.rib.rib.Peer.class, new PeerKey(this.peerId)); final Set setTables = advertizedTableTypes.stream().map(t -> new TablesKey(t.getAfi(), t.getSafi())) .collect(Collectors.toSet()); this.tables = ImmutableSet.copyOf(setTables); - this.effRibInWriter = new EffectiveRibInWriter(this, this.rib, this.rib.createPeerChain(this), - peerIId, this.tables); - registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter); - this.peerRibOutIId = peerIId.child(AdjRibOut.class); - this.effRibInWriter.init(); - setAdvertizedGracefulRestartTableTypes(advertizedGracefulRestartTableTypes.stream() - .map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList())); - this.addPathTableMaps = ImmutableMap.copyOf(mapTableTypesFamilies(addPathTablesType)); - this.trackerRegistration = this.rib.getPeerTracker().registerPeer(this); - for (final TablesKey key : this.tables) { - createAdjRibOutListener(key, true); + this.addPathTableMaps = mapTableTypesFamilies(addPathTablesType); + final boolean restartingLocally = isLocalRestarting(); + if (!restartingLocally) { + addBgp4Support(); } + if (!isRestartingGracefully()) { + this.peerId = RouterIds.createPeerId(session.getBgpId()); - addBgp4Support(); + final KeyedInstanceIdentifier peerIId = getInstanceIdentifier().child(org.opendaylight.yang.gen + .v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.Peer.class, + new PeerKey(this.peerId)); + this.peerPath = createPeerPath(this.peerId); + this.peerRibOutIId = peerPath.node(ADJRIBOUT_NID); + this.trackerRegistration = this.rib.getPeerTracker().registerPeer(this); + createEffRibInWriter(); + registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter); + + this.effRibInWriter.init(); + this.ribWriter = this.ribWriter.transform(this.peerId, this.peerPath, this.rib.getRibSupportContext(), + this.tables, this.addPathTableMaps); + + if (this.rpcRegistry != null) { + this.rpcRegistration = this.rpcRegistry.registerRpcImplementation(BgpPeerRpcService.class, + new BgpPeerRpc(this, session, this.tables), ImmutableSet.of(this.rib.getInstanceIdentifier().child( + org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib + .Peer.class, new PeerKey(this.peerId)))); + } + } else { + final Set forwardingTables; + if (advertisedTables == null) { + forwardingTables = Collections.emptySet(); + } else { + forwardingTables = advertisedTables.values().stream() + .filter(table -> table.getAfiFlags() != null) + .filter(table -> table.getAfiFlags().getForwardingState()) + .map(table -> new TablesKey(table.getAfi(), table.getSafi())) + .collect(Collectors.toSet()); + } + this.ribWriter.clearTables(Sets.difference(this.tables, forwardingTables)); + if (restartingLocally) { + this.effRibInWriter.close(); + this.peerRestartStopwatch = Stopwatch.createStarted(); + handleSelectionReferralTimer(); + this.missingEOT.addAll(this.tables); + } + } + if (advertisedTables == null || advertisedTables.isEmpty()) { + setAdvertizedGracefulRestartTableTypes(Collections.emptyList()); + } else { + setAdvertizedGracefulRestartTableTypes(advertisedTables.values().stream() + .map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList())); + } + setAfiSafiGracefulRestartState(advertisedGracefulRestartCapability.getRestartTime().toJava(), false, + restartingLocally); + + final Map llTablesReceived; + if (advertisedLLTables != null) { + llTablesReceived = new HashMap<>(); + for (var table : advertisedLLTables.values()) { + llTablesReceived.put(new TablesKey(table.getAfi(), table.getSafi()), + table.getLongLivedStaleTime().getValue().intValue()); + } + } else { + llTablesReceived = Collections.emptyMap(); + } + setAdvertizedLlGracefulRestartTableTypes(llTablesReceived); - this.peerPath = createPeerPath(); - this.ribWriter = this.ribWriter.transform(this.peerId, this.peerPath, this.rib.getRibSupportContext(), - this.tables, this.addPathTableMaps); + if (!llTablesReceived.isEmpty()) { + llgrSupport = true; + // FIXME: propagate preserved tables + } else { + // FIXME: clear preserved tables + llgrSupport = false; + } - if (this.rpcRegistry != null) { - this.rpcRegistration = this.rpcRegistry.addRoutedRpcImplementation(BgpPeerRpcService.class, - new BgpPeerRpc(this, session, this.tables)); - final KeyedInstanceIdentifier path = this.rib.getInstanceIdentifier() - .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib - .rib.Peer.class, new PeerKey(this.peerId)); - this.rpcRegistration.registerPath(PeerContext.class, path); + if (!restartingLocally) { + if (!setTables.contains(IPV4_UCAST_TABLE_KEY)) { + createAdjRibOutListener(IPV4_UCAST_TABLE_KEY, false); + } + for (final TablesKey key : getAfiSafisAdvertized()) { + createAdjRibOutListener(key, true); + } } + + // SpotBugs does not grok Optional.ifPresent() and thinks we are using unsynchronized access + final Optional errorHandling = this.bgpPeer.getErrorHandling(); + if (errorHandling.isPresent()) { + this.currentSession.addDecoderConstraint(RevisedErrorHandlingSupport.class, errorHandling.get()); + } + } + + private boolean isRestartingGracefully() { + return isLocalRestarting() || isPeerRestarting(); + } + + private synchronized void createEffRibInWriter() { + this.effRibInWriter = new EffectiveRibInWriter(this, this.rib, + this.rib.createPeerDOMChain(this), + this.peerPath, this.tables, this.tableTypeRegistry, + this.rtMemberships, + this.rtCache); } //try to add a support for old-school BGP-4, if peer did not advertise IPv4-Unicast MP capability - private synchronized void addBgp4Support() { - final TablesKey key = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class); - if (!this.tables.contains(key)) { + @Holding("this") + private void addBgp4Support() { + if (!this.tables.contains(IPV4_UCAST_TABLE_KEY)) { final HashSet newSet = new HashSet<>(this.tables); - newSet.add(key); + newSet.add(IPV4_UCAST_TABLE_KEY); this.tables = ImmutableSet.copyOf(newSet); - createAdjRibOutListener(key, false); } } - private synchronized void createAdjRibOutListener(final TablesKey key, - final boolean mpSupport) { - final RIBSupport ribSupport = this.rib.getRibSupportContext().getRIBSupport(key); + @Holding("this") + private void createAdjRibOutListener(final TablesKey key, final boolean mpSupport) { + final RIBSupport ribSupport = this.rib.getRibSupportContext().getRIBSupport(key); // not particularly nice - if (ribSupport != null && this.session instanceof BGPSessionImpl) { - final ChannelOutputLimiter limiter = ((BGPSessionImpl) this.session).getLimiter(); + if (ribSupport != null && this.currentSession instanceof BGPSessionImpl) { + final ChannelOutputLimiter limiter = ((BGPSessionImpl) this.currentSession).getLimiter(); final AdjRibOutListener adjRibOut = AdjRibOutListener.create(this.peerId, key, this.rib.getYangRibId(), this.rib.getCodecsRegistry(), ribSupport, this.rib.getService(), limiter, mpSupport); @@ -388,72 +520,149 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { } } - private synchronized FluentFuture cleanup() { - // FIXME: BUG-196: support graceful - this.adjRibOutListenerSet.values().forEach(AdjRibOutListener::close); - this.adjRibOutListenerSet.clear(); - if (this.effRibInWriter != null) { - this.effRibInWriter.close(); - } - this.tables = Collections.emptySet(); - this.addPathTableMaps = Collections.emptyMap(); - return removePeer(this.chain, this.peerPath); - } - @Override - public synchronized void onSessionDown(final BGPSession session, final Exception e) { - if (e.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) { - LOG.info("Session with peer {} went down", this.name); + public synchronized void onSessionDown(final BGPSession session, final Exception exc) { + if (exc.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) { + LOG.info("Session with peer {} went down", getName()); } else { - LOG.info("Session with peer {} went down", this.name, e); + LOG.info("Session with peer {} went down", getName(), exc); } - releaseConnection(); + releaseConnectionGracefully(); } @Override public synchronized void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) { - LOG.info("Session with peer {} terminated: {}", this.name, cause); - releaseConnection(); + LOG.info("Session with peer {} terminated: {}", getName(), cause); + releaseConnectionGracefully(); } @Override public String toString() { - return addToStringAttributes(MoreObjects.toStringHelper(this)).toString(); - } - - protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) { - toStringHelper.add("name", this.name); - toStringHelper.add("tables", this.tables); - return toStringHelper; + return MoreObjects.toStringHelper(this).add("name", getName()).add("tables", this.tables).toString(); } @Override public synchronized FluentFuture releaseConnection() { + return releaseConnection(true); + } + + /** + * On transaction chain failure, we don't want to wait for future. + * + * @param isWaitForSubmitted if true, wait for submitted future before closing binding chain. if false, don't wait. + */ + @Holding("this") + private @NonNull FluentFuture releaseConnection(final boolean isWaitForSubmitted) { LOG.info("Closing session with peer"); this.sessionUp = false; - closeRegistration(); - if (this.rpcRegistration != null) { - this.rpcRegistration.close(); + this.adjRibOutListenerSet.values().forEach(AdjRibOutListener::close); + this.adjRibOutListenerSet.clear(); + final FluentFuture future; + // FIXME: this is a typical example of something which should be handled by a behavior into which we have + // transitioned way before this method is called. This really begs to be an abstract base class with + // a 'clearTables' or similar callout + if (isRestartingGracefully()) { + final Set gracefulTables = getGracefulTables(); + this.ribWriter.storeStaleRoutes(gracefulTables); + future = this.ribWriter.clearTables(Sets.difference(this.tables, gracefulTables)); + if (isPeerRestarting()) { + this.peerRestartStopwatch = Stopwatch.createStarted(); + handleRestartTimer(); + } + } else { + future = terminateConnection(); } - final FluentFuture future = cleanup(); + releaseRibOutChain(isWaitForSubmitted); + + closeSession(); + return future; + } - if (this.session != null) { + @Holding("this") + @SuppressWarnings("checkstyle:illegalCatch") + private void closeSession() { + if (this.currentSession != null) { try { - this.session.close(); + if (isRestartingGracefully()) { + this.currentSession.closeWithoutMessage(); + } else { + this.currentSession.close(); + } } catch (final Exception e) { LOG.warn("Error closing session with peer", e); } - this.session = null; + this.currentSession = null; } - resetState(); - return future; } - private synchronized void closeRegistration() { + private Set getGracefulTables() { + return this.tables.stream() + .filter(this::isGracefulRestartReceived) + .filter(this::isGracefulRestartAdvertized) + .collect(Collectors.toSet()); + } + + private synchronized FluentFuture terminateConnection() { + final FluentFuture future; if (this.trackerRegistration != null) { this.trackerRegistration.close(); this.trackerRegistration = null; } + if (this.rpcRegistration != null) { + this.rpcRegistration.close(); + } + this.ribWriter.releaseChain(); + + if (this.effRibInWriter != null) { + this.effRibInWriter.close(); + } + this.tables = ImmutableSet.of(); + this.addPathTableMaps = Collections.emptyMap(); + future = removePeer(this.peerPath); + resetState(); + + return future; + } + + /** + * If Graceful Restart Timer expires, remove all routes advertised by peer. + */ + private synchronized void handleRestartTimer() { + if (!isPeerRestarting()) { + return; + } + + final long peerRestartTimeNanos = TimeUnit.SECONDS.toNanos(getPeerRestartTime()); + final long elapsedNanos = this.peerRestartStopwatch.elapsed(TimeUnit.NANOSECONDS); + if (elapsedNanos >= peerRestartTimeNanos) { + setAfiSafiGracefulRestartState(0, false, false); + onSessionTerminated(this.currentSession, new BGPTerminationReason(BGPError.HOLD_TIMER_EXPIRED)); + } + + currentSession.schedule(this::handleRestartTimer, peerRestartTimeNanos - elapsedNanos, TimeUnit.NANOSECONDS); + } + + private synchronized void handleSelectionReferralTimer() { + if (!isLocalRestarting()) { + return; + } + + final long referalTimerNanos = TimeUnit.SECONDS.toNanos(this.currentSelectionDeferralTimerSeconds); + final long elapsedNanos = this.peerRestartStopwatch.elapsed(TimeUnit.NANOSECONDS); + if (elapsedNanos >= referalTimerNanos) { + this.missingEOT.clear(); + handleGracefulEndOfRib(); + } + currentSession.schedule(this::handleSelectionReferralTimer, referalTimerNanos - elapsedNanos, + TimeUnit.NANOSECONDS); + } + + @Holding("this") + private void releaseConnectionGracefully() { + if (getPeerRestartTime() > 0) { + setRestartingState(); + } + releaseConnection(true); } @SuppressFBWarnings("IS2_INCONSISTENT_SYNC") @@ -464,24 +673,26 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { @Override public boolean supportsTable(final TablesKey tableKey) { - return this.tables.contains(tableKey) && this.sessionUp; + return this.sessionUp && getAfiSafisAdvertized().contains(tableKey) && this.tables.contains(tableKey); } @Override - public KeyedInstanceIdentifier getRibOutIId(final TablesKey tablesKey) { - return this.tablesIId.getUnchecked(tablesKey); + public YangInstanceIdentifier getRibOutIId(final NodeIdentifierWithPredicates tablekey) { + return this.tablesIId.getUnchecked(tablekey); } @Override - public synchronized void onTransactionChainFailed(final TransactionChain chain, - final AsyncTransaction transaction, final Throwable cause) { - LOG.error("Transaction chain failed.", cause); - this.chain.close(); - //FIXME BGPCEP-731 - /* - this.chain = this.rib.createPeerDOMChain(this); - this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this.chain); - releaseConnection();*/ + public synchronized void onTransactionChainFailed(final DOMTransactionChain chain, + final DOMDataTreeTransaction transaction, final Throwable cause) { + LOG.error("Transaction domChain failed.", cause); + releaseConnection(true); + } + + @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", + justification = "https://github.com/spotbugs/spotbugs/issues/811") + private synchronized void onRibOutChainFailed(final Throwable cause) { + LOG.error("RibOut transaction chain failed.", cause); + releaseConnection(false); } @Override @@ -491,25 +702,70 @@ public class BGPPeer extends AbstractPeer implements BGPSessionListener { @Override public synchronized BGPSessionState getBGPSessionState() { - if (this.session instanceof BGPSessionStateProvider) { - return ((BGPSessionStateProvider) this.session).getBGPSessionState(); + if (this.currentSession instanceof BGPSessionStateProvider) { + return ((BGPSessionStateProvider) this.currentSession).getBGPSessionState(); } return null; } @Override public synchronized BGPTimersState getBGPTimersState() { - if (this.session instanceof BGPSessionStateProvider) { - return ((BGPSessionStateProvider) this.session).getBGPTimersState(); + if (this.currentSession instanceof BGPSessionStateProvider) { + return ((BGPSessionStateProvider) this.currentSession).getBGPTimersState(); } return null; } @Override public synchronized BGPTransportState getBGPTransportState() { - if (this.session instanceof BGPSessionStateProvider) { - return ((BGPSessionStateProvider) this.session).getBGPTransportState(); + if (this.currentSession instanceof BGPSessionStateProvider) { + return ((BGPSessionStateProvider) this.currentSession).getBGPTransportState(); } return null; } + + @Override + public List getMemberships() { + return this.rtMemberships; + } + + @Override + public synchronized ListenableFuture restartGracefully(final long selectionDeferralTimerSeconds) { + final Set tablesToPreserve = getGracefulTables(); + if (tablesToPreserve == null || tablesToPreserve.isEmpty()) { + LOG.info("Peer {} is not capable of graceful restart or have no matching graceful tables.", this.peerId); + return Futures.immediateFailedFuture(new UnsupportedOperationException( + "Peer is not capable of graceful restart")); + } + setGracefulPreferences(true, tablesToPreserve); + this.currentSelectionDeferralTimerSeconds = selectionDeferralTimerSeconds; + setLocalRestartingState(true); + return releaseConnection(true); + } + + @Override + boolean supportsLLGR() { + return this.llgrSupport; + } + + private synchronized void setGracefulPreferences(final boolean localRestarting, + final Set preservedTables) { + final Set gracefulTables = this.tables.stream() + .filter(this::isGracefulRestartAdvertized) + .collect(Collectors.toSet()); + final BgpParameters bgpParameters = GracefulRestartUtil.getGracefulBgpParameters( + this.bgpPeer.getBgpFixedCapabilities(), gracefulTables, preservedTables, + this.bgpPeer.getGracefulRestartTimer(), localRestarting, Collections.emptySet()); + final BGPSessionPreferences oldPrefs = this.rib.getDispatcher().getBGPPeerRegistry() + .getPeerPreferences(getNeighborAddress()); + final BGPSessionPreferences newPrefs = new BGPSessionPreferences( + oldPrefs.getMyAs(), + oldPrefs.getHoldTime(), + oldPrefs.getBgpId(), + oldPrefs.getExpectedRemoteAs(), + Collections.singletonList(bgpParameters), + oldPrefs.getMd5Password()); + this.rib.getDispatcher().getBGPPeerRegistry() + .updatePeerPreferences(getNeighborAddress(), newPrefs); + } }