Skip to content

Add OPCache file cache and JIT blacklist functions #5050

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

Merged
Girgias merged 2 commits into from
Jan 19, 2026
Merged

Add OPCache file cache and JIT blacklist functions #5050

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b2625d
add OPCache file cache and JIT blacklist functions
jordikroon Jan 18, 2026
64d8478
Nit
Girgias Jan 18, 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
72 changes: 72 additions & 0 deletions reference/opcache/functions/opcache-is-script-cached-in-file-cache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.opcache-is-script-cached-in-file-cache" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>opcache_is_script_cached_in_file_cache</refname>
<refpurpose>Tells whether a script is cached in OPCache file cache</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>opcache_is_script_cached_in_file_cache</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<simpara>
This function checks if a PHP script has been cached in OPCache. This can be
used to more easily detect the "warming" of the cache for a particular script.
This function only checks file cache cache, not in-memory cache. In order to
check in-memory cache, use <function>opcache_is_script_cached</function>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<simpara>
The path to the PHP script to be checked.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Returns &true; if <parameter>filename</parameter> is cached in OPCache,
&false; otherwise.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>opcache_compile_file</function></member>
<member><function>opcache_is_script_cached</function></member>
</simplelist>
</refsect1>
Comment thread
jordikroon marked this conversation as resolved.
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
6 changes: 4 additions & 2 deletions reference/opcache/functions/opcache-is-script-cached.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
<simpara>
This function checks if a PHP script has been cached in OPCache. This can be
used to more easily detect the "warming" of the cache for a particular script.
This function only checks in-memory cache, not file cache.
This function only checks in-memory cache, not file cache. In order to
check file cache, use <function>opcache_is_script_cached_in_file_cache</function>.
Comment thread
Girgias marked this conversation as resolved.
Outdated
</simpara>
</refsect1>

Expand All @@ -36,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Returns &true; if <parameter>filename</parameter> is cached in OPCache,
Returns &true; if <parameter>filename</parameter> is cached in OPCache in-memory cache,
&false; otherwise.
</simpara>
</refsect1>
Expand All @@ -45,6 +46,7 @@
&reftitle.seealso;
<simplelist>
<member><function>opcache_compile_file</function></member>
<member><function>opcache_is_script_cached_in_file_cache</function></member>
</simplelist>
</refsect1>
</refentry>
Expand Down
107 changes: 107 additions & 0 deletions reference/opcache/functions/opcache-jit-blacklist.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.opcache-jit-blacklist" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>opcache_jit_blacklist</refname>
<refpurpose>Blacklists a function from being JIT compiled</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>opcache_jit_blacklist</methodname>
<methodparam>
<type>Closure</type>
<parameter>closure</parameter>
</methodparam>
</methodsynopsis>
<simpara>
This function blacklists a particular function from being JIT compiled when Tracing JIT is in use.
The function is specified using a <classname>Closure</classname>.
</simpara>
<warning>
<simpara>
Any parts of the function that were already JIT compiled remain unaffected
and will still be JIT compiled.
</simpara>
</warning>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>closure</parameter>
</term>
<listitem>
<simpara>
The function to blacklist, represented as a first class callable.
It is also possible to pass an anonymous function,
in which case the anonymous function itself is blacklisted.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.void;
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>
<function>opcache_jit_blacklist</function>
basic example
</title>
<programlisting role="php">
<![CDATA[
<?php
Comment thread
jordikroon marked this conversation as resolved.
function foo() {
$x = 1;
$x += 0;
++$x;
var_dump($x);
}
opcache_jit_blacklist(foo(...));
foo();
?>
]]>
</programlisting>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>opcache_invalidate</function></member>
<member><function>opcache_reset</function></member>
</simplelist>
</refsect1>
Comment thread
jordikroon marked this conversation as resolved.
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
2 changes: 2 additions & 0 deletions reference/opcache/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
<function name="opcache_get_status" from="PHP 5 &gt;= 5.5.0, PHP 7, PHP 8, PECL ZendOpcache &gt; 7.0.2"/>
<function name="opcache_invalidate" from="PHP 5 &gt;= 5.5.0, PHP 7, PHP 8, PECL ZendOpcache &gt;= 7.0.0"/>
<function name="opcache_is_script_cached" from="PHP 5 &gt;= 5.5.11, PHP 7, PHP 8, PECL ZendOpcache &gt;= 7.0.4"/>
<function name="opcache_is_script_cached_in_file_cache" from="PHP 8 &gt;= 8.5.0"/>
<function name="opcache_jit_blacklist" from="PHP 8 &gt;= 8.4.0"/>
<function name="opcache_reset" from="PHP 5 &gt;= 5.5.0, PHP 7, PHP 8, PECL ZendOpcache &gt;= 7.0.0"/>
</versions>
<!-- Keep this comment at the end of the file
Expand Down