X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=pcep%2Fimpl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fprotocol%2Fpcep%2Fimpl%2FPCEPSessionImpl.java;h=db5c8b50b8f6417a9bcca86a788601a1da86a05f;hb=1f18c032706004ce9bf0fcc648090ec5211b945a;hp=cc7228d1305716824370a76e2aca4fad3f467b57;hpb=5b076e6fdaf12faaca5e970985517bbfc3348774;p=bgpcep.git diff --git a/pcep/impl/src/main/java/org/opendaylight/protocol/pcep/impl/PCEPSessionImpl.java b/pcep/impl/src/main/java/org/opendaylight/protocol/pcep/impl/PCEPSessionImpl.java index cc7228d130..db5c8b50b8 100644 --- a/pcep/impl/src/main/java/org/opendaylight/protocol/pcep/impl/PCEPSessionImpl.java +++ b/pcep/impl/src/main/java/org/opendaylight/protocol/pcep/impl/PCEPSessionImpl.java @@ -7,14 +7,18 @@ */ package org.opendaylight.protocol.pcep.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.base.Ticker; import io.netty.channel.Channel; import io.netty.channel.ChannelFuture; import io.netty.channel.ChannelFutureListener; -import io.netty.util.Timeout; -import io.netty.util.Timer; -import io.netty.util.TimerTask; +import io.netty.channel.ChannelHandlerContext; +import io.netty.channel.SimpleChannelInboundHandler; import io.netty.util.concurrent.Future; - import java.io.IOException; import java.net.InetAddress; import java.net.InetSocketAddress; @@ -22,377 +26,417 @@ import java.util.Date; import java.util.LinkedList; import java.util.Queue; import java.util.concurrent.TimeUnit; - -import org.opendaylight.protocol.framework.AbstractProtocolSession; +import java.util.concurrent.atomic.AtomicBoolean; +import javax.annotation.concurrent.GuardedBy; import org.opendaylight.protocol.pcep.PCEPCloseTermination; import org.opendaylight.protocol.pcep.PCEPSession; import org.opendaylight.protocol.pcep.PCEPSessionListener; import org.opendaylight.protocol.pcep.TerminationReason; +import org.opendaylight.protocol.pcep.impl.spi.Util; import org.opendaylight.protocol.pcep.spi.PCEPErrors; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.CloseBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Keepalive; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.KeepaliveBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.CloseMessage; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.KeepaliveMessage; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.OpenMessage; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.close.message.CCloseMessageBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.close.object.CCloseBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.keepalive.message.KeepaliveMessageBuilder; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.Open; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.open.Tlvs; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.CloseBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.Keepalive; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.KeepaliveBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.LocalPref; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.Messages; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.PeerPref; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.CloseMessage; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.KeepaliveMessage; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Message; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.OpenMessage; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.PcerrMessage; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.close.message.CCloseMessageBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.close.object.CCloseBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.keepalive.message.KeepaliveMessageBuilder; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.Open; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.open.Tlvs; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.Charsets; -import com.google.common.base.Objects; -import com.google.common.base.Objects.ToStringHelper; -import com.google.common.base.Preconditions; - /** * Implementation of PCEPSession. (Not final for testing.) */ @VisibleForTesting -public class PCEPSessionImpl extends AbstractProtocolSession implements PCEPSession, PCEPSessionRuntimeMXBean { - /** - * System.nanoTime value about when was sent the last message Protected to be updated also in tests. - */ - protected volatile long lastMessageSentAt; - - /** - * System.nanoTime value about when was received the last message - */ - private long lastMessageReceivedAt; - - /** - * Protected for testing. - */ - protected int maxUnknownMessages; - - protected final Queue unknownMessagesTimes = new LinkedList(); - - private final PCEPSessionListener listener; - - /** - * Open Object with session characteristics that were accepted by another PCE (sent from this session). - */ - private final Open localOpen; - - /** - * Open Object with session characteristics for this session (sent from another PCE). - */ - private final Open remoteOpen; - - private static final Logger LOG = LoggerFactory.getLogger(PCEPSessionImpl.class); - - /** - * Timer object grouping FSM Timers - */ - private final Timer stateTimer; - - private int sentMsgCount = 0; - - private int receivedMsgCount = 0; - - // True if the listener should not be notified about events - private boolean closed = false; - - private final Channel channel; - - private final Keepalive kaMessage = new KeepaliveBuilder().setKeepaliveMessage(new KeepaliveMessageBuilder().build()).build(); - - PCEPSessionImpl(final Timer timer, final PCEPSessionListener listener, final int maxUnknownMessages, final Channel channel, - final Open localOpen, final Open remoteOpen) { - this.listener = Preconditions.checkNotNull(listener); - this.stateTimer = Preconditions.checkNotNull(timer); - this.channel = Preconditions.checkNotNull(channel); - this.localOpen = Preconditions.checkNotNull(localOpen); - this.remoteOpen = Preconditions.checkNotNull(remoteOpen); - this.lastMessageReceivedAt = System.nanoTime(); - - if (this.maxUnknownMessages != 0) { - this.maxUnknownMessages = maxUnknownMessages; - } - - if (getDeadTimerValue() != 0) { - this.stateTimer.newTimeout(new TimerTask() { - @Override - public void run(final Timeout timeout) throws Exception { - handleDeadTimer(); - } - }, getDeadTimerValue(), TimeUnit.SECONDS); - } - - if (getKeepAliveTimerValue() != 0) { - this.stateTimer.newTimeout(new TimerTask() { - @Override - public void run(final Timeout timeout) throws Exception { - handleKeepaliveTimer(); - } - }, getKeepAliveTimerValue(), TimeUnit.SECONDS); - } - - LOG.debug("Session started."); - } - - /** - * If DeadTimer expires, the session ends. If a message (whichever) was received during this period, the DeadTimer - * will be rescheduled by DEAD_TIMER_VALUE + the time that has passed from the start of the DeadTimer 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), that rescheduling won't occur. - */ - private synchronized void handleDeadTimer() { - final long ct = System.nanoTime(); - - final long nextDead = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(getDeadTimerValue()); - - if (this.channel.isActive()) { - if (ct >= nextDead) { - LOG.debug("DeadTimer expired. " + new Date()); - this.terminate(TerminationReason.ExpDeadtimer); - } else { - this.stateTimer.newTimeout(new TimerTask() { - @Override - public void run(final Timeout timeout) throws Exception { - handleDeadTimer(); - } - }, nextDead - 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() { - final long ct = System.nanoTime(); - - long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue()); - - if (this.channel.isActive()) { - if (ct >= nextKeepalive) { - this.sendMessage(this.kaMessage); - nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue()); - } - - this.stateTimer.newTimeout(new TimerTask() { - @Override - public void run(final Timeout timeout) throws Exception { - handleKeepaliveTimer(); - } - }, nextKeepalive - ct, TimeUnit.NANOSECONDS); - } - } - - /** - * Sends message to serialization. - * - * @param msg to be sent - */ - @Override - public Future sendMessage(final Message msg) { - final ChannelFuture f = this.channel.writeAndFlush(msg); - this.lastMessageSentAt = System.nanoTime(); - if (!(msg instanceof KeepaliveMessage)) { - LOG.debug("Message enqueued: {}", msg); - } - this.sentMsgCount++; - - f.addListener(new ChannelFutureListener() { - @Override - public void operationComplete(final ChannelFuture arg) { - if (arg.isSuccess()) { - LOG.debug("Message sent to socket: {}", msg); - } else { - LOG.debug("Message not sent: {}", msg, arg.cause()); - } - } - }); - - return f; - } - - /** - * Closes PCEP session without sending a Close message, as the channel is no longer active. - */ - @Override - public void close() { - LOG.trace("Closing session: {}", this); - this.channel.close(); - } - - /** - * Closes PCEP session, cancels all timers, returns to state Idle, sends the Close Message. KeepAlive and DeadTimer - * are cancelled if the state of the session changes to IDLE. This method is used to close the PCEP session from - * inside the session or from the listener, therefore the parent of this session should be informed. - */ - @Override - public synchronized void close(final TerminationReason reason) { - LOG.debug("Closing session: {}", this); - this.closed = true; - this.sendMessage(new CloseBuilder().setCCloseMessage( - new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build()); - this.channel.close(); - } - - @Override - public Tlvs getRemoteTlvs() { - return this.remoteOpen.getTlvs(); - } - - @Override - public InetAddress getRemoteAddress() { - return ((InetSocketAddress) this.channel.remoteAddress()).getAddress(); - } - - private synchronized void terminate(final TerminationReason reason) { - this.listener.onSessionTerminated(this, new PCEPCloseTermination(reason)); - this.closed = true; - this.sendMessage(new CloseBuilder().setCCloseMessage( - new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build()); - this.close(); - } - - @Override - public synchronized void endOfInput() { - if (!this.closed) { - this.listener.onSessionDown(this, new IOException("End of input detected. Close the session.")); - this.closed = true; - } - } - - private void sendErrorMessage(final PCEPErrors value) { - this.sendErrorMessage(value, null); - } - - /** - * Sends PCEP Error Message with one PCEPError and Open Object. - * - * @param value - * @param open - */ - private void sendErrorMessage(final PCEPErrors value, final Open open) { - this.sendMessage(Util.createErrorMessage(value, open)); - } - - /** - * The fact, that a message is malformed, comes from parser. In case of unrecognized message a particular error is - * sent (CAPABILITY_NOT_SUPPORTED) and the method checks if the MAX_UNKNOWN_MSG per minute wasn't overstepped. - * Second, any other error occurred that is specified by rfc. In this case, the an error message is generated and - * sent. - * - * @param error documented error in RFC5440 or draft - */ - @VisibleForTesting - public void handleMalformedMessage(final PCEPErrors error) { - final long ct = System.nanoTime(); - this.sendErrorMessage(error); - if (error == PCEPErrors.CAPABILITY_NOT_SUPPORTED) { - this.unknownMessagesTimes.add(ct); - while (ct - this.unknownMessagesTimes.peek() > 60 * 1E9) { - this.unknownMessagesTimes.poll(); - } - if (this.unknownMessagesTimes.size() > this.maxUnknownMessages) { - this.terminate(TerminationReason.TooManyUnknownMsg); - } - } - } - - /** - * Handles incoming message. If the session is up, it notifies the user. The user is notified about every message - * except KeepAlive. - * - * @param msg incoming message - */ - @Override - public void handleMessage(final Message msg) { - // Update last reception time - this.lastMessageReceivedAt = System.nanoTime(); - this.receivedMsgCount++; - - // Internal message handling. The user does not see these messages - if (msg instanceof KeepaliveMessage) { - // Do nothing, the timer has been already reset - LOG.trace("Session {} received a keepalive", this); - } else if (msg instanceof OpenMessage) { - this.sendErrorMessage(PCEPErrors.ATTEMPT_2ND_SESSION); - } else if (msg instanceof CloseMessage) { - /* - * Session is up, we are reporting all messages to user. One notable - * exception is CLOSE message, which needs to be converted into a - * session DOWN event. - */ - this.close(); - } else { - // This message needs to be handled by the user - this.listener.onMessage(this, msg); - } - } - - /** - * @return the sentMsgCount - */ - - @Override - public Integer getSentMsgCount() { - return this.sentMsgCount; - } - - /** - * @return the receivedMsgCount - */ - - @Override - public Integer getReceivedMsgCount() { - return this.receivedMsgCount; - } - - @Override - public Integer getDeadTimerValue() { - return Integer.valueOf(this.remoteOpen.getDeadTimer()); - } - - @Override - public Integer getKeepAliveTimerValue() { - return Integer.valueOf(this.localOpen.getKeepalive()); - } - - @Override - public String getPeerAddress() { - final InetSocketAddress a = (InetSocketAddress) this.channel.remoteAddress(); - return a.getHostName(); - } - - @Override - public void tearDown() { - this.close(); - } - - @Override - public final String toString() { - return addToStringAttributes(Objects.toStringHelper(this)).toString(); - } - - protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) { - toStringHelper.add("localOpen", this.localOpen); - toStringHelper.add("remoteOpen", this.remoteOpen); - return toStringHelper; - } - - @Override - protected void sessionUp() { - this.listener.onSessionUp(this); - } - - @Override - public String getNodeIdentifier() { - if (this.remoteOpen.getTlvs() == null && this.remoteOpen.getTlvs().getPredundancyGroupId() != null) { - return new String(this.remoteOpen.getTlvs().getPredundancyGroupId().getIdentifier(), Charsets.UTF_8); - } - return ""; - } +public class PCEPSessionImpl extends SimpleChannelInboundHandler implements PCEPSession { + private static final long MINUTE = TimeUnit.MINUTES.toNanos(1); + private static Ticker TICKER = Ticker.systemTicker(); + /** + * System.nanoTime value about when was sent the last message Protected to be updated also in tests. + */ + private volatile long lastMessageSentAt; + + /** + * System.nanoTime value about when was received the last message + */ + private long lastMessageReceivedAt; + + private final Queue unknownMessagesTimes = new LinkedList<>(); + + private final PCEPSessionListener listener; + + /** + * Open Object with session characteristics that were accepted by another PCE (sent from this session). + */ + private final Open localOpen; + + /** + * Open Object with session characteristics for this session (sent from another PCE). + */ + private final Open remoteOpen; + + private static final Logger LOG = LoggerFactory.getLogger(PCEPSessionImpl.class); + + private int maxUnknownMessages; + + // True if the listener should not be notified about events + @GuardedBy("this") + private final AtomicBoolean closed = new AtomicBoolean(false); + + private final Channel channel; + + private final Keepalive kaMessage = new KeepaliveBuilder().setKeepaliveMessage(new KeepaliveMessageBuilder().build()).build(); + + private final PCEPSessionState sessionState; + + PCEPSessionImpl(final PCEPSessionListener listener, final int maxUnknownMessages, final Channel channel, + final Open localOpen, final Open remoteOpen) { + this.listener = requireNonNull(listener); + this.channel = requireNonNull(channel); + this.localOpen = requireNonNull(localOpen); + this.remoteOpen = requireNonNull(remoteOpen); + this.lastMessageReceivedAt = TICKER.read(); + + if (maxUnknownMessages != 0) { + this.maxUnknownMessages = maxUnknownMessages; + } + + + if (getDeadTimerValue() != 0) { + channel.eventLoop().schedule(this::handleDeadTimer, getDeadTimerValue(), TimeUnit.SECONDS); + } + + if (getKeepAliveTimerValue() != 0) { + channel.eventLoop().schedule(this::handleKeepaliveTimer, getKeepAliveTimerValue(), TimeUnit.SECONDS); + } + + LOG.info("Session {}[{}] <-> {}[{}] started", channel.localAddress(), localOpen.getSessionId(), channel.remoteAddress(), + remoteOpen.getSessionId()); + this.sessionState = new PCEPSessionState(remoteOpen, localOpen, channel); + } + + public final Integer getKeepAliveTimerValue() { + return this.localOpen.getKeepalive().intValue(); + } + + public final Integer getDeadTimerValue() { + return this.remoteOpen.getDeadTimer().intValue(); + } + + /** + * If DeadTimer expires, the session ends. If a message (whichever) was received during this period, the DeadTimer + * will be rescheduled by DEAD_TIMER_VALUE + the time that has passed from the start of the DeadTimer 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), that rescheduling won't occur. + */ + private synchronized void handleDeadTimer() { + final long ct = TICKER.read(); + + final long nextDead = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(getDeadTimerValue()); + + if (this.channel.isActive()) { + if (ct >= nextDead) { + LOG.debug("DeadTimer expired. {}", new Date()); + this.terminate(TerminationReason.EXP_DEADTIMER); + } else { + this.channel.eventLoop().schedule(this::handleDeadTimer, nextDead - 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 void handleKeepaliveTimer() { + final long ct = TICKER.read(); + + long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue()); + + if (this.channel.isActive()) { + if (ct >= nextKeepalive) { + this.sendMessage(this.kaMessage); + nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue()); + } + + this.channel.eventLoop().schedule(this::handleKeepaliveTimer, nextKeepalive - ct, TimeUnit.NANOSECONDS); + } + } + + /** + * Handle exception occurred in the PCEP session. The session in error state should be closed + * properly so that it can be restored later. + */ + @VisibleForTesting + void handleException(final Throwable cause) { + LOG.error("Exception captured for session {}, closing session.", this, cause); + terminate(TerminationReason.UNKNOWN); + } + + /** + * Sends message to serialization. + * + * @param msg to be sent + */ + @Override + public Future sendMessage(final Message msg) { + final ChannelFuture f = this.channel.writeAndFlush(msg); + this.lastMessageSentAt = TICKER.read(); + this.sessionState.updateLastSentMsg(); + if (!(msg instanceof KeepaliveMessage)) { + LOG.debug("PCEP Message enqueued: {}", msg); + } + if (msg instanceof PcerrMessage) { + this.sessionState.setLastSentError(msg); + } + + f.addListener((ChannelFutureListener) arg -> { + if (arg.isSuccess()) { + LOG.trace("Message sent to socket: {}", msg); + } else { + LOG.debug("Message not sent: {}", msg, arg.cause()); + } + }); + + return f; + } + + @VisibleForTesting + ChannelFuture closeChannel() { + LOG.info("Closing PCEP session channel: {}", this.channel); + return this.channel.close(); + } + + @VisibleForTesting + public synchronized boolean isClosed() { + return this.closed.get(); + } + + /** + * Closes PCEP session without sending a Close message, as the channel is no longer active. + */ + @Override + public synchronized void close() { + close(null); + } + + /** + * Closes PCEP session, cancels all timers, returns to state Idle, sends the Close Message. KeepAlive and DeadTimer + * are cancelled if the state of the session changes to IDLE. This method is used to close the PCEP session from + * inside the session or from the listener, therefore the parent of this session should be informed. + */ + @Override + public void close(final TerminationReason reason) { + if (this.closed.getAndSet(true)) { + LOG.debug("Session is already closed."); + return; + } + // only send close message when the reason is provided + if (reason != null) { + LOG.info("Closing PCEP session with reason {}: {}", reason, this); + sendMessage(new CloseBuilder().setCCloseMessage( + new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build()); + } else { + LOG.info("Closing PCEP session: {}", this); + } + closeChannel(); + } + + @Override + public Tlvs getRemoteTlvs() { + return this.remoteOpen.getTlvs(); + } + + @Override + public InetAddress getRemoteAddress() { + return ((InetSocketAddress) this.channel.remoteAddress()).getAddress(); + } + + private synchronized void terminate(final TerminationReason reason) { + if (this.closed.get()) { + LOG.debug("Session {} is already closed.", this); + return; + } + close(reason); + this.listener.onSessionTerminated(this, new PCEPCloseTermination(reason)); + } + + synchronized void endOfInput() { + if (!this.closed.getAndSet(true)) { + this.listener.onSessionDown(this, new IOException("End of input detected. Close the session.")); + } + } + + private void sendErrorMessage(final PCEPErrors value) { + this.sendErrorMessage(value, null); + } + + /** + * Sends PCEP Error Message with one PCEPError and Open Object. + * + * @param value + * @param open + */ + private void sendErrorMessage(final PCEPErrors value, final Open open) { + this.sendMessage(Util.createErrorMessage(value, open)); + } + + /** + * The fact, that a message is malformed, comes from parser. In case of unrecognized message a particular error is + * sent (CAPABILITY_NOT_SUPPORTED) and the method checks if the MAX_UNKNOWN_MSG per minute wasn't overstepped. + * Second, any other error occurred that is specified by rfc. In this case, the an error message is generated and + * sent. + * + * @param error documented error in RFC5440 or draft + */ + @VisibleForTesting + void handleMalformedMessage(final PCEPErrors error) { + final long ct = TICKER.read(); + this.sendErrorMessage(error); + if (error == PCEPErrors.CAPABILITY_NOT_SUPPORTED) { + this.unknownMessagesTimes.add(ct); + while (ct - this.unknownMessagesTimes.peek() > MINUTE) { + final Long poll = this.unknownMessagesTimes.poll(); + } + if (this.unknownMessagesTimes.size() > this.maxUnknownMessages) { + this.terminate(TerminationReason.TOO_MANY_UNKNOWN_MSGS); + } + } + } + + /** + * Handles incoming message. If the session is up, it notifies the user. The user is notified about every message + * except KeepAlive. + * + * @param msg incoming message + */ + public synchronized void handleMessage(final Message msg) { + if (this.closed.get()) { + LOG.debug("PCEP Session {} is already closed, skip handling incoming message {}", this, msg); + return; + } + // Update last reception time + this.lastMessageReceivedAt = TICKER.read(); + this.sessionState.updateLastReceivedMsg(); + if (!(msg instanceof KeepaliveMessage)) { + LOG.debug("PCEP message {} received.", msg); + } + // Internal message handling. The user does not see these messages + if (msg instanceof KeepaliveMessage) { + // Do nothing, the timer has been already reset + } else if (msg instanceof OpenMessage) { + this.sendErrorMessage(PCEPErrors.ATTEMPT_2ND_SESSION); + } else if (msg instanceof CloseMessage) { + /* + * Session is up, we are reporting all messages to user. One notable + * exception is CLOSE message, which needs to be converted into a + * session DOWN event. + */ + close(); + this.listener.onSessionTerminated(this, new PCEPCloseTermination(TerminationReason + .forValue(((CloseMessage) msg).getCCloseMessage().getCClose().getReason()))); + } else { + // This message needs to be handled by the user + if (msg instanceof PcerrMessage) { + this.sessionState.setLastReceivedError(msg); + } + this.listener.onMessage(this, msg); + } + } + + @Override + public final String toString() { + return addToStringAttributes(MoreObjects.toStringHelper(this)).toString(); + } + + private ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) { + toStringHelper.add("channel", this.channel); + toStringHelper.add("localOpen", this.localOpen); + toStringHelper.add("remoteOpen", this.remoteOpen); + return toStringHelper; + } + + @VisibleForTesting + void sessionUp() { + try { + this.listener.onSessionUp(this); + } catch (final Exception e) { + handleException(e); + throw e; + } + } + + @VisibleForTesting + final Queue getUnknownMessagesTimes() { + return this.unknownMessagesTimes; + } + + @Override + public Messages getMessages() { + return this.sessionState.getMessages(this.unknownMessagesTimes.size()); + } + + @Override + public LocalPref getLocalPref() { + return this.sessionState.getLocalPref(); + } + + @Override + public PeerPref getPeerPref() { + return this.sessionState.getPeerPref(); + } + + @Override + public Open getLocalOpen() { + return this.sessionState.getLocalOpen(); + } + + @Override + public synchronized final void channelInactive(final ChannelHandlerContext ctx) { + LOG.debug("Channel {} inactive.", ctx.channel()); + endOfInput(); + + try { + super.channelInactive(ctx); + } catch (final Exception e) { + throw new IllegalStateException("Failed to delegate channel inactive event on channel " + ctx.channel(), e); + } + } + + @Override + protected synchronized final void channelRead0(final ChannelHandlerContext ctx, final Message msg) { + LOG.debug("Message was received: {}", msg); + handleMessage(msg); + } + + @Override + public synchronized final void handlerAdded(final ChannelHandlerContext ctx) { + this.sessionUp(); + } + + @Override + public synchronized void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) { + handleException(cause); + } + + @Override + public Tlvs getLocalTlvs() { + return this.localOpen.getTlvs(); + } + + @VisibleForTesting + static void setTicker(final Ticker ticker) { + TICKER = ticker; + } }