Skip to content

Fix GH-18139: Memory leak when overriding some settings via readline_info() #20794

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
ndossche wants to merge 2 commits into
base: PHP-8.3
Choose a base branch
from
+37 −9
Open

Fix GH-18139: Memory leak when overriding some settings via readline_info() #20794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e4c0c7
Fix GH-18139: Memory leak when overriding some settings via readline_…
ndossche Dec 28, 2025
649da43
settings state is sticky, fix test expectation for that
ndossche Dec 28, 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
28 changes: 19 additions & 9 deletions ext/readline/readline.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ static zval _prepped_callback;
static zval _readline_completion;
static zval _readline_array;

ZEND_TLS char *php_readline_custom_readline_name = NULL;
ZEND_TLS char *php_readline_custom_line_buffer = NULL;

PHP_MINIT_FUNCTION(readline);
PHP_MSHUTDOWN_FUNCTION(readline);
PHP_RSHUTDOWN_FUNCTION(readline);
Expand Down Expand Up @@ -146,7 +149,6 @@ PHP_FUNCTION(readline_info)
zend_string *what = NULL;
zval *value = NULL;
size_t oldval;
char *oldstr;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "|S!z!", &what, &value) == FAILURE) {
RETURN_THROWS();
Expand Down Expand Up @@ -181,15 +183,19 @@ PHP_FUNCTION(readline_info)
add_assoc_long(return_value,"attempted_completion_over",rl_attempted_completion_over);
} else {
if (zend_string_equals_literal_ci(what,"line_buffer")) {
oldstr = rl_line_buffer;
RETVAL_STRING(SAFE_STRING(rl_line_buffer));
if (value) {
/* XXX if (rl_line_buffer) free(rl_line_buffer); */
if (!try_convert_to_string(value)) {
RETURN_THROWS();
}
rl_line_buffer = strdup(Z_STRVAL_P(value));
char *copy = strdup(Z_STRVAL_P(value));
/* XXX: This store would need to be atomic ideally or use a memory barrier */
rl_line_buffer = copy;
if (php_readline_custom_line_buffer) {
free(php_readline_custom_line_buffer);
}
php_readline_custom_line_buffer = copy;
}
RETVAL_STRING(SAFE_STRING(oldstr));
} else if (zend_string_equals_literal_ci(what, "point")) {
RETVAL_LONG(rl_point);
#ifndef PHP_WIN32
Expand Down Expand Up @@ -248,15 +254,19 @@ PHP_FUNCTION(readline_info)
RETVAL_STRING((char *)SAFE_STRING(rl_library_version));
#endif
} else if (zend_string_equals_literal_ci(what, "readline_name")) {
oldstr = (char*)rl_readline_name;
RETVAL_STRING(SAFE_STRING(rl_readline_name));
if (value) {
/* XXX if (rl_readline_name) free(rl_readline_name); */
if (!try_convert_to_string(value)) {
RETURN_THROWS();
}
rl_readline_name = strdup(Z_STRVAL_P(value));
char *copy = strdup(Z_STRVAL_P(value));
/* XXX: This store would need to be atomic ideally or use a memory barrier */
rl_readline_name = copy;
if (php_readline_custom_readline_name) {
free(php_readline_custom_readline_name);
}
php_readline_custom_readline_name = copy;
}
RETVAL_STRING(SAFE_STRING(oldstr));
} else if (zend_string_equals_literal_ci(what, "attempted_completion_over")) {
oldval = rl_attempted_completion_over;
if (value) {
Expand Down
18 changes: 18 additions & 0 deletions ext/readline/tests/gh18139.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
--TEST--
GH-18139 (Memory leak when overriding some settings via readline_info())
--EXTENSIONS--
readline
--FILE--
<?php

var_dump(readline_info('readline_name', 'first'));
var_dump(readline_info('readline_name', 'second'));
var_dump(readline_info('line_buffer', 'third'));
var_dump(readline_info('line_buffer', 'fourth'));

?>
--EXPECTF--
string(%d) "%S"
string(5) "first"
string(%d) "%S"
string(5) "third"
Loading