Add support for setting rcvbuf buffer size on a socket #907

fadushin · 2023-10-29T12:59:32Z

This PR allows users to set the buffer size on receive operations via the socket:setopt/3 function, using the {otp, rcvbuf} configuration option.

This PR addresses Issue #896

These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).

SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later

CHANGELOG.md

doc/src/programmers-guide.md

src/libAtomVM/otp_socket.c

bettio

Let's also do a rebease before going for merge.

fadushin · 2023-11-03T01:37:20Z

src/libAtomVM/otp_socket.c

-        ssize_t buffer_size = len == 0 ? (ssize_t) res : MIN((size_t) res, len);
+        // user-supplied len has higher precedence than the default buffer size, but we also
+        // want the configured default buffer size to be a lower bound on anything we peek
+        ssize_t buffer_size = len == 0 ? MIN((size_t) res, rsrc_obj->buf_size) : MIN((size_t) res, len);


I made a change to the logic here. @pguyot and @bettio please review

Aren't we doing MIN(len == 0 ? rsrc_obj->buf_size : len, res) ?

This change is also a good chance to fix a warning we have:

AtomVM/src/libAtomVM/otp_socket.c:1665:42: warning: operand of ‘?:’ changes signedness from ‘long int’ to ‘long unsigned int’ due to unsignedness of other operand [-Wsign-compare] 1665 | ssize_t buffer_size = len == 0 ? (ssize_t) res : MIN((size_t) res, len); | ^~~~~~~~~~~~~

Aren't we doing MIN(len == 0 ? rsrc_obj->buf_size : len, res) ?

I believe these are equivalent, right? (assuming MIN is commutative) Changed to your version, with changes to address any compiler warnings.

