https://github.com/netty/netty-incubator-transport-io_uring

https://github.com/netty/netty-incubator-transport-io_uring

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/netty/netty-incubator-transport-io_uring
• Owner: netty
• License: apache-2.0
• Created: 2020-10-28T15:49:00.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-04T12:52:33.000Z (3 months ago)
• Last Synced: 2024-10-29T15:44:37.607Z (about 2 months ago)
• Language: Java
• Size: 1 MB
• Stars: 194
• Watchers: 32
• Forks: 39
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-iouring - Netty transport

README

        
![Build project](https://github.com/netty/netty-incubator-transport-io_uring/workflows/Build%20project/badge.svg)

# Netty io_uring

The new io_uring interface added to the Linux Kernel 5.1 is a high I/O performance scalable interface for fully asynchronous Linux syscalls

## Requirements:

- x86-64 / aarch64 processor

- at least 5.9

- to run the tests, you have to increase memlock(default 64K)

See [our wiki page](https://netty.io/wiki/native-transports.html).

## How to include the dependency

To include the dependency you need to ensure you also specify the right classifier. At the moment we only support linux

 x86_64 and aarch_64 but this may change. 

 

As an example this is how you would include the dependency in maven for x86_64:

```

    io.netty.incubator

    netty-incubator-transport-native-io_uring

    0.0.21.Final

    linux-x86_64

```

And in gradle:

```

dependencies {

    implementation 'io.netty.incubator:netty-incubator-transport-native-io_uring:0.0.21.Final:linux-x86_64'

}

```

## FAQ

### I tried to use io_uring but got `java.lang.RuntimeException: failed to create io_uring ring fd Cannot allocate memory`

When you tried to use io_uring but saw an exception that looked like this please try to encreate the [memlock limit](https://access.redhat.com/solutions/61334) for the user that tries to use io_uring:

```

Exception in thread "main" java.lang.UnsatisfiedLinkError: failed to load the required native library

	at io.netty.incubator.channel.uring.IOUring.ensureAvailability(IOUring.java:63)

        ...

        ...

Caused by: java.lang.RuntimeException: failed to create io_uring ring fd Cannot allocate memory

	at io.netty.incubator.channel.uring.Native.ioUringSetup(Native Method)

	at io.netty.incubator.channel.uring.Native.createRingBuffer(Native.java:141)

	at io.netty.incubator.channel.uring.Native.createRingBuffer(Native.java:174)

	at io.netty.incubator.channel.uring.IOUring.(IOUring.java:36)

	... 17 more

```

You can check your current memlock settings by

```

$ ulimit -l

65536

```