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