Go to file
Roman Puchkovskiy 4ecd78e104
Fix native image build on modern GraalVM versions for the cases when the program uses netty-dns (#10630)
Motivation:

Since GraalVM version 19.3.0, instances of java.net.InetAddress (and its subclasses Inet4Address and Inet6Address) are not allowed in native image heap (that is, they cannot be stored in static fields of classes initialized at build time or be reachable through static fields of such classes). When building a native image, it makes sense to initialize at build time as many classes as possible.
But some fields of some classes in Netty (for example, NetUtil.LOCALHOST4) contain InetAddress instances. If a program is using code path that makes it possible to reach such fields at build time initialization, it becomes impossible to build a native image initializing core Netty classes initialized at runtime. An example of such a program is a client that uses netty-dns.

Modifications:

- Add netty-testsuite-native-image-client Maven module to test that such an example program can be built after the corresponding fixes
- Add native-image.properties to resolver-dns module to move initialization of some classes to runtime (some of them are parsing configuration during initialization, so it makes no sense to initialize them at build time; for others, it's needed to avoid InetAddress reachability at build time)
- Add substitutions for NetUtil.LOCALHOST4, NetUtil.LOCALHOST6 and NetUtil.LOCALHOST to overcome the InetAddress-related prohibition
- Extract some initialization code from NetUtil to NetUtilInitializations to allow it to be used by the substitutions

Result:

A client program using netty-dns with --initialize-at-build-time=io.netty builds successfully
2020-10-26 08:34:31 +01:00
.github Create codeql-analysis.yml (#10696) 2020-10-18 14:25:48 +02:00
.mvn Use latest maven release (#9820) 2019-11-27 14:45:28 +01:00
all Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
bom Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
buffer Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-dns Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-haproxy Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-http Fix checkstyle errors introduced by 33de96f448 2020-10-24 14:50:00 +02:00
codec-http2 Fix JavaDoc of Http2Headers (#10711) 2020-10-23 15:35:43 +02:00
codec-memcache Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-mqtt Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-redis Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-smtp Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-socks Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-stomp Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
codec-xml Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
common Fix native image build on modern GraalVM versions for the cases when the program uses netty-dns (#10630) 2020-10-26 08:34:31 +01:00
dev-tools Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
docker Update java patch versions (#10703) 2020-10-17 20:24:18 +02:00
example Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
handler Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
handler-proxy Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
license Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
microbench Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
resolver Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
resolver-dns Fix native image build on modern GraalVM versions for the cases when the program uses netty-dns (#10630) 2020-10-26 08:34:31 +01:00
resolver-dns-native-macos Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
tarball Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
testsuite Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
testsuite-autobahn Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
testsuite-http2 Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
testsuite-native-image Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
testsuite-native-image-client Fix native image build on modern GraalVM versions for the cases when the program uses netty-dns (#10630) 2020-10-26 08:34:31 +01:00
testsuite-osgi Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
testsuite-shading Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
transport Fix native image build on modern GraalVM versions for the cases when the program uses netty-dns (#10630) 2020-10-26 08:34:31 +01:00
transport-blockhound-tests Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
transport-native-epoll Allow EventLoops to rethrow Error (#10694) 2020-10-24 14:56:33 +02:00
transport-native-kqueue Allow EventLoops to rethrow Error (#10694) 2020-10-24 14:56:33 +02:00
transport-native-unix-common Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
transport-native-unix-common-tests Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
transport-rxtx Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
transport-sctp Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
transport-udt Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
.fbprefs Updated Find Bugs configuration 2009-03-04 10:33:09 +00:00
.gitattributes Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
.gitignore Ignore .shelf/ folder generated by IntelliJ IDEA (#10445) 2020-08-03 07:51:53 +02:00
.lgtm.yml Enables lgtm.com to process this project and create a CodeQL database 2020-01-17 11:05:53 +01:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
LICENSE.txt Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
mvnw Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
mvnw.cmd Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
nohttp-checkstyle-suppressions.xml Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
nohttp-checkstyle.xml Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
NOTICE.txt Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
pom.xml Fix native image build on modern GraalVM versions for the cases when the program uses netty-dns (#10630) 2020-10-26 08:34:31 +01:00
README.md Enable nohttp check during the build (#10708) 2020-10-23 14:44:18 +02:00
run-example.sh Add DNS client examples for run-example.sh (#10283) 2020-05-14 12:10:32 +02:00
SECURITY.md Added a security policy (#10692) 2020-10-15 20:39:37 +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.

Usage with JDK 9

Netty can be used in modular JDK9 applications as a collection of automatic modules. The module names follow the reverse-DNS style, and are derived from subproject names rather than root packages due to historical reasons. They are listed below:

  • io.netty.all
  • io.netty.buffer
  • io.netty.codec
  • io.netty.codec.dns
  • io.netty.codec.haproxy
  • io.netty.codec.http
  • io.netty.codec.http2
  • io.netty.codec.memcache
  • io.netty.codec.mqtt
  • io.netty.codec.redis
  • io.netty.codec.smtp
  • io.netty.codec.socks
  • io.netty.codec.stomp
  • io.netty.codec.xml
  • io.netty.common
  • io.netty.handler
  • io.netty.handler.proxy
  • io.netty.resolver
  • io.netty.resolver.dns
  • io.netty.transport
  • io.netty.transport.epoll (native omitted - reserved keyword in Java)
  • io.netty.transport.kqueue (native omitted - reserved keyword in Java)
  • io.netty.transport.unix.common (native omitted - reserved keyword in Java)
  • io.netty.transport.rxtx
  • io.netty.transport.sctp
  • io.netty.transport.udt

Automatic modules do not provide any means to declare dependencies, so you need to list each used module separately in your module-info file.