Skip to content

Conversation

@arnaud-lb
Copy link
Member

@arnaud-lb arnaud-lb commented Jan 6, 2026

RFC: https://wiki.php.net/rfc/partial_function_application_v2

This follows #20717. This implements most of the RFC, except PFAs in constant expressions, and some optimization.

I wanted to split this PR more, but I didn't find a way to achieve this that makes sense.


A partial application is compiled to the usual sequence of function call
opcodes (INIT_FCALL, SEND_VAR, etc), but the sequence ends with a
CALLABLE_CONVERT_PARTIAL opcode instead of DO_FCALL, similarly to
first class callables. Placeholders are compiled to SEND_PLACEHOLDER opcodes:

$f = f($a, ?)
0001 INIT_FCALL f
0002 SEND_VAR CV($a)
0003 SEND_PLACEHOLDER
0004 CV($f) = CALLABLE_CONVERT_PARTIAL

SEND_PLACEHOLDER sets the argument slot type to _IS_PLACEHOLDER.

CALLABLE_CONVERT_PARTIAL uses the information available on the stack to
create a Closure and return it, consuming the stack frame in the process
like an internal function call.

We create the Closure by generating the relevant AST and compiling it to an
op_array.

The op_array is cached in the Opcache SHM and inline caches. The SHM key is prefixed with pfa:// to avoid any collision with actual files. When Opcache is disabled, we cache PFA op_arrays a global hash table. This is mainly useful for polymorphic PFAs, as the inline cache stores only a single entry.

Copy link
Member

@TimWolla TimWolla left a comment

Choose a reason for hiding this comment

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

Looked at 43/143 files with a mix of tests and C code.


?>
--EXPECTF--
Fatal error: Uncaught ArgumentCountError: f(): Argument #2 ($b) not passed in %s:6
Copy link
Member

Choose a reason for hiding this comment

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

Is it possible to improve the error message here to make it clear that this is happening during partial application?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is not specific to partials: https://3v4l.org/biQNc


?>
--EXPECT--
ArgumentCountError: Closure::__invoke(): Argument #3 ($c) must be passed explicitly, because the default value is not known
Copy link
Member

Choose a reason for hiding this comment

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

As a user the error message reads odd, because stating that the default value is “unknown” implies that it is unclear whether there is one. If this is a technical restriction this should be rephrased to something like “cannot be determined for Closures” or something like that.

Copy link
Member Author

Choose a reason for hiding this comment

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

This error is not specific to partials or Closures: https://3v4l.org/Kl9M1

It is thrown when a parameter with position n < func_num_args() is not specified, and has a default value of UNKNOWN, like here:

function array_keys(array $array, mixed $filter_value = UNKNOWN, bool $strict = false): array {}

The reason it can happen is that functions assume that all arguments bellow func_num_args() are specified, but due to named args it's not always the case. So the engine fills the unspecified args bellow func_num_args() with their default value, but that's not possible with UNKNOWN.

Closure::__invoke() is a special case of this, as the default value is always unknown for this function (this affects only calling __invoke() explicitly).

I'm realizing that in the context of PFAs, we could probably avoid this by making placeholders without a default value required. I can look at this in a separate PR after this one.

Copy link
Member

@TimWolla TimWolla left a comment

Choose a reason for hiding this comment

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

74/144

Comment on lines +13 to +14

Deprecated: Using "_" as a type name is deprecated since 8.4 in %s on line 5
Copy link
Member

Choose a reason for hiding this comment

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

I think this error message being emitted here is not great, because this is not actionable by the user who have written the PFA call (it can only be fixed by the author of the function being called).

Copy link
Member Author

Choose a reason for hiding this comment

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

Indeed.

Possible alternative ways to handle these errors:

  1. Prefix errors with "During compilation of partial application:"
  2. Discard non-fatal errors emitted during compilation of PFAs
  3. Implement workarounds to avoid emitting any error

The second one seems to be the most sensible, as the errors are actually related to the function being called.

Copy link
Member

Choose a reason for hiding this comment

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

I can't imagine what else than Foo would be returned for get_called_class(). Should this test involve inheritance?

Copy link
Member Author

@arnaud-lb arnaud-lb Jan 8, 2026

Choose a reason for hiding this comment

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

Yes, this is just testing basic functionality. That get_called_class() works as expected is obvious with the current implementation, but may not have been with the previous one where the call was made in a more custom way.

@arnaud-lb arnaud-lb marked this pull request as ready for review January 13, 2026 15:13
@arnaud-lb arnaud-lb requested a review from dstogov as a code owner January 13, 2026 15:13
Copy link
Member

@TimWolla TimWolla left a comment

Choose a reason for hiding this comment

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

At 100/146 files now. Looked at a majority (but not yet all of the tests). Only looked at the C files with a "small" number of changes, since I can only mark files as reviewed in a binary fashion and preferred getting as many files collapsed as possible.

