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.pcep.impl;
10 import io.netty.channel.Channel;
11 import io.netty.channel.ChannelFuture;
12 import io.netty.channel.ChannelFutureListener;
13 import io.netty.util.Timeout;
14 import io.netty.util.Timer;
15 import io.netty.util.TimerTask;
16 import io.netty.util.concurrent.Future;
18 import java.io.IOException;
19 import java.net.InetAddress;
20 import java.net.InetSocketAddress;
21 import java.util.Date;
22 import java.util.LinkedList;
23 import java.util.Queue;
24 import java.util.concurrent.TimeUnit;
26 import org.opendaylight.protocol.framework.AbstractProtocolSession;
27 import org.opendaylight.protocol.pcep.PCEPCloseTermination;
28 import org.opendaylight.protocol.pcep.PCEPSession;
29 import org.opendaylight.protocol.pcep.PCEPSessionListener;
30 import org.opendaylight.protocol.pcep.TerminationReason;
31 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.CloseBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Keepalive;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.KeepaliveBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.CloseMessage;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.KeepaliveMessage;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.OpenMessage;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.close.message.CCloseMessageBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.close.object.CCloseBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.keepalive.message.KeepaliveMessageBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.Open;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.open.Tlvs;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
47 import com.google.common.annotations.VisibleForTesting;
48 import com.google.common.base.Charsets;
49 import com.google.common.base.Objects;
50 import com.google.common.base.Objects.ToStringHelper;
51 import com.google.common.base.Preconditions;
54 * Implementation of PCEPSession. (Not final for testing.)
57 public class PCEPSessionImpl extends AbstractProtocolSession<Message> implements PCEPSession, PCEPSessionRuntimeMXBean {
59 * System.nanoTime value about when was sent the last message Protected to be updated also in tests.
61 protected volatile long lastMessageSentAt;
64 * System.nanoTime value about when was received the last message
66 private long lastMessageReceivedAt;
69 * Protected for testing.
71 protected int maxUnknownMessages;
73 protected final Queue<Long> unknownMessagesTimes = new LinkedList<Long>();
75 private final PCEPSessionListener listener;
78 * Open Object with session characteristics that were accepted by another PCE (sent from this session).
80 private final Open localOpen;
83 * Open Object with session characteristics for this session (sent from another PCE).
85 private final Open remoteOpen;
87 private static final Logger LOG = LoggerFactory.getLogger(PCEPSessionImpl.class);
90 * Timer object grouping FSM Timers
92 private final Timer stateTimer;
94 private int sentMsgCount = 0;
96 private int receivedMsgCount = 0;
98 // True if the listener should not be notified about events
99 private boolean closed = false;
101 private final Channel channel;
103 private final Keepalive kaMessage = new KeepaliveBuilder().setKeepaliveMessage(new KeepaliveMessageBuilder().build()).build();
105 PCEPSessionImpl(final Timer timer, final PCEPSessionListener listener, final int maxUnknownMessages, final Channel channel,
106 final Open localOpen, final Open remoteOpen) {
107 this.listener = Preconditions.checkNotNull(listener);
108 this.stateTimer = Preconditions.checkNotNull(timer);
109 this.channel = Preconditions.checkNotNull(channel);
110 this.localOpen = Preconditions.checkNotNull(localOpen);
111 this.remoteOpen = Preconditions.checkNotNull(remoteOpen);
112 this.lastMessageReceivedAt = System.nanoTime();
114 if (maxUnknownMessages != 0) {
115 this.maxUnknownMessages = maxUnknownMessages;
118 if (getDeadTimerValue() != 0) {
119 this.stateTimer.newTimeout(new TimerTask() {
121 public void run(final Timeout timeout) throws Exception {
124 }, getDeadTimerValue(), TimeUnit.SECONDS);
127 if (getKeepAliveTimerValue() != 0) {
128 this.stateTimer.newTimeout(new TimerTask() {
130 public void run(final Timeout timeout) throws Exception {
131 handleKeepaliveTimer();
133 }, getKeepAliveTimerValue(), TimeUnit.SECONDS);
136 LOG.info("Session {}[{}] <-> {}[{}] started", channel.localAddress(), localOpen.getSessionId(), channel.remoteAddress(), remoteOpen.getSessionId());
140 * If DeadTimer expires, the session ends. If a message (whichever) was received during this period, the DeadTimer
141 * will be rescheduled by DEAD_TIMER_VALUE + the time that has passed from the start of the DeadTimer to the time at
142 * which the message was received. If the session was closed by the time this method starts to execute (the session
143 * state will become IDLE), that rescheduling won't occur.
145 private synchronized void handleDeadTimer() {
146 final long ct = System.nanoTime();
148 final long nextDead = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(getDeadTimerValue());
150 if (this.channel.isActive()) {
151 if (ct >= nextDead) {
152 LOG.debug("DeadTimer expired. " + new Date());
153 this.terminate(TerminationReason.ExpDeadtimer);
155 this.stateTimer.newTimeout(new TimerTask() {
157 public void run(final Timeout timeout) throws Exception {
160 }, nextDead - ct, TimeUnit.NANOSECONDS);
166 * If KeepAlive Timer expires, sends KeepAlive message. If a message (whichever) was send during this period, the
167 * KeepAlive Timer will be rescheduled by KEEP_ALIVE_TIMER_VALUE + the time that has passed from the start of the
168 * KeepAlive timer to the time at which the message was sent. If the session was closed by the time this method
169 * starts to execute (the session state will become IDLE), that rescheduling won't occur.
171 private synchronized void handleKeepaliveTimer() {
172 final long ct = System.nanoTime();
174 long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
176 if (this.channel.isActive()) {
177 if (ct >= nextKeepalive) {
178 this.sendMessage(this.kaMessage);
179 nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
182 this.stateTimer.newTimeout(new TimerTask() {
184 public void run(final Timeout timeout) throws Exception {
185 handleKeepaliveTimer();
187 }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
192 * Sends message to serialization.
194 * @param msg to be sent
197 public Future<Void> sendMessage(final Message msg) {
198 final ChannelFuture f = this.channel.writeAndFlush(msg);
199 this.lastMessageSentAt = System.nanoTime();
200 if (!(msg instanceof KeepaliveMessage)) {
201 LOG.debug("Message enqueued: {}", msg);
205 f.addListener(new ChannelFutureListener() {
207 public void operationComplete(final ChannelFuture arg) {
208 if (arg.isSuccess()) {
209 LOG.debug("Message sent to socket: {}", msg);
211 LOG.debug("Message not sent: {}", msg, arg.cause());
220 * Closes PCEP session without sending a Close message, as the channel is no longer active.
223 public void close() {
224 LOG.trace("Closing session: {}", this);
225 this.channel.close();
229 * Closes PCEP session, cancels all timers, returns to state Idle, sends the Close Message. KeepAlive and DeadTimer
230 * are cancelled if the state of the session changes to IDLE. This method is used to close the PCEP session from
231 * inside the session or from the listener, therefore the parent of this session should be informed.
234 public synchronized void close(final TerminationReason reason) {
235 LOG.debug("Closing session: {}", this);
237 this.sendMessage(new CloseBuilder().setCCloseMessage(
238 new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
239 this.channel.close();
243 public Tlvs getRemoteTlvs() {
244 return this.remoteOpen.getTlvs();
248 public InetAddress getRemoteAddress() {
249 return ((InetSocketAddress) this.channel.remoteAddress()).getAddress();
252 private synchronized void terminate(final TerminationReason reason) {
253 LOG.info("Local session termination : {}", reason);
254 this.listener.onSessionTerminated(this, new PCEPCloseTermination(reason));
256 this.sendMessage(new CloseBuilder().setCCloseMessage(
257 new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
262 public synchronized void endOfInput() {
264 this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
269 private void sendErrorMessage(final PCEPErrors value) {
270 this.sendErrorMessage(value, null);
274 * Sends PCEP Error Message with one PCEPError and Open Object.
279 private void sendErrorMessage(final PCEPErrors value, final Open open) {
280 this.sendMessage(Util.createErrorMessage(value, open));
284 * The fact, that a message is malformed, comes from parser. In case of unrecognized message a particular error is
285 * sent (CAPABILITY_NOT_SUPPORTED) and the method checks if the MAX_UNKNOWN_MSG per minute wasn't overstepped.
286 * Second, any other error occurred that is specified by rfc. In this case, the an error message is generated and
289 * @param error documented error in RFC5440 or draft
292 public void handleMalformedMessage(final PCEPErrors error) {
293 final long ct = System.nanoTime();
294 this.sendErrorMessage(error);
295 if (error == PCEPErrors.CAPABILITY_NOT_SUPPORTED) {
296 this.unknownMessagesTimes.add(ct);
297 while (ct - this.unknownMessagesTimes.peek() > 60 * 1E9) {
298 this.unknownMessagesTimes.poll();
300 if (this.unknownMessagesTimes.size() > this.maxUnknownMessages) {
301 this.terminate(TerminationReason.TooManyUnknownMsg);
307 * Handles incoming message. If the session is up, it notifies the user. The user is notified about every message
310 * @param msg incoming message
313 public void handleMessage(final Message msg) {
314 // Update last reception time
315 this.lastMessageReceivedAt = System.nanoTime();
316 this.receivedMsgCount++;
318 // Internal message handling. The user does not see these messages
319 if (msg instanceof KeepaliveMessage) {
320 // Do nothing, the timer has been already reset
321 LOG.trace("Session {} received a keepalive", this);
322 } else if (msg instanceof OpenMessage) {
323 this.sendErrorMessage(PCEPErrors.ATTEMPT_2ND_SESSION);
324 } else if (msg instanceof CloseMessage) {
326 * Session is up, we are reporting all messages to user. One notable
327 * exception is CLOSE message, which needs to be converted into a
328 * session DOWN event.
332 // This message needs to be handled by the user
333 this.listener.onMessage(this, msg);
338 * @return the sentMsgCount
342 public final Integer getSentMsgCount() {
343 return this.sentMsgCount;
347 * @return the receivedMsgCount
351 public final Integer getReceivedMsgCount() {
352 return this.receivedMsgCount;
356 public final Integer getDeadTimerValue() {
357 return Integer.valueOf(this.remoteOpen.getDeadTimer());
361 public final Integer getKeepAliveTimerValue() {
362 return Integer.valueOf(this.localOpen.getKeepalive());
366 public final String getPeerAddress() {
367 final InetSocketAddress a = (InetSocketAddress) this.channel.remoteAddress();
368 return a.getHostName();
372 public void tearDown() {
377 public final String toString() {
378 return addToStringAttributes(Objects.toStringHelper(this)).toString();
381 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
382 toStringHelper.add("channel", this.channel);
383 toStringHelper.add("localOpen", this.localOpen);
384 toStringHelper.add("remoteOpen", this.remoteOpen);
385 return toStringHelper;
390 public void sessionUp() {
391 this.listener.onSessionUp(this);
395 public String getNodeIdentifier() {
396 if (this.remoteOpen.getTlvs() == null && this.remoteOpen.getTlvs().getPredundancyGroupId() != null) {
397 return new String(this.remoteOpen.getTlvs().getPredundancyGroupId().getIdentifier(), Charsets.UTF_8);