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 com.google.common.annotations.VisibleForTesting;
11 import com.google.common.base.Objects;
12 import com.google.common.base.Objects.ToStringHelper;
13 import com.google.common.base.Preconditions;
15 import io.netty.channel.Channel;
16 import io.netty.channel.ChannelFuture;
17 import io.netty.channel.ChannelFutureListener;
18 import io.netty.util.Timeout;
19 import io.netty.util.Timer;
20 import io.netty.util.TimerTask;
21 import io.netty.util.concurrent.Future;
23 import java.io.IOException;
24 import java.net.InetAddress;
25 import java.net.InetSocketAddress;
26 import java.util.Date;
27 import java.util.LinkedList;
28 import java.util.Queue;
29 import java.util.concurrent.TimeUnit;
31 import org.opendaylight.protocol.framework.AbstractProtocolSession;
32 import org.opendaylight.protocol.pcep.PCEPCloseTermination;
33 import org.opendaylight.protocol.pcep.PCEPSession;
34 import org.opendaylight.protocol.pcep.PCEPSessionListener;
35 import org.opendaylight.protocol.pcep.TerminationReason;
36 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.CloseBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Keepalive;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.KeepaliveBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.CloseMessage;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.KeepaliveMessage;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.OpenMessage;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.close.message.CCloseMessageBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.close.object.CCloseBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.keepalive.message.KeepaliveMessageBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.Open;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.open.Tlvs;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
53 * Implementation of PCEPSession. (Not final for testing.)
56 public class PCEPSessionImpl extends AbstractProtocolSession<Message> implements PCEPSession, PCEPSessionRuntimeMXBean {
58 * 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 final Queue<Long> unknownMessagesTimes = new LinkedList<Long>();
71 private final PCEPSessionListener listener;
74 * Open Object with session characteristics that were accepted by another PCE (sent from this session).
76 private final Open localOpen;
79 * Open Object with session characteristics for this session (sent from another PCE).
81 private final Open remoteOpen;
83 private static final Logger LOG = LoggerFactory.getLogger(PCEPSessionImpl.class);
86 * Timer object grouping FSM Timers
88 private final Timer stateTimer;
90 private int sentMsgCount = 0;
92 private int receivedMsgCount = 0;
94 private int maxUnknownMessages;
96 // True if the listener should not be notified about events
97 private boolean closed = false;
99 private final Channel channel;
101 private final Keepalive kaMessage = new KeepaliveBuilder().setKeepaliveMessage(new KeepaliveMessageBuilder().build()).build();
103 PCEPSessionImpl(final Timer timer, final PCEPSessionListener listener, final int maxUnknownMessages, final Channel channel,
104 final Open localOpen, final Open remoteOpen) {
105 this.listener = Preconditions.checkNotNull(listener);
106 this.stateTimer = Preconditions.checkNotNull(timer);
107 this.channel = Preconditions.checkNotNull(channel);
108 this.localOpen = Preconditions.checkNotNull(localOpen);
109 this.remoteOpen = Preconditions.checkNotNull(remoteOpen);
110 this.lastMessageReceivedAt = System.nanoTime();
112 if (maxUnknownMessages != 0) {
113 this.maxUnknownMessages = maxUnknownMessages;
116 if (getDeadTimerValue() != 0) {
117 this.stateTimer.newTimeout(new TimerTask() {
119 public void run(final Timeout timeout) {
122 }, getDeadTimerValue(), TimeUnit.SECONDS);
125 if (getKeepAliveTimerValue() != 0) {
126 this.stateTimer.newTimeout(new TimerTask() {
128 public void run(final Timeout timeout) {
129 handleKeepaliveTimer();
131 }, getKeepAliveTimerValue(), TimeUnit.SECONDS);
134 LOG.info("Session {}[{}] <-> {}[{}] started", channel.localAddress(), localOpen.getSessionId(), channel.remoteAddress(),
135 remoteOpen.getSessionId());
139 * If DeadTimer expires, the session ends. If a message (whichever) was received during this period, the DeadTimer
140 * will be rescheduled by DEAD_TIMER_VALUE + the time that has passed from the start of the DeadTimer to the time at
141 * which the message was received. If the session was closed by the time this method starts to execute (the session
142 * state will become IDLE), that rescheduling won't occur.
144 private synchronized void handleDeadTimer() {
145 final long ct = System.nanoTime();
147 final long nextDead = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(getDeadTimerValue());
149 if (this.channel.isActive()) {
150 if (ct >= nextDead) {
151 LOG.debug("DeadTimer expired. {}", new Date());
152 this.terminate(TerminationReason.ExpDeadtimer);
154 this.stateTimer.newTimeout(new TimerTask() {
156 public void run(final Timeout timeout) {
159 }, nextDead - ct, TimeUnit.NANOSECONDS);
165 * If KeepAlive Timer expires, sends KeepAlive message. If a message (whichever) was send during this period, the
166 * KeepAlive Timer will be rescheduled by KEEP_ALIVE_TIMER_VALUE + the time that has passed from the start of the
167 * KeepAlive timer to the time at which the message was sent. If the session was closed by the time this method
168 * starts to execute (the session state will become IDLE), that rescheduling won't occur.
170 private synchronized void handleKeepaliveTimer() {
171 final long ct = System.nanoTime();
173 long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
175 if (this.channel.isActive()) {
176 if (ct >= nextKeepalive) {
177 this.sendMessage(this.kaMessage);
178 nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
181 this.stateTimer.newTimeout(new TimerTask() {
183 public void run(final Timeout timeout) {
184 handleKeepaliveTimer();
186 }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
191 * Sends message to serialization.
193 * @param msg to be sent
196 public Future<Void> sendMessage(final Message msg) {
197 final ChannelFuture f = this.channel.writeAndFlush(msg);
198 this.lastMessageSentAt = System.nanoTime();
199 if (!(msg instanceof KeepaliveMessage)) {
200 LOG.debug("PCEP Message enqueued: {}", msg);
204 f.addListener(new ChannelFutureListener() {
206 public void operationComplete(final ChannelFuture arg) {
207 if (arg.isSuccess()) {
208 LOG.trace("Message sent to socket: {}", msg);
210 LOG.debug("Message not sent: {}", msg, arg.cause());
219 * Closes PCEP session without sending a Close message, as the channel is no longer active.
222 public void close() {
223 LOG.info("Closing PCEP session: {}", this);
224 this.channel.close();
228 * Closes PCEP session, cancels all timers, returns to state Idle, sends the Close Message. KeepAlive and DeadTimer
229 * are cancelled if the state of the session changes to IDLE. This method is used to close the PCEP session from
230 * inside the session or from the listener, therefore the parent of this session should be informed.
233 public synchronized void close(final TerminationReason reason) {
234 LOG.info("Closing PCEP session: {}", this);
236 this.sendMessage(new CloseBuilder().setCCloseMessage(
237 new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
238 this.channel.close();
242 public Tlvs getRemoteTlvs() {
243 return this.remoteOpen.getTlvs();
247 public InetAddress getRemoteAddress() {
248 return ((InetSocketAddress) this.channel.remoteAddress()).getAddress();
251 private synchronized void terminate(final TerminationReason reason) {
252 LOG.info("Local PCEP session termination : {}", reason);
253 this.listener.onSessionTerminated(this, new PCEPCloseTermination(reason));
255 this.sendMessage(new CloseBuilder().setCCloseMessage(
256 new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
261 public synchronized void endOfInput() {
263 this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
268 private void sendErrorMessage(final PCEPErrors value) {
269 this.sendErrorMessage(value, null);
273 * Sends PCEP Error Message with one PCEPError and Open Object.
278 private void sendErrorMessage(final PCEPErrors value, final Open open) {
279 this.sendMessage(Util.createErrorMessage(value, open));
283 * The fact, that a message is malformed, comes from parser. In case of unrecognized message a particular error is
284 * sent (CAPABILITY_NOT_SUPPORTED) and the method checks if the MAX_UNKNOWN_MSG per minute wasn't overstepped.
285 * Second, any other error occurred that is specified by rfc. In this case, the an error message is generated and
288 * @param error documented error in RFC5440 or draft
291 public void handleMalformedMessage(final PCEPErrors error) {
292 final long ct = System.nanoTime();
293 this.sendErrorMessage(error);
294 if (error == PCEPErrors.CAPABILITY_NOT_SUPPORTED) {
295 this.unknownMessagesTimes.add(ct);
296 while (ct - this.unknownMessagesTimes.peek() > 60 * 1E9) {
297 this.unknownMessagesTimes.poll();
299 if (this.unknownMessagesTimes.size() > this.maxUnknownMessages) {
300 this.terminate(TerminationReason.TooManyUnknownMsg);
306 * Handles incoming message. If the session is up, it notifies the user. The user is notified about every message
309 * @param msg incoming message
312 public void handleMessage(final Message msg) {
313 // Update last reception time
314 this.lastMessageReceivedAt = System.nanoTime();
315 this.receivedMsgCount++;
316 if (!(msg instanceof KeepaliveMessage)) {
317 LOG.debug("PCEP message {} received.", msg);
319 // Internal message handling. The user does not see these messages
320 if (msg instanceof KeepaliveMessage) {
321 // Do nothing, the timer has been already reset
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() {