bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/BGPSessionImpl.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.bgp.rib.impl;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.base.MoreObjects;
  12 import com.google.common.base.MoreObjects.ToStringHelper;
  13 import com.google.common.base.Optional;
  14 import com.google.common.base.Preconditions;
  15 import com.google.common.collect.Sets;
  16 import io.netty.channel.Channel;
  17 import io.netty.channel.ChannelFuture;
  18 import io.netty.channel.ChannelFutureListener;
  19 import java.io.IOException;
  20 import java.util.Date;
  21 import java.util.Set;
  22 import java.util.concurrent.TimeUnit;
  23 import javax.annotation.concurrent.GuardedBy;
  24 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpSessionState;
  25 import org.opendaylight.protocol.bgp.parser.AsNumberUtil;
  26 import org.opendaylight.protocol.bgp.parser.BGPError;
  27 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  28 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
  29 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
  30 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionStatistics;
  31 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
  32 import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
  33 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
  34 import org.opendaylight.protocol.framework.AbstractProtocolSession;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Keepalive;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Notify;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.NotifyBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParameters;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.OptionalCapabilities;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.optional.capabilities.CParameters;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.optional.capabilities.c.parameters.MultiprotocolCase;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  49 import org.opendaylight.yangtools.yang.binding.Notification;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 @VisibleForTesting
  54 public class BGPSessionImpl extends AbstractProtocolSession<Notification> implements BGPSession, BGPSessionStatistics {
  55
  56     private static final Logger LOG = LoggerFactory.getLogger(BGPSessionImpl.class);
  57
  58     private static final Notification KEEP_ALIVE = new KeepaliveBuilder().build();
  59
  60     private static final int KA_TO_DEADTIMER_RATIO = 3;
  61
  62     /**
  63      * Internal session state.
  64      */
  65     public enum State {
  66         /**
  67          * The session object is created by the negotiator in OpenConfirm state. While in this state, the session object
  68          * is half-alive, e.g. the timers are running, but the session is not completely up, e.g. it has not been
  69          * announced to the listener. If the session is torn down in this state, we do not inform the listener.
  70          */
  71         OPEN_CONFIRM,
  72         /**
  73          * The session has been completely established.
  74          */
  75         UP,
  76         /**
  77          * The session has been closed. It will not be resurrected.
  78          */
  79         IDLE,
  80     }
  81
  82     /**
  83      * System.nanoTime value about when was sent the last message.
  84      */
  85     @VisibleForTesting
  86     private long lastMessageSentAt;
  87
  88     /**
  89      * System.nanoTime value about when was received the last message
  90      */
  91     private long lastMessageReceivedAt;
  92
  93     private final BGPSessionListener listener;
  94
  95     private final BGPSynchronization sync;
  96
  97     private int kaCounter = 0;
  98
  99     private final Channel channel;
 100
 101     @GuardedBy("this")
 102     private State state = State.OPEN_CONFIRM;
 103
 104     private final Set<BgpTableType> tableTypes;
 105     private final int holdTimerValue;
 106     private final int keepAlive;
 107     private final AsNumber asNumber;
 108     private final Ipv4Address bgpId;
 109     private final BGPPeerRegistry peerRegistry;
 110     private final ChannelOutputLimiter limiter;
 111
 112     private BGPSessionStats sessionStats;
 113
 114     public BGPSessionImpl(final BGPSessionListener listener, final Channel channel, final Open remoteOpen, final BGPSessionPreferences localPreferences,
 115             final BGPPeerRegistry peerRegitry) {
 116         this(listener, channel, remoteOpen, localPreferences.getHoldTime(), peerRegitry);
 117         this.sessionStats = new BGPSessionStats(remoteOpen, this.holdTimerValue, this.keepAlive, channel, Optional.of(localPreferences), this.tableTypes);
 118     }
 119
 120     public BGPSessionImpl(final BGPSessionListener listener, final Channel channel, final Open remoteOpen, final int localHoldTimer,
 121             final BGPPeerRegistry peerRegitry) {
 122         this.listener = Preconditions.checkNotNull(listener);
 123         this.channel = Preconditions.checkNotNull(channel);
 124         this.limiter = new ChannelOutputLimiter(this);
 125         this.holdTimerValue = (remoteOpen.getHoldTimer() < localHoldTimer) ? remoteOpen.getHoldTimer() : localHoldTimer;
 126         LOG.info("BGP HoldTimer new value: {}", this.holdTimerValue);
 127         this.keepAlive = this.holdTimerValue / KA_TO_DEADTIMER_RATIO;
 128         this.asNumber = AsNumberUtil.advertizedAsNumber(remoteOpen);
 129         this.peerRegistry = peerRegitry;
 130
 131         final Set<TablesKey> tts = Sets.newHashSet();
 132         final Set<BgpTableType> tats = Sets.newHashSet();
 133         if (remoteOpen.getBgpParameters() != null) {
 134             for (final BgpParameters param : remoteOpen.getBgpParameters()) {
 135                 for (final OptionalCapabilities optCapa : param.getOptionalCapabilities()) {
 136                     final CParameters cp = optCapa.getCParameters();
 137                     if (cp instanceof MultiprotocolCase) {
 138                         final TablesKey tt = new TablesKey(((MultiprotocolCase) cp).getMultiprotocolCapability().getAfi(),
 139                                 ((MultiprotocolCase) cp).getMultiprotocolCapability().getSafi());
 140                         LOG.trace("Added table type to sync {}", tt);
 141                         tts.add(tt);
 142                         tats.add(new BgpTableTypeImpl(tt.getAfi(), tt.getSafi()));
 143                     }
 144                 }
 145             }
 146         }
 147
 148         this.sync = new BGPSynchronization(this, this.listener, tts);
 149         this.tableTypes = tats;
 150
 151         if (this.holdTimerValue != 0) {
 152             channel.eventLoop().schedule(new Runnable() {
 153                 @Override
 154                 public void run() {
 155                     handleHoldTimer();
 156                 }
 157             }, this.holdTimerValue, TimeUnit.SECONDS);
 158
 159             channel.eventLoop().schedule(new Runnable() {
 160                 @Override
 161                 public void run() {
 162                     handleKeepaliveTimer();
 163                 }
 164             }, this.keepAlive, TimeUnit.SECONDS);
 165         }
 166         this.bgpId = remoteOpen.getBgpIdentifier();
 167         this.sessionStats = new BGPSessionStats(remoteOpen, this.holdTimerValue, this.keepAlive, channel, Optional.<BGPSessionPreferences>absent(),
 168                 this.tableTypes);
 169     }
 170
 171     @Override
 172     public synchronized void close() {
 173         LOG.info("Closing session: {}", this);
 174
 175         if (this.state != State.IDLE) {
 176             this.sendMessage(new NotifyBuilder().setErrorCode(BGPError.CEASE.getCode()).setErrorSubcode(
 177                     BGPError.CEASE.getSubcode()).build());
 178             removePeerSession();
 179             this.channel.close();
 180             this.state = State.IDLE;
 181         }
 182     }
 183
 184     /**
 185      * Handles incoming message based on their type.
 186      *
 187      * @param msg incoming message
 188      */
 189     @Override
 190     public synchronized void handleMessage(final Notification msg) {
 191         // Update last reception time
 192         this.lastMessageReceivedAt = System.nanoTime();
 193         this.sessionStats.updateReceivedMsgTotal();
 194
 195         if (msg instanceof Open) {
 196             // Open messages should not be present here
 197             this.terminate(BGPError.FSM_ERROR);
 198         } else if (msg instanceof Notify) {
 199             // Notifications are handled internally
 200             LOG.info("Session closed because Notification message received: {} / {}", ((Notify) msg).getErrorCode(),
 201                 ((Notify) msg).getErrorSubcode());
 202             this.closeWithoutMessage();
 203             this.listener.onSessionTerminated(this, new BGPTerminationReason(BGPError.forValue(((Notify) msg).getErrorCode(),
 204                 ((Notify) msg).getErrorSubcode())));
 205             this.sessionStats.updateReceivedMsgErr((Notify) msg);
 206         } else if (msg instanceof Keepalive) {
 207             // Keepalives are handled internally
 208             LOG.trace("Received KeepAlive messsage.");
 209             this.kaCounter++;
 210             this.sessionStats.updateReceivedMsgKA();
 211             if (this.kaCounter >= 2) {
 212                 this.sync.kaReceived();
 213             }
 214         } else {
 215             // All others are passed up
 216             this.listener.onMessage(this, msg);
 217             this.sync.updReceived((Update) msg);
 218             this.sessionStats.updateReceivedMsgUpd();
 219         }
 220     }
 221
 222     @Override
 223     public synchronized void endOfInput() {
 224         if (this.state == State.UP) {
 225             this.listener.onSessionDown(this, new IOException("End of input detected. Close the session."));
 226         }
 227     }
 228
 229     synchronized void sendMessage(final Notification msg) {
 230         try {
 231             this.channel.writeAndFlush(msg).addListener(
 232                 new ChannelFutureListener() {
 233                     @Override
 234                     public void operationComplete(final ChannelFuture f) {
 235                         if (!f.isSuccess()) {
 236                             LOG.info("Failed to send message {} to socket {}", msg, f.cause(), BGPSessionImpl.this.channel);
 237                         } else {
 238                             LOG.trace("Message {} sent to socket {}", msg, BGPSessionImpl.this.channel);
 239                         }
 240                     }
 241                 });
 242             this.lastMessageSentAt = System.nanoTime();
 243             this.sessionStats.updateSentMsgTotal();
 244             if (msg instanceof Update) {
 245                 this.sessionStats.updateSentMsgUpd();
 246             } else if (msg instanceof Notify) {
 247                 this.sessionStats.updateSentMsgErr((Notify) msg);
 248             }
 249         } catch (final Exception e) {
 250             LOG.warn("Message {} was not sent.", msg, e);
 251         }
 252     }
 253
 254     private synchronized void closeWithoutMessage() {
 255         LOG.debug("Closing session: {}", this);
 256         removePeerSession();
 257         this.channel.close();
 258         this.state = State.IDLE;
 259     }
 260
 261     /**
 262      * Closes PCEP session from the parent with given reason. A message needs to be sent, but parent doesn't have to be
 263      * modified, because he initiated the closing. (To prevent concurrent modification exception).
 264      *
 265      * @param closeObject
 266      */
 267     private void terminate(final BGPError error) {
 268         this.sendMessage(new NotifyBuilder().setErrorCode(error.getCode()).setErrorSubcode(error.getSubcode()).build());
 269         this.closeWithoutMessage();
 270
 271         this.listener.onSessionTerminated(this, new BGPTerminationReason(error));
 272     }
 273
 274     private void removePeerSession() {
 275         if (this.peerRegistry != null) {
 276             this.peerRegistry.removePeerSession(StrictBGPPeerRegistry.getIpAddress(this.channel.remoteAddress()));
 277         }
 278     }
 279
 280     /**
 281      * If HoldTimer expires, the session ends. If a message (whichever) was received during this period, the HoldTimer
 282      * will be rescheduled by HOLD_TIMER_VALUE + the time that has passed from the start of the HoldTimer to the time at
 283      * which the message was received. If the session was closed by the time this method starts to execute (the session
 284      * state will become IDLE), then rescheduling won't occur.
 285      */
 286     private synchronized void handleHoldTimer() {
 287         if (this.state == State.IDLE) {
 288             return;
 289         }
 290
 291         final long ct = System.nanoTime();
 292         final long nextHold = this.lastMessageReceivedAt + TimeUnit.SECONDS.toNanos(this.holdTimerValue);
 293
 294         if (ct >= nextHold) {
 295             LOG.debug("HoldTimer expired. {}", new Date());
 296             this.terminate(BGPError.HOLD_TIMER_EXPIRED);
 297         } else {
 298             this.channel.eventLoop().schedule(new Runnable() {
 299                 @Override
 300                 public void run() {
 301                     handleHoldTimer();
 302                 }
 303             }, nextHold - ct, TimeUnit.NANOSECONDS);
 304         }
 305     }
 306
 307     /**
 308      * If KeepAlive Timer expires, sends KeepAlive message. If a message (whichever) was send during this period, the
 309      * KeepAlive Timer will be rescheduled by KEEP_ALIVE_TIMER_VALUE + the time that has passed from the start of the
 310      * KeepAlive timer to the time at which the message was sent. If the session was closed by the time this method
 311      * starts to execute (the session state will become IDLE), that rescheduling won't occur.
 312      */
 313     private synchronized void handleKeepaliveTimer() {
 314         if (this.state == State.IDLE) {
 315             return;
 316         }
 317
 318         final long ct = System.nanoTime();
 319         long nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
 320
 321         if (ct >= nextKeepalive) {
 322             this.sendMessage(KEEP_ALIVE);
 323             nextKeepalive = this.lastMessageSentAt + TimeUnit.SECONDS.toNanos(this.keepAlive);
 324             this.sessionStats.updateSentMsgKA();
 325         }
 326         this.channel.eventLoop().schedule(new Runnable() {
 327             @Override
 328             public void run() {
 329                 handleKeepaliveTimer();
 330             }
 331         }, nextKeepalive - ct, TimeUnit.NANOSECONDS);
 332     }
 333
 334     @Override
 335     public final String toString() {
 336         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
 337     }
 338
 339     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 340         toStringHelper.add("channel", this.channel);
 341         toStringHelper.add("state", this.getState());
 342         return toStringHelper;
 343     }
 344
 345     @Override
 346     public Set<BgpTableType> getAdvertisedTableTypes() {
 347         return this.tableTypes;
 348     }
 349
 350     @Override
 351     protected synchronized void sessionUp() {
 352         this.sessionStats.startSessionStopwatch();
 353         this.state = State.UP;
 354         this.listener.onSessionUp(this);
 355     }
 356
 357     public synchronized State getState() {
 358         return this.state;
 359     }
 360
 361     @Override
 362     public final Ipv4Address getBgpId() {
 363         return this.bgpId;
 364     }
 365
 366     @Override
 367     public final AsNumber getAsNumber() {
 368         return this.asNumber;
 369     }
 370
 371     synchronized boolean isWritable() {
 372         return this.channel != null && this.channel.isWritable();
 373     }
 374
 375     void schedule(final Runnable task) {
 376         Preconditions.checkState(this.channel != null);
 377         this.channel.eventLoop().submit(task);
 378     }
 379
 380     @VisibleForTesting
 381     protected synchronized void setLastMessageSentAt(final long lastMessageSentAt) {
 382         this.lastMessageSentAt = lastMessageSentAt;
 383     }
 384
 385     @Override
 386     public synchronized BgpSessionState getBgpSesionState() {
 387         return this.sessionStats.getBgpSessionState(this.state);
 388     }
 389
 390     @Override
 391     public synchronized void resetSessionStats() {
 392         this.sessionStats.resetStats();
 393     }
 394
 395     ChannelOutputLimiter getLimiter() {
 396         return limiter;
 397     }
 398 }