Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix scalability issue due to checkcast on context's invoke operations #12806

Merged
merged 5 commits into from Sep 27, 2022
Merged

Fix scalability issue due to checkcast on context's invoke operations #12806

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b0ddc0a
Fix scalability issue due to checkcast on context's invoke operations
franz1981 Sep 15, 2022
747e470
Improved style and comments
franz1981 Sep 16, 2022
8e0185c
Micro-benchmark
franz1981 Sep 20, 2022
e67fb4b
Adding duplex/non-duplex
franz1981 Sep 26, 2022
3edcb9d
Addressing scalability of HeadContext
franz1981 Sep 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
109 changes: 109 additions & 0 deletions ...c/main/java/io/netty/microbench/channel/DefaultChannelPipelineDuplexHandlerBenchmark.java
View file
Open in desktop
@@ -0,0 +1,109 @@
/*
* Copyright 2022 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:
*
* https://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.microbench.channel;

import io.netty.channel.ChannelDuplexHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.embedded.EmbeddedChannel;
import io.netty.microbench.util.AbstractMicrobenchmark;
import io.netty.util.internal.PlatformDependent;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.Measurement;
import org.openjdk.jmh.annotations.Scope;
import org.openjdk.jmh.annotations.Setup;
import org.openjdk.jmh.annotations.State;
import org.openjdk.jmh.annotations.TearDown;
import org.openjdk.jmh.annotations.Threads;
import org.openjdk.jmh.annotations.Warmup;
import org.openjdk.jmh.infra.Blackhole;
import org.openjdk.jmh.profile.LinuxPerfAsmProfiler;
import org.openjdk.jmh.profile.LinuxPerfC2CProfiler;
import org.openjdk.jmh.runner.options.ChainedOptionsBuilder;

@Warmup(iterations = 5, time = 1)
@Measurement(iterations = 5, time = 1)
@State(Scope.Thread)
public class DefaultChannelPipelineDuplexHandlerBenchmark extends AbstractMicrobenchmark {

private ChannelPipeline pipeline;
private EmbeddedChannel channel;

@Setup
public void setup() {
channel = new EmbeddedChannel() {
@Override
public void runPendingTasks() {
// NO-OP to reduce noise on flush
}
};
// disabling auto-read to reduce noise on flush
channel.config().setAutoRead(false);
pipeline = channel.pipeline();
pipeline.addLast(new ChannelInboundHandlerAdapter() {
@Override
public void channelReadComplete(final ChannelHandlerContext ctx) {
ctx.fireChannelReadComplete();
}
});
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
pipeline.addLast(new ChannelDuplexHandler() {
@Override
public void channelReadComplete(final ChannelHandlerContext ctx) {
ctx.fireChannelReadComplete();
}

@Override
public void flush(final ChannelHandlerContext ctx) {
ctx.flush();
}
});
pipeline.addLast(new ChannelDuplexHandler() {
@Override
public void channelReadComplete(final ChannelHandlerContext ctx) {
ctx.flush();
}
});
}

@TearDown
public void tearDown() {
pipeline.channel().close();
}

@Benchmark
public void propagateEvent(Blackhole hole) {
hole.consume(pipeline.fireChannelReadComplete());
}

@Benchmark
@Threads(4)
public void parallelPropagateEvent(Blackhole hole) {
hole.consume(pipeline.fireChannelReadComplete());
}

@Override
protected ChainedOptionsBuilder newOptionsBuilder() throws Exception {
if (PlatformDependent.isOsx() || PlatformDependent.isWindows()) {
return super.newOptionsBuilder();
}
return super.newOptionsBuilder()
.addProfiler(LinuxPerfAsmProfiler.class)
.addProfiler(LinuxPerfC2CProfiler.class);
}
}
160 changes: 144 additions & 16 deletions transport/src/main/java/io/netty/channel/AbstractChannelHandlerContext.java
View file
Open in desktop
Expand Up @@ -163,7 +163,15 @@ public void run() {
private void invokeChannelRegistered() {
if (invokeHandler()) {
try {
((ChannelInboundHandler) handler()).channelRegistered(this);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
franz1981 marked this conversation as resolved.
Show resolved Hide resolved
((ChannelDuplexHandler) handler).channelRegistered(this);
} else {
((ChannelInboundHandler) handler).channelRegistered(this);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -195,7 +203,15 @@ public void run() {
private void invokeChannelUnregistered() {
if (invokeHandler()) {
try {
((ChannelInboundHandler) handler()).channelUnregistered(this);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).channelUnregistered(this);
} else {
((ChannelInboundHandler) handler).channelUnregistered(this);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -227,7 +243,15 @@ public void run() {
private void invokeChannelActive() {
if (invokeHandler()) {
try {
((ChannelInboundHandler) handler()).channelActive(this);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).channelActive(this);
} else {
((ChannelInboundHandler) handler).channelActive(this);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -259,7 +283,15 @@ public void run() {
private void invokeChannelInactive() {
if (invokeHandler()) {
try {
((ChannelInboundHandler) handler()).channelInactive(this);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).channelInactive(this);
} else {
((ChannelInboundHandler) handler).channelInactive(this);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -343,7 +375,15 @@ public void run() {
private void invokeUserEventTriggered(Object event) {
if (invokeHandler()) {
try {
((ChannelInboundHandler) handler()).userEventTriggered(this, event);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).userEventTriggered(this, event);
} else {
((ChannelInboundHandler) handler).userEventTriggered(this, event);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -376,7 +416,15 @@ public void run() {
private void invokeChannelRead(Object msg) {
if (invokeHandler()) {
try {
((ChannelInboundHandler) handler()).channelRead(this, msg);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).channelRead(this, msg);
} else {
((ChannelInboundHandler) handler).channelRead(this, msg);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -407,7 +455,15 @@ static void invokeChannelReadComplete(final AbstractChannelHandlerContext next)
private void invokeChannelReadComplete() {
if (invokeHandler()) {
try {
((ChannelInboundHandler) handler()).channelReadComplete(this);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).channelReadComplete(this);
} else {
((ChannelInboundHandler) handler).channelReadComplete(this);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -438,7 +494,15 @@ static void invokeChannelWritabilityChanged(final AbstractChannelHandlerContext
private void invokeChannelWritabilityChanged() {
if (invokeHandler()) {
try {
((ChannelInboundHandler) handler()).channelWritabilityChanged(this);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).channelWritabilityChanged(this);
} else {
((ChannelInboundHandler) handler).channelWritabilityChanged(this);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -503,7 +567,15 @@ public void run() {
private void invokeBind(SocketAddress localAddress, ChannelPromise promise) {
if (invokeHandler()) {
try {
((ChannelOutboundHandler) handler()).bind(this, localAddress, promise);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).bind(this, localAddress, promise);
} else {
((ChannelOutboundHandler) handler).bind(this, localAddress, promise);
}
} catch (Throwable t) {
notifyOutboundHandlerException(t, promise);
}
Expand Down Expand Up @@ -545,7 +617,15 @@ public void run() {
private void invokeConnect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) {
if (invokeHandler()) {
try {
((ChannelOutboundHandler) handler()).connect(this, remoteAddress, localAddress, promise);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).connect(this, remoteAddress, localAddress, promise);
} else {
((ChannelOutboundHandler) handler).connect(this, remoteAddress, localAddress, promise);
}
} catch (Throwable t) {
notifyOutboundHandlerException(t, promise);
}
Expand Down Expand Up @@ -584,7 +664,15 @@ public void run() {
private void invokeDisconnect(ChannelPromise promise) {
if (invokeHandler()) {
try {
((ChannelOutboundHandler) handler()).disconnect(this, promise);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).disconnect(this, promise);
} else {
((ChannelOutboundHandler) handler).disconnect(this, promise);
}
} catch (Throwable t) {
notifyOutboundHandlerException(t, promise);
}
Expand Down Expand Up @@ -619,7 +707,15 @@ public void run() {
private void invokeClose(ChannelPromise promise) {
if (invokeHandler()) {
try {
((ChannelOutboundHandler) handler()).close(this, promise);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).close(this, promise);
} else {
((ChannelOutboundHandler) handler).close(this, promise);
}
} catch (Throwable t) {
notifyOutboundHandlerException(t, promise);
}
Expand Down Expand Up @@ -654,7 +750,15 @@ public void run() {
private void invokeDeregister(ChannelPromise promise) {
if (invokeHandler()) {
try {
((ChannelOutboundHandler) handler()).deregister(this, promise);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).deregister(this, promise);
} else {
((ChannelOutboundHandler) handler).deregister(this, promise);
}
} catch (Throwable t) {
notifyOutboundHandlerException(t, promise);
}
Expand Down Expand Up @@ -683,7 +787,15 @@ public ChannelHandlerContext read() {
private void invokeRead() {
if (invokeHandler()) {
try {
((ChannelOutboundHandler) handler()).read(this);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).read(this);
} else {
((ChannelOutboundHandler) handler).read(this);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down Expand Up @@ -714,7 +826,15 @@ void invokeWrite(Object msg, ChannelPromise promise) {

private void invokeWrite0(Object msg, ChannelPromise promise) {
try {
((ChannelOutboundHandler) handler()).write(this, msg, promise);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).write(this, msg, promise);
} else {
((ChannelOutboundHandler) handler).write(this, msg, promise);
}
} catch (Throwable t) {
notifyOutboundHandlerException(t, promise);
}
Expand Down Expand Up @@ -747,7 +867,15 @@ private void invokeFlush() {

private void invokeFlush0() {
try {
((ChannelOutboundHandler) handler()).flush(this);
final ChannelHandler handler = handler();
// DON'T CHANGE
// Duplex handlers implements both out/in interfaces causing a scalability issue
// see https://bugs.openjdk.org/browse/JDK-8180450
if (handler instanceof ChannelDuplexHandler) {
((ChannelDuplexHandler) handler).flush(this);
} else {
((ChannelOutboundHandler) handler).flush(this);
}
} catch (Throwable t) {
invokeExceptionCaught(t);
}
Expand Down