2 * Copyright (c) 2013 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 static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.VisibleForTesting;
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.Lists;
17 import com.google.common.collect.Sets;
18 import io.netty.buffer.ByteBufUtil;
19 import io.netty.channel.Channel;
20 import io.netty.channel.ChannelFuture;
21 import io.netty.channel.ChannelFutureListener;
22 import io.netty.channel.ChannelHandlerContext;
23 import io.netty.channel.ChannelPipeline;
24 import io.netty.channel.SimpleChannelInboundHandler;
25 import java.io.IOException;
26 import java.nio.channels.NonWritableChannelException;
27 import java.util.Collections;
28 import java.util.Date;
29 import java.util.List;
31 import java.util.concurrent.TimeUnit;
32 import javax.annotation.concurrent.GuardedBy;
33 import org.opendaylight.protocol.bgp.parser.AsNumberUtil;
34 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
35 import org.opendaylight.protocol.bgp.parser.BGPError;
36 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
37 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
38 import org.opendaylight.protocol.bgp.parser.spi.MultiPathSupport;
39 import org.opendaylight.protocol.bgp.parser.spi.pojo.MultiPathSupportImpl;
40 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPMessagesListener;
41 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
42 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
43 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateImpl;
44 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateProvider;
45 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
46 import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
47 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
48 import org.opendaylight.protocol.bgp.rib.spi.State;
49 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
50 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
51 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Keepalive;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.KeepaliveBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Notify;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.NotifyBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Open;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Update;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilities;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.CParameters;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.RouteRefresh;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.AddPathCapability;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapability;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.add.path.capability.AddressFamilies;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
70 import org.opendaylight.yangtools.yang.binding.Notification;
71 import org.slf4j.Logger;
72 import org.slf4j.LoggerFactory;
75 public class BGPSessionImpl extends SimpleChannelInboundHandler<Notification> implements BGPSession,
76 BGPSessionStateProvider, AutoCloseable {
78 private static final Logger LOG = LoggerFactory.getLogger(BGPSessionImpl.class);
80 private static final Notification KEEP_ALIVE = new KeepaliveBuilder().build();
82 private static final int KA_TO_DEADTIMER_RATIO = 3;
84 private static final String EXTENDED_MSG_DECODER = "EXTENDED_MSG_DECODER";
86 static final String END_OF_INPUT = "End of input detected. Close the session.";
89 * System.nanoTime value about when was sent the last message.
92 private long lastMessageSentAt;
95 * System.nanoTime value about when was received the last message
97 private long lastMessageReceivedAt;
99 private final BGPSessionListener listener;
101 private final BGPSynchronization sync;
103 private int kaCounter = 0;
105 private final Channel channel;
108 private State state = State.OPEN_CONFIRM;
110 private final Set<BgpTableType> tableTypes;
111 private final List<AddressFamilies> addPathTypes;
112 private final int holdTimerValue;
113 private final int keepAlive;
114 private final AsNumber asNumber;
115 private final Ipv4Address bgpId;
116 private final BGPPeerRegistry peerRegistry;
117 private final ChannelOutputLimiter limiter;
118 private final BGPSessionStateImpl sessionState;
119 private boolean terminationReasonNotified;
121 public BGPSessionImpl(final BGPSessionListener listener, final Channel channel, final Open remoteOpen,
122 final BGPSessionPreferences localPreferences, final BGPPeerRegistry peerRegistry) {
123 this(listener, channel, remoteOpen, localPreferences.getHoldTime(), peerRegistry);
126 public BGPSessionImpl(final BGPSessionListener listener, final Channel channel, final Open remoteOpen,
127 final int localHoldTimer, final BGPPeerRegistry peerRegistry) {
128 this.listener = requireNonNull(listener);
129 this.channel = requireNonNull(channel);
130 this.limiter = new ChannelOutputLimiter(this);
131 this.channel.pipeline().addLast(this.limiter);
132 this.holdTimerValue = remoteOpen.getHoldTimer() < localHoldTimer ? remoteOpen.getHoldTimer() : localHoldTimer;
133 LOG.info("BGP HoldTimer new value: {}", this.holdTimerValue);
134 this.keepAlive = this.holdTimerValue / KA_TO_DEADTIMER_RATIO;
135 this.asNumber = AsNumberUtil.advertizedAsNumber(remoteOpen);
136 this.peerRegistry = peerRegistry;
137 this.sessionState = new BGPSessionStateImpl();
139 final Set<TablesKey> tts = Sets.newHashSet();
140 final Set<BgpTableType> tats = Sets.newHashSet();
141 final List<AddressFamilies> addPathCapabilitiesList = Lists.newArrayList();
142 if (remoteOpen.getBgpParameters() != null) {
143 for (final BgpParameters param : remoteOpen.getBgpParameters()) {
144 for (final OptionalCapabilities optCapa : param.getOptionalCapabilities()) {
145 final CParameters cParam = optCapa.getCParameters();
146 final CParameters1 cParam1 = cParam.augmentation(CParameters1.class);
147 if (cParam1 != null) {
148 final MultiprotocolCapability multi = cParam1.getMultiprotocolCapability();
150 final TablesKey tt = new TablesKey(multi.getAfi(), multi.getSafi());
151 LOG.trace("Added table type to sync {}", tt);
153 tats.add(new BgpTableTypeImpl(tt.getAfi(), tt.getSafi()));
155 final AddPathCapability addPathCap = cParam1.getAddPathCapability();
156 if (addPathCap != null) {
157 addPathCapabilitiesList.addAll(addPathCap.getAddressFamilies());
165 this.sync = new BGPSynchronization(this.listener, tts);
166 this.tableTypes = tats;
167 this.addPathTypes = addPathCapabilitiesList;
169 if (!this.addPathTypes.isEmpty()) {
170 final ChannelPipeline pipeline = this.channel.pipeline();
171 final BGPByteToMessageDecoder decoder = pipeline.get(BGPByteToMessageDecoder.class);
172 decoder.addDecoderConstraint(MultiPathSupport.class,
173 MultiPathSupportImpl.createParserMultiPathSupport(this.addPathTypes));
176 if (this.holdTimerValue != 0) {
177 channel.eventLoop().schedule(this::handleHoldTimer, this.holdTimerValue, TimeUnit.SECONDS);
178 channel.eventLoop().schedule(this::handleKeepaliveTimer, this.keepAlive, TimeUnit.SECONDS);
180 this.bgpId = remoteOpen.getBgpIdentifier();
181 this.sessionState.advertizeCapabilities(this.holdTimerValue, channel.remoteAddress(), channel.localAddress(),
182 this.tableTypes, remoteOpen.getBgpParameters());
186 * Set the extend message coder for current channel
187 * The reason for separating this part from constructor is, in #channel.pipeline().replace(..), the
188 * invokeChannelRead() will be invoked after the original message coder handler got removed. And there
189 * is chance that before the session instance is fully initiated (constructor returns), a KeepAlive
190 * message arrived already in the channel buffer. Thus #AbstractBGPSessionNegotiator.handleMessage(..)
191 * gets invoked again and a deadlock is caused. A BGP final state machine error will happen as BGP
192 * negotiator is still in OPEN_SENT state as the session constructor hasn't returned yet.
196 public synchronized void setChannelExtMsgCoder(final Open remoteOpen) {
197 final boolean enableExMess = BgpExtendedMessageUtil.advertizedBgpExtendedMessageCapability(remoteOpen);
199 this.channel.pipeline().replace(BGPMessageHeaderDecoder.class, EXTENDED_MSG_DECODER,
200 BGPMessageHeaderDecoder.getExtendedBGPMessageHeaderDecoder());
205 public synchronized void close() {
206 if (this.state != State.IDLE) {
207 if (!this.terminationReasonNotified) {
208 this.writeAndFlush(new NotifyBuilder().setErrorCode(BGPError.CEASE.getCode())
209 .setErrorSubcode(BGPError.CEASE.getSubcode()).build());
211 this.closeWithoutMessage();
216 * Handles incoming message based on their type.
218 * @param msg incoming message
220 synchronized void handleMessage(final Notification msg) {
221 if (this.state == State.IDLE) {
225 // Update last reception time
226 this.lastMessageReceivedAt = System.nanoTime();
228 if (msg instanceof Open) {
229 // Open messages should not be present here
230 this.terminate(new BGPDocumentedException(null, BGPError.FSM_ERROR));
231 } else if (msg instanceof Notify) {
232 final Notify notify = (Notify) msg;
233 // Notifications are handled internally
234 LOG.info("Session closed because Notification message received: {} / {}, data={}",
235 notify.getErrorCode(),
236 notify.getErrorSubcode(),
237 notify.getData() != null ? ByteBufUtil.hexDump(notify.getData()) : null);
238 notifyTerminationReasonAndCloseWithoutMessage(notify.getErrorCode(), notify.getErrorSubcode());
239 } else if (msg instanceof Keepalive) {
240 // Keepalives are handled internally
241 LOG.trace("Received KeepAlive message.");
243 if (this.kaCounter >= 2) {
244 this.sync.kaReceived();
246 } else if (msg instanceof RouteRefresh) {
247 this.listener.onMessage(this, msg);
248 } else if (msg instanceof Update) {
249 this.listener.onMessage(this, msg);
250 this.sync.updReceived((Update) msg);
252 LOG.warn("Ignoring unhandled message: {}.", msg.getClass());
255 this.sessionState.messageReceived(msg);
256 } catch (final BGPDocumentedException e) {
261 private synchronized void notifyTerminationReasonAndCloseWithoutMessage(
262 final Short errorCode,
263 final Short errorSubcode) {
264 this.terminationReasonNotified = true;
265 this.closeWithoutMessage();
266 this.listener.onSessionTerminated(this, new BGPTerminationReason(
267 BGPError.forValue(errorCode, errorSubcode)));
270 synchronized void endOfInput() {
271 if (this.state == State.UP) {
272 LOG.info(END_OF_INPUT);
273 this.listener.onSessionDown(this, new IOException(END_OF_INPUT));
278 private ChannelFuture writeEpilogue(final ChannelFuture future, final Notification msg) {
280 (ChannelFutureListener) f -> {
281 if (!f.isSuccess()) {
282 LOG.warn("Failed to send message {} to socket {}", msg, BGPSessionImpl.this.channel, f.cause());
284 LOG.trace("Message {} sent to socket {}", msg, BGPSessionImpl.this.channel);
287 this.lastMessageSentAt = System.nanoTime();
288 this.sessionState.messageSent(msg);
293 this.channel.flush();
296 synchronized void write(final Notification msg) {
298 writeEpilogue(this.channel.write(msg), msg);
299 } catch (final Exception e) {
300 LOG.warn("Message {} was not sent.", msg, e);
304 synchronized ChannelFuture writeAndFlush(final Notification msg) {
306 return writeEpilogue(this.channel.writeAndFlush(msg), msg);
308 return this.channel.newFailedFuture(new NonWritableChannelException());
311 private synchronized void closeWithoutMessage() {
312 if (this.state == State.IDLE) {
315 LOG.info("Closing session: {}", this);
316 this.channel.close().addListener((ChannelFutureListener) future -> Preconditions.checkArgument(future.isSuccess(), "Channel failed to close: %s", future.cause()));
317 this.state = State.IDLE;
319 this.sessionState.setSessionState(this.state);
323 * Closes BGP session from the parent with given reason. A message needs to be sent, but parent doesn't have to be
324 * modified, because he initiated the closing. (To prevent concurrent modification exception).
326 * @param e BGPDocumentedException
329 synchronized void terminate(final BGPDocumentedException e) {
330 final BGPError error = e.getError();
331 final byte[] data = e.getData();
332 final NotifyBuilder builder = new NotifyBuilder().setErrorCode(error.getCode()).setErrorSubcode(error.getSubcode());
333 if (data != null && data.length != 0) {
334 builder.setData(data);
336 this.writeAndFlush(builder.build());
337 notifyTerminationReasonAndCloseWithoutMessage(error.getCode(), error.getSubcode());
340 private void removePeerSession() {
341 if (this.peerRegistry != null) {
342 this.peerRegistry.removePeerSession(StrictBGPPeerRegistry.getIpAddress(this.channel.remoteAddress()));
347 * If HoldTimer expires, the session ends. If a message (whichever) was received during this period, the HoldTimer
348 * will be rescheduled by HOLD_TIMER_VALUE + the time that has passed from the start of the HoldTimer to the time at
349 * which the message was received. If the session was closed by the time this method starts to execute (the session
350 * state will become IDLE), then rescheduling won't occur.
352 private synchronized void handleHoldTimer() {
353 if (this.state == State.IDLE) {
357 final long ct = System.nanoTime();
358 final long nextHold = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(this.holdTimerValue);
360 if (ct >= nextHold) {
361 LOG.debug("HoldTimer expired. {}", new Date());
362 this.terminate(new BGPDocumentedException(BGPError.HOLD_TIMER_EXPIRED));
364 this.channel.eventLoop().schedule(this::handleHoldTimer, nextHold - ct, TimeUnit.NANOSECONDS);
369 * If KeepAlive Timer expires, sends KeepAlive message. If a message (whichever) was send during this period, the
370 * KeepAlive Timer will be rescheduled by KEEP_ALIVE_TIMER_VALUE + the time that has passed from the start of the
371 * KeepAlive timer to the time at which the message was sent. If the session was closed by the time this method
372 * starts to execute (the session state will become IDLE), that rescheduling won't occur.
374 private synchronized void handleKeepaliveTimer() {
375 if (this.state == State.IDLE) {
379 final long ct = System.nanoTime();
380 long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
382 if (ct >= nextKeepalive) {
383 this.writeAndFlush(KEEP_ALIVE);
384 nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
386 this.channel.eventLoop().schedule(this::handleKeepaliveTimer, nextKeepalive - ct, TimeUnit.NANOSECONDS);
390 public final String toString() {
391 return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
394 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
395 toStringHelper.add("channel", this.channel);
396 toStringHelper.add("state", this.getState());
397 return toStringHelper;
401 public Set<BgpTableType> getAdvertisedTableTypes() {
402 return this.tableTypes;
406 public List<AddressFamilies> getAdvertisedAddPathTableTypes() {
407 return this.addPathTypes;
411 public List<BgpTableType> getAdvertisedGracefulRestartTableTypes() {
412 return Collections.emptyList();
416 synchronized void sessionUp() {
417 this.state = State.UP;
419 this.sessionState.setSessionState(this.state);
420 this.listener.onSessionUp(this);
421 } catch (final Exception e) {
427 public synchronized State getState() {
432 public final Ipv4Address getBgpId() {
437 public final AsNumber getAsNumber() {
438 return this.asNumber;
441 private synchronized boolean isWritable() {
442 return this.channel != null && this.channel.isWritable();
445 public ChannelOutputLimiter getLimiter() {
450 public final void channelInactive(final ChannelHandlerContext ctx) {
451 LOG.debug("Channel {} inactive.", ctx.channel());
455 super.channelInactive(ctx);
456 } catch (final Exception e) {
457 throw new IllegalStateException("Failed to delegate channel inactive event on channel " + ctx.channel(), e);
462 protected final void channelRead0(final ChannelHandlerContext ctx, final Notification msg) {
463 LOG.debug("Message was received: {}", msg);
464 this.handleMessage(msg);
468 public final void handlerAdded(final ChannelHandlerContext ctx) {
473 public synchronized void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
474 handleException(cause);
478 * Handle exception occurred in the BGP session. The session in error state should be closed
479 * properly so that it can be restored later.
482 void handleException(final Throwable cause) {
483 LOG.warn("BGP session encountered error", cause);
484 final Throwable docCause = cause.getCause();
485 if (docCause instanceof BGPDocumentedException) {
486 this.terminate((BGPDocumentedException) docCause);
488 this.terminate(new BGPDocumentedException(BGPError.CEASE));
493 public BGPSessionState getBGPSessionState() {
494 return this.sessionState;
498 public BGPTimersState getBGPTimersState() {
499 return this.sessionState;
503 public BGPTransportState getBGPTransportState() {
504 return this.sessionState;
508 public void registerMessagesCounter(final BGPMessagesListener bgpMessagesListener) {
509 this.sessionState.registerMessagesCounter(bgpMessagesListener);