bce0784e5e
Motivation: testWriteTaskRejected was racy as we did not ensure we dispatched all events to the executor before shutting it down. Modifications: Add a latch to ensure we dispatched everything. Result: Fix racy test that failed sometimes before.
472 lines
16 KiB
Java
472 lines
16 KiB
Java
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
package io.netty.channel;
|
|
|
|
import io.netty.buffer.ByteBuf;
|
|
import io.netty.buffer.CompositeByteBuf;
|
|
import io.netty.channel.embedded.EmbeddedChannel;
|
|
import io.netty.util.CharsetUtil;
|
|
import io.netty.util.concurrent.DefaultThreadFactory;
|
|
import io.netty.util.concurrent.RejectedExecutionHandlers;
|
|
import io.netty.util.concurrent.SingleThreadEventExecutor;
|
|
import org.junit.Test;
|
|
|
|
import java.net.SocketAddress;
|
|
import java.nio.ByteBuffer;
|
|
import java.util.Queue;
|
|
import java.util.concurrent.CountDownLatch;
|
|
import java.util.concurrent.RejectedExecutionException;
|
|
|
|
import static io.netty.buffer.Unpooled.*;
|
|
import static org.hamcrest.Matchers.*;
|
|
import static org.junit.Assert.*;
|
|
|
|
public class ChannelOutboundBufferTest {
|
|
|
|
@Test
|
|
public void testEmptyNioBuffers() {
|
|
TestChannel channel = new TestChannel();
|
|
ChannelOutboundBuffer buffer = new ChannelOutboundBuffer(channel);
|
|
assertEquals(0, buffer.nioBufferCount());
|
|
ByteBuffer[] buffers = buffer.nioBuffers();
|
|
assertNotNull(buffers);
|
|
for (ByteBuffer b: buffers) {
|
|
assertNull(b);
|
|
}
|
|
assertEquals(0, buffer.nioBufferCount());
|
|
release(buffer);
|
|
}
|
|
|
|
@Test
|
|
public void testNioBuffersSingleBacked() {
|
|
TestChannel channel = new TestChannel();
|
|
|
|
ChannelOutboundBuffer buffer = new ChannelOutboundBuffer(channel);
|
|
assertEquals(0, buffer.nioBufferCount());
|
|
|
|
ByteBuf buf = copiedBuffer("buf1", CharsetUtil.US_ASCII);
|
|
ByteBuffer nioBuf = buf.internalNioBuffer(buf.readerIndex(), buf.readableBytes());
|
|
buffer.addMessage(buf, buf.readableBytes(), channel.voidPromise());
|
|
assertEquals("Should still be 0 as not flushed yet", 0, buffer.nioBufferCount());
|
|
buffer.addFlush();
|
|
ByteBuffer[] buffers = buffer.nioBuffers();
|
|
assertNotNull(buffers);
|
|
assertEquals("Should still be 0 as not flushed yet", 1, buffer.nioBufferCount());
|
|
for (int i = 0; i < buffer.nioBufferCount(); i++) {
|
|
if (i == 0) {
|
|
assertEquals(buffers[i], nioBuf);
|
|
} else {
|
|
assertNull(buffers[i]);
|
|
}
|
|
}
|
|
release(buffer);
|
|
}
|
|
|
|
@Test
|
|
public void testNioBuffersExpand() {
|
|
TestChannel channel = new TestChannel();
|
|
|
|
ChannelOutboundBuffer buffer = new ChannelOutboundBuffer(channel);
|
|
|
|
ByteBuf buf = directBuffer().writeBytes("buf1".getBytes(CharsetUtil.US_ASCII));
|
|
for (int i = 0; i < 64; i++) {
|
|
buffer.addMessage(buf.copy(), buf.readableBytes(), channel.voidPromise());
|
|
}
|
|
assertEquals("Should still be 0 as not flushed yet", 0, buffer.nioBufferCount());
|
|
buffer.addFlush();
|
|
ByteBuffer[] buffers = buffer.nioBuffers();
|
|
assertEquals(64, buffer.nioBufferCount());
|
|
for (int i = 0; i < buffer.nioBufferCount(); i++) {
|
|
assertEquals(buffers[i], buf.internalNioBuffer(buf.readerIndex(), buf.readableBytes()));
|
|
}
|
|
release(buffer);
|
|
buf.release();
|
|
}
|
|
|
|
@Test
|
|
public void testNioBuffersExpand2() {
|
|
TestChannel channel = new TestChannel();
|
|
|
|
ChannelOutboundBuffer buffer = new ChannelOutboundBuffer(channel);
|
|
|
|
CompositeByteBuf comp = compositeBuffer(256);
|
|
ByteBuf buf = directBuffer().writeBytes("buf1".getBytes(CharsetUtil.US_ASCII));
|
|
for (int i = 0; i < 65; i++) {
|
|
comp.addComponent(true, buf.copy());
|
|
}
|
|
buffer.addMessage(comp, comp.readableBytes(), channel.voidPromise());
|
|
|
|
assertEquals("Should still be 0 as not flushed yet", 0, buffer.nioBufferCount());
|
|
buffer.addFlush();
|
|
ByteBuffer[] buffers = buffer.nioBuffers();
|
|
assertEquals(65, buffer.nioBufferCount());
|
|
for (int i = 0; i < buffer.nioBufferCount(); i++) {
|
|
if (i < 65) {
|
|
assertEquals(buffers[i], buf.internalNioBuffer(buf.readerIndex(), buf.readableBytes()));
|
|
} else {
|
|
assertNull(buffers[i]);
|
|
}
|
|
}
|
|
release(buffer);
|
|
buf.release();
|
|
}
|
|
|
|
private static void release(ChannelOutboundBuffer buffer) {
|
|
for (;;) {
|
|
if (!buffer.remove()) {
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
private static final class TestChannel extends AbstractChannel {
|
|
private static final ChannelMetadata TEST_METADATA = new ChannelMetadata(false);
|
|
private final ChannelConfig config = new DefaultChannelConfig(this);
|
|
|
|
TestChannel() {
|
|
super(null);
|
|
}
|
|
|
|
@Override
|
|
protected AbstractUnsafe newUnsafe() {
|
|
return new TestUnsafe();
|
|
}
|
|
|
|
@Override
|
|
protected boolean isCompatible(EventLoop loop) {
|
|
return false;
|
|
}
|
|
|
|
@Override
|
|
protected SocketAddress localAddress0() {
|
|
throw new UnsupportedOperationException();
|
|
}
|
|
|
|
@Override
|
|
protected SocketAddress remoteAddress0() {
|
|
throw new UnsupportedOperationException();
|
|
}
|
|
|
|
@Override
|
|
protected void doBind(SocketAddress localAddress) throws Exception {
|
|
throw new UnsupportedOperationException();
|
|
}
|
|
|
|
@Override
|
|
protected void doDisconnect() throws Exception {
|
|
throw new UnsupportedOperationException();
|
|
}
|
|
|
|
@Override
|
|
protected void doClose() throws Exception {
|
|
throw new UnsupportedOperationException();
|
|
}
|
|
|
|
@Override
|
|
protected void doBeginRead() throws Exception {
|
|
throw new UnsupportedOperationException();
|
|
}
|
|
|
|
@Override
|
|
protected void doWrite(ChannelOutboundBuffer in) throws Exception {
|
|
throw new UnsupportedOperationException();
|
|
}
|
|
|
|
@Override
|
|
public ChannelConfig config() {
|
|
return config;
|
|
}
|
|
|
|
@Override
|
|
public boolean isOpen() {
|
|
return true;
|
|
}
|
|
|
|
@Override
|
|
public boolean isActive() {
|
|
return true;
|
|
}
|
|
|
|
@Override
|
|
public ChannelMetadata metadata() {
|
|
return TEST_METADATA;
|
|
}
|
|
|
|
final class TestUnsafe extends AbstractUnsafe {
|
|
@Override
|
|
public void connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) {
|
|
throw new UnsupportedOperationException();
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
public void testWritability() {
|
|
final StringBuilder buf = new StringBuilder();
|
|
EmbeddedChannel ch = new EmbeddedChannel(new ChannelInboundHandlerAdapter() {
|
|
@Override
|
|
public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {
|
|
buf.append(ctx.channel().isWritable());
|
|
buf.append(' ');
|
|
}
|
|
});
|
|
|
|
ch.config().setWriteBufferLowWaterMark(128 + ChannelOutboundBuffer.CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD);
|
|
ch.config().setWriteBufferHighWaterMark(256 + ChannelOutboundBuffer.CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD);
|
|
|
|
ch.write(buffer().writeZero(128));
|
|
// Ensure exceeding the low watermark does not make channel unwritable.
|
|
ch.write(buffer().writeZero(2));
|
|
assertThat(buf.toString(), is(""));
|
|
|
|
ch.unsafe().outboundBuffer().addFlush();
|
|
|
|
// Ensure exceeding the high watermark makes channel unwritable.
|
|
ch.write(buffer().writeZero(127));
|
|
assertThat(buf.toString(), is("false "));
|
|
|
|
// Ensure going down to the low watermark makes channel writable again by flushing the first write.
|
|
assertThat(ch.unsafe().outboundBuffer().remove(), is(true));
|
|
assertThat(ch.unsafe().outboundBuffer().remove(), is(true));
|
|
assertThat(ch.unsafe().outboundBuffer().totalPendingWriteBytes(),
|
|
is(127L + ChannelOutboundBuffer.CHANNEL_OUTBOUND_BUFFER_ENTRY_OVERHEAD));
|
|
assertThat(buf.toString(), is("false true "));
|
|
|
|
safeClose(ch);
|
|
}
|
|
|
|
@Test
|
|
public void testUserDefinedWritability() {
|
|
final StringBuilder buf = new StringBuilder();
|
|
EmbeddedChannel ch = new EmbeddedChannel(new ChannelInboundHandlerAdapter() {
|
|
@Override
|
|
public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {
|
|
buf.append(ctx.channel().isWritable());
|
|
buf.append(' ');
|
|
}
|
|
});
|
|
|
|
ch.config().setWriteBufferLowWaterMark(128);
|
|
ch.config().setWriteBufferHighWaterMark(256);
|
|
|
|
ChannelOutboundBuffer cob = ch.unsafe().outboundBuffer();
|
|
|
|
// Ensure that the default value of a user-defined writability flag is true.
|
|
for (int i = 1; i <= 30; i ++) {
|
|
assertThat(cob.getUserDefinedWritability(i), is(true));
|
|
}
|
|
|
|
// Ensure that setting a user-defined writability flag to false affects channel.isWritable();
|
|
cob.setUserDefinedWritability(1, false);
|
|
ch.runPendingTasks();
|
|
assertThat(buf.toString(), is("false "));
|
|
|
|
// Ensure that setting a user-defined writability flag to true affects channel.isWritable();
|
|
cob.setUserDefinedWritability(1, true);
|
|
ch.runPendingTasks();
|
|
assertThat(buf.toString(), is("false true "));
|
|
|
|
safeClose(ch);
|
|
}
|
|
|
|
@Test
|
|
public void testUserDefinedWritability2() {
|
|
final StringBuilder buf = new StringBuilder();
|
|
EmbeddedChannel ch = new EmbeddedChannel(new ChannelInboundHandlerAdapter() {
|
|
@Override
|
|
public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {
|
|
buf.append(ctx.channel().isWritable());
|
|
buf.append(' ');
|
|
}
|
|
});
|
|
|
|
ch.config().setWriteBufferLowWaterMark(128);
|
|
ch.config().setWriteBufferHighWaterMark(256);
|
|
|
|
ChannelOutboundBuffer cob = ch.unsafe().outboundBuffer();
|
|
|
|
// Ensure that setting a user-defined writability flag to false affects channel.isWritable()
|
|
cob.setUserDefinedWritability(1, false);
|
|
ch.runPendingTasks();
|
|
assertThat(buf.toString(), is("false "));
|
|
|
|
// Ensure that setting another user-defined writability flag to false does not trigger
|
|
// channelWritabilityChanged.
|
|
cob.setUserDefinedWritability(2, false);
|
|
ch.runPendingTasks();
|
|
assertThat(buf.toString(), is("false "));
|
|
|
|
// Ensure that setting only one user-defined writability flag to true does not affect channel.isWritable()
|
|
cob.setUserDefinedWritability(1, true);
|
|
ch.runPendingTasks();
|
|
assertThat(buf.toString(), is("false "));
|
|
|
|
// Ensure that setting all user-defined writability flags to true affects channel.isWritable()
|
|
cob.setUserDefinedWritability(2, true);
|
|
ch.runPendingTasks();
|
|
assertThat(buf.toString(), is("false true "));
|
|
|
|
safeClose(ch);
|
|
}
|
|
|
|
@Test
|
|
public void testMixedWritability() {
|
|
final StringBuilder buf = new StringBuilder();
|
|
EmbeddedChannel ch = new EmbeddedChannel(new ChannelInboundHandlerAdapter() {
|
|
@Override
|
|
public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {
|
|
buf.append(ctx.channel().isWritable());
|
|
buf.append(' ');
|
|
}
|
|
});
|
|
|
|
ch.config().setWriteBufferLowWaterMark(128);
|
|
ch.config().setWriteBufferHighWaterMark(256);
|
|
|
|
ChannelOutboundBuffer cob = ch.unsafe().outboundBuffer();
|
|
|
|
// Trigger channelWritabilityChanged() by writing a lot.
|
|
ch.write(buffer().writeZero(257));
|
|
assertThat(buf.toString(), is("false "));
|
|
|
|
// Ensure that setting a user-defined writability flag to false does not trigger channelWritabilityChanged()
|
|
cob.setUserDefinedWritability(1, false);
|
|
ch.runPendingTasks();
|
|
assertThat(buf.toString(), is("false "));
|
|
|
|
// Ensure reducing the totalPendingWriteBytes down to zero does not trigger channelWritabilityChanged()
|
|
// because of the user-defined writability flag.
|
|
ch.flush();
|
|
assertThat(cob.totalPendingWriteBytes(), is(0L));
|
|
assertThat(buf.toString(), is("false "));
|
|
|
|
// Ensure that setting the user-defined writability flag to true triggers channelWritabilityChanged()
|
|
cob.setUserDefinedWritability(1, true);
|
|
ch.runPendingTasks();
|
|
assertThat(buf.toString(), is("false true "));
|
|
|
|
safeClose(ch);
|
|
}
|
|
|
|
@Test(timeout = 5000)
|
|
public void testWriteTaskRejected() throws Exception {
|
|
final SingleThreadEventExecutor executor = new SingleThreadEventExecutor(
|
|
null, new DefaultThreadFactory("executorPool"),
|
|
true, 1, RejectedExecutionHandlers.reject()) {
|
|
@Override
|
|
protected void run() {
|
|
do {
|
|
Runnable task = takeTask();
|
|
if (task != null) {
|
|
task.run();
|
|
updateLastExecutionTime();
|
|
}
|
|
} while (!confirmShutdown());
|
|
}
|
|
|
|
@Override
|
|
protected Queue<Runnable> newTaskQueue(int maxPendingTasks) {
|
|
return super.newTaskQueue(1);
|
|
}
|
|
};
|
|
final CountDownLatch handlerAddedLatch = new CountDownLatch(1);
|
|
final CountDownLatch handlerRemovedLatch = new CountDownLatch(1);
|
|
EmbeddedChannel ch = new EmbeddedChannel();
|
|
ch.pipeline().addLast(executor, "handler", new ChannelOutboundHandlerAdapter() {
|
|
@Override
|
|
public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
|
|
promise.setFailure(new AssertionError("Should not be called"));
|
|
}
|
|
|
|
@Override
|
|
public void handlerAdded(ChannelHandlerContext ctx) {
|
|
handlerAddedLatch.countDown();
|
|
}
|
|
|
|
@Override
|
|
public void handlerRemoved(ChannelHandlerContext ctx) {
|
|
handlerRemovedLatch.countDown();
|
|
}
|
|
});
|
|
|
|
// Lets wait until we are sure the handler was added.
|
|
handlerAddedLatch.await();
|
|
|
|
final CountDownLatch executeLatch = new CountDownLatch(1);
|
|
final CountDownLatch runLatch = new CountDownLatch(1);
|
|
executor.execute(new Runnable() {
|
|
@Override
|
|
public void run() {
|
|
try {
|
|
runLatch.countDown();
|
|
executeLatch.await();
|
|
} catch (InterruptedException e) {
|
|
Thread.currentThread().interrupt();
|
|
}
|
|
}
|
|
});
|
|
|
|
runLatch.await();
|
|
|
|
executor.execute(new Runnable() {
|
|
@Override
|
|
public void run() {
|
|
// Will not be executed but ensure the pending count is 1.
|
|
}
|
|
});
|
|
|
|
assertEquals(1, executor.pendingTasks());
|
|
assertEquals(0, ch.unsafe().outboundBuffer().totalPendingWriteBytes());
|
|
|
|
ByteBuf buffer = buffer(128).writeZero(128);
|
|
ChannelFuture future = ch.write(buffer);
|
|
ch.runPendingTasks();
|
|
|
|
assertTrue(future.cause() instanceof RejectedExecutionException);
|
|
assertEquals(0, buffer.refCnt());
|
|
|
|
// In case of rejected task we should not have anything pending.
|
|
assertEquals(0, ch.unsafe().outboundBuffer().totalPendingWriteBytes());
|
|
executeLatch.countDown();
|
|
|
|
while (executor.pendingTasks() != 0) {
|
|
// Wait until there is no more pending task left.
|
|
Thread.sleep(10);
|
|
}
|
|
|
|
ch.pipeline().remove("handler");
|
|
|
|
// Ensure we do not try to shutdown the executor before we handled everything for the Channel. Otherwise
|
|
// the Executor may reject when the Channel tries to add a task to it.
|
|
handlerRemovedLatch.await();
|
|
|
|
safeClose(ch);
|
|
|
|
executor.shutdownGracefully();
|
|
}
|
|
|
|
private static void safeClose(EmbeddedChannel ch) {
|
|
ch.finish();
|
|
for (;;) {
|
|
ByteBuf m = ch.readOutbound();
|
|
if (m == null) {
|
|
break;
|
|
}
|
|
m.release();
|
|
}
|
|
}
|
|
}
|