From bc08547dccdb9e8a24fcc60e1cd798670b4e0813 Mon Sep 17 00:00:00 2001 From: Hellblazer Date: Sat, 10 Aug 2024 09:32:46 -0700 Subject: [PATCH] add netty vm socket channel --- pom.xml | 7 + vm-socket/README.md | 20 ++ vm-socket/license.md | 201 +++++++++++ vm-socket/pom.xml | 97 +++++ .../vsock/EpollServerVSockChannel.java | 91 +++++ .../vsock/EpollServerVSockChannelConfig.java | 178 ++++++++++ .../channel/vsock/EpollVSockChannel.java | 111 ++++++ .../vsock/EpollVSockChannelConfig.java | 186 ++++++++++ .../channel/vsock/ServerVSockChannel.java | 29 ++ .../netty/channel/vsock/VSockChannel.java | 33 ++ .../channel/vsock/VSockChannelConfig.java | 62 ++++ .../netty/channel/vsock/VSockTest.java | 330 ++++++++++++++++++ 12 files changed, 1345 insertions(+) create mode 100644 vm-socket/README.md create mode 100644 vm-socket/license.md create mode 100644 vm-socket/pom.xml create mode 100644 vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollServerVSockChannel.java create mode 100644 vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollServerVSockChannelConfig.java create mode 100644 vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollVSockChannel.java create mode 100644 vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollVSockChannelConfig.java create mode 100644 vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/ServerVSockChannel.java create mode 100644 vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/VSockChannel.java create mode 100644 vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/VSockChannelConfig.java create mode 100644 vm-socket/src/test/java/com/jauntsdn/netty/channel/vsock/VSockTest.java diff --git a/pom.xml b/pom.xml index da01491d9..f66f15b19 100644 --- a/pom.xml +++ b/pom.xml @@ -31,6 +31,7 @@ domain-kqueue domain-sockets leyden + vm-socket @@ -598,6 +599,12 @@ slf4j-jdk14 2.0.6 + + org.assertj + assertj-core + 3.26.3 + test + diff --git a/vm-socket/README.md b/vm-socket/README.md new file mode 100644 index 000000000..ee082dc5d --- /dev/null +++ b/vm-socket/README.md @@ -0,0 +1,20 @@ +# netty-vmsocket + +Implementation of Netty channels for VM sockets which +complements [netty's vsock addresses](https://github.com/netty/netty/pull/13468) support. + +## LICENSE + +Copyright 2023 - present Maksym Ostroverkhov. + +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. diff --git a/vm-socket/license.md b/vm-socket/license.md new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/vm-socket/license.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/vm-socket/pom.xml b/vm-socket/pom.xml new file mode 100644 index 000000000..8264486e4 --- /dev/null +++ b/vm-socket/pom.xml @@ -0,0 +1,97 @@ + + 4.0.0 + + com.salesforce.apollo + apollo.app + 0.0.1-SNAPSHOT + + vm-socket + VM Socket + Netty channels for VM sockets + + + io.netty + netty-transport-native-epoll + ${netty.version} + + + + + org.junit.jupiter + junit-jupiter + test + + + org.mockito + mockito-core + test + + + ch.qos.logback + logback-classic + test + + + ch.qos.logback + logback-core + test + + + org.assertj + assertj-core + test + + + + + exclude + + true + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + VSockTest.java + + + + + + + + linux + + + linux + + + + + io.netty + netty-transport-native-epoll + ${os.detected.classifier} + provided + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + VSockTest.java + + + + + + + + diff --git a/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollServerVSockChannel.java b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollServerVSockChannel.java new file mode 100644 index 000000000..0fecd3ec2 --- /dev/null +++ b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollServerVSockChannel.java @@ -0,0 +1,91 @@ +/* + * Copyright 2023 - present Maksym Ostroverkhov. + * + * 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 com.jauntsdn.netty.channel.vsock; + +import static io.netty.channel.epoll.LinuxSocket.newVSockStream; + +import io.netty.channel.epoll.AbstractEpollServerChannel; +import io.netty.channel.epoll.LinuxSocket; +import io.netty.channel.epoll.VSockAddress; +import java.net.SocketAddress; + +public final class EpollServerVSockChannel extends AbstractEpollServerChannel + implements ServerVSockChannel { + private final EpollServerVSockChannelConfig config; + private volatile VSockAddress localAddr; + + public EpollServerVSockChannel() { + super(newVSockStream(), false); + config = new EpollServerVSockChannelConfig(this); + } + + public EpollServerVSockChannel(int fd) { + this(LinuxSocket.newSocket(fd)); + } + + EpollServerVSockChannel(LinuxSocket fd) { + super(fd); + config = new EpollServerVSockChannelConfig(this); + } + + EpollServerVSockChannel(LinuxSocket fd, boolean active) { + super(fd, active); + config = new EpollServerVSockChannelConfig(this); + } + + @Override + protected void doBind(SocketAddress localAddress) throws Exception { + if (!(localAddress instanceof VSockAddress)) { + throw new Error("Unexpected local SocketAddress " + localAddress); + } + VSockAddress localVSock = (VSockAddress) localAddress; + + socket.bindVSock(localVSock); + socket.listen(config.getBacklog()); + + if (localVSock.getCid() != VSockAddress.VMADDR_CID_ANY + && localVSock.getPort() != VSockAddress.VMADDR_PORT_ANY) { + localAddr = localVSock; + } + active = true; + } + + @Override + public VSockAddress remoteAddress() { + return null; + } + + @Override + public VSockAddress localAddress() { + VSockAddress local = localAddr; + if (local == null) { + local = localAddr = socket.localVSockAddress(); + } + return local; + } + + @Override + public EpollServerVSockChannelConfig config() { + return config; + } + + @Override + public VSockChannel newChildChannel(int fd, byte[] address, int offset, int len) { + LinuxSocket linuxSocket = LinuxSocket.newSocket(fd); + return new EpollVSockChannel(this, linuxSocket, linuxSocket.remoteVSockAddress()); + } +} diff --git a/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollServerVSockChannelConfig.java b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollServerVSockChannelConfig.java new file mode 100644 index 000000000..fcdd394b5 --- /dev/null +++ b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollServerVSockChannelConfig.java @@ -0,0 +1,178 @@ +/* + * Copyright 2023 - present Maksym Ostroverkhov. + * + * 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 com.jauntsdn.netty.channel.vsock; + +import static io.netty.channel.ChannelOption.SO_BACKLOG; +import static io.netty.channel.ChannelOption.SO_RCVBUF; +import static io.netty.util.internal.ObjectUtil.checkPositiveOrZero; + +import io.netty.buffer.ByteBufAllocator; +import io.netty.channel.ChannelException; +import io.netty.channel.ChannelOption; +import io.netty.channel.MessageSizeEstimator; +import io.netty.channel.RecvByteBufAllocator; +import io.netty.channel.WriteBufferWaterMark; +import io.netty.channel.epoll.EpollChannelConfig; +import io.netty.channel.epoll.EpollMode; +import io.netty.channel.socket.ServerSocketChannelConfig; +import io.netty.util.NetUtil; +import java.io.IOException; +import java.util.Map; + +public class EpollServerVSockChannelConfig extends EpollChannelConfig + implements ServerSocketChannelConfig { + private volatile int backlog = NetUtil.SOMAXCONN; + + EpollServerVSockChannelConfig(EpollServerVSockChannel channel) { + super(channel); + } + + @Override + public Map, Object> getOptions() { + return getOptions(super.getOptions(), SO_RCVBUF, SO_BACKLOG); + } + + @SuppressWarnings("unchecked") + @Override + public T getOption(ChannelOption option) { + if (option == SO_RCVBUF) { + return (T) Integer.valueOf(getReceiveBufferSize()); + } + if (option == SO_BACKLOG) { + return (T) Integer.valueOf(getBacklog()); + } + return super.getOption(option); + } + + @Override + public boolean setOption(ChannelOption option, T value) { + validate(option, value); + return super.setOption(option, value); + } + + @Override + public EpollServerVSockChannelConfig setReuseAddress(boolean reuseAddress) { + return this; + } + + @Override + public int getReceiveBufferSize() { + try { + return socket().getReceiveBufferSize(); + } catch (IOException e) { + throw new ChannelException(e); + } + } + + @Override + public EpollServerVSockChannelConfig setReceiveBufferSize(int receiveBufferSize) { + return this; + } + + @Override + public EpollServerVSockChannelConfig setPerformancePreferences( + int connectionTime, int latency, int bandwidth) { + return this; + } + + @Override + public int getBacklog() { + return backlog; + } + + @Override + public EpollServerVSockChannelConfig setBacklog(int backlog) { + checkPositiveOrZero(backlog, "backlog"); + this.backlog = backlog; + return this; + } + + @Override + public boolean isReuseAddress() { + return false; + } + + @Override + public EpollServerVSockChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis) { + super.setConnectTimeoutMillis(connectTimeoutMillis); + return this; + } + + @Override + @Deprecated + public EpollServerVSockChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead) { + super.setMaxMessagesPerRead(maxMessagesPerRead); + return this; + } + + @Override + public EpollServerVSockChannelConfig setWriteSpinCount(int writeSpinCount) { + super.setWriteSpinCount(writeSpinCount); + return this; + } + + @Override + public EpollServerVSockChannelConfig setAllocator(ByteBufAllocator allocator) { + super.setAllocator(allocator); + return this; + } + + @Override + public EpollServerVSockChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator) { + super.setRecvByteBufAllocator(allocator); + return this; + } + + @Override + public EpollServerVSockChannelConfig setAutoRead(boolean autoRead) { + super.setAutoRead(autoRead); + return this; + } + + @Override + @Deprecated + public EpollServerVSockChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) { + super.setWriteBufferHighWaterMark(writeBufferHighWaterMark); + return this; + } + + @Override + @Deprecated + public EpollServerVSockChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) { + super.setWriteBufferLowWaterMark(writeBufferLowWaterMark); + return this; + } + + @Override + public EpollServerVSockChannelConfig setWriteBufferWaterMark( + WriteBufferWaterMark writeBufferWaterMark) { + super.setWriteBufferWaterMark(writeBufferWaterMark); + return this; + } + + @Override + public EpollServerVSockChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator) { + super.setMessageSizeEstimator(estimator); + return this; + } + + @Override + public EpollServerVSockChannelConfig setEpollMode(EpollMode mode) { + super.setEpollMode(mode); + return this; + } +} diff --git a/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollVSockChannel.java b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollVSockChannel.java new file mode 100644 index 000000000..3d50dd11c --- /dev/null +++ b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollVSockChannel.java @@ -0,0 +1,111 @@ +/* + * Copyright 2023 - present Maksym Ostroverkhov. + * + * 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 com.jauntsdn.netty.channel.vsock; + +import static io.netty.channel.epoll.LinuxSocket.newVSockStream; + +import io.netty.channel.Channel; +import io.netty.channel.epoll.AbstractEpollStreamChannel; +import io.netty.channel.epoll.LinuxSocket; +import io.netty.channel.epoll.Native; +import io.netty.channel.epoll.VSockAddress; +import java.net.SocketAddress; + +public final class EpollVSockChannel extends AbstractEpollStreamChannel implements VSockChannel { + private final EpollVSockChannelConfig config; + private volatile VSockAddress localAddr; + private volatile VSockAddress remoteAddr; + + public EpollVSockChannel() { + super(newVSockStream(), false); + config = new EpollVSockChannelConfig(this); + } + + public EpollVSockChannel(int fd) { + super(fd); + config = new EpollVSockChannelConfig(this); + } + + EpollVSockChannel(LinuxSocket fd, boolean active) { + super(fd, active); + config = new EpollVSockChannelConfig(this); + } + + EpollVSockChannel(Channel parent, LinuxSocket fd, VSockAddress remoteAddress) { + super(parent, fd, remoteAddress); + this.remoteAddr = remoteAddress; + config = new EpollVSockChannelConfig(this); + } + + @Override + public VSockAddress remoteAddress() { + return remoteAddr; + } + + @Override + public VSockAddress localAddress() { + VSockAddress local = localAddr; + if (local == null) { + local = localAddr = socket.localVSockAddress(); + } + return local; + } + + @Override + public EpollVSockChannelConfig config() { + return config; + } + + @Override + protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) + throws Exception { + if (!(remoteAddress instanceof VSockAddress)) { + throw new Error("Unexpected remote SocketAddress " + remoteAddress); + } + VSockAddress remoteVSock = (VSockAddress) remoteAddress; + + VSockAddress localVSock = null; + if (localAddress != null) { + if (!(localAddress instanceof VSockAddress)) { + throw new Error("Unexpected local SocketAddress " + localAddress); + } + localVSock = (VSockAddress) localAddress; + socket.bindVSock(localVSock); + } + boolean succeeded = false; + try { + boolean connected = socket.connectVSock(remoteVSock); + if (!connected) { + setFlag(Native.EPOLLOUT); + } + + if (localVSock != null) { + if (localVSock.getCid() != VSockAddress.VMADDR_CID_ANY + && localVSock.getPort() != VSockAddress.VMADDR_PORT_ANY) { + localAddr = localVSock; + } + } + remoteAddr = remoteVSock; + succeeded = true; + return connected; + } finally { + if (!succeeded) { + doClose(); + } + } + } +} diff --git a/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollVSockChannelConfig.java b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollVSockChannelConfig.java new file mode 100644 index 000000000..965435b4c --- /dev/null +++ b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/EpollVSockChannelConfig.java @@ -0,0 +1,186 @@ +/* + * Copyright 2023 - present Maksym Ostroverkhov. + * + * 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 com.jauntsdn.netty.channel.vsock; + +import static io.netty.channel.ChannelOption.ALLOW_HALF_CLOSURE; +import static io.netty.channel.ChannelOption.SO_RCVBUF; +import static io.netty.channel.ChannelOption.SO_SNDBUF; + +import io.netty.buffer.ByteBufAllocator; +import io.netty.channel.ChannelException; +import io.netty.channel.ChannelOption; +import io.netty.channel.MessageSizeEstimator; +import io.netty.channel.RecvByteBufAllocator; +import io.netty.channel.WriteBufferWaterMark; +import io.netty.channel.epoll.EpollChannelConfig; +import io.netty.channel.epoll.EpollMode; +import io.netty.channel.socket.DuplexChannelConfig; +import java.io.IOException; +import java.util.Map; + +public final class EpollVSockChannelConfig extends EpollChannelConfig + implements VSockChannelConfig, DuplexChannelConfig { + private volatile boolean allowHalfClosure; + + EpollVSockChannelConfig(EpollVSockChannel channel) { + super(channel); + + calculateMaxBytesPerGatheringWrite(); + } + + @Override + public Map, Object> getOptions() { + return getOptions(super.getOptions(), SO_RCVBUF, SO_SNDBUF, ALLOW_HALF_CLOSURE); + } + + @SuppressWarnings("unchecked") + @Override + public T getOption(ChannelOption option) { + if (option == SO_RCVBUF) { + return (T) Integer.valueOf(getReceiveBufferSize()); + } + if (option == SO_SNDBUF) { + return (T) Integer.valueOf(getSendBufferSize()); + } + if (option == ALLOW_HALF_CLOSURE) { + return (T) Boolean.valueOf(isAllowHalfClosure()); + } + return super.getOption(option); + } + + @Override + public boolean setOption(ChannelOption option, T value) { + validate(option, value); + + if (option == ALLOW_HALF_CLOSURE) { + setAllowHalfClosure((Boolean) value); + } else { + return super.setOption(option, value); + } + return true; + } + + public int getReceiveBufferSize() { + try { + return socket().getReceiveBufferSize(); + } catch (IOException e) { + throw new ChannelException(e); + } + } + + public int getSendBufferSize() { + try { + return socket().getSendBufferSize(); + } catch (IOException e) { + throw new ChannelException(e); + } + } + + @Override + public boolean isAllowHalfClosure() { + return allowHalfClosure; + } + + @Override + public EpollVSockChannelConfig setAllowHalfClosure(boolean allowHalfClosure) { + this.allowHalfClosure = allowHalfClosure; + return this; + } + + @Override + public EpollVSockChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis) { + super.setConnectTimeoutMillis(connectTimeoutMillis); + return this; + } + + @Override + @Deprecated + public EpollVSockChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead) { + super.setMaxMessagesPerRead(maxMessagesPerRead); + return this; + } + + @Override + public EpollVSockChannelConfig setWriteSpinCount(int writeSpinCount) { + super.setWriteSpinCount(writeSpinCount); + return this; + } + + @Override + public EpollVSockChannelConfig setAllocator(ByteBufAllocator allocator) { + super.setAllocator(allocator); + return this; + } + + @Override + public EpollVSockChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator) { + super.setRecvByteBufAllocator(allocator); + return this; + } + + @Override + public EpollVSockChannelConfig setAutoRead(boolean autoRead) { + super.setAutoRead(autoRead); + return this; + } + + @Override + public EpollVSockChannelConfig setAutoClose(boolean autoClose) { + super.setAutoClose(autoClose); + return this; + } + + @Override + @Deprecated + public EpollVSockChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) { + super.setWriteBufferHighWaterMark(writeBufferHighWaterMark); + return this; + } + + @Override + @Deprecated + public EpollVSockChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) { + super.setWriteBufferLowWaterMark(writeBufferLowWaterMark); + return this; + } + + @Override + public EpollVSockChannelConfig setWriteBufferWaterMark( + WriteBufferWaterMark writeBufferWaterMark) { + super.setWriteBufferWaterMark(writeBufferWaterMark); + return this; + } + + @Override + public EpollVSockChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator) { + super.setMessageSizeEstimator(estimator); + return this; + } + + @Override + public EpollVSockChannelConfig setEpollMode(EpollMode mode) { + super.setEpollMode(mode); + return this; + } + + private void calculateMaxBytesPerGatheringWrite() { + int newSendBufferSize = getSendBufferSize() << 1; + if (newSendBufferSize > 0) { + setMaxBytesPerGatheringWrite(newSendBufferSize); + } + } +} diff --git a/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/ServerVSockChannel.java b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/ServerVSockChannel.java new file mode 100644 index 000000000..5d3bf3e12 --- /dev/null +++ b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/ServerVSockChannel.java @@ -0,0 +1,29 @@ +/* + * Copyright 2023 - present Maksym Ostroverkhov. + * + * 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 com.jauntsdn.netty.channel.vsock; + +import io.netty.channel.ServerChannel; +import io.netty.channel.epoll.VSockAddress; +import io.netty.channel.unix.UnixChannel; + +public interface ServerVSockChannel extends ServerChannel, UnixChannel { + + @Override + VSockAddress localAddress(); + + @Override + VSockAddress remoteAddress(); +} diff --git a/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/VSockChannel.java b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/VSockChannel.java new file mode 100644 index 000000000..a9a70052b --- /dev/null +++ b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/VSockChannel.java @@ -0,0 +1,33 @@ +/* + * Copyright 2023 - present Maksym Ostroverkhov. + * + * 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 com.jauntsdn.netty.channel.vsock; + +import io.netty.channel.epoll.VSockAddress; +import io.netty.channel.socket.DuplexChannel; +import io.netty.channel.unix.UnixChannel; + +public interface VSockChannel extends UnixChannel, DuplexChannel { + + @Override + VSockAddress remoteAddress(); + + @Override + VSockAddress localAddress(); + + @Override + EpollVSockChannelConfig config(); +} diff --git a/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/VSockChannelConfig.java b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/VSockChannelConfig.java new file mode 100644 index 000000000..3546e7cdc --- /dev/null +++ b/vm-socket/src/main/java/com/jauntsdn/netty/channel/vsock/VSockChannelConfig.java @@ -0,0 +1,62 @@ +/* + * Copyright 2023 - present Maksym Ostroverkhov. + * + * 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 com.jauntsdn.netty.channel.vsock; + +import io.netty.buffer.ByteBufAllocator; +import io.netty.channel.ChannelConfig; +import io.netty.channel.MessageSizeEstimator; +import io.netty.channel.RecvByteBufAllocator; +import io.netty.channel.WriteBufferWaterMark; + +public interface VSockChannelConfig extends ChannelConfig { + + @Override + @Deprecated + VSockChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead); + + @Override + VSockChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis); + + @Override + VSockChannelConfig setWriteSpinCount(int writeSpinCount); + + @Override + VSockChannelConfig setAllocator(ByteBufAllocator allocator); + + @Override + VSockChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator); + + @Override + VSockChannelConfig setAutoRead(boolean autoRead); + + @Override + VSockChannelConfig setAutoClose(boolean autoClose); + + @Override + @Deprecated + VSockChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark); + + @Override + @Deprecated + VSockChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark); + + @Override + VSockChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark); + + @Override + VSockChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator); +} diff --git a/vm-socket/src/test/java/com/jauntsdn/netty/channel/vsock/VSockTest.java b/vm-socket/src/test/java/com/jauntsdn/netty/channel/vsock/VSockTest.java new file mode 100644 index 000000000..0bfa4b384 --- /dev/null +++ b/vm-socket/src/test/java/com/jauntsdn/netty/channel/vsock/VSockTest.java @@ -0,0 +1,330 @@ +/* + * Copyright 2023 - present Maksym Ostroverkhov. + * + * 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 com.jauntsdn.netty.channel.vsock; + +import io.netty.bootstrap.Bootstrap; +import io.netty.bootstrap.ServerBootstrap; +import io.netty.buffer.ByteBuf; +import io.netty.channel.Channel; +import io.netty.channel.ChannelHandlerContext; +import io.netty.channel.ChannelInboundHandler; +import io.netty.channel.ChannelInboundHandlerAdapter; +import io.netty.channel.ChannelInitializer; +import io.netty.channel.epoll.EpollEventLoopGroup; +import io.netty.channel.epoll.VSockAddress; +import io.netty.util.ReferenceCountUtil; +import java.net.InetSocketAddress; +import java.net.SocketAddress; +import java.nio.channels.ClosedChannelException; +import java.util.concurrent.CompletableFuture; +import org.assertj.core.api.Assertions; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +public class VSockTest { + + Channel server; + + @AfterEach + void tearDown() { + Channel s = server; + if (s != null) { + s.close(); + } + } + + @Test + void remoteNonVSockAddress() throws Exception { + InetSocketAddress unsupportedAddress = new InetSocketAddress("localhost", 8080); + org.junit.jupiter.api.Assertions.assertThrows( + Error.class, () -> server(unsupportedAddress, new ChannelInboundHandlerAdapter())); + + org.junit.jupiter.api.Assertions.assertThrows( + Error.class, () -> client(unsupportedAddress, new ChannelInboundHandlerAdapter())); + } + + @Test + void localNonVSockAddress() { + InetSocketAddress unsupportedAddress = new InetSocketAddress("localhost", 8080); + + org.junit.jupiter.api.Assertions.assertThrows( + Error.class, + () -> + client( + new VSockAddress(VSockAddress.VMADDR_CID_LOCAL, 8080), + unsupportedAddress, + new ChannelInboundHandlerAdapter())); + } + + @Timeout(30) + @Test + void connectionOpen() throws Exception { + VSockAddress serverAddress = new VSockAddress(VSockAddress.VMADDR_CID_LOCAL, 8080); + VSockAddress clientAddress = new VSockAddress(VSockAddress.VMADDR_CID_LOCAL, 8081); + LifecycleHandler serverHandler = new LifecycleHandler(); + LifecycleHandler clientHandler = new LifecycleHandler(); + + server = server(serverAddress, serverHandler); + Channel client = client(serverAddress, clientAddress, clientHandler); + + serverHandler.onConnected().join(); + clientHandler.onConnected().join(); + Assertions.assertThat(server.localAddress()).isExactlyInstanceOf(VSockAddress.class); + VSockAddress actualServerAddress = (VSockAddress) server.localAddress(); + Assertions.assertThat(actualServerAddress.getCid()).isEqualTo(VSockAddress.VMADDR_CID_LOCAL); + Assertions.assertThat(actualServerAddress.getPort()).isEqualTo(8080); + + Assertions.assertThat(clientHandler.localAddress).isExactlyInstanceOf(VSockAddress.class); + Assertions.assertThat((VSockAddress) clientHandler.localAddress).isEqualTo(clientAddress); + Assertions.assertThat((VSockAddress) clientHandler.remoteAddress).isEqualTo(serverAddress); + + Assertions.assertThat(serverHandler.localAddress).isExactlyInstanceOf(VSockAddress.class); + Assertions.assertThat((VSockAddress) serverHandler.localAddress).isEqualTo(serverAddress); + Assertions.assertThat((VSockAddress) serverHandler.remoteAddress).isEqualTo(clientAddress); + } + + @Timeout(30) + @Test + void connectionCloseByClient() throws Exception { + VSockAddress serverAddress = new VSockAddress(VSockAddress.VMADDR_CID_LOCAL, 8080); + LifecycleHandler serverHandler = new LifecycleHandler(); + LifecycleHandler clientHandler = new LifecycleHandler(); + + server = server(serverAddress, serverHandler); + Channel client = client(serverAddress, clientHandler); + clientHandler.onConnected().join(); + clientHandler.close(); + clientHandler.onClosed().join(); + serverHandler.onClosed().join(); + } + + @Timeout(30) + @Test + void connectionCloseByServer() throws Exception { + VSockAddress serverAddress = new VSockAddress(VSockAddress.VMADDR_CID_LOCAL, 8080); + LifecycleHandler serverHandler = new LifecycleHandler(); + LifecycleHandler clientHandler = new LifecycleHandler(); + + server = server(serverAddress, serverHandler); + Channel client = client(serverAddress, clientHandler); + serverHandler.onConnected().join(); + serverHandler.close(); + serverHandler.onClosed().join(); + clientHandler.onClosed().join(); + } + + @Test + void config() throws Exception { + VSockAddress serverAddress = new VSockAddress(VSockAddress.VMADDR_CID_LOCAL, 8080); + + server = server(serverAddress, new ChannelInboundHandlerAdapter()); + Channel client = client(serverAddress, new ChannelInboundHandlerAdapter()); + + Assertions.assertThat(client.config()).isExactlyInstanceOf(EpollVSockChannelConfig.class); + EpollVSockChannelConfig clientConfig = (EpollVSockChannelConfig) client.config(); + Assertions.assertThat(clientConfig.getSendBufferSize()).isGreaterThan(0); + Assertions.assertThat(clientConfig.getReceiveBufferSize()).isGreaterThan(0); + Assertions.assertThat(server.config()).isExactlyInstanceOf(EpollServerVSockChannelConfig.class); + EpollServerVSockChannelConfig serverConfig = (EpollServerVSockChannelConfig) server.config(); + Assertions.assertThat(serverConfig.getReceiveBufferSize()).isGreaterThan(0); + + /*verify setSockOpts does not throw*/ + serverConfig.setReceiveBufferSize(120_000); + } + + @Timeout(30) + @Test + void exchange() throws Exception { + VSockAddress serverAddress = new VSockAddress(VSockAddress.VMADDR_CID_LOCAL, 8088); + + server = server(serverAddress, new ServerExchangeHandler()); + ClientExchangeHandler handler = new ClientExchangeHandler(); + Channel client = client(serverAddress, handler); + handler.onCompleted().join(); + } + + public Channel server(SocketAddress address, ChannelInboundHandler handler) throws Exception { + ServerBootstrap bootstrap = new ServerBootstrap(); + Channel server = + bootstrap + .group(new EpollEventLoopGroup(4)) + .channel(EpollServerVSockChannel.class) + .childHandler( + new ChannelInitializer() { + + @Override + protected void initChannel(Channel ch) { + ch.pipeline().addLast(handler); + } + }) + .bind(address) + .sync() + .channel(); + + return server; + } + + public Channel client(SocketAddress remote, ChannelInboundHandler handler) throws Exception { + return client(remote, null, handler); + } + + public Channel client(SocketAddress remote, SocketAddress local, ChannelInboundHandler handler) + throws Exception { + Bootstrap bootstrap = + new Bootstrap() + .group(new EpollEventLoopGroup(4)) + .channel(EpollVSockChannel.class) + .handler( + new ChannelInitializer() { + @Override + protected void initChannel(Channel ch) { + ch.pipeline().addLast(handler); + } + }); + if (local != null) { + bootstrap.localAddress(local); + } + return bootstrap.connect(remote).sync().channel(); + } + + private static class LifecycleHandler extends ChannelInboundHandlerAdapter { + final CompletableFuture onConnected = new CompletableFuture<>(); + final CompletableFuture onClosed = new CompletableFuture<>(); + + volatile SocketAddress localAddress; + volatile SocketAddress remoteAddress; + volatile ChannelHandlerContext ctx; + + @Override + public void channelActive(ChannelHandlerContext ctx) throws Exception { + remoteAddress = ctx.channel().remoteAddress(); + localAddress = ctx.channel().localAddress(); + this.ctx = ctx; + onConnected.complete(null); + super.channelActive(ctx); + } + + @Override + public void channelInactive(ChannelHandlerContext ctx) throws Exception { + onClosed.complete(null); + super.channelInactive(ctx); + } + + public void close() { + ctx.close(); + } + + public CompletableFuture onConnected() { + return onConnected; + } + + public CompletableFuture onClosed() { + return onClosed; + } + } + + private static class ServerExchangeHandler extends ChannelInboundHandlerAdapter { + @Override + public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { + ctx.write(msg, ctx.voidPromise()); + } + + @Override + public void channelReadComplete(ChannelHandlerContext ctx) throws Exception { + ctx.flush(); + super.channelReadComplete(ctx); + } + + @Override + public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception { + if (!ctx.channel().isWritable()) { + ctx.flush(); + } + super.channelWritabilityChanged(ctx); + } + } + + private static class ClientExchangeHandler extends ChannelInboundHandlerAdapter { + final CompletableFuture onCompleted = new CompletableFuture<>(); + final int size = 77; + int received; + + ClientExchangeHandler() {} + + public CompletableFuture onCompleted() { + return onCompleted; + } + + @Override + public void channelActive(ChannelHandlerContext ctx) throws Exception { + for (int i = 0; i < size; i++) { + ctx.write(ctx.alloc().buffer(1).writeByte(i)); + if (!ctx.channel().isWritable()) { + ctx.flush(); + } + } + ctx.flush(); + super.channelActive(ctx); + } + + @Override + public void channelInactive(ChannelHandlerContext ctx) throws Exception { + CompletableFuture completed = onCompleted; + if (!completed.isDone()) { + completed.completeExceptionally(new ClosedChannelException()); + } + super.channelInactive(ctx); + } + + @Override + public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { + if (onCompleted.isDone()) { + ReferenceCountUtil.release(msg); + return; + } + ByteBuf byteBuf = (ByteBuf) msg; + int readableBytes = byteBuf.readableBytes(); + for (int i = 0; i < readableBytes; i++) { + int r = received++; + byte b = byteBuf.readByte(); + if (b != r) { + byteBuf.release(); + onCompleted.completeExceptionally( + new IllegalStateException("unexpected value for index: " + r + " - " + b)); + ctx.close(); + return; + } + } + byteBuf.release(); + if (received > size) { + onCompleted.completeExceptionally( + new IllegalStateException("Received more than requested: " + received)); + ctx.close(); + } else if (received == size) { + onCompleted.complete(null); + ctx.close(); + } + } + + @Override + public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception { + onCompleted.completeExceptionally(new IllegalStateException(cause)); + ctx.close(); + } + } +}