Zend OPcache - Configuration Directives
This topic lists all the configuration directives for Zend OPcache.
Configuration Directives Summary
The table below is a summary of all the Zend OPcache configuration directives, and displays the directive name, its default value, and a description:
|
Directive |
Default Value |
Description |
|
1 |
Enables the opcode cache. When disabled, code is not optimised and cached. |
|
|
2 |
Prevents caching files that are less than this number of seconds old. |
|
|
Use OPCache API only from path starting the specified string. |
||
|
0 |
Enables the opcode cache for the CLI version of PHP. This is mostly useful for testing and debugging. |
|
|
1 |
If set, use the current directory as a part of the script key. |
|
|
1 |
If enabled, OPcache checks the file timestamps and updates the cache accordingly. |
|
|
2 |
How often to check file timestamps for changes to the shared memory storage allocation. |
|
|
0 |
Enables or disables file search in include_path optimization |
|
|
1 |
Enable this hack as a workaround for "can't redeclare class" errors |
|
|
0 |
This hack should only be enabled to work around "Cannot redeclare class" errors. |
|
|
1 |
The verbosity of the OPcache log. |
|
|
128 |
The OPcache shared memory storage size. The amount of memory for storing precompiled PHP code in Mbytes. |
|
|
4 |
The amount of memory used to store interned strings, in megabytes. This configuration directive is ignored in PHP < 5.3.0. |
|
|
10000 |
The maximum number of keys (scripts) in the OPcache hash table. |
|
|
5 |
The maximum percentage of "wasted" memory until a restart is scheduled. |
|
|
0 |
Check the cache checksum every N requests. |
|
|
0 |
This directive prevents file name collisions in different "chroot" environments |
|
|
0 |
Leads OPcache to check file readability on each access to cached file |
|
|
0 |
Debug Level |
|
|
180 |
Time duration (in seconds) for waiting for a scheduled restart to begin if the cache is not being accessed. |
|
|
Shared memory model to use. |
||
|
The location of the OPcache blacklist file. |
||
|
The location of the OPcache error log file. |
||
|
0 |
Protects shared memory from unexpected writes while executing scripts. This is useful for internal debugging only. |
|
|
1 |
If disabled, all PHPDoc comments are dropped from the code to reduce the size of the optimized code. |
|
|
1 |
If disabled, documentation comments won't be loaded from the opcode cache even if they exist. |
|
|
0 |
If enabled, a fast shutdown sequence is used for the accelerated code. |
|
|
0xffffffff |
A bitmask, where each bit enables or disables the appropriate OPcache passes. |
|
|
Mapping base of shared memory segments. |
||
|
/tmp |
Absolute path used to store shared lockfiles. |
|
|
0 |
Allow file existence caching. |
|
|
0 |
The maximum file size that will be cached, in bytes. If this is 0, all files will be cached |
|
|
Enables and sets the second level cache directory. It should improve performance when SHM memory is full, at server restart or SHM reset. The default "" disables file based caching |
||
|
0 |
Enables or disables opcode caching in shared memory |
|
|
1 |
Enables or disables checksum validation when script loaded from file cache |
|
|
0 |
Enables or disables copying of PHP code (text segment) into HUGE PAGES. This should improve performance, but requires appropriate OS configuration |
|
|
1 |
Implies opcache.file_cache_only=1 for a certain process that failed to reattach to the shared memory (for Windows only). Explicitly enabled file cache is required. |
|
|
1 |
Optimizer+ On/Off switch. When set to Off, code is not optimized. |
|
|
1 |
||
|
0 |
||
|
1 |
If set to On, use the current directory as a part of the script key. |
|
|
1 |
If enabled, the Optimizer+ checks the file timestamps and updates the cache accordingly. |
|
|
2 |
How often to check file timestamps for changes to the shared memory storage allocation. |
|
|
0 |
Enables or disables file search in include_path optimization |
|
|
1 |
Enable this hack as a workaround for "can't redeclare class" errors |
|
|
0 |
Enable this hack as a workaround for "duplicate definition" errors. |
|
|
1 |
The verbosity of the Optimizer+ log. |
|
|
64 |
The Optimizer+ shared memory storage size. The amount of memory for storing precompiled PHP code in Mbytes. |
|
|
4 |
The amount of memory for interned strings in Mbytes. |
|
|
2000 |
The maximum number of keys (scripts) in the Optimizer+ hash table. |
|
|
5 |
The maximum percentage of "wasted" memory until a restart is scheduled. |
|
|
0 |
Check the cache checksum each N requests. |
|
|
180 |
Time duration (in seconds) for waiting for a scheduled restart to begin if the cache is not being accessed. |
|
|
Shared memory model to use. |
||
|
The location of the Optimizer+ blacklist file. |
||
|
0 |
Protect the shared memory from writing during script execution. |
|
|
1 |
If disabled, all PHPDoc comments are dropped from the code to reduce the size of the optimized code. |
|
|
0 |
If enabled, a fast shutdown sequence is used for the accelerated code. |
|
|
0xfffffbbf |
A bitmask, where each bit enables or disables the appropriate Optimizer+ passes. |
|
|
1 |
Enables or disables the optimization passes that may take a significant amount of time, based on an internal runtime calculation. |
|
|
Mapping base of shared memory segments. |
||
|
0 |
Allow file existence caching. |
Configuration Directives Details
The list below contains information for all the available configuration directives for Zend OPcache: their description, type, units, default value, modification scope, and the Zend Server version they became available in.
opcache.enable
Enables the opcode cache. When disabled, code is not optimised and cached.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.file_update_protection
Prevents caching files that are less than this number of seconds old. It protects from caching of incompletely updated files. In case all file updates on your site are atomic, you may increase performance setting it to "0"".
Default Value: 2
Type: int
Available Since Version: 6.3
opcache.restrict_api
Allows calling OPcache API functions only from PHP scripts which path is started from specified string. The default "" means no restriction.
Default Value:
Type: string
Available Since Version: 6.3
opcache.enable_cli
Enables the opcode cache for the CLI version of PHP. This is mostly useful for testing and debugging.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.use_cwd
If enabled, OPcache appends the current working directory to the script key, thereby eliminating possible collisions between files with the same base name. Disabling this directive improves performance, but may break existing applications.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.validate_timestamps
If enabled, OPcache will check for updated scripts every opcache.revalidate_freq seconds. When this directive is disabled, you must reset OPcache manually via opcache_reset(), opcache_invalidate() or by restarting the Web server for changes to the filesystem to take effect.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 6.3
opcache.revalidate_freq
How often to check script timestamps for updates, in seconds. 0 will result in OPcache checking for updates on every request. This configuration directive is ignored if opcache.validate_timestamps if disabled.
Default Value: 2
Units: seconds
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 6.3
opcache.revalidate_path
If disabled, existing cached files using the same include_path will be reused. Thus, if a file with the same name is elsewhere in the include_path, it won't be found.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 6.3
opcache.inherited_hack
The OPcache stores the places where DECLARE_CLASS opcodes use inheritance (These are the only opcodes that can be executed by PHP, but which may not be executed because the parent class is missing due to optimization). When the file is loaded, OPcache tries to bind the inherited classes by using the current environment. The problem with this scenario is that, while the DECLARE_CLASS opcode may not be needed for the current script, if the script requires that the opcode at least be defined, it may not run. The default for this directive is disabled, which means that optimization is active. In php-5.3 and above this hack is not needed anymore and this setting has no effect.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.dups_fix
This hack should only be enabled to work around "Cannot redeclare class" errors.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 6.3
opcache.log_verbosity_level
The log verbosity level. By default, only fatal errors (level 0) and errors (level 1) are logged. Other levels available are warnings (level 2), information messages (level 3) and debug messages (level 4).
Default Value: 1
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.memory_consumption
The OPcache shared memory storage size. The amount of memory for storing precompiled PHP code in Mbytes.
Default Value: 128
Units: MBytes
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.interned_strings_buffer
The amount of memory used to store interned strings, in megabytes. This configuration directive is ignored in PHP < 5.3.0.
Default Value: 4
Units: MBytes
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.max_accelerated_files
The number is actually the the first one in the following set of prime numbers that is bigger than the one supplied: { 223, 463, 983, 1979, 3907, 7963, 16229, 32531, 65407, 130987 }. Only numbers between 200 and 100000 are allowed.
Default Value: 10000
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.max_wasted_percentage
The maximum percentage of "wasted" memory until a restart is scheduled.
Default Value: 5
Units: %
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.consistency_checks
If non-zero, OPcache will verify the cache checksum every N requests, where N is the value of this configuration directive. This should only be enabled when debugging, as it will impair performance.
Default Value: 0
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 6.3
opcache.validate_root
This directive prevents file name collisions in different "chroot" environments
Default Value: 0
Type: int
Available Since Version:
opcache.validate_permission
Leads OPcache to check file readability on each access to cached file
Default Value: 0
Type: int
Available Since Version:
opcache.opt_debug_level
Debug Level
Default Value: 0
Type: int
Available Since Version:
opcache.force_restart_timeout
The length of time to wait for a scheduled restart to begin if the cache isn't active, in seconds. If the timeout is hit, then OPcache assumes that something is wrong and will kill the processes holding locks on the cache to permit a restart. If opcache.log_verbosity_level is set to 3 or above, an error will be recorded in the error log when this occurs.
Default Value: 180
Units: seconds
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.preferred_memory_model
The preferred memory model for OPcache to use. If left empty, OPcache will choose the most appropriate model, which is the correct behaviour in virtually all cases. Possible values include mmap, shm, posix and win32.
Default Value:
Type: string
Modification Scope: ZEND_INI_ALL
Available Since Version: 6.3
opcache.blacklist_filename
The location of the OPcache blacklist file. A blacklist file is a text file containing the names of files that should not be accelerated, one per line. Wildcards are allowed, and prefixes can also be provided. Lines starting with a semi-colon are ignored as comments.
Default Value:
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.error_log
The error log for OPcache errors. An empty string is treated the same as stderr, and will result in logs being sent to standard error (which will be the Web server error log in most cases).
Default Value:
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.protect_memory
Protects shared memory from unexpected writes while executing scripts. This is useful for internal debugging only.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.save_comments
If disabled, all documentation comments will be discarded from the opcode cache to reduce the size of the optimised code. Disabling this configuration directive may break applications and frameworks that rely on comment parsing for annotations, including Doctrine, Zend Framework 2 and PHPUnit.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.load_comments
If disabled, documentation comments won't be loaded from the opcode cache even if they exist. This can be used with opcache.save_comments to only load comments for applications that require them.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.fast_shutdown
If enabled, a fast shutdown sequence is used that doesn't free each allocated block, but relies on the Zend Engine memory manager to deallocate the entire set of request variables en masse.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.optimization_level
A bitmask, where each bit enables or disables the appropriate OPcache passes.
Default Value: 0xffffffff
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.mmap_base
The base used for shared memory segments on Windows. All PHP processes have to map shared memory into the same address space. Using this directive allows "Unable to reattach to base address" errors to be fixed.
Applicable On: Windows
Default Value:
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.lockfile_path
Absolute path used to store shared lockfiles.
Default Value: /tmp
Type: string
Available Since Version:
opcache.enable_file_override
When enabled, the opcode cache will be checked for whether a file has already been cached when file_exists(), is_file() and is_readable() are called. This may increase performance in applications that check the existence and readability of PHP scripts, but risks returning stale data if opcache.validate_timestamps is disabled.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.max_file_size
The maximum file size that will be cached, in bytes. If this is 0, all files will be cached
Default Value: 0
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.3
opcache.file_cache
Enables and sets the second level cache directory. It should improve performance when SHM memory is full, at server restart or SHM reset. The default "" disables file based caching
Default Value:
Type: string
Available Since Version:
opcache.file_cache_only
Enables or disables opcode caching in shared memory
Default Value: 0
Type: int
Available Since Version:
opcache.file_cache_consistency_checks
Enables or disables checksum validation when script loaded from file cache
Default Value: 1
Type: int
Available Since Version:
opcache.huge_code_pages
Enables or disables copying of PHP code (text segment) into HUGE PAGES. This should improve performance, but requires appropriate OS configuration
Default Value: 0
Type: int
Available Since Version:
opcache.file_cache_fallback
Implies opcache.file_cache_only=1 for a certain process that failed to reattach to the shared memory (for Windows only). Explicitly enabled file cache is required.
Applicable On: Windows
Default Value: 1
Type: boolean
Available Since Version:
zend_optimizerplus.enable
Optimizer+ On/Off switch. When set to Off, code is not optimized.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.enable_cli
Default Value: 1
Type: boolean
Available Since Version: 4.0
zend_optimizerplus.file_update_protection
Default Value:
Type: string
Available Since Version: 4.0
zend_optimizerplus.max_file_size
Default Value: 0
Type: int
Available Since Version: 4.0
zend_optimizerplus.error_log
Default Value:
Type: string
Available Since Version: 4.0
zend_optimizerplus.load_comments
Default Value:
Type: boolean
Available Since Version: 4.0
zend_optimizerplus.restrict_api
Default Value:
Type: string
Available Since Version: 4.0
zend_optimizerplus.use_cwd
When this directive is enabled, the Optimizer+ appends the current working directory to the script key, thus elminating possible collisions between files with the same name (basename). Disabling the directive improves performance, but may break existing applications.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.validate_timestamps
When disabled, you must reset the Optimizer+ manually or restart the webserver for changes to the filesystem to take effect.
The frequancy of the check is controlled by the directive "zend_optimizerplus.revalidate_freq".
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_optimizerplus.revalidate_freq
How often to check file timestamps for changes to the shared memory storage allocation.
Default Value: 2
Units: seconds
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_optimizerplus.revalidate_path
If the file search is disabled and a cached file is found that uses the same include_path, the file is not searched again. Thus, if a file with the same name appears somewhere else in include_path, it will not be found. Enable this directive if this optimization has an effect on your applications. The default for this directive is disabled, which means that optimization is active.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_optimizerplus.inherited_hack
The Optimizer+ stores the places where DECLARE_CLASS opcodes use inheritance (These are the only opcodes that can be executed by PHP, but which may not be executed because the parent class is missing due to optimization). When the file is loaded, Optimizer+ tries to bind the inherited classes by using the current environment. The problem with this scenario is that, while the DECLARE_CLASS opcode may not be needed for the current script, if the script requires that the opcode at least be defined, it may not run. The default for this directive is disabled, which means that optimization is active. In php-5.3 and above this hack is not needed anymore and this setting has no effect.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.dups_fix
Enable this hack as a workaround for "duplicate definition" errors.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_optimizerplus.log_verbosity_level
All Optimizer+ errors go to the Web server log.
By default, only fatal errors (level 0) or errors (level 1) are logged. You can also enable warnings (level 2), info messages (level 3) or debug messesges (level 4).
For "debug" binaries, the default log verbosity level is 4, not 1.
Default Value: 1
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.memory_consumption
The Optimizer+ shared memory storage size. The amount of memory for storing precompiled PHP code in Mbytes.
Default Value: 64
Units: MBytes
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.interned_strings_buffer
The amount of memory for interned strings in Mbytes.
Default Value: 4
Units: MBytes
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.max_accelerated_files
The number is actually the the first one in the following set of prime numbers that is bigger than the one supplied: { 223, 463, 983, 1979, 3907, 7963, 16229, 32531, 65407, 130987 }. Only numbers between 200 and 100000 are allowed.
Default Value: 2000
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.max_wasted_percentage
The maximum percentage of "wasted" memory until a restart is scheduled.
Default Value: 5
Units: %
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.consistency_checks
The default value of "0" means that the checks are disabled. Because calculating the checksum impairs performance, this directive should be enabled only as part of a debugging process.
Default Value: 0
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_optimizerplus.force_restart_timeout
The Optimizer+ uses this directive to identify a situation where there may be a problem with a process. After this time period has passed, the Optimizer+ assumes that something has happened and starts killing the processes that still hold the locks that are preventing a restart. If the log level is 3 or above, a "killed locker" error is recorded in the Apache logs when this happens.
Default Value: 180
Units: seconds
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.preferred_memory_model
Should not be touched by mere mortal - leave empty and let the system decide for you.
Default Value:
Type: string
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_optimizerplus.blacklist_filename
For additional information, see "Extermal Configuration File" above.
Default Value:
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.protect_memory
Protect the shared memory from writing during script execution.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.save_comments
If disabled, all PHPDoc comments are dropped from the code to reduce the size of the optimized code.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.fast_shutdown
The fast shutdown sequence doesn't free each allocated block, but lets the Zend Engine Memory Manager do the work.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.optimization_level
A bitmask, where each bit enables or disables the appropriate Optimizer+ passes.
Default Value: 0xfffffbbf
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.enable_slow_optimizations
Enables or disables the optimization passes that may take a significant amount of time, based on an internal runtime calculation.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.mmap_base
Mapping base of shared memory segments.
Applicable On: Windows
Default Value:
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_optimizerplus.enable_file_override
Allow file existence override (file_exists, etc.) performance feature.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
