package org.opendaylight.openflowjava.protocol.impl.core;
import io.netty.bootstrap.ServerBootstrap;
+import io.netty.buffer.PooledByteBufAllocator;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelOption;
import io.netty.channel.nio.NioEventLoopGroup;
+import io.netty.channel.socket.ServerSocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.logging.LogLevel;
import io.netty.handler.logging.LoggingHandler;
import io.netty.util.concurrent.GenericFutureListener;
+import io.netty.channel.epoll.Epoll;
+import io.netty.channel.EventLoopGroup;
+import io.netty.channel.epoll.EpollEventLoopGroup;
+import io.netty.channel.epoll.EpollServerSocketChannel;
+
import java.net.InetAddress;
import java.net.InetSocketAddress;
-import org.opendaylight.openflowjava.protocol.api.connection.SwitchConnectionHandler;
-import org.opendaylight.openflowjava.protocol.impl.connection.ServerFacade;
+import org.opendaylight.openflowjava.protocol.api.connection.ThreadConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.util.concurrent.SettableFuture;
/**
- * Class implementing server over TCP for handling incoming connections.
+ * Class implementing server over TCP / TLS for handling incoming connections.
*
* @author michal.polkorab
*/
public class TcpHandler implements ServerFacade {
+ /*
+ * High/low write watermarks, in KiB.
+ */
+ private static final int DEFAULT_WRITE_HIGH_WATERMARK = 64;
+ private static final int DEFAULT_WRITE_LOW_WATERMARK = 32;
+ /*
+ * Write spin count. This tells netty to immediately retry a non-blocking
+ * write this many times before moving on to selecting.
+ */
+ private static final int DEFAULT_WRITE_SPIN_COUNT = 16;
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(TcpHandler.class);
private int port;
private String address;
- private InetAddress startupAddress;
- private NioEventLoopGroup workerGroup;
- private NioEventLoopGroup bossGroup;
- private static final Logger LOGGER = LoggerFactory.getLogger(TcpHandler.class);
- private SettableFuture<Boolean> isOnlineFuture;
-
-
- private PublishingChannelInitializer channelInitializer;
+ private final InetAddress startupAddress;
+ private EventLoopGroup workerGroup;
+ private EventLoopGroup bossGroup;
+ private final SettableFuture<Boolean> isOnlineFuture;
+ private ThreadConfiguration threadConfig;
- /**
- * Enum used for storing names of used components (in pipeline).
- */
- public static enum COMPONENT_NAMES {
+ private TcpChannelInitializer channelInitializer;
- /**
- * Detects switch idle state
- */
- IDLE_HANDLER,
- /**
- * Detects TLS connections
- */
- TLS_DETECTOR,
- /**
- * Component for handling TLS frames
- */
- SSL_HANDLER,
- /**
- * Decodes incoming messages into message frames
- */
- OF_FRAME_DECODER,
- /**
- * Detects version of incoming OpenFlow Protocol message
- */
- OF_VERSION_DETECTOR,
- /**
- * Transforms OpenFlow Protocol byte messages into POJOs
- */
- OF_DECODER,
- /**
- * Transforms POJOs into OpenFlow Protocol byte messages
- */
- OF_ENCODER,
- /**
- * Delegates translated POJOs into MessageConsumer
- */
- DELEGATING_INBOUND_HANDLER,
- }
-
+ private Class<? extends ServerSocketChannel> socketChannelClass;
/**
* Constructor of TCPHandler that listens on selected port.
*
* @param port listening port of TCPHandler server
*/
- public TcpHandler(int port) {
+ public TcpHandler(final int port) {
this(null, port);
}
-
+
/**
* Constructor of TCPHandler that listens on selected address and port.
* @param address listening address of TCPHandler server
* @param port listening port of TCPHandler server
*/
- public TcpHandler(InetAddress address, int port) {
+ public TcpHandler(final InetAddress address, final int port) {
this.port = port;
this.startupAddress = address;
- channelInitializer = new PublishingChannelInitializer();
isOnlineFuture = SettableFuture.create();
}
*/
@Override
public void run() {
- bossGroup = new NioEventLoopGroup();
- workerGroup = new NioEventLoopGroup();
+ /*
+ * We generally do not perform IO-unrelated tasks, so we want to have
+ * all outstanding tasks completed before the executing thread goes
+ * back into select.
+ *
+ * Any other setting means netty will measure the time it spent selecting
+ * and spend roughly proportional time executing tasks.
+ */
+ //workerGroup.setIoRatio(100);
+
+ final ChannelFuture f;
try {
ServerBootstrap b = new ServerBootstrap();
b.group(bossGroup, workerGroup)
- .channel(NioServerSocketChannel.class)
+ .channel(socketChannelClass)
.handler(new LoggingHandler(LogLevel.DEBUG))
.childHandler(channelInitializer)
.option(ChannelOption.SO_BACKLOG, 128)
.option(ChannelOption.SO_REUSEADDR, true)
- .childOption(ChannelOption.SO_KEEPALIVE, true);
+ .childOption(ChannelOption.SO_KEEPALIVE, true)
+ .childOption(ChannelOption.TCP_NODELAY , true)
+ .childOption(ChannelOption.ALLOCATOR, PooledByteBufAllocator.DEFAULT)
+ .childOption(ChannelOption.WRITE_BUFFER_HIGH_WATER_MARK, DEFAULT_WRITE_HIGH_WATERMARK * 1024)
+ .childOption(ChannelOption.WRITE_BUFFER_LOW_WATER_MARK, DEFAULT_WRITE_LOW_WATERMARK * 1024)
+ .childOption(ChannelOption.WRITE_SPIN_COUNT, DEFAULT_WRITE_SPIN_COUNT);
- ChannelFuture f;
if (startupAddress != null) {
f = b.bind(startupAddress.getHostAddress(), port).sync();
} else {
f = b.bind(port).sync();
}
-
+ } catch (InterruptedException e) {
+ LOGGER.error("Interrupted while binding port {}", port, e);
+ return;
+ }
+
+ try {
InetSocketAddress isa = (InetSocketAddress) f.channel().localAddress();
address = isa.getHostString();
- LOGGER.debug("address from tcphandler: " + address);
- port = isa.getPort();
+
+ // Update port, as it may have been specified as 0
+ this.port = isa.getPort();
+
+ LOGGER.debug("address from tcphandler: {}", address);
isOnlineFuture.set(true);
- LOGGER.info("Switch listener started and ready to accept incoming connections on port: " + port);
+ LOGGER.info("Switch listener started and ready to accept incoming tcp/tls connections on port: {}", port);
f.channel().closeFuture().sync();
- } catch (InterruptedException ex) {
- LOGGER.error(ex.getMessage(), ex);
+ } catch (InterruptedException e) {
+ LOGGER.error("Interrupted while waiting for port {} shutdown", port, e);
} finally {
shutdown();
}
@Override
public void operationComplete(
- io.netty.util.concurrent.Future<Object> downResult) throws Exception {
+ final io.netty.util.concurrent.Future<Object> downResult) throws Exception {
result.set(downResult.isSuccess());
if (downResult.cause() != null) {
result.setException(downResult.cause());
}
}
-
+
});
return result;
}
-
+
/**
- *
+ *
* @return number of connected clients / channels
*/
public int getNumberOfConnections() {
return channelInitializer.size();
}
-
- /**
- * @return channelInitializer providing channels
- */
- public PublishingChannelInitializer getChannelInitializer() {
- return channelInitializer;
- }
-
+
@Override
public ListenableFuture<Boolean> getIsOnlineFuture() {
return isOnlineFuture;
}
-
+
/**
* @return the port
*/
public int getPort() {
return port;
}
-
+
/**
* @return the address
*/
}
/**
- * @param switchConnectionHandler
+ * @param channelInitializer
*/
- public void setSwitchConnectionHandler(
- SwitchConnectionHandler switchConnectionHandler) {
- channelInitializer.setSwitchConnectionHandler(switchConnectionHandler);
+ public void setChannelInitializer(TcpChannelInitializer channelInitializer) {
+ this.channelInitializer = channelInitializer;
+ }
+
+ @Override
+ public void setThreadConfig(ThreadConfiguration threadConfig) {
+ this.threadConfig = threadConfig;
}
-
+
/**
- * @param switchIdleTimeout in milliseconds
+ * Initiate event loop groups
+ * @param threadConfiguration number of threads to be created, if not specified in threadConfig
*/
- public void setSwitchIdleTimeout(long switchIdleTimeout) {
- channelInitializer.setSwitchIdleTimeout(switchIdleTimeout);
+ public void initiateEventLoopGroups(ThreadConfiguration threadConfiguration, boolean isEpollEnabled) {
+
+ if(isEpollEnabled) {
+ initiateEpollEventLoopGroups(threadConfiguration);
+ } else {
+ initiateNioEventLoopGroups(threadConfiguration);
+ }
}
/**
- * @param tlsSupported
+ * Initiate Nio event loop groups
+ * @param threadConfiguration number of threads to be created, if not specified in threadConfig
*/
- public void setEncryption(boolean tlsSupported) {
- channelInitializer.setEncryption(tlsSupported);
+ public void initiateNioEventLoopGroups(ThreadConfiguration threadConfiguration) {
+ socketChannelClass = NioServerSocketChannel.class;
+ if (threadConfiguration != null) {
+ bossGroup = new NioEventLoopGroup(threadConfiguration.getBossThreadCount());
+ workerGroup = new NioEventLoopGroup(threadConfiguration.getWorkerThreadCount());
+ } else {
+ bossGroup = new NioEventLoopGroup();
+ workerGroup = new NioEventLoopGroup();
+ }
+ ((NioEventLoopGroup)workerGroup).setIoRatio(100);
}
-
+
+ /**
+ * Initiate Epoll event loop groups with Nio as fall back
+ * @param threadConfiguration
+ */
+ protected void initiateEpollEventLoopGroups(ThreadConfiguration threadConfiguration) {
+ try {
+ socketChannelClass = EpollServerSocketChannel.class;
+ if (threadConfiguration != null) {
+ bossGroup = new EpollEventLoopGroup(threadConfiguration.getBossThreadCount());
+ workerGroup = new EpollEventLoopGroup(threadConfiguration.getWorkerThreadCount());
+ } else {
+ bossGroup = new EpollEventLoopGroup();
+ workerGroup = new EpollEventLoopGroup();
+ }
+ ((EpollEventLoopGroup)workerGroup).setIoRatio(100);
+ return;
+ } catch (Throwable ex) {
+ LOGGER.debug("Epoll initiation failed");
+ }
+
+ //Fallback mechanism
+ initiateNioEventLoopGroups(threadConfiguration);
+ }
+
+ /**
+ * @return workerGroup
+ */
+ public EventLoopGroup getWorkerGroup() {
+ return workerGroup;
+ }
+
}