@@ %s 6 - 6

- Bound Variables [2] {
Variable #0 [ $fn ]
Copy link
Member

Choose a reason for hiding this comment

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

Should we have a second test (same file is fine) where one of the Closure parameters is called $fn?

* in this case. */
ptr = called_function->op_array.opcodes;
} else {
ptr = (void*) called_function;
Copy link
Member

Choose a reason for hiding this comment

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

Explicit void casts always look fishy. Is this because of the const? Declare const void *ptr; then.

Suggested change
ptr = (void*) called_function;
ptr = called_function;

return key;
}

zend_op_array *zend_accel_pfa_cache_get(const zend_op_array *declaring_op_array,
Copy link
Member

Choose a reason for hiding this comment

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

Can / Should this return const zend_op_array *?

func->num_args = 0;
func->required_num_args = 0;
func->arg_info = (zend_arg_info *) arg_info;
func->arg_info = zend_call_trampoline_arginfo;
Copy link
Member

Choose a reason for hiding this comment

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

Is this a pre-existing bug? This should be spun out into a separate PR then.

I stumbled over this part of the diff for a while, since I didn't see where you introduced zend_call_trampoline_arginfo until I realized this is not new.

Copy link
Member

@TimWolla TimWolla left a comment

Choose a reason for hiding this comment

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

Did a first pass at zend_partial.c

Comment on lines +57 to +58
#define IS_STATIC_CLOSURE(function) \
(((function)->common.fn_flags & (ZEND_ACC_STATIC|ZEND_ACC_CLOSURE)) == (ZEND_ACC_STATIC|ZEND_ACC_CLOSURE))
Copy link
Member

Choose a reason for hiding this comment

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

This could be a proper (inline) function.

return SUCCESS;
}

static bool zp_name_exists(zend_string **names, uint32_t num_names, zend_string *name)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
static bool zp_name_exists(zend_string **names, uint32_t num_names, zend_string *name)
static bool zp_name_exists(const zend_string **names, uint32_t num_names, const zend_string *name)

Constifying to make Gina happy.

Comment on lines +169 to +179
uint32_t n = offset - function->common.num_args;
zend_string *orig_name = zp_get_param_name(function, function->common.num_args);
zend_string *new_name;
do {
new_name = zend_strpprintf_unchecked(0, "%S%" PRIu32, orig_name, n);
if (!zp_name_exists(names, num_names, new_name)) {
break;
}
n++;
zend_string_release(new_name);
} while (true);
Copy link
Member

Choose a reason for hiding this comment

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

I stumbled over the "infinite" do-while loop, because that intuitively feels more complicated than a regular while(true). I see why it's done here that way when reading the code.

Here's a suggestion that perhaps makes the intent more clear. Feel free to disregard:

Suggested change
uint32_t n = offset - function->common.num_args;
zend_string *orig_name = zp_get_param_name(function, function->common.num_args);
zend_string *new_name;
do {
new_name = zend_strpprintf_unchecked(0, "%S%" PRIu32, orig_name, n);
if (!zp_name_exists(names, num_names, new_name)) {
break;
}
n++;
zend_string_release(new_name);
} while (true);
zend_string *orig_name = zp_get_param_name(function, function->common.num_args);
zend_string *new_name;
for (uint32_t n = offset - function->common.num_args;; n++) {
new_name = zend_strpprintf_unchecked(0, "%S%" PRIu32, orig_name, n);
if (!zp_name_exists(names, num_names, new_name)) {
break;
}
zend_string_release(new_name);
}

}
}

static bool zp_is_power_of_two(uint32_t x)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
static bool zp_is_power_of_two(uint32_t x)
static inline bool zp_is_power_of_two(uint32_t x)

FWIW: This is in C23 as stdc_has_single_bit_*() and could possibly be polyfilled in zend_portability.h.

}

/* Can not use zend_argument_error() as the function is not on the stack */
static zend_never_inline ZEND_COLD void zp_argument_error(zend_class_entry *error_ce,
Copy link
Member

Choose a reason for hiding this comment

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

This would possibly also be useful for the new TYPE_ASSERT OPcode from my array_map() optimization PR.

} else {
ZEND_ASSERT(opline->opcode == ZEND_RECV);
}
} else if (function->type == ZEND_INTERNAL_FUNCTION) {
Copy link
Member

Choose a reason for hiding this comment

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

Is there a type that is neither USER nor INTERNAL? Otherwise this should just be an else (or possibly an else with an unreachable).

default_value_ast, attributes_ast, NULL, NULL);

} else if (!Z_ISUNDEF(argv[offset])) {
// TODO: If the pre-bound parameter is a literal, it can be a
Copy link
Member

Choose a reason for hiding this comment

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

TODO

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants