bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/BGPPeer.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.protocol.bgp.rib.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects;
  13 import com.google.common.base.MoreObjects.ToStringHelper;
  14 import com.google.common.base.Objects;
  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.net.InetAddresses;
  21 import com.google.common.util.concurrent.Futures;
  22 import com.google.common.util.concurrent.ListenableFuture;
  23 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  24 import java.util.ArrayList;
  25 import java.util.Arrays;
  26 import java.util.Collections;
  27 import java.util.HashMap;
  28 import java.util.HashSet;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Optional;
  32 import java.util.Set;
  33 import java.util.stream.Collectors;
  34 import javax.annotation.concurrent.GuardedBy;
  35 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  36 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  37 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  38 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  39 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
  40 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  41 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
  42 import org.opendaylight.protocol.bgp.parser.BGPError;
  43 import org.opendaylight.protocol.bgp.parser.impl.message.update.LocalPreferenceAttributeParser;
  44 import org.opendaylight.protocol.bgp.parser.spi.MessageUtil;
  45 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  46 import org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl;
  47 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateProvider;
  48 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
  49 import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
  50 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
  51 import org.opendaylight.protocol.bgp.rib.spi.Peer;
  52 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  53 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
  54 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters;
  55 import org.opendaylight.protocol.bgp.rib.spi.state.BGPAfiSafiState;
  56 import org.opendaylight.protocol.bgp.rib.spi.state.BGPErrorHandlingState;
  57 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
  58 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
  59 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
  60 import org.opendaylight.protocol.concepts.AbstractRegistration;
  61 import org.opendaylight.protocol.util.Ipv4Util;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.ipv4.prefixes.DestinationIpv4Builder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationIpv4CaseBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Update;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.Attributes;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.AttributesBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.update.message.Nlri;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpAddPathTableType;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpTableType;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.RouteRefresh;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.SendReceive;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.add.path.capability.AddressFamilies;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpReachNlri;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpReachNlriBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpUnreachNlri;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpUnreachNlriBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev171207.BgpPeerRpcService;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev171207.PeerContext;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerId;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.PeerKey;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.peer.AdjRibOut;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.Tables;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  94 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  95 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  96 import org.opendaylight.yangtools.yang.binding.Notification;
  97 import org.slf4j.Logger;
  98 import org.slf4j.LoggerFactory;
  99
 100 /**
 101  * Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into
 102  * RIB actions.
 103  */
 104 public class BGPPeer extends BGPPeerStateImpl implements BGPRouteEntryImportParameters,
 105         BGPSessionListener, Peer, TransactionChainListener {
 106     private static final Logger LOG = LoggerFactory.getLogger(BGPPeer.class);
 107
 108     private Set<TablesKey> tables = Collections.emptySet();
 109     private final RIB rib;
 110     private final String name;
 111     private final Map<TablesKey, AdjRibOutListener> adjRibOutListenerSet = new HashMap<>();
 112     private final RpcProviderRegistry rpcRegistry;
 113     private final PeerRole peerRole;
 114     private final InstanceIdentifier<AdjRibOut> peerRibOutIId;
 115     private final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
 116             .rev171207.bgp.rib.rib.Peer, PeerKey> peerIId;
 117     @GuardedBy("this")
 118     private AbstractRegistration trackerRegistration;
 119     private final PeerId peerId;
 120     private final LoadingCache<TablesKey, KeyedInstanceIdentifier<Tables, TablesKey>> tablesIId
 121             = CacheBuilder.newBuilder()
 122             .build(new CacheLoader<TablesKey, KeyedInstanceIdentifier<Tables, TablesKey>>() {
 123                 @Override
 124                 public KeyedInstanceIdentifier<Tables, TablesKey> load(final TablesKey tablesKey) {
 125                     return BGPPeer.this.peerRibOutIId.child(Tables.class, tablesKey);
 126                 }
 127             });
 128
 129     @GuardedBy("this")
 130     private BGPSession session;
 131     @GuardedBy("this")
 132     private byte[] rawIdentifier;
 133     @GuardedBy("this")
 134     private DOMTransactionChain chain;
 135     @GuardedBy("this")
 136     private AdjRibInWriter ribWriter;
 137     @GuardedBy("this")
 138     private EffectiveRibInWriter effRibInWriter;
 139     private RoutedRpcRegistration<BgpPeerRpcService> rpcRegistration;
 140     private Map<TablesKey, SendReceive> addPathTableMaps = Collections.emptyMap();
 141
 142     public BGPPeer(final IpAddress neighborAddress, final RIB rib, final PeerRole role,
 143             final RpcProviderRegistry rpcRegistry,
 144             final Set<TablesKey> afiSafisAdvertized,
 145             final Set<TablesKey> afiSafisGracefulAdvertized) {
 146         //FIXME BUG-6971 Once Peer Group is implemented, pass it
 147         super(rib.getInstanceIdentifier(), null, neighborAddress, afiSafisAdvertized,
 148                 afiSafisGracefulAdvertized);
 149         this.peerRole = role;
 150         this.rib = requireNonNull(rib);
 151         this.name = Ipv4Util.toStringIP(neighborAddress);
 152         this.rpcRegistry = rpcRegistry;
 153         this.peerId = RouterIds.createPeerId(neighborAddress);
 154         this.peerIId = getInstanceIdentifier().child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns
 155                 .yang.bgp.rib.rev171207.bgp.rib.rib.Peer.class, new PeerKey(this.peerId));
 156         this.peerRibOutIId = this.peerIId.child(AdjRibOut.class);
 157         this.chain = rib.createPeerDOMChain(this);
 158     }
 159
 160     private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) {
 161         if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) {
 162             final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs);
 163             attributesBuilder.setCNextHop(mpReach.getCNextHop());
 164             return attributesBuilder.build();
 165         }
 166         return attrs;
 167     }
 168
 169     /**
 170      * Creates MPReach for the prefixes to be handled in the same way as linkstate routes.
 171      *
 172      * @param message Update message containing prefixes in NLRI
 173      * @return MpReachNlri with prefixes from the nlri field
 174      */
 175     private static MpReachNlri prefixesToMpReach(final Update message) {
 176         final List<Ipv4Prefixes> prefixes = message.getNlri().stream()
 177                 .map(n -> new Ipv4PrefixesBuilder().setPrefix(n.getPrefix()).setPathId(n.getPathId()).build())
 178                 .collect(Collectors.toList());
 179         final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
 180                 UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
 181                 new AdvertizedRoutesBuilder().setDestinationType(
 182                         new DestinationIpv4CaseBuilder().setDestinationIpv4(
 183                                 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
 184         if (message.getAttributes() != null) {
 185             b.setCNextHop(message.getAttributes().getCNextHop());
 186         }
 187         return b.build();
 188     }
 189
 190     /**
 191      * Create MPUnreach for the prefixes to be handled in the same way as linkstate routes.
 192      *
 193      * @param message            Update message containing withdrawn routes
 194      * @param isAnyNlriAnnounced isAnyNlriAnnounced
 195      * @return MpUnreachNlri with prefixes from the withdrawn routes field
 196      */
 197     private static MpUnreachNlri prefixesToMpUnreach(final Update message, final boolean isAnyNlriAnnounced) {
 198         final List<Ipv4Prefixes> prefixes = new ArrayList<>();
 199         message.getWithdrawnRoutes().forEach(w -> {
 200
 201             Optional<Nlri> nlriAnounced = Optional.empty();
 202             if (isAnyNlriAnnounced) {
 203                 nlriAnounced = message.getNlri().stream().filter(n -> Objects.equal(n.getPrefix(), w.getPrefix())
 204                         && Objects.equal(n.getPathId(), w.getPathId()))
 205                         .findAny();
 206             }
 207             if (!nlriAnounced.isPresent()) {
 208                 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(w.getPrefix()).setPathId(w.getPathId()).build());
 209             }
 210         });
 211         return new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class)
 212                 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(new org.opendaylight.yang.gen.v1
 213                         .urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.update.attributes.mp.unreach.nlri
 214                         .withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4(
 215                         new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build();
 216     }
 217
 218     private static Map<TablesKey, SendReceive> mapTableTypesFamilies(final List<AddressFamilies> addPathTablesType) {
 219         return ImmutableMap.copyOf(addPathTablesType.stream().collect(Collectors.toMap(af -> new TablesKey(af.getAfi(),
 220                         af.getSafi()), BgpAddPathTableType::getSendReceive)));
 221     }
 222
 223     public synchronized void instantiateServiceInstance() {
 224         this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this.chain);
 225         setActive(true);
 226     }
 227
 228     // FIXME ListenableFuture<?> should be used once closeServiceInstance uses wildcard too
 229     @Override
 230     public synchronized ListenableFuture<Void> close() {
 231         final ListenableFuture<Void> future = releaseConnection();
 232         this.chain.close();
 233         setActive(false);
 234         return future;
 235     }
 236
 237     @Override
 238     public void onMessage(final BGPSession session, final Notification msg) throws BGPDocumentedException {
 239         if (!(msg instanceof Update) && !(msg instanceof RouteRefresh)) {
 240             LOG.info("Ignoring unhandled message class {}", msg.getClass());
 241             return;
 242         }
 243         if (msg instanceof Update) {
 244             onUpdateMessage((Update) msg);
 245         } else {
 246             onRouteRefreshMessage((RouteRefresh) msg);
 247         }
 248     }
 249
 250     private void onRouteRefreshMessage(final RouteRefresh message) {
 251         final Class<? extends AddressFamily> rrAfi = message.getAfi();
 252         final Class<? extends SubsequentAddressFamily> rrSafi = message.getSafi();
 253
 254         final TablesKey key = new TablesKey(rrAfi, rrSafi);
 255         final AdjRibOutListener listener = this.adjRibOutListenerSet.get(key);
 256         if (listener != null) {
 257             listener.close();
 258             this.adjRibOutListenerSet.remove(key);
 259             createAdjRibOutListener(key, listener.isMpSupported());
 260         } else {
 261             LOG.info("Ignoring RouteRefresh message. Afi/Safi is not supported: {}, {}.", rrAfi, rrSafi);
 262         }
 263     }
 264
 265     /**
 266      * Check for presence of well known mandatory attribute LOCAL_PREF in Update message.
 267      *
 268      * @param message Update message
 269      */
 270     private void checkMandatoryAttributesPresence(final Update message) throws BGPDocumentedException {
 271         if (MessageUtil.isAnyNlriPresent(message)) {
 272             final Attributes attrs = message.getAttributes();
 273             if (this.peerRole == PeerRole.Ibgp && (attrs == null || attrs.getLocalPref() == null)) {
 274                 throw new BGPDocumentedException(BGPError.MANDATORY_ATTR_MISSING_MSG + "LOCAL_PREF",
 275                         BGPError.WELL_KNOWN_ATTR_MISSING,
 276                         new byte[]{LocalPreferenceAttributeParser.TYPE});
 277             }
 278         }
 279     }
 280
 281     /**
 282      * Process Update message received.
 283      * Calls {@link #checkMandatoryAttributesPresence(Update)} to check for presence of mandatory attributes.
 284      *
 285      * @param message Update message
 286      */
 287     private synchronized void onUpdateMessage(final Update message) throws BGPDocumentedException {
 288         checkMandatoryAttributesPresence(message);
 289
 290         // update AdjRibs
 291         final Attributes attrs = message.getAttributes();
 292         MpReachNlri mpReach;
 293         final boolean isAnyNlriAnnounced = message.getNlri() != null;
 294         if (isAnyNlriAnnounced) {
 295             mpReach = prefixesToMpReach(message);
 296         } else {
 297             mpReach = MessageUtil.getMpReachNlri(attrs);
 298         }
 299         if (mpReach != null) {
 300             this.ribWriter.updateRoutes(mpReach, nextHopToAttribute(attrs, mpReach));
 301         }
 302         MpUnreachNlri mpUnreach;
 303         if (message.getWithdrawnRoutes() != null) {
 304             mpUnreach = prefixesToMpUnreach(message, isAnyNlriAnnounced);
 305         } else {
 306             mpUnreach = MessageUtil.getMpUnreachNlri(attrs);
 307         }
 308         if (mpUnreach != null) {
 309             this.ribWriter.removeRoutes(mpUnreach);
 310         }
 311     }
 312
 313     @Override
 314     public synchronized void onSessionUp(final BGPSession session) {
 315         this.session = session;
 316         if (this.session instanceof BGPSessionStateProvider) {
 317             ((BGPSessionStateProvider) this.session).registerMessagesCounter(this);
 318         }
 319         final List<AddressFamilies> addPathTablesType = session.getAdvertisedAddPathTableTypes();
 320         final Set<BgpTableType> advertizedTableTypes = session.getAdvertisedTableTypes();
 321         final List<BgpTableType> advertizedGracefulRestartTableTypes = session.getAdvertisedGracefulRestartTableTypes();
 322         LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", this.name,
 323                 advertizedTableTypes, addPathTablesType);
 324         this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
 325         final Set<TablesKey> setTables = advertizedTableTypes.stream().map(t -> new TablesKey(t.getAfi(), t.getSafi()))
 326                 .collect(Collectors.toSet());
 327         this.tables = ImmutableSet.copyOf(setTables);
 328
 329         setAdvertizedGracefulRestartTableTypes(advertizedGracefulRestartTableTypes.stream()
 330                 .map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList()));
 331         this.addPathTableMaps = ImmutableMap.copyOf(mapTableTypesFamilies(addPathTablesType));
 332         this.trackerRegistration = this.rib.getPeerTracker().registerPeer(this);
 333
 334         for (final TablesKey key : this.tables) {
 335             createAdjRibOutListener(key, true);
 336         }
 337
 338         addBgp4Support();
 339
 340         this.effRibInWriter = EffectiveRibInWriter.create(this, this.rib, this.rib.createPeerChain(this),
 341                 this.peerIId, this.tables);
 342
 343
 344         registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter);
 345         this.ribWriter = this.ribWriter.transform(this.peerId, this.rib.getRibSupportContext(), this.tables,
 346                 this.addPathTableMaps);
 347
 348         if (this.rpcRegistry != null) {
 349             this.rpcRegistration = this.rpcRegistry.addRoutedRpcImplementation(BgpPeerRpcService.class,
 350                     new BgpPeerRpc(this, session, this.tables));
 351             final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
 352                     .rev171207.bgp.rib.rib.Peer, PeerKey> path = this.rib.getInstanceIdentifier()
 353                     .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib
 354                              .rib.Peer.class, new PeerKey(this.peerId));
 355             this.rpcRegistration.registerPath(PeerContext.class, path);
 356         }
 357     }
 358
 359     //try to add a support for old-school BGP-4, if peer did not advertise IPv4-Unicast MP capability
 360     private synchronized void addBgp4Support() {
 361         final TablesKey key = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
 362         if (!this.tables.contains(key)) {
 363             final HashSet<TablesKey> newSet = new HashSet<>(this.tables);
 364             newSet.add(key);
 365             this.tables = ImmutableSet.copyOf(newSet);
 366             createAdjRibOutListener(key, false);
 367         }
 368     }
 369
 370     private synchronized void createAdjRibOutListener(final TablesKey key,
 371             final boolean mpSupport) {
 372         final RIBSupport ribSupport = this.rib.getRibSupportContext().getRIBSupport(key);
 373
 374         // not particularly nice
 375         if (ribSupport != null && this.session instanceof BGPSessionImpl) {
 376             final ChannelOutputLimiter limiter = ((BGPSessionImpl) this.session).getLimiter();
 377             final AdjRibOutListener adjRibOut = AdjRibOutListener.create(this.peerId, key,
 378                     this.rib.getYangRibId(), this.rib.getCodecsRegistry(), ribSupport,
 379                     this.rib.getService(), limiter, mpSupport);
 380             this.adjRibOutListenerSet.put(key, adjRibOut);
 381             registerPrefixesSentCounter(key, adjRibOut);
 382         }
 383     }
 384
 385     private synchronized ListenableFuture<Void> cleanup() {
 386         // FIXME: BUG-196: support graceful
 387         this.adjRibOutListenerSet.values().forEach(AdjRibOutListener::close);
 388         this.adjRibOutListenerSet.clear();
 389         if (this.effRibInWriter != null) {
 390             this.effRibInWriter.close();
 391         }
 392         this.tables = Collections.emptySet();
 393         this.addPathTableMaps = Collections.emptyMap();
 394         if (this.ribWriter != null) {
 395             return this.ribWriter.removePeer();
 396         }
 397         return Futures.immediateFuture(null);
 398     }
 399
 400     @Override
 401     public synchronized void onSessionDown(final BGPSession session, final Exception e) {
 402         if (e.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) {
 403             LOG.info("Session with peer {} went down", this.name);
 404         } else {
 405             LOG.info("Session with peer {} went down", this.name, e);
 406         }
 407         releaseConnection();
 408     }
 409
 410     @Override
 411     public synchronized void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
 412         LOG.info("Session with peer {} terminated: {}", this.name, cause);
 413         releaseConnection();
 414     }
 415
 416     @Override
 417     public String toString() {
 418         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
 419     }
 420
 421     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 422         toStringHelper.add("name", this.name);
 423         toStringHelper.add("tables", this.tables);
 424         return toStringHelper;
 425     }
 426
 427     @Override
 428     public String getName() {
 429         return this.name;
 430     }
 431
 432     @Override
 433     public synchronized ListenableFuture<Void> releaseConnection() {
 434         if (this.rpcRegistration != null) {
 435             this.rpcRegistration.close();
 436         }
 437         closeRegistration();
 438         final ListenableFuture<Void> future = cleanup();
 439
 440         if (this.session != null) {
 441             try {
 442                 this.session.close();
 443             } catch (final Exception e) {
 444                 LOG.warn("Error closing session with peer", e);
 445             }
 446             this.session = null;
 447         }
 448         resetState();
 449         return future;
 450     }
 451
 452     private synchronized void closeRegistration() {
 453         if (this.trackerRegistration != null) {
 454             this.trackerRegistration.close();
 455             this.trackerRegistration = null;
 456         }
 457     }
 458
 459     @Override
 460     public synchronized byte[] getRawIdentifier() {
 461         return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
 462     }
 463
 464     @Override
 465     public PeerId getPeerId() {
 466         return this.peerId;
 467     }
 468
 469     @SuppressFBWarnings("IS2_INCONSISTENT_SYNC")
 470     @Override
 471     public SendReceive getSupportedAddPathTables(final TablesKey tableKey) {
 472         return this.addPathTableMaps.get(tableKey);
 473     }
 474
 475     @Override
 476     public boolean supportsTable(final TablesKey tableKey) {
 477         return this.tables.contains(tableKey);
 478     }
 479
 480     @Override
 481     public PeerRole getRole() {
 482         return this.peerRole;
 483     }
 484
 485     @Override
 486     public KeyedInstanceIdentifier<Tables, TablesKey> getRibOutIId(final TablesKey tablesKey) {
 487         return this.tablesIId.getUnchecked(tablesKey);
 488     }
 489
 490     @Override
 491     public synchronized void onTransactionChainFailed(final TransactionChain<?, ?> chain,
 492             final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 493         LOG.error("Transaction chain failed.", cause);
 494         this.chain.close();
 495         this.chain = this.rib.createPeerDOMChain(this);
 496         this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this.chain);
 497         releaseConnection();
 498     }
 499
 500     @Override
 501     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 502         LOG.debug("Transaction chain {} successful.", chain);
 503     }
 504
 505     @Override
 506     public synchronized void markUptodate(final TablesKey tablesKey) {
 507         this.ribWriter.markTableUptodate(tablesKey);
 508     }
 509
 510     @Override
 511     public BGPErrorHandlingState getBGPErrorHandlingState() {
 512         return this;
 513     }
 514
 515     @Override
 516     public BGPAfiSafiState getBGPAfiSafiState() {
 517         return this;
 518     }
 519
 520     @Override
 521     public synchronized BGPSessionState getBGPSessionState() {
 522         if (this.session instanceof BGPSessionStateProvider) {
 523             return ((BGPSessionStateProvider) this.session).getBGPSessionState();
 524         }
 525         return null;
 526     }
 527
 528     @Override
 529     public synchronized BGPTimersState getBGPTimersState() {
 530         if (this.session instanceof BGPSessionStateProvider) {
 531             return ((BGPSessionStateProvider) this.session).getBGPTimersState();
 532         }
 533         return null;
 534     }
 535
 536     @Override
 537     public synchronized BGPTransportState getBGPTransportState() {
 538         if (this.session instanceof BGPSessionStateProvider) {
 539             return ((BGPSessionStateProvider) this.session).getBGPTransportState();
 540         }
 541         return null;
 542     }
 543
 544     @Override
 545     public PeerRole getFromPeerRole() {
 546         return getRole();
 547     }
 548
 549     @Override
 550     public PeerId getFromPeerId() {
 551         return getPeerId();
 552     }
 553 }