Scanning dependencies of target libAtomVMLinux-x86_64 [ 28%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/mapped_file.c.o [ 28%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/platform_defaultatoms.c.o [ 28%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/smp.c.o [ 28%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/platform_nifs.c.o [ 28%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/socket_driver.c.o [ 28%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/otp_socket_platform.c.o [ 29%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/sys.c.o [ 29%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/__/__/__/libAtomVM/inet.c.o [ 29%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/__/__/__/libAtomVM/otp_net.c.o [ 29%] Building C object src/platforms/generic_unix/lib/CMakeFiles/libAtomVMLinux-x86_64.dir/__/__/__/libAtomVM/otp_socket.c.o [ 29%] Linking C static library liblibAtomVMLinux-x86_64.a [ 29%] Built target libAtomVMLinux-x86_64

tests/libs/estdlib/test_tcp_socket.erl

pguyot · 2023-11-17T18:27:18Z

src/libAtomVM/otp_socket.c

-        ssize_t buffer_size = len == 0 ? (ssize_t) res : MIN((size_t) res, len);
+        // user-supplied len has higher precedence than the default buffer size, but we also
+        // want the configured default buffer size to be a lower bound on anything we peek
+        ssize_t buffer_size = len == 0 ? MIN((size_t) res, rsrc_obj->buf_size) : MIN((size_t) res, len);


Aren't we doing MIN(len == 0 ? rsrc_obj->buf_size : len, res) ?

src/libAtomVM/otp_socket.c

pguyot · 2023-11-23T06:06:51Z

doc/src/programmers-guide.md

@@ -1804,12 +1804,14 @@ Currently, the following options are supported:
 |------------|--------------|-------------|
 | `{socket, reuseaddr}` | `boolean()` | Sets `SO_REUSEADDR` on the socket. |
 | `{socket, linger}` | `#{onoff => boolean(), linger => non_neg_integer()}` | Sets `SO_LINGER` on the socekt. |
+| `{otp, rcvbuf}` | `non_neg_integer()` | Sets the default buffer size (in bytes) on receive calls.  This value is only used if the `Length` parameter of the `socket:recv` family of functions has the value `0`; otherwise, the specified non-zero length in the `socket:recv` takes precendence. |


Can we have 0 for this value?
OTP specifies default | integer()>0

I wonder what the meaning of default is? Would that be for the case in which you set the buffer size to be some value, and then want to set it back to default at a later time?

I'd say in that case we either:

defer implementing that use case (not sure how useful it is) with a TODO

Add support for setting it back to default, if desired (would be easy to do)

Added note to table and TODO in the code. Not sure why CI did not kick off.

Signed-off-by: Fred Dushin <fred@dushin.net>

fadushin force-pushed the set-recv-buffer-size branch 4 times, most recently from d196d2a to ea77a28 Compare October 31, 2023 02:23

fadushin marked this pull request as ready for review October 31, 2023 02:24

fadushin requested review from pguyot and bettio October 31, 2023 02:24

fadushin force-pushed the set-recv-buffer-size branch from ea77a28 to 1b951a5 Compare November 1, 2023 01:08

pguyot reviewed Nov 1, 2023

View reviewed changes

src/libAtomVM/otp_socket.c Show resolved Hide resolved

bettio reviewed Nov 2, 2023

View reviewed changes

src/libAtomVM/otp_socket.c Outdated Show resolved Hide resolved

bettio requested changes Nov 2, 2023

View reviewed changes

fadushin force-pushed the set-recv-buffer-size branch from 1b951a5 to 7b44a4b Compare November 3, 2023 01:32

fadushin commented Nov 3, 2023

View reviewed changes

tests/libs/estdlib/test_tcp_socket.erl Show resolved Hide resolved

fadushin force-pushed the set-recv-buffer-size branch from 7b44a4b to 56f6d31 Compare November 3, 2023 02:41

fadushin marked this pull request as draft November 3, 2023 11:02

fadushin force-pushed the set-recv-buffer-size branch 11 times, most recently from 369f53c to 0bfe2af Compare November 14, 2023 01:58

fadushin marked this pull request as ready for review November 14, 2023 02:47

fadushin requested a review from pguyot November 14, 2023 02:47

fadushin requested a review from bettio November 14, 2023 02:47

pguyot reviewed Nov 17, 2023

View reviewed changes

pguyot reviewed Nov 23, 2023

View reviewed changes

fadushin force-pushed the set-recv-buffer-size branch from 0bfe2af to c2356cc Compare December 5, 2023 02:03

fadushin requested a review from pguyot December 5, 2023 02:10

fadushin force-pushed the set-recv-buffer-size branch from c2356cc to 29b291a Compare December 6, 2023 01:49

Add support for setting recvbuf buffer size on a socket.

5fc7732

Signed-off-by: Fred Dushin <fred@dushin.net>

fadushin force-pushed the set-recv-buffer-size branch from 29b291a to 5fc7732 Compare December 6, 2023 14:27

bettio approved these changes Dec 6, 2023

View reviewed changes

bettio changed the title ~~Add support for setting rcvbuf buffer size on a socket.~~ Add support for setting rcvbuf buffer size on a socket Dec 6, 2023

bettio merged commit 6abb424 into atomvm:master Dec 6, 2023
84 checks passed

fadushin deleted the set-recv-buffer-size branch December 7, 2023 16:43

fadushin mentioned this pull request Dec 27, 2023

Add ability to set buffer size in OTP socket implementation #896

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for setting rcvbuf buffer size on a socket #907

Add support for setting rcvbuf buffer size on a socket #907

fadushin commented Oct 29, 2023

bettio left a comment

fadushin Nov 3, 2023

pguyot Nov 17, 2023

bettio Nov 29, 2023

fadushin Dec 5, 2023

pguyot Nov 17, 2023

pguyot Nov 23, 2023

fadushin Dec 4, 2023

fadushin Dec 6, 2023

Add support for setting rcvbuf buffer size on a socket #907

Add support for setting rcvbuf buffer size on a socket #907

Conversation

fadushin commented Oct 29, 2023

bettio left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment