import com.google.common.base.MoreObjects;
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.collect.Sets;
import com.google.common.net.InetAddresses;
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;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
+import java.util.concurrent.ScheduledThreadPoolExecutor;
+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.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;
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.open.message.BgpParameters;
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.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.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;
*/
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<TablesKey> tables = Collections.emptySet();
private final RIB rib;
private final List<RouteTarget> rtMemberships = new ArrayList<>();
private final RpcProviderRegistry rpcRegistry;
private final BGPTableTypeRegistryConsumer tableTypeRegistry;
+ private final BgpPeer bgpPeer;
private InstanceIdentifier<AdjRibOut> peerRibOutIId;
+ private KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
+ .rev180329.bgp.rib.rib.Peer, PeerKey> peerIId;
@GuardedBy("this")
private AbstractRegistration trackerRegistration;
private final LoadingCache<TablesKey, KeyedInstanceIdentifier<Tables, TablesKey>> tablesIId
private Map<TablesKey, SendReceive> addPathTableMaps = Collections.emptyMap();
private YangInstanceIdentifier peerPath;
private boolean sessionUp;
+ private Stopwatch peerRestartStopwatch;
+ private long selectionDeferralTimerSeconds;
+ private final List<TablesKey> missingEOT = new ArrayList<>();
public BGPPeer(
final BGPTableTypeRegistryConsumer tableTypeRegistry,
final AsNumber localAs,
final RpcProviderRegistry rpcRegistry,
final Set<TablesKey> afiSafisAdvertized,
- final Set<TablesKey> afiSafisGracefulAdvertized) {
+ final Set<TablesKey> afiSafisGracefulAdvertized,
+ final BgpPeer bgpPeer) {
super(rib, Ipv4Util.toStringIP(neighborAddress), peerGroupName, role, clusterId,
localAs, neighborAddress, afiSafisAdvertized, afiSafisGracefulAdvertized);
this.tableTypeRegistry = requireNonNull(tableTypeRegistry);
this.rib = requireNonNull(rib);
this.rpcRegistry = rpcRegistry;
+ this.bgpPeer = bgpPeer;
}
- BGPPeer(
- final BGPTableTypeRegistryConsumer tableTypeRegistry,
- final IpAddress neighborAddress,
- final RIB rib,
- final PeerRole role,
- final RpcProviderRegistry rpcRegistry,
- final Set<TablesKey> afiSafisAdvertized,
- final Set<TablesKey> afiSafisGracefulAdvertized) {
- this(tableTypeRegistry, 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);
@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());
}
}
} 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();
+ }
+ }
+
+ private synchronized void handleGracefulEndOfRib() {
+ if (isLocalRestarting()) {
+ if (this.missingEOT.isEmpty()) {
+ createEffRibInWriter();
+ this.effRibInWriter.init();
+ registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter);
+ for (final TablesKey key : this.tables) {
+ createAdjRibOutListener(key, true);
+ }
+ setLocalRestartingState(false);
+ setGracefulPreferences(false, Collections.emptySet());
+ }
}
}
if (this.session instanceof BGPSessionStateProvider) {
((BGPSessionStateProvider) this.session).registerMessagesCounter(this);
}
-
+ final GracefulRestartCapability advertisedGracefulRestartCapability =
+ session.getAdvertisedGracefulRestartCapability();
+ final List<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.graceful.restart.capability.Tables> advertisedTables =
+ advertisedGracefulRestartCapability.getTables();
final List<AddressFamilies> addPathTablesType = session.getAdvertisedAddPathTableTypes();
final Set<BgpTableType> advertizedTableTypes = session.getAdvertisedTableTypes();
- final List<BgpTableType> advertizedGracefulRestartTableTypes = session.getAdvertisedGracefulRestartTableTypes();
LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", this.name,
advertizedTableTypes, addPathTablesType);
- this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
- this.peerId = RouterIds.createPeerId(session.getBgpId());
- final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
- .rev180329.bgp.rib.rib.Peer, PeerKey> 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<TablesKey> 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, this.tableTypeRegistry, rtMemberships);
- 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 (!isRestartingGracefully()) {
+ this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
+ this.peerId = RouterIds.createPeerId(session.getBgpId());
+ this.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.peerRibOutIId = peerIId.child(AdjRibOut.class);
+ 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.addRoutedRpcImplementation(BgpPeerRpcService.class,
+ new BgpPeerRpc(this, session, this.tables));
+ final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
+ .rev180329.bgp.rib.rib.Peer, PeerKey> 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);
+ }
+ } else {
+ final Set<TablesKey> forwardingTables;
+ if (advertisedTables == null) {
+ forwardingTables = Collections.emptySet();
+ } else {
+ forwardingTables = advertisedTables.stream()
+ .filter(table -> table.getAfiFlags() != null)
+ .filter(table -> table.getAfiFlags().isForwardingState())
+ .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.stream()
+ .map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList()));
+ }
+ final int restartTime = advertisedGracefulRestartCapability.getRestartTime();
+ setAfiSafiGracefulRestartState(restartTime, false, restartingLocally);
+ if (!restartingLocally) {
+ addBgp4Support();
+ for (final TablesKey key : this.tables) {
+ createAdjRibOutListener(key, true);
+ }
}
- addBgp4Support();
+ // SpotBugs does not grok Optional.ifPresent() and thinks we are using unsynchronized access
+ final Optional<RevisedErrorHandlingSupport> errorHandling = this.bgpPeer.getErrorHandling();
+ if (errorHandling.isPresent()) {
+ this.session.addDecoderConstraint(RevisedErrorHandlingSupport.class, errorHandling.get());
+ }
+ }
- this.peerPath = createPeerPath();
- this.ribWriter = this.ribWriter.transform(this.peerId, this.peerPath, this.rib.getRibSupportContext(),
- this.tables, this.addPathTableMaps);
+ private boolean isRestartingGracefully() {
+ return isLocalRestarting() || isPeerRestarting();
+ }
- if (this.rpcRegistry != null) {
- this.rpcRegistration = this.rpcRegistry.addRoutedRpcImplementation(BgpPeerRpcService.class,
- new BgpPeerRpc(this, session, this.tables));
- final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
- .rev180329.bgp.rib.rib.Peer, PeerKey> 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);
- }
+ private synchronized void createEffRibInWriter() {
+ this.effRibInWriter = new EffectiveRibInWriter(this, this.rib,
+ this.rib.createPeerChain(this),
+ this.peerIId, 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)) {
+ if (!this.tables.contains(IPV4_UCAST_TABLE_KEY)) {
final HashSet<TablesKey> newSet = new HashSet<>(this.tables);
- newSet.add(key);
+ newSet.add(IPV4_UCAST_TABLE_KEY);
this.tables = ImmutableSet.copyOf(newSet);
- createAdjRibOutListener(key, false);
+ createAdjRibOutListener(IPV4_UCAST_TABLE_KEY, false);
}
}
private synchronized void createAdjRibOutListener(final TablesKey key,
- final boolean mpSupport) {
+ final boolean mpSupport) {
final RIBSupport<?, ?, ?, ?> ribSupport = this.rib.getRibSupportContext().getRIBSupport(key);
// not particularly nice
} else {
LOG.info("Session with peer {} went down", this.name, e);
}
- releaseConnection();
+ releaseConnectionGracefully();
}
@Override
public synchronized void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
LOG.info("Session with peer {} terminated: {}", this.name, cause);
- releaseConnection();
+ releaseConnectionGracefully();
}
@Override
this.sessionUp = false;
this.adjRibOutListenerSet.values().forEach(AdjRibOutListener::close);
this.adjRibOutListenerSet.clear();
+ final FluentFuture<? extends CommitInfo> future;
+ if (!isRestartingGracefully()) {
+ future = terminateConnection();
+ } else {
+ final Set<TablesKey> gracefulTables = getGracefulTables();
+ this.ribWriter.storeStaleRoutes(gracefulTables);
+ future = this.ribWriter.clearTables(Sets.difference(this.tables, gracefulTables));
+ if (isPeerRestarting()) {
+ this.peerRestartStopwatch = Stopwatch.createStarted();
+ handleRestartTimer();
+ }
+ }
+ releaseBindingChain();
+
+ if (this.session != null) {
+ try {
+ if (isRestartingGracefully()) {
+ this.session.closeWithoutMessage();
+ } else {
+ this.session.close();
+ }
+ } catch (final Exception e) {
+ LOG.warn("Error closing session with peer", e);
+ }
+ this.session = null;
+ }
+ return future;
+ }
+
+ private Set<TablesKey> getGracefulTables() {
+ return this.tables.stream()
+ .filter(this::isGracefulRestartReceived)
+ .filter(this::isGracefulRestartAdvertized)
+ .collect(Collectors.toSet());
+ }
+
+ private synchronized FluentFuture<? extends CommitInfo> terminateConnection() {
+ final FluentFuture<? extends CommitInfo> future;
if (this.trackerRegistration != null) {
this.trackerRegistration.close();
this.trackerRegistration = null;
if (this.rpcRegistration != null) {
this.rpcRegistration.close();
}
- releaseBindingChain();
-
this.ribWriter.releaseChain();
- // FIXME: BUG-196: support graceful
if (this.effRibInWriter != null) {
this.effRibInWriter.close();
}
this.tables = Collections.emptySet();
this.addPathTableMaps = Collections.emptyMap();
- final FluentFuture<? extends CommitInfo> future = removePeer(this.peerPath);
- if (this.session != null) {
- try {
- this.session.close();
- } catch (final Exception e) {
- LOG.warn("Error closing session with peer", e);
- }
- this.session = null;
- }
+ 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.session, new BGPTerminationReason(BGPError.HOLD_TIMER_EXPIRED));
+ }
+ new ScheduledThreadPoolExecutor(1)
+ .schedule(this::handleRestartTimer, peerRestartTimeNanos - elapsedNanos, TimeUnit.NANOSECONDS);
+ }
+
+ private synchronized void handleSelectionReferralTimer() {
+ if (!isLocalRestarting()) {
+ return;
+ }
+
+ final long referalTimerNanos = TimeUnit.SECONDS.toNanos(this.selectionDeferralTimerSeconds);
+ final long elapsedNanos = this.peerRestartStopwatch.elapsed(TimeUnit.NANOSECONDS);
+ if (elapsedNanos >= referalTimerNanos) {
+ this.missingEOT.clear();
+ handleGracefulEndOfRib();
+ }
+ new ScheduledThreadPoolExecutor(1)
+ .schedule(this::handleSelectionReferralTimer, referalTimerNanos - elapsedNanos, TimeUnit.NANOSECONDS);
+ }
+
+ private void releaseConnectionGracefully() {
+ if (getPeerRestartTime() > 0) {
+ setRestartingState();
+ }
+ releaseConnection();
+ }
+
@SuppressFBWarnings("IS2_INCONSISTENT_SYNC")
@Override
public SendReceive getSupportedAddPathTables(final TablesKey tableKey) {
public List<RouteTarget> getMemberships() {
return this.rtMemberships;
}
+
+ @Override
+ public synchronized ListenableFuture<?> restartGracefully(final long selectionDeferralTimerSeconds) {
+ final Set<TablesKey> 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.selectionDeferralTimerSeconds = selectionDeferralTimerSeconds;
+ setLocalRestartingState(true);
+ return releaseConnection();
+ }
+
+ private synchronized void setGracefulPreferences(final boolean localRestarting,
+ final Set<TablesKey> preservedTables) {
+ final Set<TablesKey> 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);
+ }
}
Code Review / bgpcep.git / blobdiff