Skip to content

Add stream socket so_linger context option #20808

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
bukka wants to merge 3 commits into
base: master
Choose a base branch
from
+125 −0
Open

Add stream socket so_linger context option #20808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c89842
Add stream socket so_linger context option
bukka Dec 30, 2025
6c67b5f
Use SO_LINGER_SEC if available (MacOS)
bukka Mar 6, 2026
eefbf0e
Do not relay on exact l_onoff value (FreeBSD uses 128 instead of 1)
bukka Mar 6, 2026
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
77 changes: 77 additions & 0 deletions ext/standard/tests/network/so_linger.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
--TEST--
stream_socket_server() and stream_socket_client() SO_LINGER context option test
--EXTENSIONS--
sockets
--SKIPIF--
<?php
if (!defined('SO_LINGER')) {
die('skip SO_LINGER not available');
}
?>
--FILE--
<?php
// Test server with SO_LINGER enabled
$server_context = stream_context_create([
'socket' => [
'so_linger' => 10,
]
]);

$server = stream_socket_server("tcp://127.0.0.1:0", $errno, $errstr,
STREAM_SERVER_BIND | STREAM_SERVER_LISTEN, $server_context);

if (!$server) {
die('Unable to create server');
}

$addr = stream_socket_get_name($server, false);
$port = (int)substr(strrchr($addr, ':'), 1);

// Test client with SO_LINGER enabled
$client_context = stream_context_create([
'socket' => [
'so_linger' => 8,
]
]);

$client = stream_socket_client("tcp://127.0.0.1:$port", $errno, $errstr, 30,
STREAM_CLIENT_CONNECT, $client_context);

if (!$client) {
die('Unable to create client');
}

$accepted = stream_socket_accept($server, 1);

if (!$accepted) {
die('Unable to accept connection');
}

$so_linger = PHP_OS_FAMILY === 'Darwin' ? SO_LINGER_SEC : SO_LINGER;

// Verify server side (accepted connection)
$server_sock = socket_import_stream($accepted);
$server_linger = socket_get_option($server_sock, SOL_SOCKET, $so_linger);
echo "Server SO_LINGER\n";
var_dump($server_linger['l_onoff'] > 0);
var_dump($server_linger['l_linger']);

// Verify client side
$client_sock = socket_import_stream($client);
$client_linger = socket_get_option($client_sock, SOL_SOCKET, $so_linger);
echo "Client SO_LINGER\n";
var_dump($client_linger['l_onoff'] > 0);
var_dump($client_linger['l_linger']);

fclose($accepted);
fclose($client);
fclose($server);

