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