Skip to content

streams: various small refactoring for stream error API #22847

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

Draft
Girgias wants to merge 2 commits into
base: master
Choose a base branch
from
+65 −58
Draft

streams: various small refactoring for stream error API #22847

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
b758c27
streams: various small refactoring for stream error API
Girgias Jul 21, 2026
49bb245
no need to copy the string as the write property hook handles it
Girgias Jul 21, 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
41 changes: 23 additions & 18 deletions main/streams/php_stream_errors.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,20 @@
BEGIN_EXTERN_C()

/* Error mode context options (internal C constants) */
#define PHP_STREAM_ERROR_MODE_ERROR 0
#define PHP_STREAM_ERROR_MODE_EXCEPTION 1
#define PHP_STREAM_ERROR_MODE_SILENT 2
C23_ENUM(php_stream_error_mode, uint8_t) {
PHP_STREAM_ERROR_MODE_ERROR = 0,
PHP_STREAM_ERROR_MODE_EXCEPTION = 1,
PHP_STREAM_ERROR_MODE_SILENT = 2
};

/* Error store context options (internal C constants) */
#define PHP_STREAM_ERROR_STORE_AUTO 0
#define PHP_STREAM_ERROR_STORE_NONE 1
#define PHP_STREAM_ERROR_STORE_NON_TERM 2
#define PHP_STREAM_ERROR_STORE_TERMINAL 3
#define PHP_STREAM_ERROR_STORE_ALL 4
C23_ENUM(php_stream_error_store_mode, uint8_t) {
PHP_STREAM_ERROR_STORE_AUTO = 0,
PHP_STREAM_ERROR_STORE_NONE = 1,
PHP_STREAM_ERROR_STORE_NON_TERM = 2,
PHP_STREAM_ERROR_STORE_TERMINAL = 3,
PHP_STREAM_ERROR_STORE_ALL = 4
};

