Go to file
Anuraag Agrawal 1f1a60ae7d Use Netty's DefaultPriorityQueue instead of JDK's PriorityQueue for scheduled tasks
Motivation:

`AbstractScheduledEventExecutor` uses a standard `java.util.PriorityQueue` to keep track of task deadlines. `ScheduledFuture.cancel` removes tasks from this `PriorityQueue`. Unfortunately, `PriorityQueue.remove` has `O(n)` performance since it must search for the item in the entire queue before removing it. This is fast when the future is at the front of the queue (e.g., already triggered) but not when it's randomly located in the queue.

Many servers will use `ScheduledFuture.cancel` on all requests, e.g., to manage a request timeout. As these cancellations will be happen in arbitrary order, when there are many scheduled futures, `PriorityQueue.remove` is a bottleneck and greatly hurts performance with many concurrent requests (>10K).

Modification:

Use netty's `DefaultPriorityQueue` for scheduling futures instead of the JDK. `DefaultPriorityQueue` is almost identical to the JDK version except it is able to remove futures without searching for them in the queue. This means `DefaultPriorityQueue.remove` has `O(log n)` performance.

Result:

Before - cancelling futures has varying performance, capped at `O(n)`
After - cancelling futures has stable performance, capped at `O(log n)`

Benchmark results

After - cancelling in order and in reverse order have similar performance within `O(log n)` bounds
```
Benchmark                                           (num)   Mode  Cnt       Score      Error  Units
ScheduledFutureTaskBenchmark.cancelInOrder            100  thrpt   20  137779.616 ± 7709.751  ops/s
ScheduledFutureTaskBenchmark.cancelInOrder           1000  thrpt   20   11049.448 ±  385.832  ops/s
ScheduledFutureTaskBenchmark.cancelInOrder          10000  thrpt   20     943.294 ±   12.391  ops/s
ScheduledFutureTaskBenchmark.cancelInOrder         100000  thrpt   20      64.210 ±    1.824  ops/s
ScheduledFutureTaskBenchmark.cancelInReverseOrder     100  thrpt   20  167531.096 ± 9187.865  ops/s
ScheduledFutureTaskBenchmark.cancelInReverseOrder    1000  thrpt   20   33019.786 ± 4737.770  ops/s
ScheduledFutureTaskBenchmark.cancelInReverseOrder   10000  thrpt   20    2976.955 ±  248.555  ops/s
ScheduledFutureTaskBenchmark.cancelInReverseOrder  100000  thrpt   20     362.654 ±   45.716  ops/s
```

Before - cancelling in order and in reverse order have significantly different performance at higher queue size, orders of magnitude worse than the new implementation.
```
Benchmark                                           (num)   Mode  Cnt       Score       Error  Units
ScheduledFutureTaskBenchmark.cancelInOrder            100  thrpt   20  139968.586 ± 12951.333  ops/s
ScheduledFutureTaskBenchmark.cancelInOrder           1000  thrpt   20   12274.420 ±   337.800  ops/s
ScheduledFutureTaskBenchmark.cancelInOrder          10000  thrpt   20     958.168 ±    15.350  ops/s
ScheduledFutureTaskBenchmark.cancelInOrder         100000  thrpt   20      53.381 ±    13.981  ops/s
ScheduledFutureTaskBenchmark.cancelInReverseOrder     100  thrpt   20  123918.829 ±  3642.517  ops/s
ScheduledFutureTaskBenchmark.cancelInReverseOrder    1000  thrpt   20    5099.810 ±   206.992  ops/s
ScheduledFutureTaskBenchmark.cancelInReverseOrder   10000  thrpt   20      72.335 ±     0.443  ops/s
ScheduledFutureTaskBenchmark.cancelInReverseOrder  100000  thrpt   20       0.743 ±     0.003  ops/s
```
2017-11-10 23:09:32 -08:00
.github Use GitHub Issue/PR Template Feature 2016-12-07 11:40:26 -08:00
all [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
bom [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
buffer CompositeBytebuf.copy() and copy(...) should respect the allocator 2017-11-10 07:17:16 -08:00
codec [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-dns [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-http [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-http2 [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-smtp [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-socks [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
codec-xml [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
common Use Netty's DefaultPriorityQueue instead of JDK's PriorityQueue for scheduled tasks 2017-11-10 23:09:32 -08:00
dev-tools [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
example [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
handler Use Parameterized to run SslHandler tests with different SslProviders. 2017-11-10 07:20:35 -08:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
license Remove reference to akka code and ArrayDeque which is not part of netty anymore 2017-03-07 21:30:51 +01:00
microbench Use Netty's DefaultPriorityQueue instead of JDK's PriorityQueue for scheduled tasks 2017-11-10 23:09:32 -08:00
resolver [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
resolver-dns [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
tarball [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
testsuite [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
transport [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
transport-native-epoll [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
transport-native-kqueue [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
transport-native-unix-common [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
transport-udt [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
.fbprefs Updated Find Bugs configuration 2009-03-04 10:33:09 +00:00
.gitignore Use shaded dependency on JCTools instead of copy and paste 2016-06-10 13:19:45 +02:00
.travis.yml Travis CI branch whitelisting 2013-03-11 09:55:43 +09:00
CONTRIBUTING.md Move the pull request guide to the developer guide 2014-03-12 13:13:58 +09:00
LICENSE.txt Relicensed to Apache License v2 2009-08-28 07:15:49 +00:00
NOTICE.txt Remove reference to akka code and ArrayDeque which is not part of netty anymore 2017-03-07 21:30:51 +01:00
pom.xml [maven-release-plugin] prepare for next development iteration 2017-11-08 22:36:53 +00:00
README.md Updating Branches to look section to match the current branching structure of the project 2016-03-10 22:08:01 +01:00
run-example.sh Add UptimeServer and adjust UptimeClient's code style. 2017-04-28 07:41:07 +02:00

Netty Project

Netty is an asynchronous event-driven network application framework for rapid development of maintainable high performance protocol servers & clients.

How to build

For the detailed information about building and developing Netty, please visit the developer guide. This page only gives very basic information.

You require the following to build Netty:

Note that this is build-time requirement. JDK 5 (for 3.x) or 6 (for 4.0+) is enough to run your Netty-based application.

Branches to look

Development of all versions takes place in each branch whose name is identical to <majorVersion>.<minorVersion>. For example, the development of 3.9 and 4.0 resides in the branch '3.9' and the branch '4.0' respectively.