Skip to content

Commit

Permalink
add io_uring support (#3460)
Browse files Browse the repository at this point in the history
* io_uring support

* Fix CI errors

* Requested changes and small formatting
  • Loading branch information
duplexsystem authored Oct 8, 2021
1 parent d843e3e commit 5cc5c9d
Show file tree
Hide file tree
Showing 6 changed files with 228 additions and 0 deletions.
7 changes: 7 additions & 0 deletions dependencies/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@
<version.lib.mysql-connector-java>8.0.22</version.lib.mysql-connector-java>
<version.lib.narayana>5.12.0.Final</version.lib.narayana>
<version.lib.netty>4.1.63.Final</version.lib.netty>
<version.lib.netty-io_uring>0.0.8.Final</version.lib.netty-io_uring>
<version.lib.oci-java-sdk-objectstorage>2.3.0</version.lib.oci-java-sdk-objectstorage>
<version.lib.ojdbc8>21.3.0.0</version.lib.ojdbc8>
<version.lib.database.messaging>19.3.0.0</version.lib.database.messaging>
Expand Down Expand Up @@ -1274,6 +1275,12 @@
<version>${version.lib.netty}</version>
<classifier>osx-x86_64</classifier>
</dependency>
<dependency>
<groupId>io.netty.incubator</groupId>
<artifactId>netty-incubator-transport-native-io_uring</artifactId>
<version>${version.lib.netty-io_uring}</version>
<classifier>linux-x86_64</classifier>
</dependency>
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-common</artifactId>
Expand Down
45 changes: 45 additions & 0 deletions webserver/transport/netty/iouring/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2021 Oracle and/or its affiliates.
Licensed 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
http://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.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.helidon.webserver.transport.netty</groupId>
<artifactId>helidon-webserver-transport-netty-project</artifactId>
<version>2.4.0-SNAPSHOT</version>
</parent>
<artifactId>helidon-webserver-transport-netty-iouring</artifactId>
<name>Helidon WebServer Transport Netty io_uring</name>

<dependencies>
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver</artifactId>
</dependency>
<dependency>
<groupId>io.netty.incubator</groupId>
<artifactId>netty-incubator-transport-native-io_uring</artifactId>
<classifier>linux-x86_64</classifier>
</dependency>

</dependencies>

</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
/*
* Copyright (c) 2021 Oracle and/or its affiliates.
*
* Licensed 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
*
* http://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.helidon.webserver.transport.netty.iouring;

import java.util.Optional;

import io.helidon.webserver.ServerConfiguration;
import io.helidon.webserver.Transport;
import io.helidon.webserver.WebServer;

import io.netty.channel.ChannelFactory;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.ServerChannel;
import io.netty.incubator.channel.uring.IOUring;
import io.netty.incubator.channel.uring.IOUringEventLoopGroup;
import io.netty.incubator.channel.uring.IOUringServerSocketChannel;


/**
* A {@link Transport} implementation based upon Netty's <a
* href="https://netty.io/wiki/native-transports.html#using-the-linux-native-transport"
* target="_parent">iouring-based native transport</a>.
*
* <p>This {@link Transport} implementation is currently experimental
* and its API and implementation are subject to change.</p>
*/
public final class IOUringTransport implements Transport {

/**
* Returns {@code true} when {@link IOUring#isAvailable()} returns
* {@code true} and {@code false} otherwise.
*
* @return {@code true} when {@link IOUring#isAvailable()} returns
* {@code true}; {@code false} otherwise
*/
@Override
public boolean isAvailableFor(WebServer webServer) {
return IOUring.isAvailable();
}

/**
* Returns an artifact corresponding to the supplied artifact
* coordinates, if one is available.
*
* <p>Specifically, this method will return a non-{@linkplain
* Optional#isEmpty() empty <code>Optional</code>} only if one of the
* following conditions is true:</p>
*
* <ul>
*
* <li>{@code artifactType} is a subtype of {@link EventLoopGroup}
* and {@code artifactName} is exactly {@linkplain
* String#equals(Object) equal} to either {@code bossGroup} or
* {@code workerGroup}</li>
*
* <li>{@code artifactType} is a subtype of {@link ChannelFactory}
* and {@code artifactName} is exactly {@linkplain
* String#equals(Object) equal} to {@code serverChannelFactory}</li>
*
* </ul>
*
* @param artifactType a {@link Class} indicating the kind of
* artifact to be returned; must not be {@code null}; may usefully
* only be a subtype of either {@link EventLoopGroup} or
* {@linkplain ChannelFactory <code>ChannelFactory&lt;? extends
* ServerChannel&gt;</code>}
*
* @param artifactName a {@link String} indicating which of
* possibly several artifacts of the same kind to be returned;
* must not be {@code null}
*
* @param config the {@link ServerConfiguration} in effect; must
* not be {@code null}
*
* @return an {@link Optional}, which may be {@linkplain
* Optional#isEmpty() empty} but which will never be {@code null}
*
* @exception NullPointerException if any argument is {@code null}
*
* @see IOUring
*
* @see IOUringEventLoopGroup
*
* @see IOUringServerSocketChannel
*/
@Override
@SuppressWarnings("unchecked")
public <T> Optional<T> createTransportArtifact(Class<T> artifactType,
String artifactName,
ServerConfiguration config) {
if (EventLoopGroup.class.isAssignableFrom(artifactType)) {
switch (artifactName) {
case "bossGroup":
return Optional.of((T) new IOUringEventLoopGroup(config.sockets().size()));
case "workerGroup":
return Optional.of((T) new IOUringEventLoopGroup(Math.max(0, config.workersCount())));
default:
return Optional.empty();
}
} else if (ChannelFactory.class.isAssignableFrom(artifactType)) {
switch (artifactName) {
case "serverChannelFactory":
ChannelFactory<? extends ServerChannel> cf = IOUringServerSocketChannel::new;
return Optional.of((T) cf);
default:
return Optional.empty();
}
} else {
return Optional.empty();
}
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
* Copyright (c) 2021 Oracle and/or its affiliates.
*
* Licensed 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
*
* http://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.
*/

/**
* Netty io_uring Transport implementation.
*/
package io.helidon.webserver.transport.netty.iouring;
28 changes: 28 additions & 0 deletions webserver/transport/netty/iouring/src/main/java/module-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* Copyright (c) 2021 Oracle and/or its affiliates.
*
* Licensed 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
*
* http://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.
*/

/**
* Netty IOURING transport.
*/
module io.helidon.webserver.transport.netty.iouring {
requires io.helidon.webserver;

requires io.netty.transport;

requires io.netty.incubator.transport.io_uring;

exports io.helidon.webserver.transport.netty.iouring;
}
1 change: 1 addition & 0 deletions webserver/transport/netty/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,6 @@

<modules>
<module>epoll</module>
<module>iouring</module>
</modules>
</project>

0 comments on commit 5cc5c9d

Please sign in to comment.