Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.protocol.bgp.rib.impl;
import static java.util.Objects.requireNonNull;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.collect.ImmutableSet;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.netty.buffer.ByteBufUtil;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.util.concurrent.ScheduledFuture;
import java.io.IOException;
import java.nio.channels.NonWritableChannelException;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import org.checkerframework.checker.lock.qual.GuardedBy;
import org.checkerframework.checker.lock.qual.Holding;
import org.opendaylight.protocol.bgp.parser.AsNumberUtil;
import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
import org.opendaylight.protocol.bgp.parser.BGPError;
import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
import org.opendaylight.protocol.bgp.parser.GracefulRestartUtil;
import org.opendaylight.protocol.bgp.parser.spi.MultiPathSupport;
import org.opendaylight.protocol.bgp.parser.spi.PeerConstraint;
import org.opendaylight.protocol.bgp.parser.spi.pojo.MultiPathSupportImpl;
import org.opendaylight.protocol.bgp.rib.impl.spi.BGPMessagesListener;
import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateImpl;
import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateProvider;
import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
import org.opendaylight.protocol.bgp.rib.spi.State;
import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Keepalive;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.KeepaliveBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Notify;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.NotifyBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Open;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.BgpParameters;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilities;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParameters;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.MpCapabilities;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.RouteRefresh;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.AddPathCapability;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapability;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.LlGracefulRestartCapability;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapability;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.add.path.capability.AddressFamilies;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
import org.opendaylight.yangtools.yang.binding.ChildOf;
import org.opendaylight.yangtools.yang.binding.Notification;
import org.opendaylight.yangtools.yang.common.Uint8;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@VisibleForTesting
public class BGPSessionImpl extends SimpleChannelInboundHandler> implements BGPSession,
BGPSessionStateProvider, AutoCloseable {
private static final Logger LOG = LoggerFactory.getLogger(BGPSessionImpl.class);
private static final Keepalive KEEP_ALIVE = new KeepaliveBuilder().build();
private static final int KA_TO_DEADTIMER_RATIO = 3;
static final String END_OF_INPUT = "End of input detected. Close the session.";
/**
* System.nanoTime value about when was sent the last message.
*/
@VisibleForTesting
private long lastMessageSentAt;
/**
* System.nanoTime value about when was received the last message.
*/
private long lastMessageReceivedAt;
private final BGPSessionListener listener;
private final BGPSynchronization sync;
private int kaCounter = 0;
private final Channel channel;
@GuardedBy("this")
private State state = State.OPEN_CONFIRM;
private final Set tableTypes;
private final List addPathTypes;
private final long holdTimerNanos;
private final long keepAliveNanos;
private final AsNumber asNumber;
private final Ipv4Address bgpId;
private final BGPPeerRegistry peerRegistry;
private final ChannelOutputLimiter limiter;
private final BGPSessionStateImpl sessionState;
private final GracefulRestartCapability gracefulCapability;
private final LlGracefulRestartCapability llGracefulCapability;
private boolean terminationReasonNotified;
public BGPSessionImpl(final BGPSessionListener listener, final Channel channel, final Open remoteOpen,
final BGPSessionPreferences localPreferences, final BGPPeerRegistry peerRegistry) {
this(listener, channel, remoteOpen, localPreferences.getHoldTime(), peerRegistry);
}
@SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR",
justification = "Class not final for mocking and SpotBugs is confused by lambdas around line 200")
public BGPSessionImpl(final BGPSessionListener listener, final Channel channel, final Open remoteOpen,
final int localHoldTimer, final BGPPeerRegistry peerRegistry) {
this.listener = requireNonNull(listener);
this.channel = requireNonNull(channel);
limiter = new ChannelOutputLimiter(this);
this.channel.pipeline().addLast(limiter);
final int remoteHoldTimer = remoteOpen.getHoldTimer().toJava();
final int holdTimerValue = Math.min(remoteHoldTimer, localHoldTimer);
LOG.info("BGP HoldTimer new value: {}", holdTimerValue);
holdTimerNanos = TimeUnit.SECONDS.toNanos(holdTimerValue);
keepAliveNanos = TimeUnit.SECONDS.toNanos(holdTimerValue / KA_TO_DEADTIMER_RATIO);
asNumber = AsNumberUtil.advertizedAsNumber(remoteOpen);
this.peerRegistry = peerRegistry;
sessionState = new BGPSessionStateImpl();
final Set tts = new HashSet<>();
final Set tats = new HashSet<>();
final List addPathCapabilitiesList = new ArrayList<>();
final List bgpParameters = remoteOpen.getBgpParameters();
if (bgpParameters != null) {
for (final BgpParameters param : bgpParameters) {
for (final OptionalCapabilities optCapa : param.nonnullOptionalCapabilities()) {
final CParameters cParam = optCapa.getCParameters();
final CParameters1 cParam1 = cParam.augmentation(CParameters1.class);
if (cParam1 != null) {
final MultiprotocolCapability multi = cParam1.getMultiprotocolCapability();
if (multi != null) {
final TablesKey tt = new TablesKey(multi.getAfi(), multi.getSafi());
LOG.trace("Added table type to sync {}", tt);
tts.add(tt);
tats.add(new BgpTableTypeImpl(tt.getAfi(), tt.getSafi()));
} else {
final AddPathCapability addPathCap = cParam1.getAddPathCapability();
if (addPathCap != null) {
addPathCapabilitiesList.addAll(addPathCap.getAddressFamilies());
}
}
}
}
}
gracefulCapability = findSingleCapability(bgpParameters, "Graceful Restart",
CParameters1::getGracefulRestartCapability).orElse(GracefulRestartUtil.EMPTY_GR_CAPABILITY);
llGracefulCapability = findSingleCapability(bgpParameters, "Long-lived Graceful Restart",
CParameters1::getLlGracefulRestartCapability).orElse(GracefulRestartUtil.EMPTY_LLGR_CAPABILITY);
} else {
gracefulCapability = GracefulRestartUtil.EMPTY_GR_CAPABILITY;
llGracefulCapability = GracefulRestartUtil.EMPTY_LLGR_CAPABILITY;
}
sync = new BGPSynchronization(this.listener, tts);
tableTypes = tats;
addPathTypes = addPathCapabilitiesList;
if (!addPathTypes.isEmpty()) {
addDecoderConstraint(MultiPathSupport.class,
MultiPathSupportImpl.createParserMultiPathSupport(addPathTypes));
}
if (holdTimerValue != 0) {
channel.eventLoop().schedule(this::handleHoldTimer, holdTimerNanos, TimeUnit.NANOSECONDS);
channel.eventLoop().schedule(this::handleKeepaliveTimer, keepAliveNanos, TimeUnit.NANOSECONDS);
}
bgpId = remoteOpen.getBgpIdentifier();
sessionState.advertizeCapabilities(holdTimerValue, channel.remoteAddress(), channel.localAddress(),
tableTypes, bgpParameters);
}
private static > Optional findSingleCapability(
final List bgpParameters, final String name, final Function extractor) {
final List found = new ArrayList<>(1);
for (BgpParameters bgpParams : bgpParameters) {
for (OptionalCapabilities optCapability : bgpParams.nonnullOptionalCapabilities()) {
final CParameters cparam = optCapability.getCParameters();
if (cparam != null) {
final CParameters1 augment = cparam.augmentation(CParameters1.class);
if (augment != null) {
final T capa = extractor.apply(augment);
if (capa != null) {
found.add(capa);
}
}
}
}
}
final Set set = ImmutableSet.copyOf(found);
switch (set.size()) {
case 0:
LOG.debug("{} capability not advertised.", name);
return Optional.empty();
case 1:
return Optional.of(found.get(0));
default:
LOG.warn("Multiple instances of {} capability advertised: {}, ignoring.", name, set);
return Optional.empty();
}
}
/**
* Set the extend message coder for current channel.
* The reason for separating this part from constructor is, in #channel.pipeline().replace(..), the
* invokeChannelRead() will be invoked after the original message coder handler got removed. And there
* is chance that before the session instance is fully initiated (constructor returns), a KeepAlive
* message arrived already in the channel buffer. Thus #AbstractBGPSessionNegotiator.handleMessage(..)
* gets invoked again and a deadlock is caused. A BGP final state machine error will happen as BGP
* negotiator is still in OPEN_SENT state as the session constructor hasn't returned yet.
*/
public synchronized void setChannelExtMsgCoder(final Open remoteOpen) {
final boolean enableExMess = BgpExtendedMessageUtil.advertizedBgpExtendedMessageCapability(remoteOpen);
if (enableExMess) {
BGPMessageHeaderDecoder.enableExtendedMessages(channel);
}
}
@Override
public synchronized void close() {
if (state != State.IDLE) {
if (!terminationReasonNotified) {
writeAndFlush(new NotifyBuilder().setErrorCode(BGPError.CEASE.getCode())
.setErrorSubcode(BGPError.CEASE.getSubcode()).build());
}
closeWithoutMessage();
}
}
/**
* Handles incoming message based on their type.
*
* @param msg incoming message
*/
void handleMessage(final Notification msg) {
// synchronize on listener and then on this object to ensure correct order of locking
synchronized (listener) {
synchronized (this) {
if (state == State.IDLE) {
return;
}
try {
// Update last reception time
lastMessageReceivedAt = System.nanoTime();
if (msg instanceof Open) {
// Open messages should not be present here
terminate(new BGPDocumentedException(null, BGPError.FSM_ERROR));
} else if (msg instanceof Notify notify) {
// Notifications are handled internally
LOG.info("Session closed because Notification message received: {} / {}, data={}",
notify.getErrorCode(),
notify.getErrorSubcode(),
notify.getData() != null ? ByteBufUtil.hexDump(notify.getData()) : null);
notifyTerminationReasonAndCloseWithoutMessage(notify.getErrorCode(), notify.getErrorSubcode());
} else if (msg instanceof Keepalive) {
// Keepalives are handled internally
LOG.trace("Received KeepAlive message.");
kaCounter++;
if (kaCounter >= 2) {
sync.kaReceived();
}
} else if (msg instanceof RouteRefresh) {
listener.onMessage(this, msg);
} else if (msg instanceof Update) {
listener.onMessage(this, msg);
sync.updReceived((Update) msg);
} else {
LOG.warn("Ignoring unhandled message: {}.", msg.getClass());
}
sessionState.messageReceived(msg);
} catch (final BGPDocumentedException e) {
terminate(e);
}
}
}
}
@Holding({"this.listener", "this"})
private void notifyTerminationReasonAndCloseWithoutMessage(final BGPError error) {
terminationReasonNotified = true;
closeWithoutMessage();
listener.onSessionTerminated(this, new BGPTerminationReason(error));
}
@Holding({"this.listener", "this"})
private void notifyTerminationReasonAndCloseWithoutMessage(final Uint8 errorCode, final Uint8 errorSubcode) {
terminationReasonNotified = true;
closeWithoutMessage();
listener.onSessionTerminated(this, new BGPTerminationReason(BGPError.forValue(errorCode, errorSubcode)));
}
void endOfInput() {
// synchronize on listener and then on this object to ensure correct order of locking
synchronized (listener) {
synchronized (this) {
if (state == State.UP) {
LOG.info(END_OF_INPUT);
listener.onSessionDown(this, new IOException(END_OF_INPUT));
}
}
}
}
@Holding("this")
private ChannelFuture writeEpilogue(final ChannelFuture future, final Notification msg) {
future.addListener((ChannelFutureListener) f -> {
if (f.isSuccess()) {
LOG.trace("Message {} sent to socket {}", msg, channel);
} else {
LOG.warn("Failed to send message {} to socket {}", msg, channel, f.cause());
}
});
lastMessageSentAt = System.nanoTime();
sessionState.messageSent(msg);
return future;
}
void flush() {
channel.flush();
}
@SuppressWarnings("checkstyle:illegalCatch")
synchronized void write(final Notification msg) {
try {
writeEpilogue(channel.write(msg), msg);
} catch (final Exception e) {
LOG.warn("Message {} was not sent.", msg, e);
}
}
synchronized ChannelFuture writeAndFlush(final Notification msg) {
if (channel.isWritable()) {
return writeEpilogue(channel.writeAndFlush(msg), msg);
}
return channel.newFailedFuture(new NonWritableChannelException());
}
@Override
public synchronized void closeWithoutMessage() {
if (state == State.IDLE) {
return;
}
LOG.info("Closing session: {}", this);
channel.close().addListener((ChannelFutureListener) future -> {
if (future.isSuccess()) {
LOG.debug("Channel {} closed successfully", channel);
} else {
LOG.warn("Channel {} failed to close", channel, future.cause());
}
});
state = State.IDLE;
removePeerSession();
sessionState.setSessionState(state);
}
/**
* Closes BGP session from the parent with given reason. A message needs to be sent, but parent doesn't have to be
* modified, because he initiated the closing. (To prevent concurrent modification exception).
*
* @param cause BGPDocumentedException
*/
@VisibleForTesting
@Holding({"this.listener", "this"})
void terminate(final BGPDocumentedException cause) {
final BGPError error = cause.getError();
final byte[] data = cause.getData();
final NotifyBuilder builder = new NotifyBuilder().setErrorCode(error.getCode())
.setErrorSubcode(error.getSubcode());
if (data != null && data.length != 0) {
builder.setData(data);
}
writeAndFlush(builder.build());
notifyTerminationReasonAndCloseWithoutMessage(error);
}
private void removePeerSession() {
if (peerRegistry != null) {
peerRegistry.removePeerSession(StrictBGPPeerRegistry.getIpAddress(channel.remoteAddress()));
}
}
/**
* If HoldTimer expires, the session ends. If a message (whichever) was received during this period, the HoldTimer
* will be rescheduled by HOLD_TIMER_VALUE + the time that has passed from the start of the HoldTimer to the time at
* which the message was received. If the session was closed by the time this method starts to execute (the session
* state will become IDLE), then rescheduling won't occur.
*/
private void handleHoldTimer() {
// synchronize on listener and then on this object to ensure correct order of locking
synchronized (listener) {
synchronized (this) {
if (state == State.IDLE) {
return;
}
final long ct = System.nanoTime();
final long nextHold = lastMessageReceivedAt + holdTimerNanos;
if (ct >= nextHold) {
LOG.debug("HoldTimer expired. {}", new Date());
terminate(new BGPDocumentedException(BGPError.HOLD_TIMER_EXPIRED));
} else {
channel.eventLoop().schedule(this::handleHoldTimer, nextHold - ct, TimeUnit.NANOSECONDS);
}
}
}
}
/**
* If KeepAlive Timer expires, sends KeepAlive message. If a message (whichever) was send during this period, the
* KeepAlive Timer will be rescheduled by KEEP_ALIVE_TIMER_VALUE + the time that has passed from the start of the
* KeepAlive timer to the time at which the message was sent. If the session was closed by the time this method
* starts to execute (the session state will become IDLE), that rescheduling won't occur.
*/
private synchronized void handleKeepaliveTimer() {
if (state == State.IDLE) {
LOG.debug("Skipping keepalive on session idle {}", this);
return;
}
final long ct = System.nanoTime();
final long nextKeepalive = lastMessageSentAt + keepAliveNanos;
long nextNanos = nextKeepalive - ct;
if (nextNanos <= 0) {
final ChannelFuture future = writeAndFlush(KEEP_ALIVE);
LOG.debug("Enqueued session {} keepalive as {}", this, future);
nextNanos = keepAliveNanos;
if (LOG.isDebugEnabled()) {
future.addListener(compl -> LOG.debug("Session {} keepalive completed as {}", this, compl));
}
} else {
LOG.debug("Skipping keepalive on session {}", this);
}
LOG.debug("Scheduling next keepalive on {} in {} nanos", this, nextNanos);
channel.eventLoop().schedule(this::handleKeepaliveTimer, nextNanos, TimeUnit.NANOSECONDS);
}
@Override
public final String toString() {
return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
}
protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
toStringHelper.add("channel", channel);
toStringHelper.add("state", getState());
return toStringHelper;
}
@Override
public Set getAdvertisedTableTypes() {
return tableTypes;
}
@Override
public List getAdvertisedAddPathTableTypes() {
return addPathTypes;
}
@Override
public GracefulRestartCapability getAdvertisedGracefulRestartCapability() {
return gracefulCapability;
}
@Override
public LlGracefulRestartCapability getAdvertisedLlGracefulRestartCapability() {
return llGracefulCapability;
}
@VisibleForTesting
@SuppressWarnings("checkstyle:illegalCatch")
void sessionUp() {
// synchronize on listener and then on this object to ensure correct order of locking
synchronized (listener) {
synchronized (this) {
state = State.UP;
try {
sessionState.setSessionState(state);
listener.onSessionUp(this);
} catch (final Exception e) {
handleException(e);
throw e;
}
}
}
}
public synchronized State getState() {
return state;
}
@Override
public final Ipv4Address getBgpId() {
return bgpId;
}
@Override
public final AsNumber getAsNumber() {
return asNumber;
}
public ChannelOutputLimiter getLimiter() {
return limiter;
}
@Override
public final void channelInactive(final ChannelHandlerContext ctx) throws Exception {
LOG.debug("Channel {} inactive.", ctx.channel());
endOfInput();
super.channelInactive(ctx);
}
@Override
protected final void channelRead0(final ChannelHandlerContext ctx, final Notification msg) {
LOG.trace("Message was received: {} from {}", msg, channel.remoteAddress());
handleMessage(msg);
}
@Override
public final void handlerAdded(final ChannelHandlerContext ctx) {
sessionUp();
}
@Override
public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
// synchronize on listener and then on this object to ensure correct order of locking
synchronized (listener) {
synchronized (this) {
handleException(cause);
}
}
}
/**
* Handle exception occurred in the BGP session. The session in error state should be closed
* properly so that it can be restored later.
*/
@Holding({"this.listener", "this"})
@VisibleForTesting
void handleException(final Throwable cause) {
LOG.warn("BGP session encountered error", cause);
final Throwable docCause = cause.getCause();
terminate(docCause instanceof BGPDocumentedException
? (BGPDocumentedException) docCause : new BGPDocumentedException(BGPError.CEASE));
}
@Override
public BGPSessionState getBGPSessionState() {
return sessionState;
}
@Override
public BGPTimersState getBGPTimersState() {
return sessionState;
}
@Override
public BGPTransportState getBGPTransportState() {
return sessionState;
}
@Override
public void registerMessagesCounter(final BGPMessagesListener bgpMessagesListener) {
sessionState.registerMessagesCounter(bgpMessagesListener);
}
@Override
public void addDecoderConstraint(final Class constraintClass, final T constraint) {
channel.pipeline().get(BGPByteToMessageDecoder.class).addDecoderConstraint(constraintClass, constraint);
}
@Override
public ScheduledFuture schedule(final Runnable command, final long delay, final TimeUnit unit) {
return channel.eventLoop().schedule(command, delay, unit);
}
}
