Skip to content

ext/sockets: adding Linux's TCP_USER_TIMEOUT constant. #20708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lucasnetau wants to merge 9 commits into
base: master
Choose a base branch
from
+68 −2
Open

ext/sockets: adding Linux's TCP_USER_TIMEOUT constant. #20708

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d87015f
ext/sockets: adding Linux's TCP_USER_TIMEOUT constant.
lucasnetau Dec 15, 2025
67ee0ad
TCP_USER_TIMEOUT expects unsigned integer
lucasnetau Dec 15, 2025
1117658
Fix test case
lucasnetau Dec 16, 2025
1cd17b1
Update testcase with UINT_MAX expected output
lucasnetau Dec 16, 2025
a804258
Use ZEND_LONG_UINT_OVFL
lucasnetau Dec 16, 2025
840e546
RETURN_THROWS();
lucasnetau Dec 16, 2025
efb6560
Long to unsigned int
lucasnetau Dec 16, 2025
66a4ea4
long
lucasnetau Dec 16, 2025
dab9d20
Revert to original check
lucasnetau Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions NEWS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ PHP NEWS
. Soap::__setCookie() when cookie name is a digit is now not stored and represented
as a string anymore but a int. (David Carlier)

- Sockets:
. Added the TCP_USER_TIMEOUT constant for Linux to set the maximum time in milliseconds
transmitted data can remain unacknowledged. (James Lucas)

- SPL:
. DirectoryIterator key can now work better with filesystem supporting larger
directory indexing. (David Carlier)
Expand Down
3 changes: 3 additions & 0 deletions UPGRADING
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ PHP 8.6 UPGRADE NOTES
10. New Global Constants
========================================

- Sockets:
. TCP_USER_TIMEOUT (Linux only).

========================================
11. Changes to INI File Handling
========================================
Expand Down
16 changes: 16 additions & 0 deletions ext/sockets/sockets.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2329,6 +2329,22 @@ PHP_FUNCTION(socket_set_option)
}
#endif

#if defined(TCP_USER_TIMEOUT)
case TCP_USER_TIMEOUT: {
ov = zval_get_long(arg4);
Copy link
Member

@devnexen devnexen Dec 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my bad, I realise ov is an int.
you would need the following change

zend_long timeout = zval_get_long(arg4);
<overflow check on timeout>
unsigned int val = (unsigned int)timeout;
optlen = sizeof(val);
opt_ptr = &val;

Copy link
Member

@devnexen devnexen Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not mean this. more like

case TCP_USER_TIMEOUT: {
			zend_long timeout timeout = zval_get_long(arg4);
// TCP_USER_TIMEOUT unsigned int
			if (timeout < 0 || timeout > UINT_MAX) {
				zend_argument_value_error(4, "must be of between 0 and %u", UINT_MAX);
				RETURN_THROWS();
			}
            unsigned int val = (unsigned int)timeout;
			optlen = sizeof(val);
			opt_ptr = &val;
			break;

Your test passes because you test -1, but ov can never be greater than UINT_MAX.

Copy link
Member

@devnexen devnexen Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bear with me :) we re almost there.


// TCP_USER_TIMEOUT unsigned int
if (ov < 0 || ov > UINT_MAX) {
zend_argument_value_error(4, "must be of between 0 and %u", UINT_MAX);
RETURN_FALSE;
}

optlen = sizeof(ov);
opt_ptr = &ov;
break;
}
#endif

#if defined(UDP_SEGMENT)
case UDP_SEGMENT: {
ov = zval_get_long(arg4);
Expand Down
7 changes: 7 additions & 0 deletions ext/sockets/sockets.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,13 @@
*/
const TCP_SYNCNT = UNKNOWN;
#endif
#ifdef TCP_USER_TIMEOUT
/**
* @var int
* @cvalue TCP_USER_TIMEOUT
*/
const TCP_USER_TIMEOUT = UNKNOWN;
#endif
#ifdef SO_ZEROCOPY
/**
* @var int
Expand Down
5 changes: 4 additions & 1 deletion ext/sockets/sockets_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 33 additions & 0 deletions ext/sockets/tests/socket_setoption_tcpusertimeout.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
--TEST--
Test if socket_set_option() works, option:TCP_USER_TIMEOUT
--EXTENSIONS--
sockets
--SKIPIF--
<?php
if (!defined('TCP_USER_TIMEOUT')) { die('skip TCP_USER_TIMEOUT is not defined'); }
?>
--FILE--
<?php
$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
if (!$socket) {
die('Unable to create AF_INET socket [socket]');
}
socket_set_block($socket);

try {
socket_setopt($socket, SOL_TCP, TCP_USER_TIMEOUT, -1);
} catch (\ValueError $e) {
echo $e->getMessage(), PHP_EOL;
}

$timeout = 200;
$retval_2 = socket_set_option($socket, SOL_TCP, TCP_USER_TIMEOUT, $timeout);
$retval_3 = socket_get_option($socket, SOL_TCP, TCP_USER_TIMEOUT);
var_dump($retval_2);
var_dump($retval_3 === $timeout);
socket_close($socket);
?>
--EXPECT--
socket_setopt(): Argument #4 ($value) must be of between 0 and 4294967295
bool(true)
bool(true)