BUG-5243: Failed to send message Notify
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / BGPSessionImpl.java
index 7b5e30f0d8fd8ae72f9d83f4feaa97234ea61df8..cfc01e536d527ee0932af30004bb2003fd24b6fe 100644 (file)
@@ -8,30 +8,31 @@
 package org.opendaylight.protocol.bgp.rib.impl;
 
 import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Objects;
-import com.google.common.base.Objects.ToStringHelper;
+import com.google.common.base.MoreObjects;
+import com.google.common.base.MoreObjects.ToStringHelper;
+import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Sets;
-
 import io.netty.channel.Channel;
-import io.netty.util.Timeout;
-import io.netty.util.Timer;
-import io.netty.util.TimerTask;
-
+import io.netty.channel.ChannelFuture;
+import io.netty.channel.ChannelFutureListener;
+import io.netty.channel.ChannelHandlerContext;
+import io.netty.channel.SimpleChannelInboundHandler;
 import java.io.IOException;
 import java.util.Date;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
-
 import javax.annotation.concurrent.GuardedBy;
-
+import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpSessionState;
 import org.opendaylight.protocol.bgp.parser.AsNumberUtil;
 import org.opendaylight.protocol.bgp.parser.BGPError;
-import org.opendaylight.protocol.bgp.parser.BGPSession;
-import org.opendaylight.protocol.bgp.parser.BGPSessionListener;
-import org.opendaylight.protocol.bgp.parser.BGPTerminationReason;
 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
-import org.opendaylight.protocol.framework.AbstractProtocolSession;
+import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
+import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
+import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionStatistics;
+import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
+import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
+import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Keepalive;
@@ -40,22 +41,28 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mess
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.NotifyBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParameters;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.CParameters;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilities;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParameters;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.c.parameters.MultiprotocolCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.optional.capabilities.c.parameters.MultiprotocolCapability;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
 import org.opendaylight.yangtools.yang.binding.Notification;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 @VisibleForTesting
