Skip to content

Remove the opcache sapi whitelist #19351

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

Closed
wants to merge 1 commit into from
Closed

Remove the opcache sapi whitelist #19351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 5 additions & 40 deletions ext/opcache/ZendAccelerator.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2841,39 +2841,10 @@ static void zps_startup_failure(const char *reason, const char *api_reason, int
zend_llist_del_element(&zend_extensions, NULL, (int (*)(void *, void *))cb);
}

static inline zend_result accel_find_sapi(void)
static inline bool accel_sapi_is_cli(void)
Copy link

Choose a reason for hiding this comment

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

Suggested change
static inline bool accel_sapi_is_cli(void)
static inline bool disable_accel_for_sapi(void)

or something like that, considering that it's not only cli sapi but also phpdbg.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree that the naming is not ideal, but I've decided to keep it because it matches the INI parameter opcache.enable_cli. "cli" should be understood as any Command LIne SAPI here.

{
static const char *supported_sapis[] = {
"apache",
"fastcgi",
"cli-server",
"cgi-fcgi",
"fpm-fcgi",
"fpmi-fcgi",
"apache2handler",
"litespeed",
"uwsgi",
"fuzzer",
"frankenphp",
"ngx-php",
NULL
};
const char **sapi_name;

if (sapi_module.name) {
for (sapi_name = supported_sapis; *sapi_name; sapi_name++) {
if (strcmp(sapi_module.name, *sapi_name) == 0) {
return SUCCESS;
}
}
if (ZCG(accel_directives).enable_cli && (
strcmp(sapi_module.name, "cli") == 0
|| strcmp(sapi_module.name, "phpdbg") == 0)) {
return SUCCESS;
}
}

return FAILURE;
return strcmp(sapi_module.name, "cli") == 0
Copy link

Choose a reason for hiding this comment

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

Not that it's terribly relevant to have opcache active for php -i or other commands that don't compile php files, but is there a reason that it must be disabled? It should never even get to a opcache check on that path.

Just a question, trying to read into the source. cli-server is e.g. php some_cli_script.php, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

cli-server is the builtin web server: https://www.php.net/manual/en/features.commandline.webserver.php

cli is php some_cli_script.php.

Opcache is disabled by default on cli because populating a cache in this context will just consume more memory for no benefits (as the cache lives only for the duration of a single "request"), unless the file_cache is used. It is possible to enable opcache in cli by setting opcache.enable_cli=1. This can be beneficial on long running scripts due to opcode optimizations, or when the file_cache is enabled.

Copy link

Choose a reason for hiding this comment

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

I see, the if statement will have to be changed then, though:

if (!ZCG(accel_directives).enable_cli && accel_sapi_is_cli()) {

Would enable it for phpdbg when enable_cli is enabled. Or is that intended?

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 intended :) Opcache is disabled by default in phpdbg for the same reasons.

|| strcmp(sapi_module.name, "phpdbg") == 0;
}

static zend_result zend_accel_init_shm(void)
Expand Down Expand Up @@ -3196,15 +3167,9 @@ static int accel_startup(zend_extension *extension)
}
#endif

/* no supported SAPI found - disable acceleration and stop initialization */
if (accel_find_sapi() == FAILURE) {
if (!ZCG(accel_directives).enable_cli && accel_sapi_is_cli()) {
accel_startup_ok = false;
if (!ZCG(accel_directives).enable_cli &&
strcmp(sapi_module.name, "cli") == 0) {
zps_startup_failure("Opcode Caching is disabled for CLI", NULL, accelerator_remove_cb);
} else {
zps_startup_failure("Opcode Caching is only supported in Apache, FPM, FastCGI, FrankenPHP, LiteSpeed and uWSGI SAPIs", NULL, accelerator_remove_cb);
}
zps_startup_failure("Opcode Caching is disabled for CLI", NULL, accelerator_remove_cb);
return SUCCESS;
}

Expand Down
Loading