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.HashSet;
18 import java.util.List;
20 import javax.annotation.concurrent.GuardedBy;
21 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeMXBean;
22 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeRegistration;
23 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeRegistrator;
24 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpPeerState;
25 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpSessionState;
26 import org.opendaylight.controller.config.yang.bgp.rib.impl.RouteTable;
27 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
28 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
30 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
31 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionStatistics;
32 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
33 import org.opendaylight.protocol.bgp.rib.impl.spi.ReusableBGPPeer;
34 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
35 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
36 import org.opendaylight.protocol.bgp.rib.spi.Peer;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4Builder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
41 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;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes1;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
59 import org.opendaylight.yangtools.yang.binding.Notification;
60 import org.slf4j.Logger;
61 import org.slf4j.LoggerFactory;
64 * Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into
67 public class BGPPeer implements ReusableBGPPeer, Peer, AutoCloseable, BGPPeerRuntimeMXBean, TransactionChainListener {
69 private static final Logger LOG = LoggerFactory.getLogger(BGPPeer.class);
72 private final Set<TablesKey> tables = new HashSet<>();
74 private BGPSession session;
76 private byte[] rawIdentifier;
78 private DOMTransactionChain chain;
80 private AdjRibInWriter ribWriter;
82 private final RIB rib;
83 private final String name;
84 private BGPPeerRuntimeRegistrator registrator;
85 private BGPPeerRuntimeRegistration runtimeReg;
86 private long sessionEstablishedCounter = 0L;
88 public BGPPeer(final String name, final RIB rib) {
89 this(name, rib, PeerRole.Ibgp);
92 public BGPPeer(final String name, final RIB rib, final PeerRole role) {
93 this.rib = Preconditions.checkNotNull(rib);
95 this.chain = rib.createPeerChain(this);
96 this.ribWriter = AdjRibInWriter.create(rib.getYangRibId(), role, this.chain);
100 public synchronized void close() {
103 // TODO should this perform cleanup ?
107 public void onMessage(final BGPSession session, final Notification msg) {
108 if (!(msg instanceof Update)) {
109 LOG.info("Ignoring unhandled message class {}", msg.getClass());
112 final Update message = (Update) msg;
115 final Attributes attrs = message.getAttributes();
116 MpReachNlri mpReach = null;
117 if (message.getNlri() != null) {
118 mpReach = prefixesToMpReach(message);
119 } else if (attrs != null && attrs.getAugmentation(Attributes1.class) != null) {
120 mpReach = attrs.getAugmentation(Attributes1.class).getMpReachNlri();
122 if (mpReach != null) {
123 this.ribWriter.updateRoutes(mpReach, nextHopToAttribute(attrs, mpReach));
126 MpUnreachNlri mpUnreach = null;
127 if (message.getWithdrawnRoutes() != null) {
128 mpUnreach = prefixesToMpUnreach(message);
129 } else if (attrs != null && attrs.getAugmentation(Attributes2.class) != null) {
130 mpUnreach = attrs.getAugmentation(Attributes2.class).getMpUnreachNlri();
132 if (mpUnreach != null) {
133 this.ribWriter.removeRoutes(mpUnreach);
137 private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) {
138 if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) {
139 final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs);
140 attributesBuilder.setCNextHop(mpReach.getCNextHop());
141 return attributesBuilder.build();
147 * Creates MPReach for the prefixes to be handled in the same way as linkstate routes
149 * @param message Update message containing prefixes in NLRI
150 * @return MpReachNlri with prefixes from the nlri field
152 private static MpReachNlri prefixesToMpReach(final Update message) {
153 final List<Ipv4Prefixes> prefixes = new ArrayList<>();
154 for (final Ipv4Prefix p : message.getNlri().getNlri()) {
155 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
157 final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
158 UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
159 new AdvertizedRoutesBuilder().setDestinationType(
160 new DestinationIpv4CaseBuilder().setDestinationIpv4(
161 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
162 if (message.getAttributes() != null) {
163 b.setCNextHop(message.getAttributes().getCNextHop());
169 * Create MPUnreach for the prefixes to be handled in the same way as linkstate routes
171 * @param message Update message containing withdrawn routes
172 * @return MpUnreachNlri with prefixes from the withdrawn routes field
174 private static MpUnreachNlri prefixesToMpUnreach(final Update message) {
175 final List<Ipv4Prefixes> prefixes = new ArrayList<>();
176 for (final Ipv4Prefix p : message.getWithdrawnRoutes().getWithdrawnRoutes()) {
177 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
179 return new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setWithdrawnRoutes(
180 new WithdrawnRoutesBuilder().setDestinationType(
181 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(
182 new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build();
186 public synchronized void onSessionUp(final BGPSession session) {
187 LOG.info("Session with peer {} went up with tables: {}", this.name, session.getAdvertisedTableTypes());
188 this.session = session;
189 this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
190 final PeerId peerId = RouterIds.createPeerId(session.getBgpId());
191 TablesKey key = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
192 this.tables.add(key);
193 createAdjRibOutListener(peerId, key, false);
195 for (final BgpTableType t : session.getAdvertisedTableTypes()) {
196 key = new TablesKey(t.getAfi(), t.getSafi());
197 if (this.tables.add(key)) {
198 createAdjRibOutListener(peerId, key, true);
202 this.ribWriter = this.ribWriter.transform(peerId, this.rib.getRibSupportContext(), this.tables, false);
203 this.sessionEstablishedCounter++;
204 if (this.registrator != null) {
205 this.runtimeReg = this.registrator.register(this);
209 private void createAdjRibOutListener(final PeerId peerId, final TablesKey key, final boolean mpSupport) {
210 // not particularly nice
211 if (session instanceof BGPSessionImpl) {
212 AdjRibOutListener.create(peerId, key, this.rib.getYangRibId(), ((RIBImpl) this.rib).getService(),
213 this.rib.getRibSupportContext(), ((BGPSessionImpl) session).getLimiter(), mpSupport);
217 private synchronized void cleanup() {
218 // FIXME: BUG-196: support graceful restart
219 this.ribWriter.cleanTables(this.tables);
224 public void onSessionDown(final BGPSession session, final Exception e) {
225 LOG.info("Session with peer {} went down", this.name, e);
230 public void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
231 LOG.info("Session with peer {} terminated: {}", this.name, cause);
236 public String toString() {
237 return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
240 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
241 toStringHelper.add("name", this.name);
242 toStringHelper.add("tables", this.tables);
243 return toStringHelper;
247 public String getName() {
252 public void releaseConnection() {
258 private void dropConnection() {
259 if (this.runtimeReg != null) {
260 this.runtimeReg.close();
261 this.runtimeReg = null;
263 if (this.session != null) {
265 this.session.close();
266 } catch (final Exception e) {
267 LOG.warn("Error closing session with peer", e);
274 public boolean isSessionActive() {
275 return this.session != null;
279 public synchronized byte[] getRawIdentifier() {
280 return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
284 public void resetSession() {
289 public void resetStats() {
290 if (this.session instanceof BGPSessionStatistics) {
291 ((BGPSessionStatistics) this.session).resetSessionStats();
295 public synchronized void registerRootRuntimeBean(final BGPPeerRuntimeRegistrator registrator) {
296 this.registrator = registrator;
300 public BgpSessionState getBgpSessionState() {
301 if (this.session instanceof BGPSessionStatistics) {
302 return ((BGPSessionStatistics) this.session).getBgpSesionState();
304 return new BgpSessionState();
308 public synchronized BgpPeerState getBgpPeerState() {
309 final BgpPeerState peerState = new BgpPeerState();
310 final List<RouteTable> routes = Lists.newArrayList();
311 for (final TablesKey tablesKey : this.tables) {
312 final RouteTable routeTable = new RouteTable();
313 routeTable.setTableType("afi=" + tablesKey.getAfi().getSimpleName() + ",safi=" + tablesKey.getSafi().getSimpleName());
314 routeTable.setRoutesCount(this.rib.getRoutesCount(tablesKey));
315 routes.add(routeTable);
317 peerState.setRouteTable(routes);
318 peerState.setSessionEstablishedCount(this.sessionEstablishedCounter);
323 public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
324 LOG.error("Transaction chain failed.", cause);
325 this.dropConnection();
327 this.chain = this.rib.createPeerChain(this);
331 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
332 LOG.debug("Transaction chain {} successfull.", chain);
336 public void markUptodate(final TablesKey tablesKey) {
337 this.ribWriter.markTableUptodate(tablesKey);