openflowjava/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/TcpHandler.java

   1 /*
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. 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
   9 package org.opendaylight.openflowjava.protocol.impl.core;
  10
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import com.google.common.util.concurrent.SettableFuture;
  13 import io.netty.bootstrap.ServerBootstrap;
  14 import io.netty.buffer.PooledByteBufAllocator;
  15 import io.netty.channel.ChannelFuture;
  16 import io.netty.channel.ChannelOption;
  17 import io.netty.channel.EventLoopGroup;
  18 import io.netty.channel.WriteBufferWaterMark;
  19 import io.netty.channel.epoll.EpollEventLoopGroup;
  20 import io.netty.channel.epoll.EpollServerSocketChannel;
  21 import io.netty.channel.nio.NioEventLoopGroup;
  22 import io.netty.channel.socket.ServerSocketChannel;
  23 import io.netty.channel.socket.nio.NioServerSocketChannel;
  24 import io.netty.handler.logging.LogLevel;
  25 import io.netty.handler.logging.LoggingHandler;
  26 import java.net.InetAddress;
  27 import java.net.InetSocketAddress;
  28 import org.opendaylight.openflowjava.protocol.api.connection.ThreadConfiguration;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 /**
  33  * Class implementing server over TCP / TLS for handling incoming connections.
  34  *
  35  * @author michal.polkorab
  36  */
  37 public class TcpHandler implements ServerFacade {
  38     /*
  39      * High/low write watermarks
  40      */
  41     private static final int DEFAULT_WRITE_HIGH_WATERMARK = 64 * 1024;
  42     private static final int DEFAULT_WRITE_LOW_WATERMARK = 32 * 1024;
  43     /*
  44      * Write spin count. This tells netty to immediately retry a non-blocking
  45      * write this many times before moving on to selecting.
  46      */
  47     private static final int DEFAULT_WRITE_SPIN_COUNT = 16;
  48
  49     private static final Logger LOG = LoggerFactory.getLogger(TcpHandler.class);
  50
  51     private int port;
  52     private String address;
  53     private final InetAddress startupAddress;
  54     private final Runnable readyRunnable;
  55     private EventLoopGroup workerGroup;
  56     private EventLoopGroup bossGroup;
  57     private final SettableFuture<Boolean> isOnlineFuture = SettableFuture.create();
  58
  59     private TcpChannelInitializer channelInitializer;
  60
  61     private Class<? extends ServerSocketChannel> socketChannelClass;
  62
  63     /**
  64      * Constructor of TCPHandler that listens on selected port.
  65      *
  66      * @param port listening port of TCPHandler server
  67      */
  68     public TcpHandler(final int port, final Runnable readyRunnable) {
  69         this(null, port, readyRunnable);
  70     }
  71
  72     /**
  73      * Constructor of TCPHandler that listens on selected address and port.
  74      * @param address listening address of TCPHandler server
  75      * @param port listening port of TCPHandler server
  76      */
  77     public TcpHandler(final InetAddress address, final int port, final Runnable readyRunnable) {
  78         this.port = port;
  79         startupAddress = address;
  80         this.readyRunnable = readyRunnable;
  81     }
  82
  83     /**
  84      * Starts server on selected port.
  85      */
  86     @Override
  87     @SuppressWarnings("checkstyle:IllegalCatch")
  88     public void run() {
  89         /*
  90          * We generally do not perform IO-unrelated tasks, so we want to have
  91          * all outstanding tasks completed before the executing thread goes
  92          * back into select.
  93          *
  94          * Any other setting means netty will measure the time it spent selecting
  95          * and spend roughly proportional time executing tasks.
  96          */
  97         //workerGroup.setIoRatio(100);
  98
  99         final ChannelFuture f;
 100         try {
 101             ServerBootstrap bootstrap = new ServerBootstrap();
 102             bootstrap.group(bossGroup, workerGroup)
 103                     .channel(socketChannelClass)
 104                     .handler(new LoggingHandler(LogLevel.DEBUG))
 105                     .childHandler(channelInitializer)
 106                     .option(ChannelOption.SO_BACKLOG, 128)
 107                     .option(ChannelOption.SO_REUSEADDR, true)
 108                     .childOption(ChannelOption.SO_KEEPALIVE, true)
 109                     .childOption(ChannelOption.TCP_NODELAY , true)
 110                     .childOption(ChannelOption.ALLOCATOR, PooledByteBufAllocator.DEFAULT)
 111                     .childOption(ChannelOption.WRITE_BUFFER_WATER_MARK,
 112                             new WriteBufferWaterMark(DEFAULT_WRITE_LOW_WATERMARK, DEFAULT_WRITE_HIGH_WATERMARK))
 113                     .childOption(ChannelOption.WRITE_SPIN_COUNT, DEFAULT_WRITE_SPIN_COUNT);
 114
 115             if (startupAddress != null) {
 116                 f = bootstrap.bind(startupAddress.getHostAddress(), port).sync();
 117             } else {
 118                 f = bootstrap.bind(port).sync();
 119             }
 120         } catch (InterruptedException e) {
 121             LOG.error("Interrupted while binding port {}", port, e);
 122             return;
 123         } catch (Throwable throwable) {
 124             // sync() re-throws exceptions declared as Throwable, so the compiler doesn't see them
 125             LOG.error("Error while binding address {} and port {}", startupAddress, port, throwable);
 126             throw throwable;
 127         }
 128
 129         try {
 130             InetSocketAddress isa = (InetSocketAddress) f.channel().localAddress();
 131             address = isa.getHostString();
 132
 133             // Update port, as it may have been specified as 0
 134             port = isa.getPort();
 135
 136             LOG.debug("address from tcphandler: {}", address);
 137             LOG.info("Switch listener started and ready to accept incoming tcp/tls connections on port: {}", port);
 138             readyRunnable.run();
 139             isOnlineFuture.set(true);
 140
 141             // This waits until this channel is closed, and rethrows the cause of the failure if this future failed.
 142             f.channel().closeFuture().sync();
 143         } catch (InterruptedException e) {
 144             LOG.error("Interrupted while waiting for port {} shutdown", port, e);
 145         } finally {
 146             shutdown();
 147         }
 148     }
 149
 150     /**
 151      * Shuts down {@link TcpHandler}}.
 152      */
 153     @Override
 154     public ListenableFuture<Boolean> shutdown() {
 155         final SettableFuture<Boolean> result = SettableFuture.create();
 156         workerGroup.shutdownGracefully();
 157         // boss will shutdown as soon, as worker is down
 158         bossGroup.shutdownGracefully().addListener(downResult -> {
 159             result.set(downResult.isSuccess());
 160             if (downResult.cause() != null) {
 161                 result.setException(downResult.cause());
 162             }
 163         });
 164         return result;
 165     }
 166
 167     /**
 168      * Returns the number of connected clients / channels.
 169      *
 170      * @return number of connected clients / channels
 171      */
 172     public int getNumberOfConnections() {
 173         return channelInitializer.size();
 174     }
 175
 176     @Override
 177     public ListenableFuture<Boolean> getIsOnlineFuture() {
 178         return isOnlineFuture;
 179     }
 180
 181     public int getPort() {
 182         return port;
 183     }
 184
 185     public String getAddress() {
 186         return address;
 187     }
 188
 189     public void setChannelInitializer(final TcpChannelInitializer channelInitializer) {
 190         this.channelInitializer = channelInitializer;
 191     }
 192
 193     @Override
 194     @Deprecated(since = "0.17.2", forRemoval = true)
 195     public void setThreadConfig(final ThreadConfiguration threadConfig) {
 196         // No-op
 197     }
 198
 199     /**
 200      * Initiate event loop groups.
 201      *
 202      * @param threadConfiguration number of threads to be created, if not specified in threadConfig
 203      */
 204     public void initiateEventLoopGroups(final ThreadConfiguration threadConfiguration, final boolean isEpollEnabled) {
 205         if (isEpollEnabled) {
 206             initiateEpollEventLoopGroups(threadConfiguration);
 207         } else {
 208             initiateNioEventLoopGroups(threadConfiguration);
 209         }
 210     }
 211
 212     /**
 213      * Initiate Nio event loop groups.
 214      *
 215      * @param threadConfiguration number of threads to be created, if not specified in threadConfig
 216      */
 217     public void initiateNioEventLoopGroups(final ThreadConfiguration threadConfiguration) {
 218         socketChannelClass = NioServerSocketChannel.class;
 219         if (threadConfiguration != null) {
 220             bossGroup = new NioEventLoopGroup(threadConfiguration.getBossThreadCount());
 221             workerGroup = new NioEventLoopGroup(threadConfiguration.getWorkerThreadCount());
 222         } else {
 223             bossGroup = new NioEventLoopGroup();
 224             workerGroup = new NioEventLoopGroup();
 225         }
 226         ((NioEventLoopGroup)workerGroup).setIoRatio(100);
 227     }
 228
 229     /**
 230      * Initiate Epoll event loop groups with Nio as fall back.
 231      *
 232      * @param threadConfiguration the ThreadConfiguration
 233      */
 234     @SuppressWarnings("checkstyle:IllegalCatch")
 235     protected void initiateEpollEventLoopGroups(final ThreadConfiguration threadConfiguration) {
 236         try {
 237             socketChannelClass = EpollServerSocketChannel.class;
 238             if (threadConfiguration != null) {
 239                 bossGroup = new EpollEventLoopGroup(threadConfiguration.getBossThreadCount());
 240                 workerGroup = new EpollEventLoopGroup(threadConfiguration.getWorkerThreadCount());
 241             } else {
 242                 bossGroup = new EpollEventLoopGroup();
 243                 workerGroup = new EpollEventLoopGroup();
 244             }
 245             ((EpollEventLoopGroup)workerGroup).setIoRatio(100);
 246             return;
 247         } catch (RuntimeException ex) {
 248             LOG.debug("Epoll initiation failed");
 249         }
 250
 251         //Fallback mechanism
 252         initiateNioEventLoopGroups(threadConfiguration);
 253     }
 254
 255     public EventLoopGroup getWorkerGroup() {
 256         return workerGroup;
 257     }
 258 }