Language: include() does not mark path for include_once — Zend skips + true (Zend/zend_execute.c)

[PurHur]

Category

Language · php-src-strict · include / include_once EG(included_files)

Problem

Zend records every successful include/require in EG(included_files). A later include_once/require_once of the same path must skip re-execution and return boolean true.

This compiler only calls Context::markCompileUnitLoaded() on the *_once opcodes. A prior plain include updates get_included_files() via recordIncludedFile() but does not set the once-guard, so the next include_once re-runs the file and returns its return value again.

include_once twice (no intervening plain include) already matches Zend — the once-table itself works.

Probed 2026-08-18 @ 03a5c7b939 — Zend 8.2.32 vs php bin/vm.php / php bin/jit.php.

Repro	Zend 8.2.32	VM / JIT (2026-08-18)
file echo "RUN\n"; return 42; then include $f; include_once $f;	RUN once, then 42 / true	RUN twice, 42 / 42
include_once $g; include_once $g; (control)	RUN2 once, 7 / true	same (green)

php-src reference

• php/php-src Zend/zend_execute.c — ZEND_INCLUDE_OR_EVAL, zend_hash_add_empty_element(&EG(included_files), …) on all successful includes; once kinds skip when the key exists and return true

PHP implementation target

• lib/VM.php — TYPE_INCLUDE handler (~L9965–9975): call markCompileUnitLoaded() for plain include/require as well as *_once (or key the once-guard off recordIncludedFile / includedFiles)
• lib/VM/Context.php — markCompileUnitLoaded / isCompileUnitLoaded / recordIncludedFile should share one table matching EG(included_files)
• lib/VM/VmInclude.php — keep skip-return true; JIT/AOT go through the same helper
• Distinct from Language: var_export(require_once) after once returns int not true (re-#21938, Zend/zend_execute.c) #25852 (var_export(require_once) int vs true on an already-once path) and Language: require_once and include_once deduplication #120 / Regression: include/require(+_once) expression returns NULL — Zend returns 1 or file return (re-#4483, Zend/zend_execute.c) #21938 (once return NULL)

Repro

./script/docker-exec.sh -- bash -lc 'php test/repro/maintainer_gap_include_once_return.php'
./script/docker-exec.sh -- bash -lc 'php bin/vm.php test/repro/maintainer_gap_include_once_return.php'
./script/docker-exec.sh -- bash -lc 'php bin/jit.php test/repro/maintainer_gap_include_once_return.php'

Snippet if the repro file is not in tree:

<?php
$f = '/tmp/phpc_once_ret.php';
file_put_contents($f, '<?php echo "RUN\n"; return 42;');
echo "include1="; var_export(include $f); echo "\n";
echo "include_once2="; var_export(include_once $f); echo "\n";

Done when

• After a successful include/require, include_once/require_once of the same realpath does not re-execute and returns true (VM + JIT; AOT if in scope)
• include_once twice (no prior plain include) still matches Zend
• Compliance .phpt under test/compliance/cases/language/
• php-src-strict; no php-compiler-strict shortcut

[PurHur]

claim: worker-lane-b — starting this run

[PurHur]

Merged in #32114.

Fix: Context::recordIncludedFile() now marks loadedCompileUnits for all successful include/require paths (matching Zend EG(included_files)). Plain include therefore guards subsequent include_once.

Verification:

./script/docker-exec.sh -- bash -lc 'php bin/vm.php test/repro/maintainer_gap_include_once_return.php'
./script/docker-exec.sh -- bash -lc 'php bin/jit.php test/repro/maintainer_gap_include_once_return.php'

Both output include_once2=true (was 42 before fix). Compliance: test/compliance/cases/language/include_then_include_once.phpt.