pcep/impl/src/main/java/org/opendaylight/protocol/pcep/impl/PCEPSessionImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.protocol.pcep.impl;
   9
  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;
  17
  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;
  25
  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;
  46
  47 import com.google.common.annotations.VisibleForTesting;
  48 import com.google.common.base.Objects;
  49 import com.google.common.base.Objects.ToStringHelper;
  50 import com.google.common.base.Preconditions;
  51
  52 /**
  53  * Implementation of PCEPSession. (Not final for testing.)
  54  */
  55 @VisibleForTesting
  56 public class PCEPSessionImpl extends AbstractProtocolSession<Message> implements PCEPSession, PCEPSessionRuntimeMXBean {
  57         /**
  58          * System.nanoTime value about when was sent the last message Protected to be updated also in tests.
  59          */
  60         protected volatile long lastMessageSentAt;
  61
  62         /**
  63          * System.nanoTime value about when was received the last message
  64          */
  65         private long lastMessageReceivedAt;
  66
  67         /**
  68          * Protected for testing.
  69          */
  70         protected int maxUnknownMessages;
  71
  72         protected final Queue<Long> unknownMessagesTimes = new LinkedList<Long>();
  73
  74         private final PCEPSessionListener listener;
  75
  76         /**
  77          * Open Object with session characteristics that were accepted by another PCE (sent from this session).
  78          */
  79         private final Open localOpen;
  80
  81         /**
  82          * Open Object with session characteristics for this session (sent from another PCE).
  83          */
  84         private final Open remoteOpen;
  85
  86         private static final Logger LOG = LoggerFactory.getLogger(PCEPSessionImpl.class);
  87
  88         /**
  89          * Timer object grouping FSM Timers
  90          */
  91         private final Timer stateTimer;
  92
  93         private int sentMsgCount = 0;
  94
  95         private int receivedMsgCount = 0;
  96
  97         // True if the listener should not be notified about events
  98         private boolean closed = false;
  99
 100         private final Channel channel;
 101
 102         private final Keepalive kaMessage = new KeepaliveBuilder().setKeepaliveMessage(new KeepaliveMessageBuilder().build()).build();
 103
 104         PCEPSessionImpl(final Timer timer, final PCEPSessionListener listener, final int maxUnknownMessages, final Channel channel,
 105                         final Open localOpen, final Open remoteOpen) {
 106                 this.listener = Preconditions.checkNotNull(listener);
 107                 this.stateTimer = Preconditions.checkNotNull(timer);
 108                 this.channel = Preconditions.checkNotNull(channel);
 109                 this.localOpen = Preconditions.checkNotNull(localOpen);
 110                 this.remoteOpen = Preconditions.checkNotNull(remoteOpen);
 111                 this.lastMessageReceivedAt = System.nanoTime();
 112
 113                 if (maxUnknownMessages != 0) {
 114                         this.maxUnknownMessages = maxUnknownMessages;
 115                 }
 116
 117                 if (getDeadTimerValue() != 0) {
 118                         this.stateTimer.newTimeout(new TimerTask() {
 119                                 @Override
 120                                 public void run(final Timeout timeout) {
 121                                         handleDeadTimer();
 122                                 }
 123                         }, getDeadTimerValue(), TimeUnit.SECONDS);
 124                 }
 125
 126                 if (getKeepAliveTimerValue() != 0) {
 127                         this.stateTimer.newTimeout(new TimerTask() {
 128                                 @Override
 129                                 public void run(final Timeout timeout) {
 130                                         handleKeepaliveTimer();
 131                                 }
 132                         }, getKeepAliveTimerValue(), TimeUnit.SECONDS);
 133                 }
 134
 135                 LOG.info("Session {}[{}] <-> {}[{}] started", channel.localAddress(), localOpen.getSessionId(), channel.remoteAddress(),
 136                                 remoteOpen.getSessionId());
 137         }
 138
 139         /**
 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.
 144          */
 145         private synchronized void handleDeadTimer() {
 146                 final long ct = System.nanoTime();
 147
 148                 final long nextDead = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(getDeadTimerValue());
 149
 150                 if (this.channel.isActive()) {
 151                         if (ct >= nextDead) {
 152                                 LOG.debug("DeadTimer expired. " + new Date());
 153                                 this.terminate(TerminationReason.ExpDeadtimer);
 154                         } else {
 155                                 this.stateTimer.newTimeout(new TimerTask() {
 156                                         @Override
 157                                         public void run(final Timeout timeout) {
 158                                                 handleDeadTimer();
 159                                         }
 160                                 }, nextDead - ct, TimeUnit.NANOSECONDS);
 161                         }
 162                 }
 163         }
 164
 165         /**
 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.
 170          */
 171         private synchronized void handleKeepaliveTimer() {
 172                 final long ct = System.nanoTime();
 173
 174                 long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
 175
 176                 if (this.channel.isActive()) {
 177                         if (ct >= nextKeepalive) {
 178                                 this.sendMessage(this.kaMessage);
 179                                 nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
 180                         }
 181
 182                         this.stateTimer.newTimeout(new TimerTask() {
 183                                 @Override
 184                                 public void run(final Timeout timeout) {
 185                                         handleKeepaliveTimer();
 186                                 }
 187                         }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
 188                 }
 189         }
 190
 191         /**
 192          * Sends message to serialization.
 193          *
 194          * @param msg to be sent
 195          */
 196         @Override
 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);
 202                 }
 203                 this.sentMsgCount++;
 204
 205                 f.addListener(new ChannelFutureListener() {
 206                         @Override
 207                         public void operationComplete(final ChannelFuture arg) {
 208                                 if (arg.isSuccess()) {
 209                                         LOG.debug("Message sent to socket: {}", msg);
 210                                 } else {
 211                                         LOG.debug("Message not sent: {}", msg, arg.cause());
 212                                 }
 213                         }
 214                 });
 215
 216                 return f;
 217         }
 218
 219         /**
 220          * Closes PCEP session without sending a Close message, as the channel is no longer active.
 221          */
 222         @Override
 223         public void close() {
 224                 LOG.trace("Closing session: {}", this);
 225                 this.channel.close();
 226         }
 227
 228         /**
 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.
 232          */
 233         @Override
 234         public synchronized void close(final TerminationReason reason) {
 235                 LOG.debug("Closing session: {}", this);
 236                 this.closed = true;
 237                 this.sendMessage(new CloseBuilder().setCCloseMessage(
 238                                 new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
 239                 this.channel.close();
 240         }
 241
 242         @Override
 243         public Tlvs getRemoteTlvs() {
 244                 return this.remoteOpen.getTlvs();
 245         }
 246
 247         @Override
 248         public InetAddress getRemoteAddress() {
 249                 return ((InetSocketAddress) this.channel.remoteAddress()).getAddress();
 250         }
 251
 252         private synchronized void terminate(final TerminationReason reason) {
 253                 LOG.info("Local session termination : {}", reason);
 254                 this.listener.onSessionTerminated(this, new PCEPCloseTermination(reason));
 255                 this.closed = true;
 256                 this.sendMessage(new CloseBuilder().setCCloseMessage(
 257                                 new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
 258                 this.close();
 259         }
 260
 261         @Override
 262         public synchronized void endOfInput() {
 263                 if (!this.closed) {
 264                         this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
 265                         this.closed = true;
 266                 }
 267         }
 268
 269         private void sendErrorMessage(final PCEPErrors value) {
 270                 this.sendErrorMessage(value, null);
 271         }
 272
 273         /**
 274          * Sends PCEP Error Message with one PCEPError and Open Object.
 275          *
 276          * @param value
 277          * @param open
 278          */
 279         private void sendErrorMessage(final PCEPErrors value, final Open open) {
 280                 this.sendMessage(Util.createErrorMessage(value, open));
 281         }
 282
 283         /**
 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
 287          * sent.
 288          *
 289          * @param error documented error in RFC5440 or draft
 290          */
 291         @VisibleForTesting
 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();
 299                         }
 300                         if (this.unknownMessagesTimes.size() > this.maxUnknownMessages) {
 301                                 this.terminate(TerminationReason.TooManyUnknownMsg);
 302                         }
 303                 }
 304         }
 305
 306         /**
 307          * Handles incoming message. If the session is up, it notifies the user. The user is notified about every message
 308          * except KeepAlive.
 309          *
 310          * @param msg incoming message
 311          */
 312         @Override
 313         public void handleMessage(final Message msg) {
 314                 // Update last reception time
 315                 this.lastMessageReceivedAt = System.nanoTime();
 316                 this.receivedMsgCount++;
 317
 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) {
 325                         /*
 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.
 329                          */
 330                         this.close();
 331                 } else {
 332                         // This message needs to be handled by the user
 333                         this.listener.onMessage(this, msg);
 334                 }
 335         }
 336
 337         /**
 338          * @return the sentMsgCount
 339          */
 340
 341         @Override
 342         public final Integer getSentMsgCount() {
 343                 return this.sentMsgCount;
 344         }
 345
 346         /**
 347          * @return the receivedMsgCount
 348          */
 349
 350         @Override
 351         public final Integer getReceivedMsgCount() {
 352                 return this.receivedMsgCount;
 353         }
 354
 355         @Override
 356         public final Integer getDeadTimerValue() {
 357                 return Integer.valueOf(this.remoteOpen.getDeadTimer());
 358         }
 359
 360         @Override
 361         public final Integer getKeepAliveTimerValue() {
 362                 return Integer.valueOf(this.localOpen.getKeepalive());
 363         }
 364
 365         @Override
 366         public final String getPeerAddress() {
 367                 final InetSocketAddress a = (InetSocketAddress) this.channel.remoteAddress();
 368                 return a.getHostName();
 369         }
 370
 371         @Override
 372         public void tearDown() {
 373                 this.close();
 374         }
 375
 376         @Override
 377         public final String toString() {
 378                 return addToStringAttributes(Objects.toStringHelper(this)).toString();
 379         }
 380
 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;
 386         }
 387
 388         @Override
 389         @VisibleForTesting
 390         public void sessionUp() {
 391                 this.listener.onSessionUp(this);
 392         }
 393
 394         @Override
 395         public String getNodeIdentifier() {
 396                 return "";
 397         }
 398 }