Go to file
Daniel Zou fca62510f3 Modify OpenSSL native library loading to accommodate GraalVM (#10395)
**Motivation:**

We are interested in building Netty libraries with Ahead-of-time compilation with GraalVM. We saw there was [prior work done on this](https://github.com/netty/netty/search?q=graalvm&unscoped_q=graalvm). We want to introduce a change which will unblock GraalVM support for applications using netty and `netty-tcnative`.

This solves the error [that some others encounter](https://github.com/oracle/graal/search?q=UnsatisfiedLinkError+sslOpCipherServerPreference&type=Issues):

```
Exception in thread "main" java.lang.UnsatisfiedLinkError: io.grpc.netty.shaded.io.netty.internal.tcnative.NativeStaticallyReferencedJniMethods.sslOpCipherServerPreference()I [symbol: Java_io_grpc_netty_shaded_io_netty_internal_tcnative_NativeStaticallyReferencedJniMethods_sslOpCipherServerPreference or Java_io_grpc_netty_shaded_io_netty_internal_tcnative_NativeStaticallyReferencedJniMethods_sslOpCipherServerPreference__]
```

**Modification:**

The root cause of the issue is that in the tcnative libraries, the [`SSL.java` class](783a8b6b69/openssl-dynamic/src/main/java/io/netty/internal/tcnative/SSL.java (L67)) references a native call in the static initialization of the class - the method `sslOpCipherServerPreference()` on line 67 is used to initialize the static variable. But you see that `OpenSsl` also uses[ `SSL.class` to check if `netty-tcnative` is on the classpath before loading the native library](cbe238a95b/handler/src/main/java/io/netty/handler/ssl/OpenSsl.java (L123)). 

So this is the problem because in ahead-of-time compilation, when it references the SSL class, it will try to load those static initializers and make the native library call, but it cannot do so because the native library has not been loaded yet since the `SSL` class is being referenced to check if the library should be loaded in the first place.

**Solution:** So the proposed solution here is to just choose a different class in the `tcnative` package which does not make a native library call during static initialization. I just chose `SSLContext` if this is OK.

This should have no negative effects other than unblocking the GraalVM use-case.

**Result:**

It fixes the unsatisfied link error. It will fix error for future users; it is a common error people encounter.
2020-07-08 10:47:10 +02:00
.github Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
.mvn Use latest maven release (#9820) 2019-11-27 14:45:48 +01:00
all Include aarch64 packages in netty-bom (#10292) 2020-05-15 10:34:35 +02:00
bom Include aarch64 packages in netty-bom (#10292) 2020-05-15 10:34:35 +02:00
buffer Include more details if we throw an IllegalArgumentException because of overflow (#10330) 2020-06-02 10:08:06 +02:00
codec Fix date format in headers to use 2-digit day of month (#10259) 2020-05-11 08:57:37 +02:00
codec-dns Workaround Android bug that cause AbstractDnsRecord to throw when the name is only a ROOT label (#10039) 2020-02-18 15:11:06 +01:00
codec-haproxy Add support for HAProxyMessageEncoder (#10175) 2020-04-16 11:53:43 +02:00
codec-http Add option to HttpObjectDecoder to allow duplicate Content-Lengths (#10349) 2020-07-06 14:50:15 +02:00
codec-http2 Add detailed error message corresponding to the IndexOutOfBoundsException while calling getEntry(...) (#10386) 2020-07-06 10:19:37 +02:00
codec-memcache Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-mqtt Replace MQTT deprecated API usage 2020-03-30 21:24:01 +02:00
codec-redis Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-smtp add AUTH & EMPTY to SmtpCommand (#9999) 2020-02-07 14:30:16 +01:00
codec-socks Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
codec-stomp Fix allocate additional buffer for encoding stompFrame without readab… (#10150) 2020-03-31 16:03:16 +02:00
codec-xml Remove the intermediate List from ByteToMessageDecoder (and sub-class… (#8626) 2019-12-16 21:00:32 +01:00
common Fix compile errors introduced by bad cherry-picks (#10391) 2020-07-06 13:22:31 +02:00
dev-tools Update version number to start working on Netty 5 2018-11-20 15:49:57 +01:00
docker Update GraalVM with JDK 8 and add GraalVM with JDK 11 (#10333) 2020-06-02 11:53:18 +02:00
example Fix #10261 stomp can be chunked, so implement StompWebSocketFrameEncoder (#10274) 2020-06-04 19:14:46 +02:00
handler Modify OpenSSL native library loading to accommodate GraalVM (#10395) 2020-07-08 10:47:10 +02:00
handler-proxy Ensure WebSocket*Handshaker can not corrupt pipeline when HttpProxyHa… (#10103) 2020-03-16 11:45:25 +01:00
license Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
microbench Efficient BytBuf search algorithms (#9914) (#9955) 2020-04-15 10:26:53 +02:00
resolver Reduce scope of synchronized block introduced in 5114588cba (#10013) 2020-02-10 19:31:17 +01:00
resolver-dns Fix possible StackOverflowError when try to resolve authorative names… (#10337) 2020-06-04 19:14:29 +02:00
resolver-dns-native-macos Use MacOSDnsServerAddressStreamProvider when on the classpath and we … (#10079) 2020-03-06 11:42:19 +01:00
tarball Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
testsuite Add a null check to method TestUtils.compressHeapDumps (#10053) 2020-02-25 09:44:22 +01:00
testsuite-autobahn Cleanup usage of Channel*Handler (#9959) 2020-01-20 17:47:17 -08:00
testsuite-http2 Ensure the DefaultChannelHandlerContext is unlinked once removed (#9970) 2020-03-01 08:13:33 +01:00
testsuite-native-image Rename SimpleChannelInboundHandler.channelRead0() to messageReceived() (#8819) 2019-11-01 07:23:07 +01:00
testsuite-osgi Use lambdas whenever possible (#9979) 2020-01-30 09:28:24 +01:00
testsuite-shading Allow to build on powerpc 2019-09-13 22:21:36 +02:00
transport Guard against re-entrancy issues while draining AbstractCoalescingBufferQueue (#10294) 2020-05-15 10:00:40 +02:00
transport-blockhound-tests Do not report ReferenceCountedOpenSslClientContext$ExtendedTrustManagerVerifyCallback.verify as blocking call (#10387) 2020-07-06 09:36:00 +02:00
transport-native-epoll Add epoll aarch64 maven config and Dockerfile (#9804) 2020-05-14 09:32:11 +02:00
transport-native-kqueue Cleanup usage of Channel*Handler (#9959) 2020-01-20 17:47:17 -08:00
transport-native-unix-common Add epoll aarch64 maven config and Dockerfile (#9804) 2020-05-14 09:32:11 +02:00
transport-native-unix-common-tests Rename SimpleChannelInboundHandler.channelRead0() to messageReceived() (#8819) 2019-11-01 07:23:07 +01:00
transport-sctp Replace the type of fragments field with IntObjectMap in SctpMessageCompletionHandler (#10057) 2020-02-24 20:02:35 +01:00
transport-udt/lib/bin/lib/x86_64-MacOSX-gpp/jni Replace reflection usage with MethodHandles when performance matters (#10097) 2020-03-11 21:04:40 +01: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 Add vscode specific files / directory to .gitignore (#9652) 2019-10-10 07:35:34 +02:00
.lgtm.yml Enables lgtm.com to process this project and create a CodeQL database 2020-01-20 19:22:49 +01:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
LICENSE.txt Relicensed to Apache License v2 2009-08-28 07:15:49 +00:00
mvnw Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
mvnw.cmd Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
NOTICE.txt Introduce MacOSDnsServerAddressStreamProvider which correctly detect all nameserver configuration on MacOS (#9161) 2019-10-28 15:03:40 +01:00
pom.xml Update to netty-tcnative 2.0.31.Final and make SslErrorTest more robust (#10392) 2020-07-07 10:56:42 +02:00
README.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:10:14 +02:00
run-example.sh Add DNS client examples for run-example.sh (#10283) 2020-05-14 12:10:48 +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.