2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.protocol.bgp.rib.impl;
10 import com.google.common.base.MoreObjects;
11 import com.google.common.base.MoreObjects.ToStringHelper;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.Lists;
14 import com.google.common.net.InetAddresses;
15 import java.util.ArrayList;
16 import java.util.Arrays;
17 import java.util.HashMap;
18 import java.util.HashSet;
19 import java.util.List;
22 import javax.annotation.concurrent.GuardedBy;
23 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeMXBean;
24 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeRegistration;
25 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeRegistrator;
26 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpPeerState;
27 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpSessionState;
28 import org.opendaylight.controller.config.yang.bgp.rib.impl.RouteTable;
29 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
30 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
31 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
32 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
33 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionStatistics;
34 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
35 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext;
36 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
37 import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
38 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
39 import org.opendaylight.protocol.bgp.rib.spi.Peer;
40 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4Builder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
45 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;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes1;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.RouteRefresh;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.add.path.capability.AddressFamilies;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
67 import org.opendaylight.yangtools.yang.binding.Notification;
68 import org.slf4j.Logger;
69 import org.slf4j.LoggerFactory;
72 * Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into
75 public class BGPPeer implements BGPSessionListener, Peer, AutoCloseable, BGPPeerRuntimeMXBean, TransactionChainListener {
77 private static final Logger LOG = LoggerFactory.getLogger(BGPPeer.class);
80 private final Set<TablesKey> tables = new HashSet<>();
82 private BGPSession session;
84 private byte[] rawIdentifier;
86 private DOMTransactionChain chain;
88 private AdjRibInWriter ribWriter;
90 private final RIB rib;
91 private final String name;
92 private BGPPeerRuntimeRegistrator registrator;
93 private BGPPeerRuntimeRegistration runtimeReg;
94 private long sessionEstablishedCounter = 0L;
95 private final Map<TablesKey, AdjRibOutListener> adjRibOutListenerSet = new HashMap();
97 public BGPPeer(final String name, final RIB rib) {
98 this(name, rib, PeerRole.Ibgp);
101 public BGPPeer(final String name, final RIB rib, final PeerRole role) {
102 this.rib = Preconditions.checkNotNull(rib);
104 this.chain = rib.createPeerChain(this);
105 this.ribWriter = AdjRibInWriter.create(rib.getYangRibId(), role, this.chain);
109 public synchronized void close() {
115 public void onMessage(final BGPSession session, final Notification msg) {
116 if (!(msg instanceof Update) && !(msg instanceof RouteRefresh)) {
117 LOG.info("Ignoring unhandled message class {}", msg.getClass());
120 if (msg instanceof Update) {
121 onUpdateMessage((Update) msg);
123 onRouteRefreshMessage((RouteRefresh) msg, session);
127 private void onRouteRefreshMessage(final RouteRefresh message, final BGPSession session) {
128 final Class<? extends AddressFamily> rrAfi = message.getAfi();
129 final Class<? extends SubsequentAddressFamily> rrSafi = message.getSafi();
131 final TablesKey key = new TablesKey(rrAfi, rrSafi);
132 final AdjRibOutListener listener = this.adjRibOutListenerSet.get(key);
133 if (listener != null) {
135 this.adjRibOutListenerSet.remove(listener);
136 createAdjRibOutListener(RouterIds.createPeerId(session.getBgpId()), key, true);
138 LOG.info("Ignoring RouteRefresh message. Afi/Safi is not supported: {}, {}.", rrAfi, rrSafi);
142 private void onUpdateMessage(final Update message) {
144 final Attributes attrs = message.getAttributes();
145 MpReachNlri mpReach = null;
146 final boolean isAnyNlriAnnounced = message.getNlri() != null;
147 if (isAnyNlriAnnounced) {
148 mpReach = prefixesToMpReach(message);
149 } else if (attrs != null && attrs.getAugmentation(Attributes1.class) != null) {
150 mpReach = attrs.getAugmentation(Attributes1.class).getMpReachNlri();
152 if (mpReach != null) {
153 this.ribWriter.updateRoutes(mpReach, nextHopToAttribute(attrs, mpReach));
155 MpUnreachNlri mpUnreach = null;
156 if (message.getWithdrawnRoutes() != null) {
157 mpUnreach = prefixesToMpUnreach(message, isAnyNlriAnnounced);
158 } else if (attrs != null && attrs.getAugmentation(Attributes2.class) != null) {
159 mpUnreach = attrs.getAugmentation(Attributes2.class).getMpUnreachNlri();
161 if (mpUnreach != null) {
162 this.ribWriter.removeRoutes(mpUnreach);
166 private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) {
167 if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) {
168 final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs);
169 attributesBuilder.setCNextHop(mpReach.getCNextHop());
170 return attributesBuilder.build();
176 * Creates MPReach for the prefixes to be handled in the same way as linkstate routes
178 * @param message Update message containing prefixes in NLRI
179 * @return MpReachNlri with prefixes from the nlri field
181 private static MpReachNlri prefixesToMpReach(final Update message) {
182 final List<Ipv4Prefixes> prefixes = new ArrayList<>();
183 for (final Ipv4Prefix p : message.getNlri().getNlri()) {
184 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
186 final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
187 UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
188 new AdvertizedRoutesBuilder().setDestinationType(
189 new DestinationIpv4CaseBuilder().setDestinationIpv4(
190 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
191 if (message.getAttributes() != null) {
192 b.setCNextHop(message.getAttributes().getCNextHop());
198 * Create MPUnreach for the prefixes to be handled in the same way as linkstate routes
200 * @param message Update message containing withdrawn routes
201 * @param isAnyNlriAnnounced
202 * @return MpUnreachNlri with prefixes from the withdrawn routes field
204 private static MpUnreachNlri prefixesToMpUnreach(final Update message, final boolean isAnyNlriAnnounced) {
205 final List<Ipv4Prefixes> prefixes = new ArrayList<>();
206 for (final Ipv4Prefix p : message.getWithdrawnRoutes().getWithdrawnRoutes()) {
207 boolean nlriAnounced = false;
208 if(isAnyNlriAnnounced) {
209 nlriAnounced = message.getNlri().getNlri().contains(p);
213 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
216 return new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setWithdrawnRoutes(
217 new WithdrawnRoutesBuilder().setDestinationType(
218 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(
219 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build();
223 public synchronized void onSessionUp(final BGPSession session) {
224 final List<AddressFamilies> addPathTablesType = session.getAdvertisedAddPathTableTypes();
225 LOG.info("Session with peer {} went up with tables {} and Add Path tables {}", this.name, addPathTablesType,
226 session.getAdvertisedAddPathTableTypes());
227 this.session = session;
228 this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
229 final PeerId peerId = RouterIds.createPeerId(session.getBgpId());
230 createAdjRibOutListener(peerId);
232 this.ribWriter = this.ribWriter.transform(peerId, this.rib.getRibSupportContext(), this.tables, addPathTablesType, false);
233 this.sessionEstablishedCounter++;
234 if (this.registrator != null) {
235 this.runtimeReg = this.registrator.register(this);
239 private void createAdjRibOutListener(final PeerId peerId) {
240 for (final BgpTableType t : this.session.getAdvertisedTableTypes()) {
241 final TablesKey key = new TablesKey(t.getAfi(), t.getSafi());
242 if (this.tables.add(key)) {
243 createAdjRibOutListener(peerId, key, true);
247 addBgp4Support(peerId);
250 //try to add a support for old-school BGP-4, if peer did not advertise IPv4-Unicast MP capability
251 private void addBgp4Support(final PeerId peerId) {
252 final TablesKey key = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
253 if (this.tables.add(key)) {
254 createAdjRibOutListener(peerId, key, false);
258 private void createAdjRibOutListener(final PeerId peerId, final TablesKey key, final boolean mpSupport) {
259 final RIBSupportContext context = this.rib.getRibSupportContext().getRIBSupportContext(key);
261 // not particularly nice
262 if (context != null && this.session instanceof BGPSessionImpl) {
263 this.adjRibOutListenerSet.put(key, AdjRibOutListener.create(peerId, key, this.rib.getYangRibId(), this.rib.getCodecsRegistry(),
264 context.getRibSupport(), ((RIBImpl) this.rib).getService(), ((BGPSessionImpl) this.session).getLimiter(), mpSupport));
268 private synchronized void cleanup() {
269 // FIXME: BUG-196: support graceful
270 for (final AdjRibOutListener adjRibOutListener : this.adjRibOutListenerSet.values()) {
271 adjRibOutListener.close();
273 this.adjRibOutListenerSet.clear();
274 this.ribWriter.removePeer();
279 public void onSessionDown(final BGPSession session, final Exception e) {
280 if(e.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) {
281 LOG.info("Session with peer {} went down", this.name);
283 LOG.info("Session with peer {} went down", this.name, e);
289 public void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
290 LOG.info("Session with peer {} terminated: {}", this.name, cause);
295 public String toString() {
296 return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
299 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
300 toStringHelper.add("name", this.name);
301 toStringHelper.add("tables", this.tables);
302 return toStringHelper;
306 public String getName() {
311 public void releaseConnection() {
312 addPeerToDisconnectedSharedList();
317 private void addPeerToDisconnectedSharedList() {
318 if(this.session != null) {
319 this.rib.getCacheDisconnectedPeers().insertDesconectedPeer(this.session.getBgpId());
324 private void dropConnection() {
325 if (this.runtimeReg != null) {
326 this.runtimeReg.close();
327 this.runtimeReg = null;
329 if (this.session != null) {
331 this.session.close();
332 } catch (final Exception e) {
333 LOG.warn("Error closing session with peer", e);
340 public boolean isSessionActive() {
341 return this.session != null;
345 public synchronized byte[] getRawIdentifier() {
346 return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
350 public void resetSession() {
355 public void resetStats() {
356 if (this.session instanceof BGPSessionStatistics) {
357 ((BGPSessionStatistics) this.session).resetSessionStats();
361 public synchronized void registerRootRuntimeBean(final BGPPeerRuntimeRegistrator registrator) {
362 this.registrator = registrator;
366 public BgpSessionState getBgpSessionState() {
367 if (this.session instanceof BGPSessionStatistics) {
368 return ((BGPSessionStatistics) this.session).getBgpSesionState();
370 return new BgpSessionState();
374 public synchronized BgpPeerState getBgpPeerState() {
375 final BgpPeerState peerState = new BgpPeerState();
376 final List<RouteTable> routes = Lists.newArrayList();
377 for (final TablesKey tablesKey : this.tables) {
378 final RouteTable routeTable = new RouteTable();
379 routeTable.setTableType("afi=" + tablesKey.getAfi().getSimpleName() + ",safi=" + tablesKey.getSafi().getSimpleName());
380 routeTable.setRoutesCount(this.rib.getRoutesCount(tablesKey));
381 routes.add(routeTable);
383 peerState.setRouteTable(routes);
384 peerState.setSessionEstablishedCount(this.sessionEstablishedCounter);
389 public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
390 LOG.error("Transaction chain failed.", cause);
393 this.chain = this.rib.createPeerChain(this);
397 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
398 LOG.debug("Transaction chain {} successfull.", chain);
402 public void markUptodate(final TablesKey tablesKey) {
403 this.ribWriter.markTableUptodate(tablesKey);