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
  12 import com.google.common.base.MoreObjects;
  13 import com.google.common.base.MoreObjects.ToStringHelper;
  14 import com.google.common.base.Objects;
  15 import com.google.common.collect.ImmutableMap;
  16 import com.google.common.net.InetAddresses;
  17 import com.google.common.util.concurrent.Futures;
  18 import com.google.common.util.concurrent.ListenableFuture;
  19 import java.util.ArrayList;
  20 import java.util.Arrays;
  21 import java.util.Collections;
  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.concurrent.GuardedBy;
  30 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  31 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  32 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  33 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  34 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
  35 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  36 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
  37 import org.opendaylight.protocol.bgp.parser.BGPError;
  38 import org.opendaylight.protocol.bgp.parser.impl.message.update.LocalPreferenceAttributeParser;
  39 import org.opendaylight.protocol.bgp.parser.spi.MessageUtil;
  40 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  41 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext;
  42 import org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl;
  43 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateProvider;
  44 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
  45 import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
  46 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
  47 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
  48 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
  49 import org.opendaylight.protocol.bgp.rib.spi.Peer;
  50 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
  51 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters;
  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.protocol.util.Ipv4Util;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.ipv4.prefixes.DestinationIpv4Builder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
  63 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;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Update;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.Attributes;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.AttributesBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.update.message.Nlri;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpAddPathTableType;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpTableType;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.RouteRefresh;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.SendReceive;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.add.path.capability.AddressFamilies;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpReachNlri;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpReachNlriBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpUnreachNlri;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpUnreachNlriBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev171207.BgpPeerRpcService;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.peer.rpc.rev171207.PeerContext;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerId;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.PeerKey;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  89 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  90 import org.opendaylight.yangtools.yang.binding.Notification;
  91 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  92 import org.slf4j.Logger;
  93 import org.slf4j.LoggerFactory;
  94
  95 /**
  96  * Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into
  97  * RIB actions.
  98  */
  99 public class BGPPeer extends BGPPeerStateImpl implements BGPRouteEntryImportParameters,
 100         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     private final RIB rib;
 106     private final String name;
 107     private final Map<TablesKey, AdjRibOutListener> adjRibOutListenerSet = new HashMap<>();
 108     private final RpcProviderRegistry rpcRegistry;
 109     private final PeerRole peerRole;
 110     private final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
 111             .rev171207.bgp.rib.rib.Peer, PeerKey> peerIId;
 112     @GuardedBy("this")
 113     private AbstractRegistration trackerRegistration;
 114     @GuardedBy("this")
 115     private final Set<AbstractRegistration> tableRegistration = new HashSet<>();
 116     private final PeerId peerId;
 117     private final YangInstanceIdentifier peerYIId;
 118     @GuardedBy("this")
 119     private BGPSession session;
 120     @GuardedBy("this")
 121     private byte[] rawIdentifier;
 122     @GuardedBy("this")
 123     private DOMTransactionChain chain;
 124     @GuardedBy("this")
 125     private AdjRibInWriter ribWriter;
 126     @GuardedBy("this")
 127     private EffectiveRibInWriter effRibInWriter;
 128     private RoutedRpcRegistration<BgpPeerRpcService> rpcRegistration;
 129     private Map<TablesKey, SendReceive> addPathTableMaps = Collections.emptyMap();
 130
 131     public BGPPeer(final IpAddress neighborAddress, final RIB rib, final PeerRole role,
 132             final RpcProviderRegistry rpcRegistry,
 133             final Set<TablesKey> afiSafisAdvertized,
 134             final Set<TablesKey> afiSafisGracefulAdvertized) {
 135         //FIXME BUG-6971 Once Peer Group is implemented, pass it
 136         super(rib.getInstanceIdentifier(), null, neighborAddress, afiSafisAdvertized,
 137                 afiSafisGracefulAdvertized);
 138         this.peerRole = role;
 139         this.rib = requireNonNull(rib);
 140         this.name = Ipv4Util.toStringIP(neighborAddress);
 141         this.rpcRegistry = rpcRegistry;
 142         this.peerId = RouterIds.createPeerId(neighborAddress);
 143         this.peerIId = getInstanceIdentifier().child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns
 144                 .yang.bgp.rib.rev171207.bgp.rib.rib.Peer.class, new PeerKey(this.peerId));
 145         this.peerYIId = this.rib.getYangRibId().node(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang
 146                 .bgp.rib.rev171207.bgp.rib.rib.Peer.QNAME).node(IdentifierUtils.domPeerId(this.peerId));
 147         this.chain = rib.createPeerDOMChain(this);
 148     }
 149
 150     private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) {
 151         if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) {
 152             final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs);
 153             attributesBuilder.setCNextHop(mpReach.getCNextHop());
 154             return attributesBuilder.build();
 155         }
 156         return attrs;
 157     }
 158
 159     /**
 160      * Creates MPReach for the prefixes to be handled in the same way as linkstate routes.
 161      *
 162      * @param message Update message containing prefixes in NLRI
 163      * @return MpReachNlri with prefixes from the nlri field
 164      */
 165     private static MpReachNlri prefixesToMpReach(final Update message) {
 166         final List<Ipv4Prefixes> prefixes = message.getNlri().stream()
 167                 .map(n -> new Ipv4PrefixesBuilder().setPrefix(n.getPrefix()).setPathId(n.getPathId()).build())
 168                 .collect(Collectors.toList());
 169         final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
 170                 UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
 171                 new AdvertizedRoutesBuilder().setDestinationType(
 172                         new DestinationIpv4CaseBuilder().setDestinationIpv4(
 173                                 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
 174         if (message.getAttributes() != null) {
 175             b.setCNextHop(message.getAttributes().getCNextHop());
 176         }
 177         return b.build();
 178     }
 179
 180     /**
 181      * Create MPUnreach for the prefixes to be handled in the same way as linkstate routes.
 182      *
 183      * @param message            Update message containing withdrawn routes
 184      * @param isAnyNlriAnnounced isAnyNlriAnnounced
 185      * @return MpUnreachNlri with prefixes from the withdrawn routes field
 186      */
 187     private static MpUnreachNlri prefixesToMpUnreach(final Update message, final boolean isAnyNlriAnnounced) {
 188         final List<Ipv4Prefixes> prefixes = new ArrayList<>();
 189         message.getWithdrawnRoutes().forEach(w -> {
 190
 191             Optional<Nlri> nlriAnounced = Optional.empty();
 192             if (isAnyNlriAnnounced) {
 193                 nlriAnounced = message.getNlri().stream().filter(n -> Objects.equal(n.getPrefix(), w.getPrefix())
 194                         && Objects.equal(n.getPathId(), w.getPathId()))
 195                         .findAny();
 196             }
 197             if (!nlriAnounced.isPresent()) {
 198                 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(w.getPrefix()).setPathId(w.getPathId()).build());
 199             }
 200         });
 201         return new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class)
 202                 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(new org.opendaylight.yang.gen.v1
 203                         .urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.update.attributes.mp.unreach.nlri
 204                         .withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4(
 205                         new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build();
 206     }
 207
 208     private static Map<TablesKey, SendReceive> mapTableTypesFamilies(final List<AddressFamilies> addPathTablesType) {
 209         return ImmutableMap.copyOf(addPathTablesType.stream().collect(Collectors.toMap(af -> new TablesKey(af.getAfi(),
 210                         af.getSafi()),
 211                 BgpAddPathTableType::getSendReceive)));
 212     }
 213
 214     public synchronized void instantiateServiceInstance() {
 215         this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, 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);
 238         }
 239     }
 240
 241     private void onRouteRefreshMessage(final RouteRefresh message) {
 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(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;
 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;
 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         final List<AddressFamilies> addPathTablesType = session.getAdvertisedAddPathTableTypes();
 311         final Set<BgpTableType> advertizedTableTypes = session.getAdvertisedTableTypes();
 312         final List<BgpTableType> advertizedGracefulRestartTableTypes = session.getAdvertisedGracefulRestartTableTypes();
 313         LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", this.name,
 314                 advertizedTableTypes, addPathTablesType);
 315         this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
 316         this.tables.addAll(advertizedTableTypes.stream().map(t -> new TablesKey(t.getAfi(), t.getSafi()))
 317                 .collect(Collectors.toList()));
 318
 319         setAdvertizedGracefulRestartTableTypes(advertizedGracefulRestartTableTypes.stream()
 320                 .map(t -> new TablesKey(t.getAfi(), t.getSafi())).collect(Collectors.toList()));
 321         this.addPathTableMaps = mapTableTypesFamilies(addPathTablesType);
 322
 323         for (final TablesKey key : this.tables) {
 324             createAdjRibOutListener(key, true);
 325         }
 326
 327         for(final TablesKey tablesKey :this.tables) {
 328             final ExportPolicyPeerTracker exportTracker = this.rib.getExportPolicyPeerTracker(tablesKey);
 329             if (exportTracker != null) {
 330                 this.tableRegistration.add(exportTracker.registerPeer(this.peerId, this.addPathTableMaps.get(tablesKey),
 331                         this.peerYIId, this.peerRole));
 332             }
 333         }
 334         addBgp4Support();
 335
 336         this.effRibInWriter = EffectiveRibInWriter.create(this, this.rib, this.rib.createPeerChain(this),
 337                 this.peerIId, this.tables);
 338         registerPrefixesCounters(this.effRibInWriter, this.effRibInWriter);
 339         this.ribWriter = this.ribWriter.transform(this.peerId, this.rib.getRibSupportContext(), this.tables,
 340                 this.addPathTableMaps);
 341
 342         if (this.rpcRegistry != null) {
 343             this.rpcRegistration = this.rpcRegistry.addRoutedRpcImplementation(BgpPeerRpcService.class,
 344                     new BgpPeerRpc(this, session, this.tables));
 345             final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib
 346                     .rev171207.bgp.rib.rib.Peer, PeerKey> path = this.rib.getInstanceIdentifier()
 347                     .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib
 348                              .rib.Peer.class, new PeerKey(this.peerId));
 349             this.rpcRegistration.registerPath(PeerContext.class, path);
 350         }
 351         this.trackerRegistration = this.rib.getPeerTracker().registerPeer(this);
 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() {
 356         final TablesKey key = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
 357         if (this.tables.add(key)) {
 358             createAdjRibOutListener(key, false);
 359             final ExportPolicyPeerTracker exportTracker = this.rib.getExportPolicyPeerTracker(key);
 360             if (exportTracker != null) {
 361                 this.tableRegistration.add(exportTracker.registerPeer(peerId,  null, this.peerYIId,
 362                         this.peerRole));
 363             }
 364         }
 365     }
 366
 367     private synchronized void createAdjRibOutListener(final TablesKey key,
 368             final boolean mpSupport) {
 369         final RIBSupportContext context = this.rib.getRibSupportContext().getRIBSupportContext(key);
 370
 371         // not particularly nice
 372         if (context != null && this.session instanceof BGPSessionImpl) {
 373             final ChannelOutputLimiter limiter = ((BGPSessionImpl) this.session).getLimiter();
 374             final AdjRibOutListener adjRibOut = AdjRibOutListener.create(this.peerId, key,
 375                     this.rib.getYangRibId(), this.rib.getCodecsRegistry(), context.getRibSupport(),
 376                     this.rib.getService(), limiter, mpSupport);
 377             this.adjRibOutListenerSet.put(key, adjRibOut);
 378             registerPrefixesSentCounter(key, adjRibOut);
 379         }
 380     }
 381
 382     private ListenableFuture<Void> cleanup() {
 383         // FIXME: BUG-196: support graceful
 384         this.adjRibOutListenerSet.values().forEach(AdjRibOutListener::close);
 385         this.adjRibOutListenerSet.clear();
 386         if (this.effRibInWriter != null) {
 387             this.effRibInWriter.close();
 388         }
 389         this.tables.clear();
 390         if (this.ribWriter != null) {
 391             return this.ribWriter.removePeer();
 392         }
 393         return Futures.immediateFuture(null);
 394     }
 395
 396     @Override
 397     public void onSessionDown(final BGPSession session, final Exception e) {
 398         if (e.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) {
 399             LOG.info("Session with peer {} went down", this.name);
 400         } else {
 401             LOG.info("Session with peer {} went down", this.name, e);
 402         }
 403         releaseConnection();
 404     }
 405
 406     @Override
 407     public void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
 408         LOG.info("Session with peer {} terminated: {}", this.name, cause);
 409         releaseConnection();
 410     }
 411
 412     @Override
 413     public String toString() {
 414         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
 415     }
 416
 417     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 418         toStringHelper.add("name", this.name);
 419         toStringHelper.add("tables", this.tables);
 420         return toStringHelper;
 421     }
 422
 423     @Override
 424     public String getName() {
 425         return this.name;
 426     }
 427
 428     @Override
 429     public synchronized ListenableFuture<Void> releaseConnection() {
 430         if (this.rpcRegistration != null) {
 431             this.rpcRegistration.close();
 432         }
 433         closeRegistration();
 434         final ListenableFuture<Void> future = cleanup();
 435
 436         if (this.session != null) {
 437             try {
 438                 this.session.close();
 439             } catch (final Exception e) {
 440                 LOG.warn("Error closing session with peer", e);
 441             }
 442             this.session = null;
 443         }
 444
 445         resetState();
 446         return future;
 447     }
 448
 449     private void closeRegistration() {
 450         this.tableRegistration.iterator().forEachRemaining(AbstractRegistration::close);
 451         this.tableRegistration.clear();
 452         if (this.trackerRegistration != null) {
 453             this.trackerRegistration.close();
 454             this.trackerRegistration = null;
 455         }
 456     }
 457
 458     @Override
 459     public synchronized byte[] getRawIdentifier() {
 460         return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
 461     }
 462
 463     @Override
 464     public PeerId getPeerId() {
 465         return this.peerId;
 466     }
 467
 468     @Override
 469     public SendReceive getSupportedAddPathTables(final TablesKey tableKey) {
 470         return this.addPathTableMaps.get(tableKey);
 471     }
 472
 473     @Override
 474     public boolean supportsTable(final TablesKey tableKey) {
 475         return this.tables.contains(tableKey);
 476     }
 477
 478     @Override
 479     public YangInstanceIdentifier getPeerRibInstanceIdentifier() {
 480         return this.peerYIId;
 481     }
 482
 483     @Override
 484     public PeerRole getRole() {
 485         return this.peerRole;
 486     }
 487
 488     @Override
 489     public synchronized void onTransactionChainFailed(final TransactionChain<?, ?> chain,
 490             final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 491         LOG.error("Transaction chain failed.", cause);
 492         this.chain.close();
 493         this.chain = this.rib.createPeerDOMChain(this);
 494         this.ribWriter = AdjRibInWriter.create(this.rib.getYangRibId(), this.peerRole, this.chain);
 495         releaseConnection();
 496     }
 497
 498     @Override
 499     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 500         LOG.debug("Transaction chain {} successful.", chain);
 501     }
 502
 503     @Override
 504     public synchronized void markUptodate(final TablesKey tablesKey) {
 505         this.ribWriter.markTableUptodate(tablesKey);
 506     }
 507
 508     @Override
 509     public BGPErrorHandlingState getBGPErrorHandlingState() {
 510         return this;
 511     }
 512
 513     @Override
 514     public BGPAfiSafiState getBGPAfiSafiState() {
 515         return this;
 516     }
 517
 518     @Override
 519     public synchronized BGPSessionState getBGPSessionState() {
 520         if (this.session instanceof BGPSessionStateProvider) {
 521             return ((BGPSessionStateProvider) this.session).getBGPSessionState();
 522         }
 523         return null;
 524     }
 525
 526     @Override
 527     public synchronized BGPTimersState getBGPTimersState() {
 528         if (this.session instanceof BGPSessionStateProvider) {
 529             return ((BGPSessionStateProvider) this.session).getBGPTimersState();
 530         }
 531         return null;
 532     }
 533
 534     @Override
 535     public synchronized BGPTransportState getBGPTransportState() {
 536         if (this.session instanceof BGPSessionStateProvider) {
 537             return ((BGPSessionStateProvider) this.session).getBGPTransportState();
 538         }
 539         return null;
 540     }
 541
 542     @Override
 543     public PeerRole getFromPeerRole() {
 544         return getRole();
 545     }
 546
 547     @Override
 548     public PeerId getFromPeerId() {
 549         return getPeerId();
 550     }
 551 }