mirror of
https://github.com/php/php-src.git
synced 2026-04-27 18:23:26 +02:00
Christoph M. Becker
e2ed7e6716
Formerly, there was at most a single OPcache instance per user and the so called system ID (which is determined from the PHP version). Sometimes multiple OPcaches might be desired, though, particularly for unrelated CLI scripts, which may even be necessary (e.g. for our test suite in parallel mode). We therefore introduce a new INI directive `opcache.cache_id` which allows to configure independent OPcache instances for the same user. We also use `GetUserNameW()` instead of `php_win32_get_username()`, because the latter retrieves the user name encoded in the `default_charset`, which can obviously yield different results for different charsets, leading to OPcache "incompatibilities". Slightly worse, some characters may not even be encodeable in the `default_charset` and would be replaced by question marks, which could result in different users sharing the same OPcache. We also refactor, and re-use existing APIs to avoid duplicated code.
322 lines
11 KiB
C
322 lines
11 KiB
C
/*
|
|
+----------------------------------------------------------------------+
|
|
| Zend OPcache |
|
|
+----------------------------------------------------------------------+
|
|
| Copyright (c) The PHP Group |
|
|
+----------------------------------------------------------------------+
|
|
| This source file is subject to version 3.01 of the PHP license, |
|
|
| that is bundled with this package in the file LICENSE, and is |
|
|
| available through the world-wide-web at the following url: |
|
|
| http://www.php.net/license/3_01.txt |
|
|
| If you did not receive a copy of the PHP license and are unable to |
|
|
| obtain it through the world-wide-web, please send a note to |
|
|
| license@php.net so we can mail you a copy immediately. |
|
|
+----------------------------------------------------------------------+
|
|
| Authors: Andi Gutmans <andi@php.net> |
|
|
| Zeev Suraski <zeev@php.net> |
|
|
| Stanislav Malyshev <stas@zend.com> |
|
|
| Dmitry Stogov <dmitry@php.net> |
|
|
+----------------------------------------------------------------------+
|
|
*/
|
|
|
|
#ifndef ZEND_ACCELERATOR_H
|
|
#define ZEND_ACCELERATOR_H
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
# include <config.h>
|
|
#endif
|
|
|
|
#define ACCELERATOR_PRODUCT_NAME "Zend OPcache"
|
|
/* 2 - added Profiler support, on 20010712 */
|
|
/* 3 - added support for Optimizer's encoded-only-files mode */
|
|
/* 4 - works with the new Optimizer, that supports the file format with licenses */
|
|
/* 5 - API 4 didn't really work with the license-enabled file format. v5 does. */
|
|
/* 6 - Monitor was removed from ZendPlatform.so, to a module of its own */
|
|
/* 7 - Optimizer was embedded into Accelerator */
|
|
/* 8 - Standalone Open Source Zend OPcache */
|
|
#define ACCELERATOR_API_NO 8
|
|
|
|
#if ZEND_WIN32
|
|
# include "zend_config.w32.h"
|
|
#else
|
|
#include "zend_config.h"
|
|
# include <sys/time.h>
|
|
# include <sys/resource.h>
|
|
#endif
|
|
|
|
#if HAVE_UNISTD_H
|
|
# include "unistd.h"
|
|
#endif
|
|
|
|
#include "zend_extensions.h"
|
|
#include "zend_compile.h"
|
|
|
|
#include "Optimizer/zend_optimizer.h"
|
|
#include "zend_accelerator_hash.h"
|
|
#include "zend_accelerator_debug.h"
|
|
|
|
#ifndef PHPAPI
|
|
# ifdef ZEND_WIN32
|
|
# define PHPAPI __declspec(dllimport)
|
|
# else
|
|
# define PHPAPI
|
|
# endif
|
|
#endif
|
|
|
|
#ifndef ZEND_EXT_API
|
|
# ifdef ZEND_WIN32
|
|
# define ZEND_EXT_API __declspec(dllexport)
|
|
# elif defined(__GNUC__) && __GNUC__ >= 4
|
|
# define ZEND_EXT_API __attribute__ ((visibility("default")))
|
|
# else
|
|
# define ZEND_EXT_API
|
|
# endif
|
|
#endif
|
|
|
|
#ifdef ZEND_WIN32
|
|
# ifndef MAXPATHLEN
|
|
# include "win32/ioutil.h"
|
|
# define MAXPATHLEN PHP_WIN32_IOUTIL_MAXPATHLEN
|
|
# endif
|
|
# include <direct.h>
|
|
#else
|
|
# ifndef MAXPATHLEN
|
|
# define MAXPATHLEN 4096
|
|
# endif
|
|
# include <sys/param.h>
|
|
#endif
|
|
|
|
/*** file locking ***/
|
|
#ifndef ZEND_WIN32
|
|
extern int lock_file;
|
|
#endif
|
|
|
|
#if defined(ZEND_WIN32)
|
|
# define ENABLE_FILE_CACHE_FALLBACK 1
|
|
#else
|
|
# define ENABLE_FILE_CACHE_FALLBACK 0
|
|
#endif
|
|
|
|
#if ZEND_WIN32
|
|
typedef unsigned __int64 accel_time_t;
|
|
#else
|
|
typedef time_t accel_time_t;
|
|
#endif
|
|
|
|
typedef enum _zend_accel_restart_reason {
|
|
ACCEL_RESTART_OOM, /* restart because of out of memory */
|
|
ACCEL_RESTART_HASH, /* restart because of hash overflow */
|
|
ACCEL_RESTART_USER /* restart scheduled by opcache_reset() */
|
|
} zend_accel_restart_reason;
|
|
|
|
typedef struct _zend_persistent_script {
|
|
zend_script script;
|
|
zend_long compiler_halt_offset; /* position of __HALT_COMPILER or -1 */
|
|
int ping_auto_globals_mask; /* which autoglobals are used by the script */
|
|
accel_time_t timestamp; /* the script modification time */
|
|
zend_bool corrupted;
|
|
zend_bool is_phar;
|
|
zend_bool empty;
|
|
|
|
void *mem; /* shared memory area used by script structures */
|
|
size_t size; /* size of used shared memory */
|
|
void *arena_mem; /* part that should be copied into process */
|
|
size_t arena_size;
|
|
|
|
/* All entries that shouldn't be counted in the ADLER32
|
|
* checksum must be declared in this struct
|
|
*/
|
|
struct zend_persistent_script_dynamic_members {
|
|
time_t last_used;
|
|
#ifdef ZEND_WIN32
|
|
LONGLONG hits;
|
|
#else
|
|
zend_ulong hits;
|
|
#endif
|
|
unsigned int memory_consumption;
|
|
unsigned int checksum;
|
|
time_t revalidate;
|
|
} dynamic_members;
|
|
} zend_persistent_script;
|
|
|
|
typedef struct _zend_accel_directives {
|
|
zend_long memory_consumption;
|
|
zend_long max_accelerated_files;
|
|
double max_wasted_percentage;
|
|
char *user_blacklist_filename;
|
|
zend_long consistency_checks;
|
|
zend_long force_restart_timeout;
|
|
zend_bool use_cwd;
|
|
zend_bool ignore_dups;
|
|
zend_bool validate_timestamps;
|
|
zend_bool revalidate_path;
|
|
zend_bool save_comments;
|
|
zend_bool protect_memory;
|
|
zend_bool file_override_enabled;
|
|
zend_bool enable_cli;
|
|
zend_bool validate_permission;
|
|
#ifndef ZEND_WIN32
|
|
zend_bool validate_root;
|
|
#endif
|
|
zend_ulong revalidate_freq;
|
|
zend_ulong file_update_protection;
|
|
char *error_log;
|
|
#ifdef ZEND_WIN32
|
|
char *mmap_base;
|
|
#endif
|
|
char *memory_model;
|
|
zend_long log_verbosity_level;
|
|
|
|
zend_long optimization_level;
|
|
zend_long opt_debug_level;
|
|
zend_long max_file_size;
|
|
zend_long interned_strings_buffer;
|
|
char *restrict_api;
|
|
#ifndef ZEND_WIN32
|
|
char *lockfile_path;
|
|
#endif
|
|
char *file_cache;
|
|
zend_bool file_cache_only;
|
|
zend_bool file_cache_consistency_checks;
|
|
#if ENABLE_FILE_CACHE_FALLBACK
|
|
zend_bool file_cache_fallback;
|
|
#endif
|
|
#ifdef HAVE_HUGE_CODE_PAGES
|
|
zend_bool huge_code_pages;
|
|
#endif
|
|
char *preload;
|
|
#ifdef ZEND_WIN32
|
|
char *cache_id;
|
|
#endif
|
|
} zend_accel_directives;
|
|
|
|
typedef struct _zend_accel_globals {
|
|
int counted; /* the process uses shared memory */
|
|
zend_bool enabled;
|
|
zend_bool locked; /* thread obtained exclusive lock */
|
|
zend_bool accelerator_enabled; /* accelerator enabled for current request */
|
|
zend_bool pcre_reseted;
|
|
HashTable bind_hash; /* prototype and zval lookup table */
|
|
zend_accel_directives accel_directives;
|
|
zend_string *cwd; /* current working directory or NULL */
|
|
zend_string *include_path; /* current value of "include_path" directive */
|
|
char include_path_key[32]; /* key of current "include_path" */
|
|
char cwd_key[32]; /* key of current working directory */
|
|
int include_path_key_len;
|
|
int include_path_check;
|
|
int cwd_key_len;
|
|
int cwd_check;
|
|
int auto_globals_mask;
|
|
time_t request_time;
|
|
time_t last_restart_time; /* used to synchronize SHM and in-process caches */
|
|
HashTable xlat_table;
|
|
#ifndef ZEND_WIN32
|
|
zend_ulong root_hash;
|
|
#endif
|
|
/* preallocated shared-memory block to save current script */
|
|
void *mem;
|
|
void *arena_mem;
|
|
zend_persistent_script *current_persistent_script;
|
|
zend_bool is_immutable_class;
|
|
/* cache to save hash lookup on the same INCLUDE opcode */
|
|
const zend_op *cache_opline;
|
|
zend_persistent_script *cache_persistent_script;
|
|
/* preallocated buffer for keys */
|
|
int key_len;
|
|
char key[MAXPATHLEN * 8];
|
|
} zend_accel_globals;
|
|
|
|
typedef struct _zend_string_table {
|
|
uint32_t nTableMask;
|
|
uint32_t nNumOfElements;
|
|
zend_string *start;
|
|
zend_string *top;
|
|
zend_string *end;
|
|
zend_string *saved_top;
|
|
} zend_string_table;
|
|
|
|
typedef struct _zend_accel_shared_globals {
|
|
/* Cache Data Structures */
|
|
zend_ulong hits;
|
|
zend_ulong misses;
|
|
zend_ulong blacklist_misses;
|
|
zend_ulong oom_restarts; /* number of restarts because of out of memory */
|
|
zend_ulong hash_restarts; /* number of restarts because of hash overflow */
|
|
zend_ulong manual_restarts; /* number of restarts scheduled by opcache_reset() */
|
|
zend_accel_hash hash; /* hash table for cached scripts */
|
|
|
|
size_t map_ptr_last;
|
|
|
|
/* Directives & Maintenance */
|
|
time_t start_time;
|
|
time_t last_restart_time;
|
|
time_t force_restart_time;
|
|
zend_bool accelerator_enabled;
|
|
zend_bool restart_pending;
|
|
zend_accel_restart_reason restart_reason;
|
|
zend_bool cache_status_before_restart;
|
|
#ifdef ZEND_WIN32
|
|
LONGLONG mem_usage;
|
|
LONGLONG restart_in;
|
|
#endif
|
|
zend_bool restart_in_progress;
|
|
|
|
/* Preloading */
|
|
zend_persistent_script *preload_script;
|
|
zend_persistent_script **saved_scripts;
|
|
|
|
/* uninitialized HashTable Support */
|
|
uint32_t uninitialized_bucket[-HT_MIN_MASK];
|
|
|
|
/* Interned Strings Support (must be the last element) */
|
|
zend_string_table interned_strings;
|
|
} zend_accel_shared_globals;
|
|
|
|
extern char accel_system_id[32];
|
|
#ifdef ZEND_WIN32
|
|
extern char accel_uname_id[32];
|
|
#endif
|
|
extern zend_bool accel_startup_ok;
|
|
extern zend_bool file_cache_only;
|
|
#if ENABLE_FILE_CACHE_FALLBACK
|
|
extern zend_bool fallback_process;
|
|
#endif
|
|
|
|
extern zend_accel_shared_globals *accel_shared_globals;
|
|
#define ZCSG(element) (accel_shared_globals->element)
|
|
|
|
#ifdef ZTS
|
|
# define ZCG(v) ZEND_TSRMG(accel_globals_id, zend_accel_globals *, v)
|
|
extern int accel_globals_id;
|
|
# ifdef COMPILE_DL_OPCACHE
|
|
ZEND_TSRMLS_CACHE_EXTERN()
|
|
# endif
|
|
#else
|
|
# define ZCG(v) (accel_globals.v)
|
|
extern zend_accel_globals accel_globals;
|
|
#endif
|
|
|
|
extern char *zps_api_failure_reason;
|
|
|
|
void accel_shutdown(void);
|
|
int accel_activate(INIT_FUNC_ARGS);
|
|
int accel_post_deactivate(void);
|
|
void zend_accel_schedule_restart(zend_accel_restart_reason reason);
|
|
void zend_accel_schedule_restart_if_necessary(zend_accel_restart_reason reason);
|
|
accel_time_t zend_get_file_handle_timestamp(zend_file_handle *file_handle, size_t *size);
|
|
int validate_timestamp_and_record(zend_persistent_script *persistent_script, zend_file_handle *file_handle);
|
|
int validate_timestamp_and_record_ex(zend_persistent_script *persistent_script, zend_file_handle *file_handle);
|
|
int zend_accel_invalidate(const char *filename, size_t filename_len, zend_bool force);
|
|
int accelerator_shm_read_lock(void);
|
|
void accelerator_shm_read_unlock(void);
|
|
|
|
char *accel_make_persistent_key(const char *path, size_t path_length, int *key_len);
|
|
zend_op_array *persistent_compile_file(zend_file_handle *file_handle, int type);
|
|
|
|
#define IS_ACCEL_INTERNED(str) \
|
|
((char*)(str) >= (char*)ZCSG(interned_strings).start && (char*)(str) < (char*)ZCSG(interned_strings).top)
|
|
|
|
zend_string* ZEND_FASTCALL accel_new_interned_string(zend_string *str);
|
|
|
|
#endif /* ZEND_ACCELERATOR_H */
|