*/
package org.opendaylight.protocol.bgp.rib.impl;
-import io.netty.channel.ChannelHandlerContext;
+import io.netty.channel.Channel;
+import io.netty.util.Timeout;
+import io.netty.util.Timer;
+import io.netty.util.TimerTask;
import java.io.IOException;
import java.util.Date;
import java.util.Set;
-import java.util.Timer;
-import java.util.TimerTask;
+import java.util.concurrent.TimeUnit;
-import org.opendaylight.protocol.bgp.concepts.BGPTableType;
-import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
+import javax.annotation.concurrent.GuardedBy;
+
+import org.opendaylight.protocol.bgp.parser.AsNumberUtil;
import org.opendaylight.protocol.bgp.parser.BGPError;
-import org.opendaylight.protocol.bgp.parser.BGPMessage;
-import org.opendaylight.protocol.bgp.parser.BGPParameter;
import org.opendaylight.protocol.bgp.parser.BGPSession;
import org.opendaylight.protocol.bgp.parser.BGPSessionListener;
-import org.opendaylight.protocol.bgp.parser.message.BGPKeepAliveMessage;
-import org.opendaylight.protocol.bgp.parser.message.BGPNotificationMessage;
-import org.opendaylight.protocol.bgp.parser.message.BGPOpenMessage;
-import org.opendaylight.protocol.bgp.parser.parameter.MultiprotocolCapability;
-import org.opendaylight.protocol.bgp.rib.impl.spi.BGPConnection;
-import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
-import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionProposalChecker;
-import org.opendaylight.protocol.framework.DeserializerException;
-import org.opendaylight.protocol.framework.DocumentedException;
-import org.opendaylight.protocol.framework.ProtocolMessage;
-import org.opendaylight.protocol.framework.ProtocolMessageFactory;
-import org.opendaylight.protocol.framework.ProtocolSession;
-import org.opendaylight.protocol.framework.ProtocolSessionOutboundHandler;
-import org.opendaylight.protocol.framework.SessionParent;
+import org.opendaylight.protocol.bgp.parser.BGPTerminationReason;
+import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
+import org.opendaylight.protocol.framework.AbstractProtocolSession;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.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.Update;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParameters;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.CParameters;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.c.parameters.MultiprotocolCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
+import org.opendaylight.yangtools.yang.binding.Notification;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Objects;
+import com.google.common.base.Objects.ToStringHelper;
+import com.google.common.base.Preconditions;
import com.google.common.collect.Sets;
-class BGPSessionImpl implements BGPSession, ProtocolSession {
-
- private static final Logger logger = LoggerFactory.getLogger(BGPSessionImpl.class);
-
- /**
- * KeepAlive Timer is to be scheduled periodically, each time it starts, it sends KeepAlive Message.
- */
- private class KeepAliveTimer extends TimerTask {
- private final BGPSessionImpl parent;
-
- public KeepAliveTimer(final BGPSessionImpl parent) {
- this.parent = parent;
- }
+@VisibleForTesting
+public class BGPSessionImpl extends AbstractProtocolSession<Notification> implements BGPSession {
- @Override
- public void run() {
- this.parent.handleKeepaliveTimer();
- }
- }
+ private static final Logger LOG = LoggerFactory.getLogger(BGPSessionImpl.class);
- /**
- * HoldTimer is to be scheduled periodically, when it expires, it closes BGP session.
+ /*
+ * 240
*/
- private class HoldTimer extends TimerTask {
- private final BGPSessionImpl parent;
-
- public HoldTimer(final BGPSessionImpl parent) {
- this.parent = parent;
- }
-
- @Override
- public void run() {
- this.parent.handleHoldTimer();
- }
- }
-
private static final int DEFAULT_HOLD_TIMER_VALUE = 15;
- public static int HOLD_TIMER_VALUE = DEFAULT_HOLD_TIMER_VALUE; // 240
-
- public int KEEP_ALIVE_TIMER_VALUE;
+ private static final Notification KEEP_ALIVE = new KeepaliveBuilder().build();
/**
- * Possible states for Finite State Machine
+ * Internal session state.
*/
- private enum State {
- IDLE, OPEN_SENT, OPEN_CONFIRM, ESTABLISHED
+ public enum State {
+ /**
+ * The session object is created by the negotiator in OpenConfirm state. While in this state, the session object
+ * is half-alive, e.g. the timers are running, but the session is not completely up, e.g. it has not been
+ * announced to the listener. If the session is torn down in this state, we do not inform the listener.
+ */
+ OpenConfirm,
+ /**
+ * The session has been completely established.
+ */
+ Up,
+ /**
+ * The session has been closed. It will not be resurrected.
+ */
+ Idle,
}
- /**
- * Actual state of the FSM.
- */
- private State state;
-
/**
* System.nanoTime value about when was sent the last message Protected to be updated also in tests.
*/
+ @VisibleForTesting
protected long lastMessageSentAt;
/**
*/
private long lastMessageReceivedAt;
- private final int sessionId;
-
private final BGPSessionListener listener;
- /**
- * Open message with session characteristics that were accepted by another BGP (sent from this session).
- */
- private BGPSessionPreferences localOpen = null;
-
- /**
- * Open Object with session characteristics for this session (sent from another BGP speaker).
- */
- private BGPSessionPreferences remoteOpen = null;
-
/**
* Timer object grouping FSM Timers
*/
private final Timer stateTimer;
- private final SessionParent parent;
-
- private final ProtocolMessageFactory parser;
+ private final BGPSynchronization sync;
- private final BGPSessionProposalChecker checker;
+ private int kaCounter = 0;
- private final BGPSynchronization sync;
+ private final Channel channel;
+
+ @GuardedBy("this")
+ private State state = State.OpenConfirm;
+
+
+ private final Set<BgpTableType> tableTypes;
+ private final int holdTimerValue;
+ private final int keepAlive;
+ private final AsNumber asNumber;
+ private final Ipv4Address bgpId;
+
+ BGPSessionImpl(final Timer timer, final BGPSessionListener listener, final Channel channel, final Open remoteOpen) {
+ this.listener = Preconditions.checkNotNull(listener);
+ this.stateTimer = Preconditions.checkNotNull(timer);
+ this.channel = Preconditions.checkNotNull(channel);
+ this.keepAlive = remoteOpen.getHoldTimer() / 3;
+ this.holdTimerValue = remoteOpen.getHoldTimer();
+ this.asNumber = AsNumberUtil.advertizedAsNumber(remoteOpen);
+
+ final Set<TablesKey> tts = Sets.newHashSet();
+ final Set<BgpTableType> tats = Sets.newHashSet();
+ if (remoteOpen.getBgpParameters() != null) {
+ for (final BgpParameters param : remoteOpen.getBgpParameters()) {
+ final CParameters cp = param.getCParameters();
+ if (cp instanceof MultiprotocolCase) {
+ final TablesKey tt = new TablesKey(((MultiprotocolCase) cp).getMultiprotocolCapability().getAfi(), ((MultiprotocolCase) cp).getMultiprotocolCapability().getSafi());
+ LOG.trace("Added table type to sync {}", tt);
+ tts.add(tt);
+ tats.add(new BgpTableTypeImpl(tt.getAfi(), tt.getSafi()));
+ }
+ }
+ }
- private final ProtocolSessionOutboundHandler handler;
+ this.sync = new BGPSynchronization(this, this.listener, tts);
+ this.tableTypes = tats;
- private int kaCounter = 0;
+ if (remoteOpen.getHoldTimer() != 0) {
+ this.stateTimer.newTimeout(new TimerTask() {
- private final ChannelHandlerContext ctx;
-
- BGPSessionImpl(final SessionParent parent, final Timer timer, final BGPConnection connection, final int sessionId,
- final ProtocolMessageFactory parser, final ChannelHandlerContext ctx) {
- this.state = State.IDLE;
- this.listener = connection.getListener();
- this.sessionId = sessionId;
- this.localOpen = connection.getProposal();
- this.stateTimer = timer;
- this.parent = parent;
- this.parser = parser;
- this.ctx = ctx;
- this.checker = connection.getProposalChecker();
- this.sync = new BGPSynchronization(this.listener);
- this.handler = new ProtocolSessionOutboundHandler();
- }
+ @Override
+ public void run(final Timeout timeout) throws Exception {
+ handleHoldTimer();
+ }
+ }, remoteOpen.getHoldTimer(), TimeUnit.SECONDS);
- @Override
- public void close() {
- logger.debug("Closing session: " + this);
- if (this.state == State.ESTABLISHED) {
- this.sendMessage(new BGPNotificationMessage(BGPError.CEASE));
+ this.stateTimer.newTimeout(new TimerTask() {
+ @Override
+ public void run(final Timeout timeout) throws Exception {
+ handleKeepaliveTimer();
+ }
+ }, this.keepAlive, TimeUnit.SECONDS);
}
- this.changeState(State.IDLE);
- this.parent.onSessionClosed(this);
+ this.bgpId = remoteOpen.getBgpIdentifier();
}
@Override
- public void startSession() {
- logger.debug("Session started.");
- this.sendMessage(new BGPOpenMessage(this.localOpen.getMyAs(), (short) this.localOpen.getHoldTime(), this.localOpen.getBgpId(), this.localOpen.getParams()));
- this.stateTimer.schedule(new HoldTimer(this), DEFAULT_HOLD_TIMER_VALUE * 1000);
- this.changeState(State.OPEN_SENT);
+ public synchronized void close() {
+ LOG.debug("Closing session: {}", this);
+ if (this.state != State.Idle) {
+ this.sendMessage(new NotifyBuilder().setErrorCode(BGPError.CEASE.getCode()).build());
+ this.channel.close();
+ this.state = State.Idle;
+ }
}
/**
* @param msg incoming message
*/
@Override
- public void handleMessage(final ProtocolMessage msg) {
- final BGPMessage bgpMsg = (BGPMessage) msg;
+ public void handleMessage(final Notification msg) {
// Update last reception time
this.lastMessageReceivedAt = System.nanoTime();
- // Open messages are handled internally, but are parsed also in bgp-parser, so notify bgp listener
- if (bgpMsg instanceof BGPOpenMessage) {
- this.handleOpenMessage((BGPOpenMessage) bgpMsg);
- }
- // Keepalives are handled internally
- else if (bgpMsg instanceof BGPKeepAliveMessage) {
- this.handleKeepAliveMessage();
- }
- // Notifications are handled internally
- else if (bgpMsg instanceof BGPNotificationMessage) {
- logger.info("Session closed because Notification message received: {}" + ((BGPNotificationMessage) bgpMsg).getError());
+ if (msg instanceof Open) {
+ // Open messages should not be present here
+ this.terminate(BGPError.FSM_ERROR);
+ } else if (msg instanceof Notify) {
+ // Notifications are handled internally
+ LOG.info("Session closed because Notification message received: {} / {}", ((Notify) msg).getErrorCode(),
+ ((Notify) msg).getErrorSubcode());
this.closeWithoutMessage();
- this.listener.onSessionTerminated(((BGPNotificationMessage) bgpMsg).getError());
+ this.listener.onSessionTerminated(this,
+ new BGPTerminationReason(BGPError.forValue(((Notify) msg).getErrorCode(), ((Notify) msg).getErrorSubcode())));
+ } else if (msg instanceof Keepalive) {
+ // Keepalives are handled internally
+ LOG.debug("Received KeepAlive messsage.");
+ this.kaCounter++;
+ if (this.kaCounter >= 2) {
+ this.sync.kaReceived();
+ }
} else {
- this.listener.onMessage(bgpMsg);
+ // All others are passed up
+ this.listener.onMessage(this, msg);
+ this.sync.updReceived((Update) msg);
}
}
@Override
- public void handleMalformedMessage(final DeserializerException e) {
- logger.warn("Received malformed message: {}", e.getMessage(), e);
- this.terminate(BGPError.FSM_ERROR);
- }
-
- @Override
- public void handleMalformedMessage(final DocumentedException e) {
- logger.warn("Received malformed message: {}", e.getMessage(), e);
- this.terminate(((BGPDocumentedException) e).getError());
- }
-
- @Override
- public void endOfInput() {
- if (this.state != State.IDLE) {
+ public synchronized void endOfInput() {
+ if (this.state == State.Up) {
this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
}
}
- @Override
- public ProtocolMessageFactory getMessageFactory() {
- return this.parser;
- }
-
- @Override
- public int maximumMessageSize() {
- return 4096;
- }
-
- void sendMessage(final BGPMessage msg) {
+ void sendMessage(final Notification msg) {
try {
- this.handler.writeDown(this.ctx, msg);
+ this.channel.writeAndFlush(msg);
this.lastMessageSentAt = System.nanoTime();
- logger.debug("Sent message: " + msg);
+ LOG.debug("Sent message: {}", msg);
} catch (final Exception e) {
- logger.warn("Message {} was not sent.", msg, e);
+ LOG.warn("Message {} was not sent.", msg, e);
}
}
- private void closeWithoutMessage() {
- logger.debug("Closing session: " + this);
- HOLD_TIMER_VALUE = DEFAULT_HOLD_TIMER_VALUE;
- this.changeState(State.IDLE);
- this.parent.onSessionClosed(this);
+ private synchronized void closeWithoutMessage() {
+ LOG.debug("Closing session: {}", this);
+ this.channel.close();
+ this.state = State.Idle;
}
/**
* @param closeObject
*/
private void terminate(final BGPError error) {
- this.sendMessage(new BGPNotificationMessage(error));
+ this.sendMessage(new NotifyBuilder().setErrorCode(error.getCode()).setErrorSubcode(error.getSubcode()).build());
this.closeWithoutMessage();
- this.listener.onSessionTerminated(error);
+
+ this.listener.onSessionTerminated(this, new BGPTerminationReason(error));
}
/**
* state will become IDLE), then rescheduling won't occur.
*/
private synchronized void handleHoldTimer() {
- final long ct = System.nanoTime();
+ if (this.state == State.Idle) {
+ return;
+ }
- final long nextHold = (long) (this.lastMessageReceivedAt + (HOLD_TIMER_VALUE * 1E9));
+ final long ct = System.nanoTime();
+ final long nextHold = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(holdTimerValue);
- if (this.state != State.IDLE) {
- if (ct >= nextHold) {
- logger.debug("HoldTimer expired. " + new Date());
- this.terminate(BGPError.HOLD_TIMER_EXPIRED);
- return;
- }
- this.stateTimer.schedule(new HoldTimer(this), (long) ((nextHold - ct) / 1E6));
+ if (ct >= nextHold) {
+ LOG.debug("HoldTimer expired. " + new Date());
+ this.terminate(BGPError.HOLD_TIMER_EXPIRED);
+ } else {
+ this.stateTimer.newTimeout(new TimerTask() {
+ @Override
+ public void run(final Timeout timeout) throws Exception {
+ handleHoldTimer();
+ }
+ }, nextHold - ct, TimeUnit.NANOSECONDS);
}
}
* starts to execute (the session state will become IDLE), that rescheduling won't occur.
*/
private synchronized void handleKeepaliveTimer() {
- final long ct = System.nanoTime();
+ if (this.state == State.Idle) {
+ return;
+ }
- long nextKeepalive = (long) (this.lastMessageSentAt + (this.KEEP_ALIVE_TIMER_VALUE * 1E9));
+ final long ct = System.nanoTime();
+ long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
- if (this.state == State.ESTABLISHED) {
- if (ct >= nextKeepalive) {
- this.sendMessage(new BGPKeepAliveMessage());
- nextKeepalive = (long) (this.lastMessageSentAt + (this.KEEP_ALIVE_TIMER_VALUE * 1E9));
- }
- this.stateTimer.schedule(new KeepAliveTimer(this), (long) ((nextKeepalive - ct) / 1E6));
+ if (ct >= nextKeepalive) {
+ this.sendMessage(KEEP_ALIVE);
+ nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
}
+ this.stateTimer.newTimeout(new TimerTask() {
+ @Override
+ public void run(final Timeout timeout) throws Exception {
+ handleKeepaliveTimer();
+ }
+ }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
}
- private void changeState(final State finalState) {
- final String desc = "Changed to state: ";
- switch (finalState) {
- case IDLE:
- logger.debug(desc + State.IDLE);
- this.state = State.IDLE;
- return;
- case OPEN_SENT:
- logger.debug(desc + State.OPEN_SENT);
- if (this.state != State.IDLE) {
- throw new IllegalArgumentException("Cannot change state from " + this.state + " to " + State.OPEN_SENT);
- }
- this.state = State.OPEN_SENT;
- return;
- case OPEN_CONFIRM:
- logger.debug(desc + State.OPEN_CONFIRM);
- if (this.state == State.ESTABLISHED) {
- throw new IllegalArgumentException("Cannot change state from " + this.state + " to " + State.OPEN_CONFIRM);
- }
- this.state = State.OPEN_CONFIRM;
- return;
- case ESTABLISHED:
- logger.debug(desc + State.ESTABLISHED);
- if (this.state != State.OPEN_CONFIRM) {
- throw new IllegalArgumentException("Cannot change state from " + this.state + " to " + State.ESTABLISHED);
- }
- this.state = State.ESTABLISHED;
- return;
- }
+ @Override
+ public final String toString() {
+ return addToStringAttributes(Objects.toStringHelper(this)).toString();
}
- /**
- * Open message should be handled only if the FSM is in OPEN_SENT or IDLE state. When in IDLE state, the Open
- * message was received _before_ local Open message was sent. When in OPEN_SENT state, the message was received
- * _after_ local Open message was sent.
- *
- * @param msg received Open Message.
- */
- private void handleOpenMessage(final BGPOpenMessage msg) {
- this.remoteOpen = new BGPSessionPreferences(msg.getMyAS(), msg.getHoldTime(), msg.getBgpId(), msg.getOptParams());
- logger.debug("Received message: {}", msg.toString());
- if (this.state != State.IDLE && this.state != State.OPEN_SENT) {
- this.terminate(BGPError.FSM_ERROR);
- return;
- }
- // if the session characteristics were unacceptable, the session is terminated
- // with given BGP error
- try {
- this.checker.checkSessionCharacteristics(this.remoteOpen);
- } catch (final BGPDocumentedException e) {
- this.terminate(e.getError());
- }
- // the session characteristics were acceptable
- HOLD_TIMER_VALUE = this.remoteOpen.getHoldTime();
- logger.debug("Session chars are acceptable. Overwriting: holdtimer: {}", HOLD_TIMER_VALUE);
- // when in IDLE state, we haven't send Open Message yet, do it now
- if (this.state == State.IDLE) {
- this.sendMessage(new BGPOpenMessage(this.localOpen.getMyAs(), (short) this.localOpen.getHoldTime(), this.localOpen.getBgpId(), this.localOpen.getParams()));
- }
- this.sendMessage(new BGPKeepAliveMessage());
- // if the timer is not disabled
- if (HOLD_TIMER_VALUE != 0) {
- this.KEEP_ALIVE_TIMER_VALUE = HOLD_TIMER_VALUE / 3;
- this.stateTimer.schedule(new KeepAliveTimer(this), this.KEEP_ALIVE_TIMER_VALUE * 1000);
- this.stateTimer.schedule(new HoldTimer(this), HOLD_TIMER_VALUE * 1000);
- }
- this.changeState(State.OPEN_CONFIRM);
+ protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
+ toStringHelper.add("channel", this.channel);
+ toStringHelper.add("state", this.state);
+ return toStringHelper;
}
- /**
- * KeepAlive message should be explicitly parsed in FSM when its state is OPEN_CONFIRM. Otherwise is handled by the
- * KeepAliveTimer or it's invalid.
- */
- private void handleKeepAliveMessage() {
- logger.debug("Received KeepAlive messsage.");
- if (this.state == State.OPEN_CONFIRM) {
- if (HOLD_TIMER_VALUE != 0) {
- this.stateTimer.schedule(new HoldTimer(this), HOLD_TIMER_VALUE * 1000);
- this.stateTimer.schedule(new KeepAliveTimer(this), this.KEEP_ALIVE_TIMER_VALUE * 1000);
- }
- this.changeState(State.ESTABLISHED);
- final Set<BGPTableType> tts = Sets.newHashSet();
- if (this.remoteOpen.getParams() != null) {
- for (final BGPParameter param : this.remoteOpen.getParams()) {
- if (param instanceof MultiprotocolCapability) {
- tts.add(((MultiprotocolCapability) param).getTableType());
- }
- }
- }
- this.sync.addTableTypes(tts);
- this.listener.onSessionUp(tts);
- // check if the KA is EOR for some AFI/SAFI
- } else if (this.state == State.ESTABLISHED) {
- this.kaCounter++;
- if (this.kaCounter >= 2) {
- this.sync.kaReceived();
- }
- }
+ @Override
+ public Set<BgpTableType> getAdvertisedTableTypes() {
+ return this.tableTypes;
+ }
+
+ @Override
+ protected synchronized void sessionUp() {
+ this.state = State.Up;
+ this.listener.onSessionUp(this);
+ }
+
+ public synchronized State getState() {
+ return this.state;
+ }
+
+ @Override
+ public final byte[] getBgpId() {
+ return this.bgpId.getValue().getBytes();
}
@Override
- public String toString() {
- final StringBuilder builder = new StringBuilder();
- builder.append("BGPSessionImpl [state=");
- builder.append(this.state);
- builder.append(", sessionId=");
- builder.append(this.sessionId);
- builder.append(", localOpen=");
- builder.append(this.localOpen);
- builder.append(", remoteOpen=");
- builder.append(this.remoteOpen);
- builder.append("]");
- return builder.toString();
+ public final AsNumber getAsNumber() {
+ return this.asNumber;
}
}
Code Review / bgpcep.git / blobdiff