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