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 logger = 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 (this.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) throws Exception {
 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) throws Exception {
 130                                         handleKeepaliveTimer();
 131                                 }
 132                         }, getKeepAliveTimerValue(), TimeUnit.SECONDS);
 133                 }
 134
 135                 logger.debug("Session started.");
 136         }
 137
 138         /**
 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.
 143          */
 144         private synchronized void handleDeadTimer() {
 145                 final long ct = System.nanoTime();
 146
 147                 final long nextDead = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(getDeadTimerValue());
 148
 149                 if (this.channel.isActive()) {
 150                         if (ct >= nextDead) {
 151                                 logger.debug("DeadTimer expired. " + new Date());
 152                                 this.terminate(TerminationReason.ExpDeadtimer);
 153                         } else {
 154                                 this.stateTimer.newTimeout(new TimerTask() {
 155                                         @Override
 156                                         public void run(final Timeout timeout) throws Exception {
 157                                                 handleDeadTimer();
 158                                         }
 159                                 }, nextDead - ct, TimeUnit.NANOSECONDS);
 160                         }
 161                 }
 162         }
 163
 164         /**
 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.
 169          */
 170         private synchronized void handleKeepaliveTimer() {
 171                 final long ct = System.nanoTime();
 172
 173                 long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
 174
 175                 if (this.channel.isActive()) {
 176                         if (ct >= nextKeepalive) {
 177                                 this.sendMessage(this.kaMessage);
 178                                 nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
 179                         }
 180
 181                         this.stateTimer.newTimeout(new TimerTask() {
 182                                 @Override
 183                                 public void run(final Timeout timeout) throws Exception {
 184                                         handleKeepaliveTimer();
 185                                 }
 186                         }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
 187                 }
 188         }
 189
 190         /**
 191          * Sends message to serialization.
 192          *
 193          * @param msg to be sent
 194          */
 195         @Override
 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                         logger.debug("Message enqueued: {}", msg);
 201                 }
 202                 this.sentMsgCount++;
 203
 204                 f.addListener(new ChannelFutureListener() {
 205                         @Override
 206                         public void operationComplete(final ChannelFuture arg) {
 207                                 if (arg.isSuccess()) {
 208                                         logger.debug("Message sent to socket: {}", msg);
 209                                 } else {
 210                                         logger.debug("Message not sent: {}", msg, arg.cause());
 211                                 }
 212                         }
 213                 });
 214
 215                 return f;
 216         }
 217
 218         /**
 219          * Closes PCEP session without sending a Close message, as the channel is no longer active.
 220          */
 221         @Override
 222         public void close() {
 223                 logger.trace("Closing session: {}", this);
 224                 this.channel.close();
 225         }
 226
 227         /**
 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.
 231          */
 232         @Override
 233         public synchronized void close(final TerminationReason reason) {
 234                 logger.debug("Closing session: {}", this);
 235                 this.closed = true;
 236                 this.sendMessage(new CloseBuilder().setCCloseMessage(
 237                                 new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
 238                 this.channel.close();
 239         }
 240
 241         @Override
 242         public Tlvs getRemoteTlvs() {
 243                 return this.remoteOpen.getTlvs();
 244         }
 245
 246         @Override
 247         public InetAddress getRemoteAddress() {
 248                 return ((InetSocketAddress) this.channel.remoteAddress()).getAddress();
 249         }
 250
 251         private synchronized void terminate(final TerminationReason reason) {
 252                 this.listener.onSessionTerminated(this, new PCEPCloseTermination(reason));
 253                 this.closed = true;
 254                 this.sendMessage(new CloseBuilder().setCCloseMessage(
 255                                 new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
 256                 this.close();
 257         }
 258
 259         @Override
 260         public synchronized void endOfInput() {
 261                 if (!this.closed) {
 262                         this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
 263                         this.closed = true;
 264                 }
 265         }
 266
 267         private void sendErrorMessage(final PCEPErrors value) {
 268                 this.sendErrorMessage(value, null);
 269         }
 270
 271         /**
 272          * Sends PCEP Error Message with one PCEPError and Open Object.
 273          *
 274          * @param value
 275          * @param open
 276          */
 277         private void sendErrorMessage(final PCEPErrors value, final Open open) {
 278                 this.sendMessage(Util.createErrorMessage(value, open));
 279         }
 280
 281         /**
 282          * The fact, that a message is malformed, comes from parser. In case of unrecognized message a particular error is
 283          * sent (CAPABILITY_NOT_SUPPORTED) and the method checks if the MAX_UNKNOWN_MSG per minute wasn't overstepped.
 284          * Second, any other error occurred that is specified by rfc. In this case, the an error message is generated and
 285          * sent.
 286          *
 287          * @param error documented error in RFC5440 or draft
 288          */
 289         @VisibleForTesting
 290         public void handleMalformedMessage(final PCEPErrors error) {
 291                 final long ct = System.nanoTime();
 292                 this.sendErrorMessage(error);
 293                 if (error == PCEPErrors.CAPABILITY_NOT_SUPPORTED) {
 294                         this.unknownMessagesTimes.add(ct);
 295                         while (ct - this.unknownMessagesTimes.peek() > 60 * 1E9) {
 296                                 this.unknownMessagesTimes.poll();
 297                         }
 298                         if (this.unknownMessagesTimes.size() > this.maxUnknownMessages) {
 299                                 this.terminate(TerminationReason.TooManyUnknownMsg);
 300                         }
 301                 }
 302         }
 303
 304         /**
 305          * Handles incoming message. If the session is up, it notifies the user. The user is notified about every message
 306          * except KeepAlive.
 307          *
 308          * @param msg incoming message
 309          */
 310         @Override
 311         public void handleMessage(final Message msg) {
 312                 // Update last reception time
 313                 this.lastMessageReceivedAt = System.nanoTime();
 314                 this.receivedMsgCount++;
 315
 316                 // Internal message handling. The user does not see these messages
 317                 if (msg instanceof KeepaliveMessage) {
 318                         // Do nothing, the timer has been already reset
 319                 } else if (msg instanceof OpenMessage) {
 320                         this.sendErrorMessage(PCEPErrors.ATTEMPT_2ND_SESSION);
 321                 } else if (msg instanceof CloseMessage) {
 322                         /*
 323                          * Session is up, we are reporting all messages to user. One notable
 324                          * exception is CLOSE message, which needs to be converted into a
 325                          * session DOWN event.
 326                          */
 327                         this.close();
 328                 } else {
 329                         // This message needs to be handled by the user
 330                         this.listener.onMessage(this, msg);
 331                 }
 332         }
 333
 334         /**
 335          * @return the sentMsgCount
 336          */
 337
 338         @Override
 339         public Integer getSentMsgCount() {
 340                 return this.sentMsgCount;
 341         }
 342
 343         /**
 344          * @return the receivedMsgCount
 345          */
 346
 347         @Override
 348         public Integer getReceivedMsgCount() {
 349                 return this.receivedMsgCount;
 350         }
 351
 352         @Override
 353         public Integer getDeadTimerValue() {
 354                 return new Integer(this.remoteOpen.getDeadTimer());
 355         }
 356
 357         @Override
 358         public Integer getKeepAliveTimerValue() {
 359                 return new Integer(this.localOpen.getKeepalive());
 360         }
 361
 362         @Override
 363         public String getPeerAddress() {
 364                 final InetSocketAddress a = (InetSocketAddress) this.channel.remoteAddress();
 365                 return a.getHostName();
 366         }
 367
 368         @Override
 369         public void tearDown() {
 370                 this.close();
 371         }
 372
 373         @Override
 374         public final String toString() {
 375                 return addToStringAttributes(Objects.toStringHelper(this)).toString();
 376         }
 377
 378         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 379                 toStringHelper.add("localOpen", this.localOpen);
 380                 toStringHelper.add("remoteOpen", this.remoteOpen);
 381                 return toStringHelper;
 382         }
 383
 384         @Override
 385         protected void sessionUp() {
 386                 this.listener.onSessionUp(this);
 387         }
 388
 389         @Override
 390         public String getNodeIdentifier() {
 391                 if (this.remoteOpen.getTlvs() == null) {
 392                         if (this.remoteOpen.getTlvs().getPredundancyGroupId() != null) {
 393                                 return new String(this.remoteOpen.getTlvs().getPredundancyGroupId().getIdentifier());
 394                         }
 395                 }
 396                 return "";
 397         }
 398
 399 }