?>
--EXPECT--
Server SO_LINGER
bool(true)
int(10)
Client SO_LINGER
bool(true)
int(8)
26 changes: 26 additions & 0 deletions main/network.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,19 @@ php_socket_t php_network_bind_socket_to_local_addr_ex(const char *host, unsigned

/* Set socket values if provided */
if (sockvals != NULL) {
#ifdef SO_LINGER
if (sockvals->mask & PHP_SOCKVAL_SO_LINGER) {
struct linger linger_val = {
.l_onoff = (sockvals->linger > 0),
.l_linger = (unsigned short)sockvals->linger
Copy link
Member

@devnexen devnexen Mar 7, 2026

Choose a reason for hiding this comment

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

the only subtlety is setting l_onoff with 1 but with l_linger with 0 is a valid use case (closing connection w/o handshake aka RST on close) but you can only carry one value per socket option right ?

Copy link
Member

@devnexen devnexen Mar 7, 2026

Choose a reason for hiding this comment

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

saying that, even rust expresses this in a similar way I just recalled having pushing a PR in there :)

};
#ifdef SO_LINGER_SEC
setsockopt(sock, SOL_SOCKET, SO_LINGER_SEC, (char*)&linger_val, sizeof(linger_val));
#else
setsockopt(sock, SOL_SOCKET, SO_LINGER, (char*)&linger_val, sizeof(linger_val));
#endif
}
#endif
#if defined(TCP_KEEPIDLE)
if (sockvals->mask & PHP_SOCKVAL_TCP_KEEPIDLE) {
setsockopt(sock, IPPROTO_TCP, TCP_KEEPIDLE, (char*)&sockvals->keepalive.keepidle, sizeof(sockvals->keepalive.keepidle));
Expand Down Expand Up @@ -1027,6 +1040,19 @@ php_socket_t php_network_connect_socket_to_host_ex(const char *host, unsigned sh

/* Set socket values if provided */
if (sockvals != NULL) {
#ifdef SO_LINGER
if (sockvals->mask & PHP_SOCKVAL_SO_LINGER) {
struct linger linger_val = {
.l_onoff = (sockvals->linger > 0),
.l_linger = (unsigned short)sockvals->linger
};
#ifdef SO_LINGER_SEC
setsockopt(sock, SOL_SOCKET, SO_LINGER_SEC, (char*)&linger_val, sizeof(linger_val));
#else
setsockopt(sock, SOL_SOCKET, SO_LINGER, (char*)&linger_val, sizeof(linger_val));
#endif
}
#endif
#if defined(TCP_KEEPIDLE)
if (sockvals->mask & PHP_SOCKVAL_TCP_KEEPIDLE) {
setsockopt(sock, IPPROTO_TCP, TCP_KEEPIDLE, (char*)&sockvals->keepalive.keepidle, sizeof(sockvals->keepalive.keepidle));
Expand Down
2 changes: 2 additions & 0 deletions main/php_network.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,12 +271,14 @@ typedef struct {
#define PHP_SOCKVAL_TCP_KEEPIDLE (1 << 1)
#define PHP_SOCKVAL_TCP_KEEPCNT (1 << 2)
#define PHP_SOCKVAL_TCP_KEEPINTVL (1 << 3)
#define PHP_SOCKVAL_SO_LINGER (1 << 4)

#define PHP_SOCKVAL_IS_SET(sockvals, opt) ((sockvals)->mask & (opt))

typedef struct {
unsigned int mask;
int tcp_nodelay;
int linger;
struct {
int keepidle;
int keepcnt;
Expand Down
20 changes: 20 additions & 0 deletions main/streams/xp_socket.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,6 +749,16 @@ static inline int php_tcp_sockop_bind(php_stream *stream, php_netstream_data_t *
}
#endif

#ifdef SO_LINGER
if (PHP_STREAM_XPORT_IS_TCP(stream)
&& PHP_STREAM_CONTEXT(stream)
&& (tmpzval = php_stream_context_get_option(PHP_STREAM_CONTEXT(stream), "socket", "so_linger")) != NULL
) {
sockvals.mask |= PHP_SOCKVAL_SO_LINGER;
sockvals.linger = (int)zval_get_long(tmpzval);
}
#endif

#ifdef SO_KEEPALIVE
if (PHP_STREAM_XPORT_IS_TCP(stream) /* SO_KEEPALIVE is only applicable for TCP */
&& PHP_STREAM_CONTEXT(stream)
Expand Down Expand Up @@ -877,6 +887,16 @@ static inline int php_tcp_sockop_connect(php_stream *stream, php_netstream_data_
sockopts |= STREAM_SOCKOP_TCP_NODELAY;
}

#ifdef SO_LINGER
if (PHP_STREAM_XPORT_IS_TCP(stream)
&& PHP_STREAM_CONTEXT(stream)
&& (tmpzval = php_stream_context_get_option(PHP_STREAM_CONTEXT(stream), "socket", "so_linger")) != NULL
) {
sockvals.mask |= PHP_SOCKVAL_SO_LINGER;
sockvals.linger = (int)zval_get_long(tmpzval);
}
#endif

#ifdef SO_KEEPALIVE
if (PHP_STREAM_XPORT_IS_TCP(stream) /* SO_KEEPALIVE is only applicable for TCP */
&& PHP_STREAM_CONTEXT(stream)
Expand Down
Loading