/* Maximum operation nesting depth */
#define PHP_STREAM_ERROR_MAX_DEPTH 1000
Expand Down Expand Up @@ -105,8 +109,8 @@ typedef struct {

/* Error operation management */
PHPAPI php_stream_error_operation *php_stream_error_operation_begin(void);
PHPAPI void php_stream_error_operation_end(php_stream_context *context);
PHPAPI void php_stream_error_operation_end_for_stream(php_stream *stream);
PHPAPI void php_stream_error_operation_end(const php_stream_context *context);
PHPAPI void php_stream_error_operation_end_for_stream(const php_stream *stream);
PHPAPI void php_stream_error_operation_abort(void);

/* State cleanup function */
Expand All @@ -120,35 +124,36 @@ PHPAPI void php_stream_error_clear_stored(void);

/* Wrapper error reporting functions */
PHPAPI void php_stream_wrapper_error_with_name(const char *wrapper_name,
php_stream_context *context, const char *docref, int options, int severity,
const php_stream_context *context, const char *docref, int options, int severity,
bool terminating, zend_enum_StreamErrorCode code, const char *fmt, ...)
ZEND_ATTRIBUTE_FORMAT(printf, 8, 9);

PHPAPI void php_stream_wrapper_error(php_stream_wrapper *wrapper, php_stream_context *context,
PHPAPI void php_stream_wrapper_error(
const php_stream_wrapper *wrapper, const php_stream_context *context,
const char *docref, int options, int severity, bool terminating,
zend_enum_StreamErrorCode code, const char *fmt, ...)
ZEND_ATTRIBUTE_FORMAT(printf, 8, 9);

PHPAPI void php_stream_error(php_stream *stream, const char *docref, int severity,
PHPAPI void php_stream_error(const php_stream *stream, const char *docref, int severity,
bool terminating, zend_enum_StreamErrorCode code, const char *fmt, ...)
ZEND_ATTRIBUTE_FORMAT(printf, 6, 7);

/* Legacy wrapper error log functions */
PHPAPI void php_stream_wrapper_log_error(const php_stream_wrapper *wrapper,
php_stream_context *context, int options, int severity, bool terminating,
const php_stream_context *context, int options, int severity, bool terminating,
zend_enum_StreamErrorCode code, const char *fmt, ...)
ZEND_ATTRIBUTE_FORMAT(printf, 7, 8);

PHPAPI void php_stream_display_wrapper_name_errors(const char *wrapper_name,
php_stream_context *context, zend_enum_StreamErrorCode code,
const php_stream_context *context, zend_enum_StreamErrorCode code,
const char *caption);

PHPAPI void php_stream_display_wrapper_errors(php_stream_wrapper *wrapper,
php_stream_context *context, zend_enum_StreamErrorCode code,
PHPAPI void php_stream_display_wrapper_errors(const php_stream_wrapper *wrapper,
const php_stream_context *context, zend_enum_StreamErrorCode code,
const char *caption);

PHPAPI void php_stream_tidy_wrapper_name_error_log(const char *wrapper_name);
PHPAPI void php_stream_tidy_wrapper_error_log(php_stream_wrapper *wrapper);
PHPAPI void php_stream_tidy_wrapper_error_log(const php_stream_wrapper *wrapper);

/* Convenience macros - code argument is the bare case name (e.g. RenameFailed) */
#define php_stream_wrapper_warn(wrapper, context, options, code, ...) \
Expand Down
82 changes: 42 additions & 40 deletions main/streams/stream_errors.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ static zend_class_entry *php_ce_stream_exception;
static void php_stream_error_entry_free(php_stream_error_entry *entry);

/* Helper to create a single StreamError object from an entry */
static void php_stream_error_create_object(zval *zv, php_stream_error_entry *entry)
static void php_stream_error_create_object(zval *zv, const php_stream_error_entry *entry)
{
object_init_ex(zv, php_ce_stream_error);

Expand Down Expand Up @@ -69,11 +69,11 @@ static void php_stream_error_create_object(zval *zv, php_stream_error_entry *ent
}

/* Create array of StreamError objects from error chain */
PHPAPI void php_stream_error_create_array(zval *zv, php_stream_error_entry *first)
static void php_stream_error_create_array(zval *zv, const php_stream_error_entry *first)
{
array_init(zv);

php_stream_error_entry *entry = first;
const php_stream_error_entry *entry = first;
while (entry) {
zval error_obj;
php_stream_error_create_object(&error_obj, entry);
Expand All @@ -84,7 +84,7 @@ PHPAPI void php_stream_error_create_array(zval *zv, php_stream_error_entry *firs

/* Context option helpers */

static int php_stream_auto_decide_error_store_mode(int error_mode)
static php_stream_error_store_mode php_stream_auto_decide_error_store_mode(php_stream_error_mode error_mode)
{
switch (error_mode) {
case PHP_STREAM_ERROR_MODE_ERROR:
Expand All @@ -98,7 +98,7 @@ static int php_stream_auto_decide_error_store_mode(int error_mode)
}
}

static int php_stream_get_error_mode(php_stream_context *context)
static php_stream_error_mode php_stream_get_error_mode(const php_stream_context *context)
{
if (!context) {
return PHP_STREAM_ERROR_MODE_ERROR;
Expand Down Expand Up @@ -127,7 +127,7 @@ static int php_stream_get_error_mode(php_stream_context *context)
return PHP_STREAM_ERROR_MODE_ERROR;
}

static int php_stream_get_error_store_mode(php_stream_context *context, int error_mode)
static php_stream_error_store_mode php_stream_get_error_store_mode(const php_stream_context *context, php_stream_error_mode error_mode)
{
if (!context) {
return php_stream_auto_decide_error_store_mode(error_mode);
Expand Down Expand Up @@ -162,9 +162,9 @@ static int php_stream_get_error_store_mode(php_stream_context *context, int erro

/* Helper functions */

static bool php_stream_has_terminating_error(php_stream_error_operation *op)
static bool php_stream_has_terminating_error(const php_stream_error_operation *op)
{
php_stream_error_entry *entry = op->first_error;
const php_stream_error_entry *entry = op->first_error;
while (entry) {
if (entry->terminating) {
return true;
Expand All @@ -189,7 +189,7 @@ static inline php_stream_error_operation *php_stream_get_operation_at_depth(uint

static inline php_stream_error_operation *php_stream_get_parent_operation(void)
{
php_stream_error_state *state = &FG(stream_error_state);
const php_stream_error_state *state = &FG(stream_error_state);

if (state->operation_depth <= 1) {
return NULL;
Expand Down Expand Up @@ -249,7 +249,7 @@ PHPAPI void php_stream_error_state_cleanup(void)

PHPAPI void php_stream_error_get_last(zval *return_value)
{
php_stream_error_state *state = &FG(stream_error_state);
const php_stream_error_state *state = &FG(stream_error_state);

if (!state->stored_errors) {
ZVAL_EMPTY_ARRAY(return_value);
Expand Down Expand Up @@ -283,7 +283,7 @@ PHPAPI php_stream_error_operation *php_stream_error_operation_begin(void)

if (state->operation_depth >= PHP_STREAM_ERROR_MAX_DEPTH) {
php_error_docref(NULL, E_WARNING,
"Stream error operation depth exceeded (%u), possible infinite recursion",
"Stream error operation depth exceeded (%"PRIu32"), possible infinite recursion",
state->operation_depth);
return NULL;
}
Expand Down Expand Up @@ -343,7 +343,7 @@ static void php_stream_error_add(zend_enum_StreamErrorCode code, const char *wra

/* Error reporting */

static void php_stream_call_error_handler(zval *handler, zval *errors_array)
static void php_stream_call_error_handler(const zval *handler, zval *errors_array)
{
zend_fcall_info_cache fcc;
char *is_callable_error = NULL;
Expand All @@ -359,7 +359,7 @@ static void php_stream_call_error_handler(zval *handler, zval *errors_array)
zend_call_known_fcc(&fcc, NULL, 1, errors_array, NULL);
}

static void php_stream_throw_exception_with_errors(php_stream_error_operation *op)
static void php_stream_throw_exception_with_errors(const php_stream_error_operation *op)
{
if (!op->first_error) {
return;
Expand All @@ -369,8 +369,8 @@ static void php_stream_throw_exception_with_errors(php_stream_error_operation *o
object_init_ex(&ex, php_ce_stream_exception);

/* Set message from first error */
zend_update_property_string(php_ce_stream_exception, Z_OBJ(ex), ZEND_STRL("message"),
ZSTR_VAL(op->first_error->message));
zend_update_property_str(php_ce_stream_exception, Z_OBJ(ex), ZEND_STRL("message"),
op->first_error->message);

/* Set code from first error */
zend_update_property_long(php_ce_stream_exception, Z_OBJ(ex), ZEND_STRL("code"),
Expand All @@ -385,8 +385,8 @@ static void php_stream_throw_exception_with_errors(php_stream_error_operation *o
zend_throw_exception_object(&ex);
}

static void php_stream_report_errors(php_stream_context *context, php_stream_error_operation *op,
int error_mode, bool is_terminating)
static void php_stream_report_errors(const php_stream_context *context, const php_stream_error_operation *op,
php_stream_error_mode error_mode, bool is_terminating)
{
switch (error_mode) {
case PHP_STREAM_ERROR_MODE_ERROR: {
Expand All @@ -410,7 +410,7 @@ static void php_stream_report_errors(php_stream_context *context, php_stream_err
}

/* Call user error handler if set */
zval *handler
const zval *handler
= context ? php_stream_context_get_option(context, "stream", "error_handler") : NULL;

if (handler) {
Expand All @@ -425,7 +425,7 @@ static void php_stream_report_errors(php_stream_context *context, php_stream_err

/* Error storage */

PHPAPI void php_stream_error_operation_end(php_stream_context *context)
PHPAPI void php_stream_error_operation_end(const php_stream_context *context)
{
php_stream_error_state *state = &FG(stream_error_state);
php_stream_error_operation *op = state->current_operation;
Expand All @@ -439,8 +439,8 @@ PHPAPI void php_stream_error_operation_end(php_stream_context *context)
context = FG(default_context);
}

int error_mode = php_stream_get_error_mode(context);
int store_mode = php_stream_get_error_store_mode(context, error_mode);
php_stream_error_mode error_mode = php_stream_get_error_mode(context);
php_stream_error_store_mode store_mode = php_stream_get_error_store_mode(context, error_mode);

bool is_terminating = php_stream_has_terminating_error(op);

Expand Down Expand Up @@ -517,7 +517,7 @@ PHPAPI void php_stream_error_operation_end(php_stream_context *context)
op->error_count = 0;
}

PHPAPI void php_stream_error_operation_end_for_stream(php_stream *stream)
PHPAPI void php_stream_error_operation_end_for_stream(const php_stream *stream)
{
php_stream_error_state *state = &FG(stream_error_state);
php_stream_error_operation *op = state->current_operation;
Expand All @@ -535,7 +535,7 @@ PHPAPI void php_stream_error_operation_end_for_stream(php_stream *stream)
return;
}

php_stream_context *context = PHP_STREAM_CONTEXT(stream);
const php_stream_context *context = PHP_STREAM_CONTEXT(stream);
php_stream_error_operation_end(context);
}

Expand All @@ -559,7 +559,7 @@ PHPAPI void php_stream_error_operation_abort(void)

/* Wrapper error reporting */

static void php_stream_wrapper_error_internal(const char *wrapper_name, php_stream_context *context,
static void php_stream_wrapper_error_internal(const char *wrapper_name, const php_stream_context *context,
const char *docref, int severity, bool terminating,
zend_enum_StreamErrorCode code, zend_string *message)
{
Expand All @@ -576,7 +576,7 @@ static void php_stream_wrapper_error_internal(const char *wrapper_name, php_stre
}

PHPAPI void php_stream_wrapper_error_with_name(const char *wrapper_name,
php_stream_context *context, const char *docref, int options, int severity,
const php_stream_context *context, const char *docref, int options, int severity,
bool terminating, zend_enum_StreamErrorCode code, const char *fmt, ...)
{
if (!(options & REPORT_ERRORS)) {
Expand All @@ -592,7 +592,9 @@ PHPAPI void php_stream_wrapper_error_with_name(const char *wrapper_name,
wrapper_name, context, docref, severity, terminating, code, message);
}

PHPAPI void php_stream_wrapper_error(php_stream_wrapper *wrapper, php_stream_context *context,
PHPAPI void php_stream_wrapper_error(
const php_stream_wrapper *wrapper,
const php_stream_context *context,
const char *docref, int options, int severity, bool terminating,
zend_enum_StreamErrorCode code, const char *fmt, ...)
{
Expand All @@ -613,7 +615,7 @@ PHPAPI void php_stream_wrapper_error(php_stream_wrapper *wrapper, php_stream_con

/* Stream error reporting */

PHPAPI void php_stream_error(php_stream *stream, const char *docref, int severity,
PHPAPI void php_stream_error(const php_stream *stream, const char *docref, int severity,
bool terminating, zend_enum_StreamErrorCode code, const char *fmt, ...)
{
va_list args;
Expand All @@ -624,7 +626,7 @@ PHPAPI void php_stream_error(php_stream *stream, const char *docref, int severit

const char *wrapper_name = stream->wrapper ? stream->wrapper->wops->label : "stream";

php_stream_context *context = PHP_STREAM_CONTEXT(stream);
const php_stream_context *context = PHP_STREAM_CONTEXT(stream);

php_stream_wrapper_error_internal(wrapper_name, context, docref, severity,
terminating, code, message);
Expand Down Expand Up @@ -678,7 +680,7 @@ static void php_stream_wrapper_log_store_error(zend_string *message, zend_enum_S
}

PHPAPI void php_stream_wrapper_log_error(const php_stream_wrapper *wrapper,
php_stream_context *context, int options, int severity, bool terminating,
const php_stream_context *context, int options, int severity, bool terminating,
zend_enum_StreamErrorCode code, const char *fmt, ...)
{
va_list args;
Expand Down Expand Up @@ -706,12 +708,12 @@ static zend_llist *php_stream_get_wrapper_errors_list(const char *wrapper_name)
}

PHPAPI void php_stream_display_wrapper_name_errors(const char *wrapper_name,
php_stream_context *context, zend_enum_StreamErrorCode code,
const php_stream_context *context, zend_enum_StreamErrorCode code,
const char *caption)
{
char *msg;
char errstr[256];
int free_msg = 0;
bool free_msg = false;

if (EG(exception)) {
return;
Expand All @@ -721,9 +723,7 @@ PHPAPI void php_stream_display_wrapper_name_errors(const char *wrapper_name,
zend_llist *err_list = php_stream_get_wrapper_errors_list(wrapper_name);
if (err_list) {
size_t l = 0;
int brlen;
int i;
int count = (int) zend_llist_count(err_list);
size_t brlen;
const char *br;
php_stream_error_entry **err_entry_p;
zend_llist_position pos;
Expand All @@ -736,7 +736,9 @@ PHPAPI void php_stream_display_wrapper_name_errors(const char *wrapper_name,
br = "\n";
}

for (err_entry_p = zend_llist_get_first_ex(err_list, &pos), i = 0; err_entry_p;
size_t i = 0;
const size_t count = zend_llist_count(err_list);
for (i = 0, err_entry_p = zend_llist_get_first_ex(err_list, &pos); err_entry_p;
err_entry_p = zend_llist_get_next_ex(err_list, &pos), i++) {
l += ZSTR_LEN((*err_entry_p)->message);
if (i < count - 1) {
Expand All @@ -753,7 +755,7 @@ PHPAPI void php_stream_display_wrapper_name_errors(const char *wrapper_name,
}
}

free_msg = 1;
free_msg = true;
} else {
if (!strcmp(wrapper_name, php_plain_files_wrapper.wops->label)) {
msg = php_socket_strerror_s(errno, errstr, sizeof(errstr));
Expand All @@ -775,8 +777,8 @@ PHPAPI void php_stream_display_wrapper_name_errors(const char *wrapper_name,
}
}

PHPAPI void php_stream_display_wrapper_errors(php_stream_wrapper *wrapper,
php_stream_context *context, zend_enum_StreamErrorCode code,
PHPAPI void php_stream_display_wrapper_errors(const php_stream_wrapper *wrapper,
const php_stream_context *context, zend_enum_StreamErrorCode code,
const char *caption)
{
if (wrapper) {
Expand All @@ -792,7 +794,7 @@ PHPAPI void php_stream_tidy_wrapper_name_error_log(const char *wrapper_name)
}
}

PHPAPI void php_stream_tidy_wrapper_error_log(php_stream_wrapper *wrapper)
PHPAPI void php_stream_tidy_wrapper_error_log(const php_stream_wrapper *wrapper)
{
if (wrapper) {
const char *wrapper_name = PHP_STREAM_ERROR_WRAPPER_NAME(wrapper);
Expand All @@ -806,7 +808,7 @@ PHP_METHOD(StreamException, getErrors)
{
ZEND_PARSE_PARAMETERS_NONE();

zval *errors = zend_read_property(
const zval *errors = zend_read_property(
php_ce_stream_exception, Z_OBJ_P(ZEND_THIS), ZEND_STRL("errors"), 1, NULL);

RETURN_COPY(errors);
Expand Down
Loading