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 static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import com.google.common.base.Ticker;
  16 import io.netty.channel.Channel;
  17 import io.netty.channel.ChannelFuture;
  18 import io.netty.channel.ChannelFutureListener;
  19 import io.netty.channel.ChannelHandlerContext;
  20 import io.netty.channel.SimpleChannelInboundHandler;
  21 import io.netty.util.concurrent.Future;
  22 import java.io.IOException;
  23 import java.net.InetAddress;
  24 import java.net.InetSocketAddress;
  25 import java.util.Date;
  26 import java.util.LinkedList;
  27 import java.util.Queue;
  28 import java.util.concurrent.TimeUnit;
  29 import javax.annotation.concurrent.GuardedBy;
  30 import org.opendaylight.protocol.pcep.PCEPCloseTermination;
  31 import org.opendaylight.protocol.pcep.PCEPSession;
  32 import org.opendaylight.protocol.pcep.PCEPSessionListener;
  33 import org.opendaylight.protocol.pcep.TerminationReason;
  34 import org.opendaylight.protocol.pcep.impl.spi.Util;
  35 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.stats.rev141006.pcep.session.state.LocalPref;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.stats.rev141006.pcep.session.state.Messages;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.stats.rev141006.pcep.session.state.PeerPref;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.CloseBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Keepalive;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.KeepaliveBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.CloseMessage;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.KeepaliveMessage;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.OpenMessage;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.PcerrMessage;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.close.message.CCloseMessageBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.close.object.CCloseBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.keepalive.message.KeepaliveMessageBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.Open;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.open.Tlvs;
  52 import org.opendaylight.yangtools.yang.binding.DataContainer;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 /**
  57  * Implementation of PCEPSession. (Not final for testing.)
  58  */
  59 @VisibleForTesting
  60 public class PCEPSessionImpl extends SimpleChannelInboundHandler<Message> implements PCEPSession {
  61     private static final long MINUTE = TimeUnit.MINUTES.toNanos(1);
  62     private static Ticker TICKER = Ticker.systemTicker();
  63     /**
  64      * System.nanoTime value about when was sent the last message Protected to be updated also in tests.
  65      */
  66     @VisibleForTesting
  67     protected volatile long lastMessageSentAt;
  68
  69     /**
  70      * System.nanoTime value about when was received the last message
  71      */
  72     private long lastMessageReceivedAt;
  73
  74     private final Queue<Long> unknownMessagesTimes = new LinkedList<>();
  75
  76     private final PCEPSessionListener listener;
  77
  78     /**
  79      * Open Object with session characteristics that were accepted by another PCE (sent from this session).
  80      */
  81     private final Open localOpen;
  82
  83     /**
  84      * Open Object with session characteristics for this session (sent from another PCE).
  85      */
  86     private final Open remoteOpen;
  87
  88     private static final Logger LOG = LoggerFactory.getLogger(PCEPSessionImpl.class);
  89
  90     private int maxUnknownMessages;
  91
  92     // True if the listener should not be notified about events
  93     @GuardedBy("this")
  94     private boolean closed = false;
  95
  96     private final Channel channel;
  97
  98     private final Keepalive kaMessage = new KeepaliveBuilder().setKeepaliveMessage(new KeepaliveMessageBuilder().build()).build();
  99
 100     private final PCEPSessionState sessionState;
 101
 102     PCEPSessionImpl(final PCEPSessionListener listener, final int maxUnknownMessages, final Channel channel,
 103         final Open localOpen, final Open remoteOpen) {
 104         this.listener = requireNonNull(listener);
 105         this.channel = requireNonNull(channel);
 106         this.localOpen = requireNonNull(localOpen);
 107         this.remoteOpen = requireNonNull(remoteOpen);
 108         this.lastMessageReceivedAt = TICKER.read();
 109
 110         if (maxUnknownMessages != 0) {
 111             this.maxUnknownMessages = maxUnknownMessages;
 112         }
 113
 114
 115         if (getDeadTimerValue() != 0) {
 116             channel.eventLoop().schedule(this::handleDeadTimer, getDeadTimerValue(), TimeUnit.SECONDS);
 117         }
 118
 119         if (getKeepAliveTimerValue() != 0) {
 120             channel.eventLoop().schedule(this::handleKeepaliveTimer, getKeepAliveTimerValue(), TimeUnit.SECONDS);
 121         }
 122
 123         LOG.info("Session {}[{}] <-> {}[{}] started", channel.localAddress(), localOpen.getSessionId(), channel.remoteAddress(),
 124             remoteOpen.getSessionId());
 125         this.sessionState = new PCEPSessionState(remoteOpen, localOpen, channel);
 126     }
 127
 128     public final Integer getKeepAliveTimerValue() {
 129         return this.localOpen.getKeepalive().intValue();
 130     }
 131
 132     public final Integer getDeadTimerValue() {
 133         return this.remoteOpen.getDeadTimer().intValue();
 134     }
 135
 136     /**
 137      * If DeadTimer expires, the session ends. If a message (whichever) was received during this period, the DeadTimer
 138      * will be rescheduled by DEAD_TIMER_VALUE + the time that has passed from the start of the DeadTimer to the time at
 139      * which the message was received. If the session was closed by the time this method starts to execute (the session
 140      * state will become IDLE), that rescheduling won't occur.
 141      */
 142     private synchronized void handleDeadTimer() {
 143         final long ct = TICKER.read();
 144
 145         final long nextDead = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(getDeadTimerValue());
 146
 147         if (this.channel.isActive()) {
 148             if (ct >= nextDead) {
 149                 LOG.debug("DeadTimer expired. {}", new Date());
 150                 this.terminate(TerminationReason.EXP_DEADTIMER);
 151             } else {
 152                 this.channel.eventLoop().schedule(this::handleDeadTimer, nextDead - ct, TimeUnit.NANOSECONDS);
 153             }
 154         }
 155     }
 156
 157     /**
 158      * If KeepAlive Timer expires, sends KeepAlive message. If a message (whichever) was send during this period, the
 159      * KeepAlive Timer will be rescheduled by KEEP_ALIVE_TIMER_VALUE + the time that has passed from the start of the
 160      * KeepAlive timer to the time at which the message was sent. If the session was closed by the time this method
 161      * starts to execute (the session state will become IDLE), that rescheduling won't occur.
 162      */
 163     private  void handleKeepaliveTimer() {
 164         final long ct = TICKER.read();
 165
 166         long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
 167
 168         if (this.channel.isActive()) {
 169             if (ct >= nextKeepalive) {
 170                 this.sendMessage(this.kaMessage);
 171                 nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(getKeepAliveTimerValue());
 172             }
 173
 174             this.channel.eventLoop().schedule(this::handleKeepaliveTimer, nextKeepalive - ct, TimeUnit.NANOSECONDS);
 175         }
 176     }
 177
 178     /**
 179      * Handle exception occurred in the PCEP session. The session in error state should be closed
 180      * properly so that it can be restored later.
 181      */
 182     @VisibleForTesting
 183     void handleException(final Throwable cause) {
 184         LOG.error("Exception captured for session {}, closing session.", this, cause);
 185         terminate(TerminationReason.UNKNOWN);
 186     }
 187
 188     /**
 189      * Sends message to serialization.
 190      *
 191      * @param msg to be sent
 192      */
 193     @Override
 194     public Future<Void> sendMessage(final Message msg) {
 195         final ChannelFuture f = this.channel.writeAndFlush(msg);
 196         this.lastMessageSentAt = TICKER.read();
 197         this.sessionState.updateLastSentMsg();
 198         if (!(msg instanceof KeepaliveMessage)) {
 199             LOG.debug("PCEP Message enqueued: {}", msg);
 200         }
 201         if (msg instanceof PcerrMessage) {
 202             this.sessionState.setLastSentError(msg);
 203         }
 204
 205         f.addListener((ChannelFutureListener) arg -> {
 206             if (arg.isSuccess()) {
 207                 LOG.trace("Message sent to socket: {}", msg);
 208             } else {
 209                 LOG.debug("Message not sent: {}", msg, arg.cause());
 210             }
 211         });
 212
 213         return f;
 214     }
 215
 216     @VisibleForTesting
 217     ChannelFuture closeChannel() {
 218         LOG.info("Closing PCEP session channel: {}", this.channel);
 219         return this.channel.close();
 220     }
 221
 222     @VisibleForTesting
 223     public synchronized boolean isClosed() {
 224         return this.closed;
 225     }
 226
 227     /**
 228      * Closes PCEP session without sending a Close message, as the channel is no longer active.
 229      */
 230     @Override
 231     public synchronized void close() {
 232         close(null);
 233     }
 234
 235     /**
 236      * Closes PCEP session, cancels all timers, returns to state Idle, sends the Close Message. KeepAlive and DeadTimer
 237      * are cancelled if the state of the session changes to IDLE. This method is used to close the PCEP session from
 238      * inside the session or from the listener, therefore the parent of this session should be informed.
 239      */
 240     @Override
 241     public synchronized void close(final TerminationReason reason) {
 242         if (this.closed) {
 243             LOG.debug("Session is already closed.");
 244             return;
 245         }
 246         this.closed = true;
 247         // only send close message when the reason is provided
 248         if (reason != null) {
 249             LOG.info("Closing PCEP session with reason {}: {}", reason, this);
 250             sendMessage(new CloseBuilder().setCCloseMessage(
 251                     new CCloseMessageBuilder().setCClose(new CCloseBuilder().setReason(reason.getShortValue()).build()).build()).build());
 252         } else {
 253             LOG.info("Closing PCEP session: {}", this);
 254         }
 255         closeChannel();
 256     }
 257
 258     @Override
 259     public Tlvs getRemoteTlvs() {
 260         return this.remoteOpen.getTlvs();
 261     }
 262
 263     @Override
 264     public InetAddress getRemoteAddress() {
 265         return ((InetSocketAddress) this.channel.remoteAddress()).getAddress();
 266     }
 267
 268     private synchronized void terminate(final TerminationReason reason) {
 269         if (this.closed) {
 270             LOG.debug("Session {} is already closed.", this);
 271             return;
 272         }
 273         close(reason);
 274         this.listener.onSessionTerminated(this, new PCEPCloseTermination(reason));
 275     }
 276
 277     public synchronized void endOfInput() {
 278         if (!this.closed) {
 279             this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
 280             this.closed = true;
 281         }
 282     }
 283
 284     private void sendErrorMessage(final PCEPErrors value) {
 285         this.sendErrorMessage(value, null);
 286     }
 287
 288     /**
 289      * Sends PCEP Error Message with one PCEPError and Open Object.
 290      *
 291      * @param value
 292      * @param open
 293      */
 294     private void sendErrorMessage(final PCEPErrors value, final Open open) {
 295         this.sendMessage(Util.createErrorMessage(value, open));
 296     }
 297
 298     /**
 299      * The fact, that a message is malformed, comes from parser. In case of unrecognized message a particular error is
 300      * sent (CAPABILITY_NOT_SUPPORTED) and the method checks if the MAX_UNKNOWN_MSG per minute wasn't overstepped.
 301      * Second, any other error occurred that is specified by rfc. In this case, the an error message is generated and
 302      * sent.
 303      *
 304      * @param error documented error in RFC5440 or draft
 305      */
 306     @VisibleForTesting
 307     public void handleMalformedMessage(final PCEPErrors error) {
 308         final long ct = TICKER.read();
 309         this.sendErrorMessage(error);
 310         if (error == PCEPErrors.CAPABILITY_NOT_SUPPORTED) {
 311             this.unknownMessagesTimes.add(ct);
 312             while ( ct - this.unknownMessagesTimes.peek() > MINUTE) {
 313                 this.unknownMessagesTimes.poll();
 314             }
 315             if (this.unknownMessagesTimes.size() > this.maxUnknownMessages) {
 316                 this.terminate(TerminationReason.TOO_MANY_UNKNOWN_MSGS);
 317             }
 318         }
 319     }
 320
 321     /**
 322      * Handles incoming message. If the session is up, it notifies the user. The user is notified about every message
 323      * except KeepAlive.
 324      *
 325      * @param msg incoming message
 326      */
 327     public synchronized void handleMessage(final Message msg) {
 328         if (this.closed) {
 329             LOG.debug("PCEP Session {} is already closed, skip handling incoming message {}", this, msg);
 330             return;
 331         }
 332         // Update last reception time
 333         this.lastMessageReceivedAt = TICKER.read();
 334         this.sessionState.updateLastReceivedMsg();
 335         if (!(msg instanceof KeepaliveMessage)) {
 336             LOG.debug("PCEP message {} received.", msg);
 337         }
 338         // Internal message handling. The user does not see these messages
 339         if (msg instanceof KeepaliveMessage) {
 340             // Do nothing, the timer has been already reset
 341         } else if (msg instanceof OpenMessage) {
 342             this.sendErrorMessage(PCEPErrors.ATTEMPT_2ND_SESSION);
 343         } else if (msg instanceof CloseMessage) {
 344             /*
 345              * Session is up, we are reporting all messages to user. One notable
 346              * exception is CLOSE message, which needs to be converted into a
 347              * session DOWN event.
 348              */
 349             close();
 350             this.listener.onSessionTerminated(this, new PCEPCloseTermination(TerminationReason.forValue(((CloseMessage) msg).getCCloseMessage().getCClose().getReason())));
 351         } else {
 352             // This message needs to be handled by the user
 353             if (msg instanceof PcerrMessage) {
 354                 this.sessionState.setLastReceivedError(msg);
 355             }
 356             this.listener.onMessage(this, msg);
 357         }
 358     }
 359
 360     @Override
 361     public final String toString() {
 362         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
 363     }
 364
 365     private ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 366         toStringHelper.add("channel", this.channel);
 367         toStringHelper.add("localOpen", this.localOpen);
 368         toStringHelper.add("remoteOpen", this.remoteOpen);
 369         return toStringHelper;
 370     }
 371
 372     @VisibleForTesting
 373     void sessionUp() {
 374         try {
 375             this.listener.onSessionUp(this);
 376         } catch (final Exception e) {
 377             handleException(e);
 378             throw e;
 379         }
 380     }
 381
 382     @VisibleForTesting
 383     final Queue<Long> getUnknownMessagesTimes() {
 384         return this.unknownMessagesTimes;
 385     }
 386
 387     @Override
 388     public Messages getMessages() {
 389         return this.sessionState.getMessages(this.unknownMessagesTimes.size());
 390     }
 391
 392     @Override
 393     public LocalPref getLocalPref() {
 394         return this.sessionState.getLocalPref();
 395     }
 396
 397     @Override
 398     public PeerPref getPeerPref() {
 399         return this.sessionState.getPeerPref();
 400     }
 401
 402     @Override
 403     public Class<? extends DataContainer> getImplementedInterface() {
 404         throw new UnsupportedOperationException();
 405     }
 406
 407     @Override
 408     public void resetStats() {
 409         this.sessionState.reset();
 410     }
 411
 412     @Override
 413     public final void channelInactive(final ChannelHandlerContext ctx) {
 414         LOG.debug("Channel {} inactive.", ctx.channel());
 415         this.endOfInput();
 416
 417         try {
 418             super.channelInactive(ctx);
 419         } catch (final Exception e) {
 420             throw new IllegalStateException("Failed to delegate channel inactive event on channel " + ctx.channel(), e);
 421         }
 422     }
 423
 424     @Override
 425     protected final void channelRead0(final ChannelHandlerContext ctx, final Message msg) {
 426         LOG.debug("Message was received: {}", msg);
 427         this.handleMessage(msg);
 428     }
 429
 430     @Override
 431     public final void handlerAdded(final ChannelHandlerContext ctx) {
 432         this.sessionUp();
 433     }
 434
 435     @Override
 436     public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
 437         handleException(cause);
 438     }
 439
 440     @Override
 441     public Tlvs localSessionCharacteristics() {
 442         return this.localOpen.getTlvs();
 443     }
 444
 445     @VisibleForTesting
 446     static void setTicker(final Ticker ticker) {
 447         TICKER = ticker;
 448     }
 449 }