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.Collections;
  25 import java.util.HashMap;
  26 import java.util.HashSet;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Optional;
  30 import java.util.Set;
  31 import java.util.stream.Collectors;
  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     private final PeerId peerId;
 116     private final YangInstanceIdentifier peerIId;
 117     @GuardedBy("this")
 118     private BGPSession session;
 119     @GuardedBy("this")
 120     private byte[] rawIdentifier;
 121     @GuardedBy("this")
 122     private DOMTransactionChain chain;
 123     @GuardedBy("this")
 124     private AdjRibInWriter ribWriter;
 125     @GuardedBy("this")
 126     private EffectiveRibInWriter effRibInWriter;
 127     private RoutedRpcRegistration<BgpPeerRpcService> rpcRegistration;
 128     private Map<TablesKey, SendReceive> addPathTableMaps = Collections.emptyMap();
 129
 130     public BGPPeer(final IpAddress neighborAddress, final RIB rib, final PeerRole role,
 131             final SimpleRoutingPolicy peerStatus, final RpcProviderRegistry rpcRegistry,
 132             final Set<TablesKey> afiSafisAdvertized,
 133             final Set<TablesKey> afiSafisGracefulAdvertized) {
 134         //FIXME BUG-6971 Once Peer Group is implemented, pass it
 135         super(rib.getInstanceIdentifier(), null, neighborAddress, afiSafisAdvertized,
 136                 afiSafisGracefulAdvertized);
 137         this.peerRole = role;
 138         this.simpleRoutingPolicy = Optional.ofNullable(peerStatus);
 139         this.rib = requireNonNull(rib);
 140         this.name = Ipv4Util.toStringIP(neighborAddress);
 141         this.rpcRegistry = rpcRegistry;
 142         this.peerId = RouterIds.createPeerId(neighborAddress);
 143         this.peerIId = this.rib.getYangRibId().node(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang
 144                 .bgp.rib.rev171207.bgp.rib.rib.Peer.QNAME).node(IdentifierUtils.domPeerId(this.peerId));
 145
 146         this.chain = rib.createPeerChain(this);
 147     }
 148
 149     @VisibleForTesting
 150     BGPPeer(final IpAddress neighborAddress, final RIB rib, final PeerRole role,
 151             final RpcProviderRegistry rpcRegistry, final Set<TablesKey> afiSafisAdvertized,
 152             final Set<TablesKey> afiSafisGracefulAdvertized) {
 153         this(neighborAddress, rib, role, null, rpcRegistry, afiSafisAdvertized, afiSafisGracefulAdvertized);
 154     }
 155
 156     private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) {
 157         if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) {
 158             final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs);
 159             attributesBuilder.setCNextHop(mpReach.getCNextHop());
 160             return attributesBuilder.build();
 161         }
 162         return attrs;
 163     }
 164
 165     /**
 166      * Creates MPReach for the prefixes to be handled in the same way as linkstate routes.
 167      *
 168      * @param message Update message containing prefixes in NLRI
 169      * @return MpReachNlri with prefixes from the nlri field
 170      */
 171     private static MpReachNlri prefixesToMpReach(final Update message) {
 172         final List<Ipv4Prefixes> prefixes = message.getNlri().stream()
 173                 .map(n -> new Ipv4PrefixesBuilder().setPrefix(n.getPrefix()).setPathId(n.getPathId()).build())
 174                 .collect(Collectors.toList());
 175         final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
 176                 UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
 177                 new AdvertizedRoutesBuilder().setDestinationType(
 178                         new DestinationIpv4CaseBuilder().setDestinationIpv4(
 179                                 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
 180         if (message.getAttributes() != null) {
 181             b.setCNextHop(message.getAttributes().getCNextHop());
 182         }
 183         return b.build();
 184     }
 185
 186     /**
 187      * Create MPUnreach for the prefixes to be handled in the same way as linkstate routes.
 188      *
 189      * @param message            Update message containing withdrawn routes
 190      * @param isAnyNlriAnnounced isAnyNlriAnnounced
 191      * @return MpUnreachNlri with prefixes from the withdrawn routes field
 192      */
 193     private static MpUnreachNlri prefixesToMpUnreach(final Update message, final boolean isAnyNlriAnnounced) {
 194         final List<Ipv4Prefixes> prefixes = new ArrayList<>();
 195         message.getWithdrawnRoutes().forEach(w -> {
 196
 197             Optional<Nlri> nlriAnounced = Optional.empty();
 198             if (isAnyNlriAnnounced) {
 199                 nlriAnounced = message.getNlri().stream().filter(n -> Objects.equal(n.getPrefix(), w.getPrefix())
 200                         && Objects.equal(n.getPathId(), w.getPathId()))
 201                         .findAny();
 202             }
 203             if (!nlriAnounced.isPresent()) {
 204                 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(w.getPrefix()).setPathId(w.getPathId()).build());
 205             }
 206         });
 207         return new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class)
 208                 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(new org.opendaylight.yang.gen.v1
 209                         .urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.update.attributes.mp.unreach.nlri
 210                         .withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4(
 211                         new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build();
 212     }
 213
 214     private static Map<TablesKey, SendReceive> mapTableTypesFamilies(final List<AddressFamilies> addPathTablesType) {
 215         return ImmutableMap.copyOf(addPathTablesType.stream().collect(Collectors.toMap(af -> new TablesKey(af.getAfi(),
 216                         af.getSafi()),
 217                 BgpAddPathTableType::getSendReceive)));
 218     }
 219
 220     public synchronized void instantiateServiceInstance() {
 221         this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this.simpleRoutingPolicy,
 222                 this.chain);
 223         setActive(true);
 224     }
 225
 226     // FIXME ListenableFuture<?> should be used once closeServiceInstance uses wildcard too
 227     @Override
 228     public synchronized ListenableFuture<Void> close() {
 229         final ListenableFuture<Void> future = releaseConnection();
 230         this.chain.close();
 231         setActive(false);
 232         return future;
 233     }
 234
 235     @Override
 236     public void onMessage(final BGPSession session, final Notification msg) throws BGPDocumentedException {
 237         if (!(msg instanceof Update) && !(msg instanceof RouteRefresh)) {
 238             LOG.info("Ignoring unhandled message class {}", msg.getClass());
 239             return;
 240         }
 241         if (msg instanceof Update) {
 242             onUpdateMessage((Update) msg);
 243         } else {
 244             onRouteRefreshMessage((RouteRefresh) msg);
 245         }
 246     }
 247
 248     private void onRouteRefreshMessage(final RouteRefresh message) {
 249         final Class<? extends AddressFamily> rrAfi = message.getAfi();
 250         final Class<? extends SubsequentAddressFamily> rrSafi = message.getSafi();
 251
 252         final TablesKey key = new TablesKey(rrAfi, rrSafi);
 253         final AdjRibOutListener listener = this.adjRibOutListenerSet.get(key);
 254         if (listener != null) {
 255             listener.close();
 256             this.adjRibOutListenerSet.remove(key);
 257             createAdjRibOutListener(key, listener.isMpSupported());
 258         } else {
 259             LOG.info("Ignoring RouteRefresh message. Afi/Safi is not supported: {}, {}.", rrAfi, rrSafi);
 260         }
 261     }
 262
 263     /**
 264      * Check for presence of well known mandatory attribute LOCAL_PREF in Update message.
 265      *
 266      * @param message Update message
 267      */
 268     private void checkMandatoryAttributesPresence(final Update message) throws BGPDocumentedException {
 269         if (MessageUtil.isAnyNlriPresent(message)) {
 270             final Attributes attrs = message.getAttributes();
 271             if (this.peerRole == PeerRole.Ibgp && (attrs == null || attrs.getLocalPref() == null)) {
 272                 throw new BGPDocumentedException(BGPError.MANDATORY_ATTR_MISSING_MSG + "LOCAL_PREF",
 273                         BGPError.WELL_KNOWN_ATTR_MISSING,
 274                         new byte[]{LocalPreferenceAttributeParser.TYPE});
 275             }
 276         }
 277     }
 278
 279     /**
 280      * Process Update message received.
 281      * Calls {@link #checkMandatoryAttributesPresence(Update)} to check for presence of mandatory attributes.
 282      *
 283      * @param message Update message
 284      */
 285     private synchronized void onUpdateMessage(final Update message) throws BGPDocumentedException {
 286         checkMandatoryAttributesPresence(message);
 287
 288         // update AdjRibs
 289         final Attributes attrs = message.getAttributes();
 290         MpReachNlri mpReach;
 291         final boolean isAnyNlriAnnounced = message.getNlri() != null;
 292         if (isAnyNlriAnnounced) {
 293             mpReach = prefixesToMpReach(message);
 294         } else {
 295             mpReach = MessageUtil.getMpReachNlri(attrs);
 296         }
 297         if (mpReach != null) {
 298             this.ribWriter.updateRoutes(mpReach, nextHopToAttribute(attrs, mpReach));
 299         }
 300         MpUnreachNlri mpUnreach;
 301         if (message.getWithdrawnRoutes() != null) {
 302             mpUnreach = prefixesToMpUnreach(message, isAnyNlriAnnounced);
 303         } else {
 304             mpUnreach = MessageUtil.getMpUnreachNlri(attrs);
 305         }
 306         if (mpUnreach != null) {
 307             this.ribWriter.removeRoutes(mpUnreach);
 308         }
 309     }
 310
 311     @Override
 312     public synchronized void onSessionUp(final BGPSession session) {
 313         this.session = session;
 314         if (this.session instanceof BGPSessionStateProvider) {
 315             ((BGPSessionStateProvider) this.session).registerMessagesCounter(this);
 316         }
 317         final List<AddressFamilies> addPathTablesType = session.getAdvertisedAddPathTableTypes();
 318         final Set<BgpTableType> advertizedTableTypes = session.getAdvertisedTableTypes();
 319         final List<BgpTableType> advertizedGracefulRestartTableTypes = session.getAdvertisedGracefulRestartTableTypes();
 320         LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", this.name,
 321                 advertizedTableTypes, addPathTablesType);
 322         this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
 323         this.tables.addAll(advertizedTableTypes.stream().map(t -> new TablesKey(t.getAfi(), t.getSafi()))
 324                 .collect(Collectors.toList()));
 325
 326         setAdvertizedGracefulRestartTableTypes(advertizedGracefulRestartTableTypes.stream()
 327                 .map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList()));
 328         final boolean announceNone = isAnnounceNone(this.simpleRoutingPolicy);
 329         this.addPathTableMaps = mapTableTypesFamilies(addPathTablesType);
 330
 331         if (!announceNone) {
 332             for (final TablesKey key : this.tables) {
 333                 createAdjRibOutListener(key, true);
 334             }
 335         }
 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(this.peerId, this.addPathTableMaps.get(tablesKey),
 341                         this.peerIId, this.peerRole, this.simpleRoutingPolicy));
 342             }
 343         }
 344         addBgp4Support(announceNone);
 345
 346         if (!isLearnNone(this.simpleRoutingPolicy)) {
 347             this.effRibInWriter = EffectiveRibInWriter.create(this.rib.getService(),
 348                     this.rib.createPeerChain(this),
 349                     this.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(this.peerId, this.rib.getRibSupportContext(), this.tables,
 356                 this.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(this.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 boolean announceNone) {
 371         final TablesKey key = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
 372         if (this.tables.add(key) && !announceNone) {
 373             createAdjRibOutListener(key, false);
 374             final ExportPolicyPeerTracker exportTracker = this.rib.getExportPolicyPeerTracker(key);
 375             if (exportTracker != null) {
 376                 this.tableRegistration.add(exportTracker.registerPeer(peerId,  null, this.peerIId,
 377                         this.peerRole, this.simpleRoutingPolicy));
 378             }
 379         }
 380     }
 381
 382     private synchronized void createAdjRibOutListener(final TablesKey key,
 383             final boolean mpSupport) {
 384         final RIBSupportContext context = this.rib.getRibSupportContext().getRIBSupportContext(key);
 385
 386         // not particularly nice
 387         if (context != null && this.session instanceof BGPSessionImpl) {
 388             final ChannelOutputLimiter limiter = ((BGPSessionImpl) this.session).getLimiter();
 389             final AdjRibOutListener adjRibOut = AdjRibOutListener.create(this.peerId, key,
 390                     this.rib.getYangRibId(), this.rib.getCodecsRegistry(), context.getRibSupport(),
 391                     this.rib.getService(), limiter, mpSupport);
 392             this.adjRibOutListenerSet.put(key, adjRibOut);
 393             registerPrefixesSentCounter(key, adjRibOut);
 394         }
 395     }
 396
 397     private ListenableFuture<Void> cleanup() {
 398         // FIXME: BUG-196: support graceful
 399         this.adjRibOutListenerSet.values().forEach(AdjRibOutListener::close);
 400         this.adjRibOutListenerSet.clear();
 401         if (this.effRibInWriter != null) {
 402             this.effRibInWriter.close();
 403         }
 404         this.tables.clear();
 405         if (this.ribWriter != null) {
 406             return this.ribWriter.removePeer();
 407         }
 408         return Futures.immediateFuture(null);
 409     }
 410
 411     @Override
 412     public void onSessionDown(final BGPSession session, final Exception e) {
 413         if (e.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) {
 414             LOG.info("Session with peer {} went down", this.name);
 415         } else {
 416             LOG.info("Session with peer {} went down", this.name, e);
 417         }
 418         releaseConnection();
 419     }
 420
 421     @Override
 422     public void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
 423         LOG.info("Session with peer {} terminated: {}", this.name, cause);
 424         releaseConnection();
 425     }
 426
 427     @Override
 428     public String toString() {
 429         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
 430     }
 431
 432     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 433         toStringHelper.add("name", this.name);
 434         toStringHelper.add("tables", this.tables);
 435         return toStringHelper;
 436     }
 437
 438     @Override
 439     public String getName() {
 440         return this.name;
 441     }
 442
 443     @Override
 444     public synchronized ListenableFuture<Void> releaseConnection() {
 445         if (this.rpcRegistration != null) {
 446             this.rpcRegistration.close();
 447         }
 448         closeRegistration();
 449         final ListenableFuture<Void> future = cleanup();
 450
 451         if (this.session != null) {
 452             try {
 453                 this.session.close();
 454             } catch (final Exception e) {
 455                 LOG.warn("Error closing session with peer", e);
 456             }
 457             this.session = null;
 458         }
 459
 460         resetState();
 461         return future;
 462     }
 463
 464     private void closeRegistration() {
 465         this.tableRegistration.iterator().forEachRemaining(AbstractRegistration::close);
 466         this.tableRegistration.clear();
 467     }
 468
 469     @Override
 470     public synchronized byte[] getRawIdentifier() {
 471         return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
 472     }
 473
 474     @Override
 475     public PeerId getPeerId() {
 476         return this.peerId;
 477     }
 478
 479     @Override
 480     public SendReceive getSupportedAddPathTables(final TablesKey tableKey) {
 481         return this.addPathTableMaps.get(tableKey);
 482     }
 483
 484     @Override
 485     public boolean supportsTable(final TablesKey tableKey) {
 486         return this.tables.contains(tableKey);
 487     }
 488
 489     @Override
 490     public YangInstanceIdentifier getPeerRibInstanceIdentifier() {
 491         return this.peerIId;
 492     }
 493
 494     @Override
 495     public PeerRole getRole() {
 496         return this.peerRole;
 497     }
 498
 499     @Override
 500     public synchronized void onTransactionChainFailed(final TransactionChain<?, ?> chain,
 501             final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 502         LOG.error("Transaction chain failed.", cause);
 503         this.chain.close();
 504         this.chain = this.rib.createPeerChain(this);
 505         this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this.simpleRoutingPolicy,
 506                 this.chain);
 507         releaseConnection();
 508     }
 509
 510     @Override
 511     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 512         LOG.debug("Transaction chain {} successful.", chain);
 513     }
 514
 515     @Override
 516     public synchronized void markUptodate(final TablesKey tablesKey) {
 517         this.ribWriter.markTableUptodate(tablesKey);
 518     }
 519
 520     @Override
 521     public BGPErrorHandlingState getBGPErrorHandlingState() {
 522         return this;
 523     }
 524
 525     @Override
 526     public BGPAfiSafiState getBGPAfiSafiState() {
 527         return this;
 528     }
 529
 530     @Override
 531     public synchronized BGPSessionState getBGPSessionState() {
 532         if (this.session instanceof BGPSessionStateProvider) {
 533             return ((BGPSessionStateProvider) this.session).getBGPSessionState();
 534         }
 535         return null;
 536     }
 537
 538     @Override
 539     public synchronized BGPTimersState getBGPTimersState() {
 540         if (this.session instanceof BGPSessionStateProvider) {
 541             return ((BGPSessionStateProvider) this.session).getBGPTimersState();
 542         }
 543         return null;
 544     }
 545
 546     @Override
 547     public synchronized BGPTransportState getBGPTransportState() {
 548         if (this.session instanceof BGPSessionStateProvider) {
 549             return ((BGPSessionStateProvider) this.session).getBGPTransportState();
 550         }
 551         return null;
 552     }
 553 }