* 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.Preconditions;
import io.netty.channel.Channel;
-import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.concurrent.Promise;
+import io.netty.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
-import javax.annotation.concurrent.GuardedBy;
+import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.checkerframework.checker.lock.qual.Holding;
import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
import org.opendaylight.protocol.bgp.parser.BGPError;
import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
import org.opendaylight.protocol.bgp.rib.spi.SessionNegotiator;
import org.opendaylight.protocol.util.Ipv6Util;
import org.opendaylight.protocol.util.Values;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
-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.rev130919.Keepalive;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Notify;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.NotifyBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Keepalive;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.KeepaliveBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Notify;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.NotifyBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Open;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.OpenBuilder;
import org.opendaylight.yangtools.yang.binding.Notification;
+import org.opendaylight.yangtools.yang.common.Uint16;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
// 4 minutes recommended in http://tools.ietf.org/html/rfc4271#section-8.2.2
private static final int INITIAL_HOLDTIMER = 4;
- /**
- * @see <a href="http://tools.ietf.org/html/rfc6793">BGP Support for 4-Octet AS Number Space</a>
- */
- private static final int AS_TRANS = 23456;
+ // <a href="http://tools.ietf.org/html/rfc6793">BGP Support for 4-Octet AS Number Space</a>
+ @VisibleForTesting
+ static final Uint16 AS_TRANS = Uint16.valueOf(23456).intern();
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractBGPSessionNegotiator.class);
+ private final BGPPeerRegistry registry;
+ private final Promise<BGPSessionImpl> promise;
+ private final Channel channel;
+ @GuardedBy("this")
+ private State state = State.IDLE;
+ @GuardedBy("this")
+ private BGPSessionImpl session;
+ @GuardedBy("this")
+ private ScheduledFuture<?> pending;
@VisibleForTesting
public enum State {
FINISHED,
}
- private static final Logger LOG = LoggerFactory.getLogger(AbstractBGPSessionNegotiator.class);
- private final BGPPeerRegistry registry;
- private final Promise<BGPSessionImpl> promise;
- private final Channel channel;
- @GuardedBy("this")
- private State state = State.IDLE;
- @GuardedBy("this")
- private BGPSessionImpl session;
-
AbstractBGPSessionNegotiator(final Promise<BGPSessionImpl> promise, final Channel channel,
final BGPPeerRegistry registry) {
- this.promise = Preconditions.checkNotNull(promise);
- this.channel = Preconditions.checkNotNull(channel);
+ this.promise = requireNonNull(promise);
+ this.channel = requireNonNull(channel);
this.registry = registry;
}
+ @SuppressWarnings("checkstyle:illegalCatch")
private synchronized void startNegotiation() {
if (!(this.state == State.IDLE || this.state == State.OPEN_CONFIRM)) {
return;
}
// Open can be sent first either from ODL (IDLE) or from peer (OPEN_CONFIRM)
- final IpAddress remoteIp = getRemoteIp();
+ final IpAddressNoZone remoteIp = getRemoteIp();
try {
// Check if peer is configured in registry before retrieving preferences
if (!this.registry.isPeerConfigured(remoteIp)) {
final BGPDocumentedException cause = new BGPDocumentedException(
- String.format("BGP peer with ip: %s not configured, check configured peers in : %s", remoteIp, this.registry), BGPError.CONNECTION_REJECTED);
+ String.format("BGP peer with ip: %s not configured, check configured peers in : %s",
+ remoteIp, this.registry), BGPError.CONNECTION_REJECTED);
negotiationFailed(cause);
return;
}
final BGPSessionPreferences preferences = this.registry.getPeerPreferences(remoteIp);
-
- int as = preferences.getMyAs().getValue().intValue();
- // Set as AS_TRANS if the value is bigger than 2B
- if (as > Values.UNSIGNED_SHORT_MAX_VALUE) {
- as = AS_TRANS;
- }
+ final Uint16 as = openASNumber(preferences.getMyAs().getValue().longValue());
sendMessage(new OpenBuilder().setMyAsNumber(as).setHoldTimer(preferences.getHoldTime()).setBgpIdentifier(
- preferences.getBgpId()).setBgpParameters(preferences.getParams()).build());
+ preferences.getBgpId()).setBgpParameters(preferences.getParams()).build());
if (this.state != State.FINISHED) {
this.state = State.OPEN_SENT;
- this.channel.eventLoop().schedule(new Runnable() {
- @Override
- public void run() {
- synchronized (AbstractBGPSessionNegotiator.this) {
- if (AbstractBGPSessionNegotiator.this.state != State.FINISHED) {
- AbstractBGPSessionNegotiator.this
+ this.pending = this.channel.eventLoop().schedule(() -> {
+ synchronized (AbstractBGPSessionNegotiator.this) {
+ AbstractBGPSessionNegotiator.this.pending = null;
+ if (AbstractBGPSessionNegotiator.this.state != State.FINISHED) {
+ AbstractBGPSessionNegotiator.this
.sendMessage(buildErrorNotify(BGPError.HOLD_TIMER_EXPIRED));
- negotiationFailed(new BGPDocumentedException("HoldTimer expired", BGPError.FSM_ERROR));
- AbstractBGPSessionNegotiator.this.state = State.FINISHED;
- }
+ negotiationFailed(new BGPDocumentedException("HoldTimer expired", BGPError.FSM_ERROR));
+ AbstractBGPSessionNegotiator.this.state = State.FINISHED;
}
}
}, INITIAL_HOLDTIMER, TimeUnit.MINUTES);
}
}
- private IpAddress getRemoteIp() {
- final IpAddress remoteIp = StrictBGPPeerRegistry.getIpAddress(this.channel.remoteAddress());
- if (remoteIp.getIpv6Address() != null) {
- return new IpAddress(Ipv6Util.getFullForm(remoteIp.getIpv6Address()));
+ private IpAddressNoZone getRemoteIp() {
+ final IpAddressNoZone remoteIp = StrictBGPPeerRegistry.getIpAddress(this.channel.remoteAddress());
+ if (remoteIp.getIpv6AddressNoZone() != null) {
+ return new IpAddressNoZone(Ipv6Util.getFullForm(remoteIp.getIpv6AddressNoZone()));
}
return remoteIp;
}
- protected synchronized void handleMessage(final Notification msg) {
+ synchronized void handleMessage(final Notification msg) {
LOG.debug("Channel {} handling message in state {}, msg: {}", this.channel, this.state, msg);
switch (this.state) {
- case FINISHED:
- sendMessage(buildErrorNotify(BGPError.FSM_ERROR));
- return;
- case IDLE:
- // to avoid race condition when Open message was sent by the peer before startNegotiation could be executed
- if (msg instanceof Open) {
- startNegotiation();
- handleOpen((Open) msg);
+ case FINISHED:
+ sendMessage(buildErrorNotify(BGPError.FSM_ERROR));
return;
- }
- sendMessage(buildErrorNotify(BGPError.FSM_ERROR));
- break;
- case OPEN_CONFIRM:
- if (msg instanceof Keepalive) {
- negotiationSuccessful(this.session);
- LOG.info("BGP Session with peer {} established successfully.", this.channel);
- } else if (msg instanceof Notify) {
- final Notify ntf = (Notify) msg;
- negotiationFailed(new BGPDocumentedException("Peer refusal", BGPError.forValue(ntf.getErrorCode(), ntf.getErrorSubcode())));
- }
- this.state = State.FINISHED;
- return;
- case OPEN_SENT:
- if (msg instanceof Open) {
- handleOpen((Open) msg);
+ case IDLE:
+ // to avoid race condition when Open message was sent by the peer before startNegotiation could be
+ // executed
+ if (msg instanceof Open) {
+ startNegotiation();
+ handleOpen((Open) msg);
+ return;
+ }
+ sendMessage(buildErrorNotify(BGPError.FSM_ERROR));
+ break;
+ case OPEN_CONFIRM:
+ if (msg instanceof Keepalive) {
+ negotiationSuccessful();
+ LOG.info("BGP Session with peer {} established successfully.", this.channel);
+ } else if (msg instanceof Notify) {
+ final Notify ntf = (Notify) msg;
+ negotiationFailed(new BGPDocumentedException("Peer refusal",
+ BGPError.forValue(ntf.getErrorCode(), ntf.getErrorSubcode())));
+ }
+ this.state = State.FINISHED;
return;
- }
- break;
- default:
- break;
+ case OPEN_SENT:
+ if (msg instanceof Open) {
+ handleOpen((Open) msg);
+ return;
+ }
+ break;
+ default:
+ break;
}
// Catch-all for unexpected message
LOG.warn("Channel {} state {} unexpected message {}", this.channel, this.state, msg);
sendMessage(buildErrorNotify(BGPError.FSM_ERROR));
- negotiationFailed(new BGPDocumentedException("Unexpected message channel: " + this.channel + ", state: " + this.state + ", message: " + msg, BGPError.FSM_ERROR));
+ negotiationFailed(new BGPDocumentedException("Unexpected message channel: "
+ + this.channel + ", state: " + this.state + ", message: " + msg, BGPError.FSM_ERROR));
this.state = State.FINISHED;
}
}
private synchronized void handleOpen(final Open openObj) {
- final IpAddress remoteIp = getRemoteIp();
+ final IpAddressNoZone remoteIp = getRemoteIp();
final BGPSessionPreferences preferences = this.registry.getPeerPreferences(remoteIp);
try {
- final BGPSessionListener peer = this.registry.getPeer(remoteIp, getSourceId(openObj, preferences), getDestinationId(openObj, preferences), openObj);
+ final BGPSessionListener peer = this.registry.getPeer(remoteIp, getSourceId(openObj, preferences),
+ getDestinationId(openObj, preferences), openObj);
sendMessage(new KeepaliveBuilder().build());
this.state = State.OPEN_CONFIRM;
this.session = new BGPSessionImpl(peer, this.channel, openObj, preferences, this.registry);
}
}
- private synchronized void negotiationFailed(final Throwable e) {
- LOG.warn("Channel {} negotiation failed: {}", this.channel, e.getMessage());
- if (e instanceof BGPDocumentedException) {
- // although sendMessage() can also result in calling this method, it won't create a cycle. In case sendMessage() fails to
- // deliver the message, this method gets called with different exception (definitely not with BGPDocumentedException).
- sendMessage(buildErrorNotify(((BGPDocumentedException)e).getError(), ((BGPDocumentedException) e).getData()));
+ private synchronized void negotiationFailed(final Throwable cause) {
+ LOG.warn("Channel {} negotiation failed: {}", this.channel, cause.getMessage());
+ if (cause instanceof BGPDocumentedException) {
+ // although sendMessage() can also result in calling this method, it won't create a cycle.
+ // In case sendMessage() fails to deliver the message, this method gets called with different
+ // exception (definitely not with BGPDocumentedException).
+ sendMessage(buildErrorNotify(((BGPDocumentedException) cause).getError(),
+ ((BGPDocumentedException) cause).getData()));
}
if (this.state == State.OPEN_CONFIRM) {
this.registry.removePeerSession(getRemoteIp());
}
- negotiationFailedCloseChannel(e);
+ negotiationFailedCloseChannel(cause);
this.state = State.FINISHED;
}
/**
+ * Get destination identifier.
+ *
* @param openMsg Open message received from remote BGP speaker
* @param preferences Local BGP speaker preferences
* @return BGP Id of device that accepted the connection
*/
- protected abstract Ipv4Address getDestinationId(final Open openMsg, final BGPSessionPreferences preferences);
+ protected abstract Ipv4AddressNoZone getDestinationId(Open openMsg, BGPSessionPreferences preferences);
/**
+ * Get source identifier.
+ *
* @param openMsg Open message received from remote BGP speaker
* @param preferences Local BGP speaker preferences
* @return BGP Id of device that accepted the connection
*/
- protected abstract Ipv4Address getSourceId(final Open openMsg, final BGPSessionPreferences preferences);
+ protected abstract Ipv4AddressNoZone getSourceId(Open openMsg, BGPSessionPreferences preferences);
public synchronized State getState() {
return this.state;
}
- private void negotiationSuccessful(final BGPSessionImpl session) {
+ @Holding("this")
+ private void negotiationSuccessful() {
LOG.debug("Negotiation on channel {} successful with session {}", this.channel, session);
this.channel.pipeline().replace(this, "session", session);
this.promise.setSuccess(session);
private void negotiationFailedCloseChannel(final Throwable cause) {
LOG.debug("Negotiation on channel {} failed", this.channel, cause);
this.channel.close();
- this.promise.setFailure(cause);
+ synchronized (AbstractBGPSessionNegotiator.this) {
+ if (this.pending != null && this.pending.isCancellable()) {
+ this.pending.cancel(true);
+ this.pending = null;
+ }
+ }
}
private void sendMessage(final Notification msg) {
- this.channel.writeAndFlush(msg).addListener(new ChannelFutureListener() {
- @Override
- public void operationComplete(final ChannelFuture f) {
- if (!f.isSuccess()) {
- LOG.warn("Failed to send message {} to channel {}", msg, AbstractBGPSessionNegotiator.this.channel, f.cause());
- negotiationFailedCloseChannel(f.cause());
- } else {
- LOG.trace("Message {} sent to channel {}", msg, AbstractBGPSessionNegotiator.this.channel);
- }
+ this.channel.writeAndFlush(msg).addListener((ChannelFutureListener) f -> {
+ if (!f.isSuccess()) {
+ LOG.warn("Failed to send message {} to channel {}", msg, AbstractBGPSessionNegotiator.this.channel,
+ f.cause());
+ negotiationFailedCloseChannel(f.cause());
+ } else {
+ LOG.trace("Message {} sent to channel {}", msg, AbstractBGPSessionNegotiator.this.channel);
}
});
}
}
@Override
+ @SuppressWarnings("checkstyle:illegalCatch")
public final void channelRead(final ChannelHandlerContext ctx, final Object msg) {
LOG.debug("Negotiation read invoked on channel {}", this.channel);
try {
LOG.info("Unexpected error during negotiation", cause);
negotiationFailedCloseChannel(cause);
}
+
+ @VisibleForTesting
+ static Uint16 openASNumber(final long configuredASNumber) {
+ // Return AS_TRANS if the value is bigger than 2B.
+ return configuredASNumber > Values.UNSIGNED_SHORT_MAX_VALUE ? AS_TRANS : Uint16.valueOf(configuredASNumber);
+ }
}
Code Review / bgpcep.git / blobdiff