-public class BGPSessionImpl extends AbstractProtocolSession<Notification> implements BGPSession {
+public class BGPSessionImpl extends SimpleChannelInboundHandler<Notification> implements BGPSession, BGPSessionStatistics, AutoCloseable {
 
     private static final Logger LOG = LoggerFactory.getLogger(BGPSessionImpl.class);
 
     private static final Notification KEEP_ALIVE = new KeepaliveBuilder().build();
 
+    private static final int KA_TO_DEADTIMER_RATIO = 3;
+
+    static final String END_OF_INPUT = "End of input detected. Close the session.";
+
     /**
      * Internal session state.
      */
@@ -65,22 +72,22 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
          * is half-alive, e.g. the timers are running, but the session is not completely up, e.g. it has not been
          * announced to the listener. If the session is torn down in this state, we do not inform the listener.
          */
-        OpenConfirm,
+        OPEN_CONFIRM,
         /**
          * The session has been completely established.
          */
-        Up,
+        UP,
         /**
          * The session has been closed. It will not be resurrected.
          */
-        Idle,
+        IDLE,
     }
 
     /**
-     * System.nanoTime value about when was sent the last message Protected to be updated also in tests.
+     * System.nanoTime value about when was sent the last message.
      */
     @VisibleForTesting
-    protected long lastMessageSentAt;
+    private long lastMessageSentAt;
 
     /**
      * System.nanoTime value about when was received the last message
@@ -89,11 +96,6 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
 
     private final BGPSessionListener listener;
 
-    /**
-     * Timer object grouping FSM Timers
-     */
-    private final Timer stateTimer;
-
     private final BGPSynchronization sync;
 
     private int kaCounter = 0;
@@ -101,31 +103,48 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
     private final Channel channel;
 
     @GuardedBy("this")
-    private State state = State.OpenConfirm;
+    private State state = State.OPEN_CONFIRM;
 
     private final Set<BgpTableType> tableTypes;
     private final int holdTimerValue;
     private final int keepAlive;
     private final AsNumber asNumber;
     private final Ipv4Address bgpId;
+    private final BGPPeerRegistry peerRegistry;
+    private final ChannelOutputLimiter limiter;
+
+    private BGPSessionStats sessionStats;
+
+    public BGPSessionImpl(final BGPSessionListener listener, final Channel channel, final Open remoteOpen, final BGPSessionPreferences localPreferences,
+            final BGPPeerRegistry peerRegistry) {
+        this(listener, channel, remoteOpen, localPreferences.getHoldTime(), peerRegistry);
+        this.sessionStats = new BGPSessionStats(remoteOpen, this.holdTimerValue, this.keepAlive, channel, Optional.of(localPreferences), this.tableTypes);
+    }
 
-    BGPSessionImpl(final Timer timer, final BGPSessionListener listener, final Channel channel, final Open remoteOpen,
-            final int localHoldTimer) {
+    public BGPSessionImpl(final BGPSessionListener listener, final Channel channel, final Open remoteOpen, final int localHoldTimer,
+            final BGPPeerRegistry peerRegistry) {
         this.listener = Preconditions.checkNotNull(listener);
-        this.stateTimer = Preconditions.checkNotNull(timer);
         this.channel = Preconditions.checkNotNull(channel);
+        this.limiter = new ChannelOutputLimiter(this);
+        this.channel.pipeline().addLast(this.limiter);
         this.holdTimerValue = (remoteOpen.getHoldTimer() < localHoldTimer) ? remoteOpen.getHoldTimer() : localHoldTimer;
         LOG.info("BGP HoldTimer new value: {}", this.holdTimerValue);
-        this.keepAlive = this.holdTimerValue / 3;
+        this.keepAlive = this.holdTimerValue / KA_TO_DEADTIMER_RATIO;
         this.asNumber = AsNumberUtil.advertizedAsNumber(remoteOpen);
+        this.peerRegistry = peerRegistry;
 
         final Set<TablesKey> tts = Sets.newHashSet();
         final Set<BgpTableType> tats = Sets.newHashSet();
         if (remoteOpen.getBgpParameters() != null) {
             for (final BgpParameters param : remoteOpen.getBgpParameters()) {
-                final CParameters cp = param.getCParameters();
-                if (cp instanceof MultiprotocolCase) {
-                    final TablesKey tt = new TablesKey(((MultiprotocolCase) cp).getMultiprotocolCapability().getAfi(), ((MultiprotocolCase) cp).getMultiprotocolCapability().getSafi());
+                for (final OptionalCapabilities optCapa : param.getOptionalCapabilities()) {
+                    final CParameters cParam = optCapa.getCParameters();
+                    if ( cParam.getAugmentation(CParameters1.class) == null ||
+                            cParam.getAugmentation(CParameters1.class).getMultiprotocolCapability() == null ) {
+                        continue;
+                    }
+                    final MultiprotocolCapability multi = cParam.getAugmentation(CParameters1.class).getMultiprotocolCapability();
+                    final TablesKey tt = new TablesKey(multi.getAfi(), multi.getSafi());
                     LOG.trace("Added table type to sync {}", tt);
                     tts.add(tt);
                     tats.add(new BgpTableTypeImpl(tt.getAfi(), tt.getSafi()));
@@ -133,36 +152,36 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
             }
         }
 
-        this.sync = new BGPSynchronization(this, this.listener, tts);
+        this.sync = new BGPSynchronization(this.listener, tts);
         this.tableTypes = tats;
 
         if (this.holdTimerValue != 0) {
-            this.stateTimer.newTimeout(new TimerTask() {
-
+            channel.eventLoop().schedule(new Runnable() {
                 @Override
-                public void run(final Timeout timeout) {
+                public void run() {
                     handleHoldTimer();
                 }
             }, this.holdTimerValue, TimeUnit.SECONDS);
 
-            this.stateTimer.newTimeout(new TimerTask() {
+            channel.eventLoop().schedule(new Runnable() {
                 @Override
-                public void run(final Timeout timeout) {
+                public void run() {
                     handleKeepaliveTimer();
                 }
             }, this.keepAlive, TimeUnit.SECONDS);
         }
         this.bgpId = remoteOpen.getBgpIdentifier();
+        this.sessionStats = new BGPSessionStats(remoteOpen, this.holdTimerValue, this.keepAlive, channel, Optional.<BGPSessionPreferences>absent(),
+                this.tableTypes);
     }
 
     @Override
     public synchronized void close() {
-        LOG.info("Closing session: {}", this);
-        if (this.state != State.Idle) {
-            this.sendMessage(new NotifyBuilder().setErrorCode(BGPError.CEASE.getCode()).build());
-            this.channel.close();
-            this.state = State.Idle;
+        if (this.state != State.IDLE && this.channel.isActive()) {
+            this.writeAndFlush(new NotifyBuilder().setErrorCode(BGPError.CEASE.getCode()).setErrorSubcode(
+                BGPError.CEASE.getSubcode()).build());
         }
+        this.closeWithoutMessage();
     }
 
     /**
@@ -170,10 +189,10 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
      *
      * @param msg incoming message
      */
-    @Override
-    public void handleMessage(final Notification msg) {
+    public synchronized void handleMessage(final Notification msg) {
         // Update last reception time
         this.lastMessageReceivedAt = System.nanoTime();
+        this.sessionStats.updateReceivedMsgTotal();
 
         if (msg instanceof Open) {
             // Open messages should not be present here
@@ -181,14 +200,16 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
         } else if (msg instanceof Notify) {
             // Notifications are handled internally
             LOG.info("Session closed because Notification message received: {} / {}", ((Notify) msg).getErrorCode(),
-                    ((Notify) msg).getErrorSubcode());
+                ((Notify) msg).getErrorSubcode());
             this.closeWithoutMessage();
             this.listener.onSessionTerminated(this, new BGPTerminationReason(BGPError.forValue(((Notify) msg).getErrorCode(),
-                    ((Notify) msg).getErrorSubcode())));
+                ((Notify) msg).getErrorSubcode())));
+            this.sessionStats.updateReceivedMsgErr((Notify) msg);
         } else if (msg instanceof Keepalive) {
             // Keepalives are handled internally
             LOG.trace("Received KeepAlive messsage.");
             this.kaCounter++;
+            this.sessionStats.updateReceivedMsgKA();
             if (this.kaCounter >= 2) {
                 this.sync.kaReceived();
             }
@@ -196,45 +217,81 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
             // All others are passed up
             this.listener.onMessage(this, msg);
             this.sync.updReceived((Update) msg);
+            this.sessionStats.updateReceivedMsgUpd();
         }
     }
 
-    @Override
     public synchronized void endOfInput() {
-        if (this.state == State.Up) {
-            this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
+        if (this.state == State.UP) {
+            LOG.info(END_OF_INPUT);
+            this.listener.onSessionDown(this, new IOException(END_OF_INPUT));
+        }
+    }
+
+    @GuardedBy("this")
+    private void writeEpilogue(final ChannelFuture future, final Notification msg) {
+        future.addListener(
+            new ChannelFutureListener() {
+                @Override
+                public void operationComplete(final ChannelFuture f) {
+                    if (!f.isSuccess()) {
+                        LOG.warn("Failed to send message {} to socket {}", msg, f.cause(), BGPSessionImpl.this.channel);
+                    } else {
+                        LOG.trace("Message {} sent to socket {}", msg, BGPSessionImpl.this.channel);
+                    }
+                }
+            });
+        this.lastMessageSentAt = System.nanoTime();
+        this.sessionStats.updateSentMsgTotal();
+        if (msg instanceof Update) {
+            this.sessionStats.updateSentMsgUpd();
+        } else if (msg instanceof Notify) {
+            this.sessionStats.updateSentMsgErr((Notify) msg);
         }
     }
 
-    void sendMessage(final Notification msg) {
+    void flush() {
+        this.channel.flush();
+    }
+
+    synchronized void write(final Notification msg) {
         try {
-            this.channel.writeAndFlush(msg);
-            this.lastMessageSentAt = System.nanoTime();
-            LOG.debug("Sent message: {}", msg);
+            writeEpilogue(this.channel.write(msg), msg);
         } catch (final Exception e) {
             LOG.warn("Message {} was not sent.", msg, e);
         }
     }
 
+    synchronized void writeAndFlush(final Notification msg) {
+        writeEpilogue(this.channel.writeAndFlush(msg), msg);
+    }
+
     private synchronized void closeWithoutMessage() {
-        LOG.debug("Closing session: {}", this);
+        LOG.info("Closing session: {}", this);
+        removePeerSession();
         this.channel.close();
-        this.state = State.Idle;
+        this.state = State.IDLE;
     }
 
     /**
      * Closes PCEP session from the parent with given reason. A message needs to be sent, but parent doesn't have to be
      * modified, because he initiated the closing. (To prevent concurrent modification exception).
      *
-     * @param closeObject
+     * @param error
      */
     private void terminate(final BGPError error) {
-        this.sendMessage(new NotifyBuilder().setErrorCode(error.getCode()).setErrorSubcode(error.getSubcode()).build());
+        this.writeAndFlush(new NotifyBuilder().setErrorCode(error.getCode()).setErrorSubcode(error.getSubcode()).build());
         this.closeWithoutMessage();
 
         this.listener.onSessionTerminated(this, new BGPTerminationReason(error));
     }
 
+    private void removePeerSession() {
+        if (this.peerRegistry != null) {
+            this.peerRegistry.removePeerSession(StrictBGPPeerRegistry.getIpAddress(this.channel.remoteAddress()));
+        }
+    }
+
     /**
      * If HoldTimer expires, the session ends. If a message (whichever) was received during this period, the HoldTimer
      * will be rescheduled by HOLD_TIMER_VALUE + the time that has passed from the start of the HoldTimer to the time at
@@ -242,7 +299,7 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
      * state will become IDLE), then rescheduling won't occur.
      */
     private synchronized void handleHoldTimer() {
-        if (this.state == State.Idle) {
+        if (this.state == State.IDLE) {
             return;
         }
 
@@ -253,9 +310,9 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
             LOG.debug("HoldTimer expired. {}", new Date());
             this.terminate(BGPError.HOLD_TIMER_EXPIRED);
         } else {
-            this.stateTimer.newTimeout(new TimerTask() {
+            this.channel.eventLoop().schedule(new Runnable() {
                 @Override
-                public void run(final Timeout timeout) {
+                public void run() {
                     handleHoldTimer();
                 }
             }, nextHold - ct, TimeUnit.NANOSECONDS);
@@ -269,7 +326,7 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
      * starts to execute (the session state will become IDLE), that rescheduling won't occur.
      */
     private synchronized void handleKeepaliveTimer() {
-        if (this.state == State.Idle) {
+        if (this.state == State.IDLE) {
             return;
         }
 
@@ -277,12 +334,13 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
         long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
 
         if (ct >= nextKeepalive) {
-            this.sendMessage(KEEP_ALIVE);
+            this.writeAndFlush(KEEP_ALIVE);
             nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
+            this.sessionStats.updateSentMsgKA();
         }
-        this.stateTimer.newTimeout(new TimerTask() {
+        this.channel.eventLoop().schedule(new Runnable() {
             @Override
-            public void run(final Timeout timeout) {
+            public void run() {
                 handleKeepaliveTimer();
             }
         }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
@@ -290,12 +348,12 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
 
     @Override
     public final String toString() {
-        return addToStringAttributes(Objects.toStringHelper(this)).toString();
+        return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
     }
 
     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
         toStringHelper.add("channel", this.channel);
-        toStringHelper.add("state", this.state);
+        toStringHelper.add("state", this.getState());
         return toStringHelper;
     }
 
@@ -304,9 +362,9 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
         return this.tableTypes;
     }
 
-    @Override
     protected synchronized void sessionUp() {
-        this.state = State.Up;
+        this.sessionStats.startSessionStopwatch();
+        this.state = State.UP;
         this.listener.onSessionUp(this);
     }
 
@@ -323,4 +381,55 @@ public class BGPSessionImpl extends AbstractProtocolSession<Notification> implem
     public final AsNumber getAsNumber() {
         return this.asNumber;
     }
+
+    synchronized boolean isWritable() {
+        return this.channel != null && this.channel.isWritable();
+    }
+
+    void schedule(final Runnable task) {
+        Preconditions.checkState(this.channel != null);
+        this.channel.eventLoop().submit(task);
+    }
+
+    @VisibleForTesting
+    protected synchronized void setLastMessageSentAt(final long lastMessageSentAt) {
+        this.lastMessageSentAt = lastMessageSentAt;
+    }
+
+    @Override
+    public synchronized BgpSessionState getBgpSesionState() {
+        return this.sessionStats.getBgpSessionState(this.state);
+    }
+
+    @Override
+    public synchronized void resetSessionStats() {
+        this.sessionStats.resetStats();
+    }
+
+    ChannelOutputLimiter getLimiter() {
+        return this.limiter;
+    }
+
+    @Override
+    public final void channelInactive(final ChannelHandlerContext ctx) {
+        LOG.debug("Channel {} inactive.", ctx.channel());
+        this.endOfInput();
+
+        try {
+            super.channelInactive(ctx);
+        } catch (final Exception e) {
+            throw new IllegalStateException("Failed to delegate channel inactive event on channel " + ctx.channel(), e);
+        }
+    }
+
+    @Override
+    protected final void channelRead0(final ChannelHandlerContext ctx, final Notification msg) {
+        LOG.debug("Message was received: {}", msg);
+        this.handleMessage(msg);
+    }
+
+    @Override
+    public final void handlerAdded(final ChannelHandlerContext ctx) {
+        this.sessionUp();
+    }
 }