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     }
 150
 151     // FIXME ListenableFuture<?> should be used once closeServiceInstance uses wildcard too
 152     @Override
 153     public synchronized ListenableFuture<Void> close() {
 154         final ListenableFuture<Void> future = releaseConnection();
 155         this.chain.close();
 156         return future;
 157     }
 158
 159     @Override
 160     public void onMessage(final BGPSession session, final Notification msg) throws BGPDocumentedException {
 161         if (!(msg instanceof Update) && !(msg instanceof RouteRefresh)) {
 162             LOG.info("Ignoring unhandled message class {}", msg.getClass());
 163             return;
 164         }
 165         if (msg instanceof Update) {
 166             onUpdateMessage((Update) msg);
 167         } else {
 168             onRouteRefreshMessage((RouteRefresh) msg, session);
 169         }
 170     }
 171
 172     private void onRouteRefreshMessage(final RouteRefresh message, final BGPSession session) {
 173         final Class<? extends AddressFamily> rrAfi = message.getAfi();
 174         final Class<? extends SubsequentAddressFamily> rrSafi = message.getSafi();
 175
 176         final TablesKey key = new TablesKey(rrAfi, rrSafi);
 177         final AdjRibOutListener listener = this.adjRibOutListenerSet.get(key);
 178         if (listener != null) {
 179             listener.close();
 180             this.adjRibOutListenerSet.remove(key);
 181             createAdjRibOutListener(RouterIds.createPeerId(session.getBgpId()), key, listener.isMpSupported());
 182         } else {
 183             LOG.info("Ignoring RouteRefresh message. Afi/Safi is not supported: {}, {}.", rrAfi, rrSafi);
 184         }
 185     }
 186
 187     /**
 188      * Check for presence of well known mandatory attribute LOCAL_PREF in Update message
 189      *
 190      * @param message Update message
 191      * @throws BGPDocumentedException
 192      */
 193     private void checkMandatoryAttributesPresence(final Update message) throws BGPDocumentedException {
 194         if (MessageUtil.isAnyNlriPresent(message)) {
 195             final Attributes attrs = message.getAttributes();
 196             if (this.peerRole == PeerRole.Ibgp && (attrs == null || attrs.getLocalPref() == null)) {
 197                 throw new BGPDocumentedException(BGPError.MANDATORY_ATTR_MISSING_MSG + "LOCAL_PREF",
 198                         BGPError.WELL_KNOWN_ATTR_MISSING,
 199                         new byte[]{LocalPreferenceAttributeParser.TYPE});
 200             }
 201         }
 202     }
 203
 204     /**
 205      * Process Update message received.
 206      * Calls {@link #checkMandatoryAttributesPresence(Update)} to check for presence of mandatory attributes.
 207      *
 208      * @param message Update message
 209      * @throws BGPDocumentedException
 210      */
 211     private void onUpdateMessage(final Update message) throws BGPDocumentedException {
 212         checkMandatoryAttributesPresence(message);
 213
 214         // update AdjRibs
 215         final Attributes attrs = message.getAttributes();
 216         MpReachNlri mpReach = null;
 217         final boolean isAnyNlriAnnounced = message.getNlri() != null;
 218         if (isAnyNlriAnnounced) {
 219             mpReach = prefixesToMpReach(message);
 220         } else {
 221             mpReach = MessageUtil.getMpReachNlri(attrs);
 222         }
 223         if (mpReach != null) {
 224             this.ribWriter.updateRoutes(mpReach, nextHopToAttribute(attrs, mpReach));
 225         }
 226         MpUnreachNlri mpUnreach = null;
 227         if (message.getWithdrawnRoutes() != null) {
 228             mpUnreach = prefixesToMpUnreach(message, isAnyNlriAnnounced);
 229         } else {
 230             mpUnreach = MessageUtil.getMpUnreachNlri(attrs);
 231         }
 232         if (mpUnreach != null) {
 233             this.ribWriter.removeRoutes(mpUnreach);
 234         }
 235     }
 236
 237     private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) {
 238         if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) {
 239             final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs);
 240             attributesBuilder.setCNextHop(mpReach.getCNextHop());
 241             return attributesBuilder.build();
 242         }
 243         return attrs;
 244     }
 245
 246     /**
 247      * Creates MPReach for the prefixes to be handled in the same way as linkstate routes
 248      *
 249      * @param message Update message containing prefixes in NLRI
 250      * @return MpReachNlri with prefixes from the nlri field
 251      */
 252     private static MpReachNlri prefixesToMpReach(final Update message) {
 253         final List<Ipv4Prefixes> prefixes = new ArrayList<>();
 254         for (final Ipv4Prefix p : message.getNlri().getNlri()) {
 255             prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
 256         }
 257         final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
 258                 UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
 259                 new AdvertizedRoutesBuilder().setDestinationType(
 260                         new DestinationIpv4CaseBuilder().setDestinationIpv4(
 261                                 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
 262         if (message.getAttributes() != null) {
 263             b.setCNextHop(message.getAttributes().getCNextHop());
 264         }
 265         return b.build();
 266     }
 267
 268     /**
 269      * Create MPUnreach for the prefixes to be handled in the same way as linkstate routes
 270      *
 271      * @param message            Update message containing withdrawn routes
 272      * @param isAnyNlriAnnounced
 273      * @return MpUnreachNlri with prefixes from the withdrawn routes field
 274      */
 275     private static MpUnreachNlri prefixesToMpUnreach(final Update message, final boolean isAnyNlriAnnounced) {
 276         final List<Ipv4Prefixes> prefixes = new ArrayList<>();
 277         for (final Ipv4Prefix p : message.getWithdrawnRoutes().getWithdrawnRoutes()) {
 278             boolean nlriAnounced = false;
 279             if (isAnyNlriAnnounced) {
 280                 nlriAnounced = message.getNlri().getNlri().contains(p);
 281             }
 282
 283             if (!nlriAnounced) {
 284                 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
 285             }
 286         }
 287         return new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setWithdrawnRoutes(
 288                 new WithdrawnRoutesBuilder().setDestinationType(
 289                         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(
 290                                 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build();
 291     }
 292
 293     @Override
 294     public synchronized void onSessionUp(final BGPSession session) {
 295         this.session = session;
 296         if (this.session instanceof BGPSessionStateProvider) {
 297             ((BGPSessionStateProvider) this.session).registerMessagesCounter(this);
 298         }
 299
 300         final List<AddressFamilies> addPathTablesType = session.getAdvertisedAddPathTableTypes();
 301         final Set<BgpTableType> advertizedTableTypes = session.getAdvertisedTableTypes();
 302         final List<BgpTableType> advertizedGracefulRestartTableTypes = session.getAdvertisedGracefulRestartTableTypes();
 303         LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", this.name, advertizedTableTypes, addPathTablesType);
 304         this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
 305         final PeerId peerId = RouterIds.createPeerId(session.getBgpId());
 306
 307         this.tables.addAll(advertizedTableTypes.stream().map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList()));
 308
 309         setAdvertizedGracefulRestartTableTypes(advertizedGracefulRestartTableTypes.stream()
 310                 .map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList()));
 311         final boolean announceNone = isAnnounceNone(this.simpleRoutingPolicy);
 312         final Map<TablesKey, SendReceive> addPathTableMaps = mapTableTypesFamilies(addPathTablesType);
 313         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)
 314                 .node(IdentifierUtils.domPeerId(peerId));
 315
 316         if (!announceNone) {
 317             createAdjRibOutListener(peerId);
 318         }
 319         this.tables.forEach(tablesKey -> {
 320             final ExportPolicyPeerTracker exportTracker = this.rib.getExportPolicyPeerTracker(tablesKey);
 321             if (exportTracker != null) {
 322                 this.tableRegistration.add(exportTracker.registerPeer(peerId, addPathTableMaps.get(tablesKey), this.peerIId, this.peerRole,
 323                         this.simpleRoutingPolicy));
 324             }
 325         });
 326         addBgp4Support(peerId, announceNone);
 327
 328         if (!isLearnNone(this.simpleRoutingPolicy)) {
 329             this.effRibInWriter = EffectiveRibInWriter.create(this.rib.getService(),
 330                     this.rib.createPeerChain(this),
 331                     this.peerIId, this.rib.getImportPolicyPeerTracker(),
 332                     this.rib.getRibSupportContext(),
 333                     this.peerRole,
 334                     this.tables);
 335             registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter);
 336         }
 337         this.ribWriter = this.ribWriter.transform(peerId, this.rib.getRibSupportContext(), this.tables, addPathTableMaps);
 338
 339         if (this.rpcRegistry != null) {
 340             this.rpcRegistration = this.rpcRegistry.addRoutedRpcImplementation(BgpPeerRpcService.class,
 341                     new BgpPeerRpc(this, session, this.tables));
 342             final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer, PeerKey> path =
 343                     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));
 344             this.rpcRegistration.registerPath(PeerContext.class, path);
 345         }
 346     }
 347
 348     private void createAdjRibOutListener(final PeerId peerId) {
 349         this.tables.forEach(key -> createAdjRibOutListener(peerId, key, true));
 350     }
 351
 352     //try to add a support for old-school BGP-4, if peer did not advertise IPv4-Unicast MP capability
 353     private void addBgp4Support(final PeerId peerId, final boolean announceNone) {
 354         final TablesKey key = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
 355         if (this.tables.add(key) && !announceNone) {
 356             createAdjRibOutListener(peerId, key, false);
 357         }
 358     }
 359
 360     private void createAdjRibOutListener(final PeerId peerId, final TablesKey key, final boolean mpSupport) {
 361         final RIBSupportContext context = this.rib.getRibSupportContext().getRIBSupportContext(key);
 362
 363         // not particularly nice
 364         if (context != null && this.session instanceof BGPSessionImpl) {
 365             final ChannelOutputLimiter limiter = ((BGPSessionImpl) this.session).getLimiter();
 366             final AdjRibOutListener adjRibOut = AdjRibOutListener.create(peerId, key,
 367                     this.rib.getYangRibId(), this.rib.getCodecsRegistry(), context.getRibSupport(),
 368                     this.rib.getService(), limiter, mpSupport);
 369             this.adjRibOutListenerSet.put(key, adjRibOut);
 370             registerPrefixesSentCounter(key, adjRibOut);
 371         }
 372     }
 373
 374     private ListenableFuture<Void> cleanup() {
 375         // FIXME: BUG-196: support graceful
 376         this.adjRibOutListenerSet.values().forEach(AdjRibOutListener::close);
 377         this.adjRibOutListenerSet.clear();
 378         if (this.effRibInWriter != null) {
 379             this.effRibInWriter.close();
 380         }
 381         this.tables.clear();
 382         if (this.ribWriter != null) {
 383             return this.ribWriter.removePeer();
 384         }
 385         return Futures.immediateFuture(null);
 386     }
 387
 388     @Override
 389     public void onSessionDown(final BGPSession session, final Exception e) {
 390         if (e.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) {
 391             LOG.info("Session with peer {} went down", this.name);
 392         } else {
 393             LOG.info("Session with peer {} went down", this.name, e);
 394         }
 395         releaseConnection();
 396     }
 397
 398     @Override
 399     public void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
 400         LOG.info("Session with peer {} terminated: {}", this.name, cause);
 401         releaseConnection();
 402     }
 403
 404     @Override
 405     public String toString() {
 406         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
 407     }
 408
 409     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 410         toStringHelper.add("name", this.name);
 411         toStringHelper.add("tables", this.tables);
 412         return toStringHelper;
 413     }
 414
 415     @Override
 416     public String getName() {
 417         return this.name;
 418     }
 419
 420     @Override
 421     public synchronized ListenableFuture<Void> releaseConnection() {
 422         if (this.rpcRegistration != null) {
 423             this.rpcRegistration.close();
 424         }
 425         closeRegistration();
 426         final ListenableFuture<Void> future = cleanup();
 427
 428         if (this.session != null) {
 429             try {
 430                 this.session.close();
 431             } catch (final Exception e) {
 432                 LOG.warn("Error closing session with peer", e);
 433             }
 434             this.session = null;
 435         }
 436
 437         resetState();
 438         return future;
 439     }
 440
 441     private void closeRegistration() {
 442         this.tableRegistration.iterator().forEachRemaining(AbstractRegistration::close);
 443         this.tableRegistration.clear();
 444     }
 445
 446     @Override
 447     public synchronized byte[] getRawIdentifier() {
 448         return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
 449     }
 450
 451     @Override
 452     public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 453         LOG.error("Transaction chain failed.", cause);
 454         this.chain.close();
 455         this.chain = this.rib.createPeerChain(this);
 456         this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this.simpleRoutingPolicy, this.chain);
 457         releaseConnection();
 458     }
 459
 460     @Override
 461     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 462         LOG.debug("Transaction chain {} successfull.", chain);
 463     }
 464
 465     @Override
 466     public void markUptodate(final TablesKey tablesKey) {
 467         this.ribWriter.markTableUptodate(tablesKey);
 468     }
 469
 470     private static Map<TablesKey, SendReceive> mapTableTypesFamilies(final List<AddressFamilies> addPathTablesType) {
 471         return ImmutableMap.copyOf(addPathTablesType.stream().collect(Collectors.toMap(af -> new TablesKey(af.getAfi(), af.getSafi()),
 472                 BgpAddPathTableType::getSendReceive)));
 473     }
 474
 475     @Override
 476     public BGPErrorHandlingState getBGPErrorHandlingState() {
 477         return this;
 478     }
 479
 480     @Override
 481     public BGPAfiSafiState getBGPAfiSafiState() {
 482         return this;
 483     }
 484
 485     @Override
 486     public BGPSessionState getBGPSessionState() {
 487         if (this.session instanceof BGPSessionStateProvider) {
 488             return ((BGPSessionStateProvider) this.session).getBGPSessionState();
 489         }
 490         return null;
 491     }
 492
 493     @Override
 494     public BGPTimersState getBGPTimersState() {
 495         if (this.session instanceof BGPSessionStateProvider) {
 496             return ((BGPSessionStateProvider) this.session).getBGPTimersState();
 497         }
 498         return null;
 499     }
 500
 501     @Override
 502     public BGPTransportState getBGPTransportState() {
 503         if (this.session instanceof BGPSessionStateProvider) {
 504             return ((BGPSessionStateProvider) this.session).getBGPTransportState();
 505         }
 506         return null;
 507     }
 508 }