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