2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.protocol.bgp.rib.impl;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.base.MoreObjects;
13 import com.google.common.base.Objects;
14 import com.google.common.base.Stopwatch;
15 import com.google.common.cache.CacheBuilder;
16 import com.google.common.cache.CacheLoader;
17 import com.google.common.cache.LoadingCache;
18 import com.google.common.collect.ImmutableMap;
19 import com.google.common.collect.ImmutableSet;
20 import com.google.common.collect.Sets;
21 import com.google.common.net.InetAddresses;
22 import com.google.common.util.concurrent.FluentFuture;
23 import com.google.common.util.concurrent.Futures;
24 import com.google.common.util.concurrent.ListenableFuture;
25 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
26 import java.util.ArrayList;
27 import java.util.Collections;
28 import java.util.HashMap;
29 import java.util.HashSet;
30 import java.util.List;
32 import java.util.Optional;
34 import java.util.concurrent.ScheduledThreadPoolExecutor;
35 import java.util.concurrent.TimeUnit;
36 import java.util.stream.Collectors;
37 import javax.annotation.concurrent.GuardedBy;
38 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
39 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
40 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
41 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
42 import org.opendaylight.mdsal.common.api.CommitInfo;
43 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
44 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
45 import org.opendaylight.protocol.bgp.parser.BGPError;
46 import org.opendaylight.protocol.bgp.parser.impl.message.update.LocalPreferenceAttributeParser;
47 import org.opendaylight.protocol.bgp.parser.spi.MessageUtil;
48 import org.opendaylight.protocol.bgp.rib.impl.config.BgpPeer;
49 import org.opendaylight.protocol.bgp.rib.impl.config.GracefulRestartUtil;
50 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
51 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
52 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateProvider;
53 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
54 import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
55 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
56 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
57 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
58 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
59 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
60 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
61 import org.opendaylight.protocol.concepts.AbstractRegistration;
62 import org.opendaylight.protocol.util.Ipv4Util;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.prefixes.DestinationIpv4Builder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
68 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;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Update;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.Nlri;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpAddPathTableType;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.RouteRefresh;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.SendReceive;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapability;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.add.path.capability.AddressFamilies;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev180329.BgpPeerRpcService;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev180329.PeerContext;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.PeerKey;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.peer.AdjRibOut;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.ClusterIdentifier;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.RouteTarget;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
99 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
100 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
101 import org.opendaylight.yangtools.yang.binding.Notification;
102 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
103 import org.slf4j.Logger;
104 import org.slf4j.LoggerFactory;
107 * Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into
110 public class BGPPeer extends AbstractPeer implements BGPSessionListener {
111 private static final Logger LOG = LoggerFactory.getLogger(BGPPeer.class);
112 private static final TablesKey IPV4_UCAST_TABLE_KEY = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
114 private Set<TablesKey> tables = Collections.emptySet();
115 private final RIB rib;
116 private final Map<TablesKey, AdjRibOutListener> adjRibOutListenerSet = new HashMap<>();
117 private final List<RouteTarget> rtMemberships = new ArrayList<>();
118 private final RpcProviderRegistry rpcRegistry;
119 private final BGPTableTypeRegistryConsumer tableTypeRegistry;
120 private final BgpPeer bgpPeer;
121 private InstanceIdentifier<AdjRibOut> peerRibOutIId;
122 private KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
123 .rev180329.bgp.rib.rib.Peer, PeerKey> peerIId;
125 private AbstractRegistration trackerRegistration;
126 private final LoadingCache<TablesKey, KeyedInstanceIdentifier<Tables, TablesKey>> tablesIId
127 = CacheBuilder.newBuilder()
128 .build(new CacheLoader<TablesKey, KeyedInstanceIdentifier<Tables, TablesKey>>() {
130 public KeyedInstanceIdentifier<Tables, TablesKey> load(final TablesKey tablesKey) {
131 return BGPPeer.this.peerRibOutIId.child(Tables.class, tablesKey);
136 private BGPSession session;
138 private AdjRibInWriter ribWriter;
140 private EffectiveRibInWriter effRibInWriter;
141 private RoutedRpcRegistration<BgpPeerRpcService> rpcRegistration;
142 private Map<TablesKey, SendReceive> addPathTableMaps = Collections.emptyMap();
143 private YangInstanceIdentifier peerPath;
144 private boolean sessionUp;
145 private Stopwatch peerRestartStopwatch;
146 private long selectionDeferralTimerSeconds;
147 private final List<TablesKey> missingEOT = new ArrayList<>();
150 final BGPTableTypeRegistryConsumer tableTypeRegistry,
151 final IpAddress neighborAddress,
152 final String peerGroupName,
155 final ClusterIdentifier clusterId,
156 final AsNumber localAs,
157 final RpcProviderRegistry rpcRegistry,
158 final Set<TablesKey> afiSafisAdvertized,
159 final Set<TablesKey> afiSafisGracefulAdvertized,
160 final BgpPeer bgpPeer) {
161 super(rib, Ipv4Util.toStringIP(neighborAddress), peerGroupName, role, clusterId,
162 localAs, neighborAddress, afiSafisAdvertized, afiSafisGracefulAdvertized);
163 this.tableTypeRegistry = requireNonNull(tableTypeRegistry);
164 this.rib = requireNonNull(rib);
165 this.rpcRegistry = rpcRegistry;
166 this.bgpPeer = bgpPeer;
170 final BGPTableTypeRegistryConsumer tableTypeRegistry,
171 final IpAddress neighborAddress,
174 final RpcProviderRegistry rpcRegistry,
175 final Set<TablesKey> afiSafisAdvertized,
176 final Set<TablesKey> afiSafisGracefulAdvertized) {
177 this(tableTypeRegistry, neighborAddress, null, rib, role, null, null, rpcRegistry,
178 afiSafisAdvertized, afiSafisGracefulAdvertized, null);
182 private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) {
183 if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) {
184 final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs);
185 attributesBuilder.setCNextHop(mpReach.getCNextHop());
186 return attributesBuilder.build();
192 * Creates MPReach for the prefixes to be handled in the same way as linkstate routes.
194 * @param message Update message containing prefixes in NLRI
195 * @return MpReachNlri with prefixes from the nlri field
197 private static MpReachNlri prefixesToMpReach(final Update message) {
198 final List<Ipv4Prefixes> prefixes = message.getNlri().stream()
199 .map(n -> new Ipv4PrefixesBuilder().setPrefix(n.getPrefix()).setPathId(n.getPathId()).build())
200 .collect(Collectors.toList());
201 final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
202 UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
203 new AdvertizedRoutesBuilder().setDestinationType(
204 new DestinationIpv4CaseBuilder().setDestinationIpv4(
205 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
206 if (message.getAttributes() != null) {
207 b.setCNextHop(message.getAttributes().getCNextHop());
213 * Create MPUnreach for the prefixes to be handled in the same way as linkstate routes.
215 * @param message Update message containing withdrawn routes
216 * @param isAnyNlriAnnounced isAnyNlriAnnounced
217 * @return MpUnreachNlri with prefixes from the withdrawn routes field
219 private static MpUnreachNlri prefixesToMpUnreach(final Update message, final boolean isAnyNlriAnnounced) {
220 final List<Ipv4Prefixes> prefixes = new ArrayList<>();
221 message.getWithdrawnRoutes().forEach(w -> {
223 Optional<Nlri> nlriAnounced = Optional.empty();
224 if (isAnyNlriAnnounced) {
225 nlriAnounced = message.getNlri().stream().filter(n -> Objects.equal(n.getPrefix(), w.getPrefix())
226 && Objects.equal(n.getPathId(), w.getPathId()))
229 if (!nlriAnounced.isPresent()) {
230 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(w.getPrefix()).setPathId(w.getPathId()).build());
233 return new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class)
234 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(new org.opendaylight.yang.gen.v1
235 .urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.update.attributes.mp.unreach.nlri
236 .withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4(
237 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build();
240 private static Map<TablesKey, SendReceive> mapTableTypesFamilies(final List<AddressFamilies> addPathTablesType) {
241 return ImmutableMap.copyOf(addPathTablesType.stream().collect(Collectors.toMap(af -> new TablesKey(af.getAfi(),
242 af.getSafi()), BgpAddPathTableType::getSendReceive)));
245 public synchronized void instantiateServiceInstance() {
246 this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this);
251 public synchronized FluentFuture<? extends CommitInfo> close() {
252 final FluentFuture<? extends CommitInfo> future = releaseConnection();
259 public void onMessage(final BGPSession session, final Notification msg) throws BGPDocumentedException {
260 if (msg instanceof Update) {
261 onUpdateMessage((Update) msg);
262 } else if (msg instanceof RouteRefresh) {
263 onRouteRefreshMessage((RouteRefresh) msg);
265 LOG.info("Ignoring unhandled message class {}", msg.getClass());
269 private void onRouteRefreshMessage(final RouteRefresh message) {
270 final Class<? extends AddressFamily> rrAfi = message.getAfi();
271 final Class<? extends SubsequentAddressFamily> rrSafi = message.getSafi();
273 final TablesKey key = new TablesKey(rrAfi, rrSafi);
274 final AdjRibOutListener listener = this.adjRibOutListenerSet.get(key);
275 if (listener != null) {
277 this.adjRibOutListenerSet.remove(key);
278 createAdjRibOutListener(key, listener.isMpSupported());
280 LOG.info("Ignoring RouteRefresh message. Afi/Safi is not supported: {}, {}.", rrAfi, rrSafi);
285 * Check for presence of well known mandatory attribute LOCAL_PREF in Update message.
287 * @param message Update message
289 private void checkMandatoryAttributesPresence(final Update message) throws BGPDocumentedException {
290 if (MessageUtil.isAnyNlriPresent(message)) {
291 final Attributes attrs = message.getAttributes();
292 if (this.peerRole == PeerRole.Ibgp && (attrs == null || attrs.getLocalPref() == null)) {
293 throw new BGPDocumentedException(BGPError.MANDATORY_ATTR_MISSING_MSG + "LOCAL_PREF",
294 BGPError.WELL_KNOWN_ATTR_MISSING,
295 new byte[]{LocalPreferenceAttributeParser.TYPE});
301 * Process Update message received.
302 * Calls {@link #checkMandatoryAttributesPresence(Update)} to check for presence of mandatory attributes.
304 * @param message Update message
306 private synchronized void onUpdateMessage(final Update message) throws BGPDocumentedException {
307 checkMandatoryAttributesPresence(message);
310 final Attributes attrs = message.getAttributes();
312 final boolean isAnyNlriAnnounced = message.getNlri() != null;
313 if (isAnyNlriAnnounced) {
314 mpReach = prefixesToMpReach(message);
316 mpReach = MessageUtil.getMpReachNlri(attrs);
318 if (mpReach != null) {
319 this.ribWriter.updateRoutes(mpReach, nextHopToAttribute(attrs, mpReach));
321 MpUnreachNlri mpUnreach;
322 if (message.getWithdrawnRoutes() != null) {
323 mpUnreach = prefixesToMpUnreach(message, isAnyNlriAnnounced);
325 mpUnreach = MessageUtil.getMpUnreachNlri(attrs);
327 final boolean endOfRib = BgpPeerUtil.isEndOfRib(message);
328 if (mpUnreach != null) {
330 final TablesKey tablesKey = new TablesKey(mpUnreach.getAfi(), mpUnreach.getSafi());
331 this.ribWriter.removeStaleRoutes(tablesKey);
332 this.missingEOT.remove(tablesKey);
333 handleGracefulEndOfRib();
335 this.ribWriter.removeRoutes(mpUnreach);
337 } else if (endOfRib) {
338 this.ribWriter.removeStaleRoutes(IPV4_UCAST_TABLE_KEY);
339 this.missingEOT.remove(IPV4_UCAST_TABLE_KEY);
340 handleGracefulEndOfRib();
344 private synchronized void handleGracefulEndOfRib() {
345 if (isLocalRestarting()) {
346 if (this.missingEOT.isEmpty()) {
347 createEffRibInWriter();
348 this.effRibInWriter.init();
349 registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter);
350 for (final TablesKey key : this.tables) {
351 createAdjRibOutListener(key, true);
353 setLocalRestartingState(false);
354 setGracefulPreferences(false, Collections.emptySet());
360 public synchronized void onSessionUp(final BGPSession session) {
361 this.session = session;
362 this.sessionUp = true;
363 this.bindingChain = this.rib.createPeerChain(this);
364 if (this.session instanceof BGPSessionStateProvider) {
365 ((BGPSessionStateProvider) this.session).registerMessagesCounter(this);
367 final GracefulRestartCapability advertisedGracefulRestartCapability =
368 session.getAdvertisedGracefulRestartCapability();
369 final List<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.graceful.restart.capability.Tables> advertisedTables =
370 advertisedGracefulRestartCapability.getTables();
371 final List<AddressFamilies> addPathTablesType = session.getAdvertisedAddPathTableTypes();
372 final Set<BgpTableType> advertizedTableTypes = session.getAdvertisedTableTypes();
373 LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", this.name,
374 advertizedTableTypes, addPathTablesType);
375 final Set<TablesKey> setTables = advertizedTableTypes.stream().map(t -> new TablesKey(t.getAfi(), t.getSafi()))
376 .collect(Collectors.toSet());
377 this.tables = ImmutableSet.copyOf(setTables);
378 this.addPathTableMaps = mapTableTypesFamilies(addPathTablesType);
379 final boolean restartingLocally = isLocalRestarting();
381 if (!isRestartingGracefully()) {
382 this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
383 this.peerId = RouterIds.createPeerId(session.getBgpId());
384 this.peerIId = getInstanceIdentifier().child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns
385 .yang.bgp.rib.rev180329.bgp.rib.rib.Peer.class, new PeerKey(this.peerId));
386 this.peerPath = createPeerPath();
387 this.peerRibOutIId = peerIId.child(AdjRibOut.class);
388 this.trackerRegistration = this.rib.getPeerTracker().registerPeer(this);
389 createEffRibInWriter();
390 registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter);
392 this.effRibInWriter.init();
393 this.ribWriter = this.ribWriter.transform(this.peerId, this.peerPath, this.rib.getRibSupportContext(),
394 this.tables, this.addPathTableMaps);
396 if (this.rpcRegistry != null) {
397 this.rpcRegistration = this.rpcRegistry.addRoutedRpcImplementation(BgpPeerRpcService.class,
398 new BgpPeerRpc(this, session, this.tables));
399 final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
400 .rev180329.bgp.rib.rib.Peer, PeerKey> path = this.rib.getInstanceIdentifier()
401 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib
402 .rib.Peer.class, new PeerKey(this.peerId));
403 this.rpcRegistration.registerPath(PeerContext.class, path);
406 final Set<TablesKey> forwardingTables;
407 if (advertisedTables == null) {
408 forwardingTables = Collections.emptySet();
410 forwardingTables = advertisedTables.stream()
411 .filter(table -> table.getAfiFlags() != null)
412 .filter(table -> table.getAfiFlags().isForwardingState())
413 .map(table -> new TablesKey(table.getAfi(), table.getSafi()))
414 .collect(Collectors.toSet());
416 this.ribWriter.clearTables(Sets.difference(this.tables, forwardingTables));
417 if (restartingLocally) {
418 this.effRibInWriter.close();
419 this.peerRestartStopwatch = Stopwatch.createStarted();
420 handleSelectionReferralTimer();
421 this.missingEOT.addAll(this.tables);
424 if (advertisedTables == null ||
425 advertisedTables.isEmpty()) {
426 setAdvertizedGracefulRestartTableTypes(Collections.emptyList());
428 setAdvertizedGracefulRestartTableTypes(advertisedTables.stream()
429 .map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList()));
431 final int restartTime = advertisedGracefulRestartCapability.getRestartTime();
432 setAfiSafiGracefulRestartState(restartTime, false, restartingLocally);
433 if (!restartingLocally) {
435 for (final TablesKey key : this.tables) {
436 createAdjRibOutListener(key, true);
441 private boolean isRestartingGracefully() {
442 return isLocalRestarting() || isPeerRestarting();
445 private synchronized void createEffRibInWriter() {
446 this.effRibInWriter = new EffectiveRibInWriter(this, this.rib,
447 this.rib.createPeerChain(this),
448 this.peerIId, this.tables, this.tableTypeRegistry,
453 //try to add a support for old-school BGP-4, if peer did not advertise IPv4-Unicast MP capability
454 private synchronized void addBgp4Support() {
455 if (!this.tables.contains(IPV4_UCAST_TABLE_KEY)) {
456 final HashSet<TablesKey> newSet = new HashSet<>(this.tables);
457 newSet.add(IPV4_UCAST_TABLE_KEY);
458 this.tables = ImmutableSet.copyOf(newSet);
459 createAdjRibOutListener(IPV4_UCAST_TABLE_KEY, false);
463 private synchronized void createAdjRibOutListener(final TablesKey key,
464 final boolean mpSupport) {
465 final RIBSupport<?, ?, ?, ?> ribSupport = this.rib.getRibSupportContext().getRIBSupport(key);
467 // not particularly nice
468 if (ribSupport != null && this.session instanceof BGPSessionImpl) {
469 final ChannelOutputLimiter limiter = ((BGPSessionImpl) this.session).getLimiter();
470 final AdjRibOutListener adjRibOut = AdjRibOutListener.create(this.peerId, key,
471 this.rib.getYangRibId(), this.rib.getCodecsRegistry(), ribSupport,
472 this.rib.getService(), limiter, mpSupport);
473 this.adjRibOutListenerSet.put(key, adjRibOut);
474 registerPrefixesSentCounter(key, adjRibOut);
479 public synchronized void onSessionDown(final BGPSession session, final Exception e) {
480 if (e.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) {
481 LOG.info("Session with peer {} went down", this.name);
483 LOG.info("Session with peer {} went down", this.name, e);
485 releaseConnectionGracefully();
489 public synchronized void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
490 LOG.info("Session with peer {} terminated: {}", this.name, cause);
491 releaseConnectionGracefully();
495 public String toString() {
496 return MoreObjects.toStringHelper(this)
497 .add("name", this.name)
498 .add("tables", this.tables).toString();
502 public synchronized FluentFuture<? extends CommitInfo> releaseConnection() {
503 LOG.info("Closing session with peer");
504 this.sessionUp = false;
505 this.adjRibOutListenerSet.values().forEach(AdjRibOutListener::close);
506 this.adjRibOutListenerSet.clear();
507 final FluentFuture<? extends CommitInfo> future;
508 if (!isRestartingGracefully()) {
509 future = terminateConnection();
511 final Set<TablesKey> gracefulTables = getGracefulTables();
512 this.ribWriter.storeStaleRoutes(gracefulTables);
513 future = this.ribWriter.clearTables(Sets.difference(this.tables, gracefulTables));
514 if (isPeerRestarting()) {
515 this.peerRestartStopwatch = Stopwatch.createStarted();
516 handleRestartTimer();
519 releaseBindingChain();
521 if (this.session != null) {
523 if (isRestartingGracefully()) {
524 this.session.closeWithoutMessage();
526 this.session.close();
528 } catch (final Exception e) {
529 LOG.warn("Error closing session with peer", e);
536 private Set<TablesKey> getGracefulTables() {
537 return this.tables.stream()
538 .filter(this::isGracefulRestartReceived)
539 .filter(this::isGracefulRestartAdvertized)
540 .collect(Collectors.toSet());
543 private synchronized FluentFuture<? extends CommitInfo> terminateConnection() {
544 final FluentFuture<? extends CommitInfo> future;
545 if (this.trackerRegistration != null) {
546 this.trackerRegistration.close();
547 this.trackerRegistration = null;
549 if (this.rpcRegistration != null) {
550 this.rpcRegistration.close();
552 this.ribWriter.releaseChain();
554 if (this.effRibInWriter != null) {
555 this.effRibInWriter.close();
557 this.tables = Collections.emptySet();
558 this.addPathTableMaps = Collections.emptyMap();
559 future = removePeer(this.peerPath);
566 * If Graceful Restart Timer expires, remove all routes advertised by peer.
568 private synchronized void handleRestartTimer() {
569 if (!isPeerRestarting()) {
573 final long peerRestartTimeNanos = TimeUnit.SECONDS.toNanos(getPeerRestartTime());
574 final long elapsedNanos = this.peerRestartStopwatch.elapsed(TimeUnit.NANOSECONDS);
575 if (elapsedNanos >= peerRestartTimeNanos) {
576 setAfiSafiGracefulRestartState(0, false, false);
577 onSessionTerminated(this.session, new BGPTerminationReason(BGPError.HOLD_TIMER_EXPIRED));
579 new ScheduledThreadPoolExecutor(1)
580 .schedule(this::handleRestartTimer, peerRestartTimeNanos - elapsedNanos, TimeUnit.NANOSECONDS);
583 private synchronized void handleSelectionReferralTimer() {
584 if (!isLocalRestarting()) {
588 final long referalTimerNanos = TimeUnit.SECONDS.toNanos(this.selectionDeferralTimerSeconds);
589 final long elapsedNanos = this.peerRestartStopwatch.elapsed(TimeUnit.NANOSECONDS);
590 if (elapsedNanos >= referalTimerNanos) {
591 this.missingEOT.clear();
592 handleGracefulEndOfRib();
594 new ScheduledThreadPoolExecutor(1)
595 .schedule(this::handleSelectionReferralTimer, referalTimerNanos - elapsedNanos, TimeUnit.NANOSECONDS);
598 private void releaseConnectionGracefully() {
599 if (getPeerRestartTime() > 0) {
600 setRestartingState();
605 @SuppressFBWarnings("IS2_INCONSISTENT_SYNC")
607 public SendReceive getSupportedAddPathTables(final TablesKey tableKey) {
608 return this.addPathTableMaps.get(tableKey);
612 public boolean supportsTable(final TablesKey tableKey) {
613 return this.tables.contains(tableKey) && this.sessionUp;
617 public KeyedInstanceIdentifier<Tables, TablesKey> getRibOutIId(final TablesKey tablesKey) {
618 return this.tablesIId.getUnchecked(tablesKey);
622 public synchronized void onTransactionChainFailed(final TransactionChain<?, ?> chain,
623 final AsyncTransaction<?, ?> transaction, final Throwable cause) {
624 LOG.error("Transaction domChain failed.", cause);
629 public synchronized void markUptodate(final TablesKey tablesKey) {
630 this.ribWriter.markTableUptodate(tablesKey);
634 public synchronized BGPSessionState getBGPSessionState() {
635 if (this.session instanceof BGPSessionStateProvider) {
636 return ((BGPSessionStateProvider) this.session).getBGPSessionState();
642 public synchronized BGPTimersState getBGPTimersState() {
643 if (this.session instanceof BGPSessionStateProvider) {
644 return ((BGPSessionStateProvider) this.session).getBGPTimersState();
650 public synchronized BGPTransportState getBGPTransportState() {
651 if (this.session instanceof BGPSessionStateProvider) {
652 return ((BGPSessionStateProvider) this.session).getBGPTransportState();
658 public List<RouteTarget> getMemberships() {
659 return this.rtMemberships;
663 public synchronized ListenableFuture<?> restartGracefully(final long selectionDeferralTimerSeconds) {
664 final Set<TablesKey> tablesToPreserve = getGracefulTables();
665 if (tablesToPreserve == null || tablesToPreserve.isEmpty()) {
666 LOG.info("Peer {} is not capable of graceful restart or have no matching graceful tables.", this.peerId);
667 return Futures.immediateFailedFuture(new UnsupportedOperationException(
668 "Peer is not capable of graceful restart"));
670 setGracefulPreferences(true, tablesToPreserve);
671 this.selectionDeferralTimerSeconds = selectionDeferralTimerSeconds;
672 setLocalRestartingState(true);
673 return releaseConnection();
676 private synchronized void setGracefulPreferences(final boolean localRestarting,
677 final Set<TablesKey> preservedTables) {
678 final Set<TablesKey> gracefulTables = this.tables.stream()
679 .filter(this::isGracefulRestartAdvertized)
680 .collect(Collectors.toSet());
681 final BgpParameters bgpParameters = GracefulRestartUtil.getGracefulBgpParameters(
682 this.bgpPeer.getBgpFixedCapabilities(), gracefulTables, preservedTables,
683 this.bgpPeer.getGracefulRestartTimer(), localRestarting, Collections.emptySet());
684 final BGPSessionPreferences oldPrefs = this.rib.getDispatcher().getBGPPeerRegistry()
685 .getPeerPreferences(getNeighborAddress());
686 final BGPSessionPreferences newPrefs = new BGPSessionPreferences(
688 oldPrefs.getHoldTime(),
690 oldPrefs.getExpectedRemoteAs(),
691 Collections.singletonList(bgpParameters),
692 oldPrefs.getMd5Password());
693 this.rib.getDispatcher().getBGPPeerRegistry()
694 .updatePeerPreferences(getNeighborAddress(), newPrefs);