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