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.RIBSupportContext;
34 import org.opendaylight.protocol.bgp.rib.impl.spi.ReusableBGPPeer;
35 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
36 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
37 import org.opendaylight.protocol.bgp.rib.spi.Peer;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4Builder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
42 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;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes1;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
60 import org.opendaylight.yangtools.yang.binding.Notification;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
65 * Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into
68 public class BGPPeer implements ReusableBGPPeer, Peer, AutoCloseable, BGPPeerRuntimeMXBean, TransactionChainListener {
70 private static final Logger LOG = LoggerFactory.getLogger(BGPPeer.class);
73 private final Set<TablesKey> tables = new HashSet<>();
75 private BGPSession session;
77 private byte[] rawIdentifier;
79 private DOMTransactionChain chain;
81 private AdjRibInWriter ribWriter;
83 private final RIB rib;
84 private final String name;
85 private BGPPeerRuntimeRegistrator registrator;
86 private BGPPeerRuntimeRegistration runtimeReg;
87 private long sessionEstablishedCounter = 0L;
89 public BGPPeer(final String name, final RIB rib) {
90 this(name, rib, PeerRole.Ibgp);
93 public BGPPeer(final String name, final RIB rib, final PeerRole role) {
94 this.rib = Preconditions.checkNotNull(rib);
96 this.chain = rib.createPeerChain(this);
97 this.ribWriter = AdjRibInWriter.create(rib.getYangRibId(), role, this.chain);
101 public synchronized void close() {
104 // TODO should this perform cleanup ?
108 public void onMessage(final BGPSession session, final Notification msg) {
109 if (!(msg instanceof Update)) {
110 LOG.info("Ignoring unhandled message class {}", msg.getClass());
113 final Update message = (Update) msg;
116 final Attributes attrs = message.getAttributes();
117 MpReachNlri mpReach = null;
118 if (message.getNlri() != null) {
119 mpReach = prefixesToMpReach(message);
120 } else if (attrs != null && attrs.getAugmentation(Attributes1.class) != null) {
121 mpReach = attrs.getAugmentation(Attributes1.class).getMpReachNlri();
123 if (mpReach != null) {
124 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 final RIBSupportContext context = this.rib.getRibSupportContext().getRIBSupportContext(key);
212 // not particularly nice
213 if (context != null && this.session instanceof BGPSessionImpl) {
214 AdjRibOutListener.create(peerId, key, this.rib.getYangRibId(), this.rib.getCodecsRegistry(), context.getRibSupport(), ((RIBImpl) this.rib).getService(),
215 ((BGPSessionImpl) this.session).getLimiter(), mpSupport);
219 private synchronized void cleanup() {
220 // FIXME: BUG-196: support graceful restart
221 this.ribWriter.cleanTables(this.tables);
226 public void onSessionDown(final BGPSession session, final Exception e) {
227 LOG.info("Session with peer {} went down", this.name, e);
232 public void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
233 LOG.info("Session with peer {} terminated: {}", this.name, cause);
238 public String toString() {
239 return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
242 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
243 toStringHelper.add("name", this.name);
244 toStringHelper.add("tables", this.tables);
245 return toStringHelper;
249 public String getName() {
254 public void releaseConnection() {
260 private void dropConnection() {
261 if (this.runtimeReg != null) {
262 this.runtimeReg.close();
263 this.runtimeReg = null;
265 if (this.session != null) {
267 this.session.close();
268 } catch (final Exception e) {
269 LOG.warn("Error closing session with peer", e);
276 public boolean isSessionActive() {
277 return this.session != null;
281 public synchronized byte[] getRawIdentifier() {
282 return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
286 public void resetSession() {
291 public void resetStats() {
292 if (this.session instanceof BGPSessionStatistics) {
293 ((BGPSessionStatistics) this.session).resetSessionStats();
297 public synchronized void registerRootRuntimeBean(final BGPPeerRuntimeRegistrator registrator) {
298 this.registrator = registrator;
302 public BgpSessionState getBgpSessionState() {
303 if (this.session instanceof BGPSessionStatistics) {
304 return ((BGPSessionStatistics) this.session).getBgpSesionState();
306 return new BgpSessionState();
310 public synchronized BgpPeerState getBgpPeerState() {
311 final BgpPeerState peerState = new BgpPeerState();
312 final List<RouteTable> routes = Lists.newArrayList();
313 for (final TablesKey tablesKey : this.tables) {
314 final RouteTable routeTable = new RouteTable();
315 routeTable.setTableType("afi=" + tablesKey.getAfi().getSimpleName() + ",safi=" + tablesKey.getSafi().getSimpleName());
316 routeTable.setRoutesCount(this.rib.getRoutesCount(tablesKey));
317 routes.add(routeTable);
319 peerState.setRouteTable(routes);
320 peerState.setSessionEstablishedCount(this.sessionEstablishedCounter);
325 public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
326 LOG.error("Transaction chain failed.", cause);
329 this.chain = this.rib.createPeerChain(this);
333 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
334 LOG.debug("Transaction chain {} successfull.", chain);
338 public void markUptodate(final TablesKey tablesKey) {
339 this.ribWriter.markTableUptodate(tablesKey);