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 io.netty.bootstrap.ServerBootstrap;
  12 import io.netty.buffer.PooledByteBufAllocator;
  13 import io.netty.channel.ChannelFuture;
  14 import io.netty.channel.ChannelOption;
  15 import io.netty.channel.nio.NioEventLoopGroup;
  16 import io.netty.channel.socket.nio.NioServerSocketChannel;
  17 import io.netty.handler.logging.LogLevel;
  18 import io.netty.handler.logging.LoggingHandler;
  19 import io.netty.util.concurrent.GenericFutureListener;
  20
  21 import java.net.InetAddress;
  22 import java.net.InetSocketAddress;
  23
  24 import org.opendaylight.openflowjava.protocol.api.connection.ThreadConfiguration;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 import com.google.common.util.concurrent.ListenableFuture;
  29 import com.google.common.util.concurrent.SettableFuture;
  30
  31 /**
  32  * Class implementing server over TCP / TLS for handling incoming connections.
  33  *
  34  * @author michal.polkorab
  35  */
  36 public class TcpHandler implements ServerFacade {
  37     /*
  38      * High/low write watermarks, in KiB.
  39      */
  40     private static final int DEFAULT_WRITE_HIGH_WATERMARK = 64;
  41     private static final int DEFAULT_WRITE_LOW_WATERMARK = 32;
  42     /*
  43      * Write spin count. This tells netty to immediately retry a non-blocking
  44      * write this many times before moving on to selecting.
  45      */
  46     private static final int DEFAULT_WRITE_SPIN_COUNT = 16;
  47
  48     private static final Logger LOGGER = LoggerFactory.getLogger(TcpHandler.class);
  49
  50     private int port;
  51     private String address;
  52     private final InetAddress startupAddress;
  53     private NioEventLoopGroup workerGroup;
  54     private NioEventLoopGroup bossGroup;
  55     private final SettableFuture<Boolean> isOnlineFuture;
  56     private ThreadConfiguration threadConfig;
  57
  58     private TcpChannelInitializer channelInitializer;
  59
  60     /**
  61      * Constructor of TCPHandler that listens on selected port.
  62      *
  63      * @param port listening port of TCPHandler server
  64      */
  65     public TcpHandler(final int port) {
  66         this(null, port);
  67     }
  68
  69     /**
  70      * Constructor of TCPHandler that listens on selected address and port.
  71      * @param address listening address of TCPHandler server
  72      * @param port listening port of TCPHandler server
  73      */
  74     public TcpHandler(final InetAddress address, final int port) {
  75         this.port = port;
  76         this.startupAddress = address;
  77         isOnlineFuture = SettableFuture.create();
  78     }
  79
  80     /**
  81      * Starts server on selected port.
  82      */
  83     @Override
  84     public void run() {
  85         /*
  86          * We generally do not perform IO-unrelated tasks, so we want to have
  87          * all outstanding tasks completed before the executing thread goes
  88          * back into select.
  89          *
  90          * Any other setting means netty will measure the time it spent selecting
  91          * and spend roughly proportional time executing tasks.
  92          */
  93         workerGroup.setIoRatio(100);
  94
  95         final ChannelFuture f;
  96         try {
  97             ServerBootstrap b = new ServerBootstrap();
  98             b.group(bossGroup, workerGroup)
  99                     .channel(NioServerSocketChannel.class)
 100                     .handler(new LoggingHandler(LogLevel.DEBUG))
 101                     .childHandler(channelInitializer)
 102                     .option(ChannelOption.SO_BACKLOG, 128)
 103                     .option(ChannelOption.SO_REUSEADDR, true)
 104                     .childOption(ChannelOption.SO_KEEPALIVE, true)
 105                     .childOption(ChannelOption.ALLOCATOR, PooledByteBufAllocator.DEFAULT)
 106                     .childOption(ChannelOption.WRITE_BUFFER_HIGH_WATER_MARK, DEFAULT_WRITE_HIGH_WATERMARK * 1024)
 107                     .childOption(ChannelOption.WRITE_BUFFER_LOW_WATER_MARK, DEFAULT_WRITE_LOW_WATERMARK * 1024)
 108                     .childOption(ChannelOption.WRITE_SPIN_COUNT, DEFAULT_WRITE_SPIN_COUNT);
 109
 110             if (startupAddress != null) {
 111                 f = b.bind(startupAddress.getHostAddress(), port).sync();
 112             } else {
 113                 f = b.bind(port).sync();
 114             }
 115         } catch (InterruptedException e) {
 116             LOGGER.error("Interrupted while binding port {}", port, e);
 117             return;
 118         }
 119
 120         try {
 121             InetSocketAddress isa = (InetSocketAddress) f.channel().localAddress();
 122             address = isa.getHostString();
 123
 124             // Update port, as it may have been specified as 0
 125             this.port = isa.getPort();
 126
 127             LOGGER.debug("address from tcphandler: {}", address);
 128             isOnlineFuture.set(true);
 129             LOGGER.info("Switch listener started and ready to accept incoming tcp/tls connections on port: {}", port);
 130             f.channel().closeFuture().sync();
 131         } catch (InterruptedException e) {
 132             LOGGER.error("Interrupted while waiting for port {} shutdown", port, e);
 133         } finally {
 134             shutdown();
 135         }
 136     }
 137
 138     /**
 139      * Shuts down {@link TcpHandler}}
 140      */
 141     @Override
 142     public ListenableFuture<Boolean> shutdown() {
 143         final SettableFuture<Boolean> result = SettableFuture.create();
 144         workerGroup.shutdownGracefully();
 145         // boss will shutdown as soon, as worker is down
 146         bossGroup.shutdownGracefully().addListener(new GenericFutureListener<io.netty.util.concurrent.Future<Object>>() {
 147
 148             @Override
 149             public void operationComplete(
 150                     final io.netty.util.concurrent.Future<Object> downResult) throws Exception {
 151                 result.set(downResult.isSuccess());
 152                 if (downResult.cause() != null) {
 153                     result.setException(downResult.cause());
 154                 }
 155             }
 156
 157         });
 158         return result;
 159     }
 160
 161     /**
 162      *
 163      * @return number of connected clients / channels
 164      */
 165     public int getNumberOfConnections() {
 166         return channelInitializer.size();
 167     }
 168
 169     @Override
 170     public ListenableFuture<Boolean> getIsOnlineFuture() {
 171         return isOnlineFuture;
 172     }
 173
 174     /**
 175      * @return the port
 176      */
 177     public int getPort() {
 178         return port;
 179     }
 180
 181     /**
 182      * @return the address
 183      */
 184     public String getAddress() {
 185         return address;
 186     }
 187
 188     /**
 189      * @param channelInitializer
 190      */
 191     public void setChannelInitializer(TcpChannelInitializer channelInitializer) {
 192         this.channelInitializer = channelInitializer;
 193     }
 194
 195     @Override
 196     public void setThreadConfig(ThreadConfiguration threadConfig) {
 197         this.threadConfig = threadConfig;
 198     }
 199
 200     /**
 201      * Initiate event loop groups
 202      * @param threadConfiguration number of threads to be created, if not specified in threadConfig
 203      */
 204     public void initiateEventLoopGroups(ThreadConfiguration threadConfiguration) {
 205         if (threadConfiguration != null) {
 206             bossGroup = new NioEventLoopGroup(threadConfiguration.getBossThreadCount());
 207             workerGroup = new NioEventLoopGroup(threadConfiguration.getWorkerThreadCount());
 208         } else {
 209             bossGroup = new NioEventLoopGroup();
 210             workerGroup = new NioEventLoopGroup();
 211         }
 212     }
 213
 214     /**
 215      * @return workerGroup
 216      */
 217     public NioEventLoopGroup getWorkerGroup() {
 218         return workerGroup;
 219     }
 220
 221 }