/* +----------------------------------------------------------------------+ | Zend OPcache | +----------------------------------------------------------------------+ | Copyright (c) 1998-2016 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 | | Zeev Suraski | | Stanislav Malyshev | | Dmitry Stogov | +----------------------------------------------------------------------+ */ #ifndef ZEND_ACCELERATOR_H #define ZEND_ACCELERATOR_H #ifdef HAVE_CONFIG_H # include #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 # include #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 # if WIN32|WINNT # 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 # define MAXPATHLEN _MAX_PATH # endif # include #else # ifndef MAXPATHLEN # define MAXPATHLEN 4096 # endif # include #endif #define PHP_5_0_X_API_NO 220040412 #define PHP_5_1_X_API_NO 220051025 #define PHP_5_2_X_API_NO 220060519 #define PHP_5_3_X_API_NO 220090626 #define PHP_5_4_X_API_NO 220100525 #define PHP_5_5_X_API_NO 220121212 #define PHP_5_6_X_API_NO 220131226 /*** file locking ***/ #ifndef ZEND_WIN32 extern int lock_file; # if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || (defined(__APPLE__) && defined(__MACH__)/* Darwin */) || defined(__OpenBSD__) || defined(__NetBSD__) # define FLOCK_STRUCTURE(name, type, whence, start, len) \ struct flock name = {start, len, -1, type, whence} # elif defined(__svr4__) # define FLOCK_STRUCTURE(name, type, whence, start, len) \ struct flock name = {type, whence, start, len} # elif defined(__linux__) || defined(__hpux) || defined(__GNU__) # define FLOCK_STRUCTURE(name, type, whence, start, len) \ struct flock name = {type, whence, start, len, 0} # elif defined(_AIX) # if defined(_LARGE_FILES) || defined(__64BIT__) # define FLOCK_STRUCTURE(name, type, whence, start, len) \ struct flock name = {type, whence, 0, 0, 0, start, len } # else # define FLOCK_STRUCTURE(name, type, whence, start, len) \ struct flock name = {type, whence, start, len} # endif # elif defined(HAVE_FLOCK_BSD) # define FLOCK_STRUCTURE(name, type, whence, start, len) \ struct flock name = {start, len, -1, type, whence} # elif defined(HAVE_FLOCK_LINUX) # define FLOCK_STRUCTURE(name, type, whence, start, len) \ struct flock name = {type, whence, start, len} # else # error "Don't know how to define struct flock" # endif #endif #define PZ_REFCOUNT_P(pz) (pz)->refcount__gc #define PZ_SET_REFCOUNT_P(pz, v) (pz)->refcount__gc = (v) #define PZ_ADDREF_P(pz) ++((pz)->refcount__gc) #define PZ_DELREF_P(pz) --((pz)->refcount__gc) #define PZ_ISREF_P(pz) (pz)->is_ref__gc #define PZ_SET_ISREF_P(pz) Z_SET_ISREF_TO_P(pz, 1) #define PZ_UNSET_ISREF_P(pz) Z_SET_ISREF_TO_P(pz, 0) #define PZ_SET_ISREF_TO_P(pz, isref) (pz)->is_ref__gc = (isref) #define DO_ALLOCA(x) do_alloca(x, use_heap) #define FREE_ALLOCA(x) free_alloca(x, use_heap) #if defined(HAVE_OPCACHE_FILE_CACHE) && defined(ZEND_WIN32) # define ENABLE_FILE_CACHE_FALLBACK 1 #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_string *full_path; /* full real path with resolved symlinks */ zend_op_array main_op_array; HashTable function_table; HashTable class_table; 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; 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 fast_shutdown; zend_bool protect_memory; zend_bool file_override_enabled; zend_bool inherited_hack; 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 max_file_size; zend_long interned_strings_buffer; char *restrict_api; #ifndef ZEND_WIN32 char *lockfile_path; #endif #ifdef HAVE_OPCACHE_FILE_CACHE char *file_cache; zend_bool file_cache_only; zend_bool file_cache_consistency_checks; #endif #if ENABLE_FILE_CACHE_FALLBACK zend_bool file_cache_fallback; #endif #ifdef HAVE_HUGE_CODE_PAGES zend_bool huge_code_pages; #endif } zend_accel_directives; typedef struct _zend_accel_globals { /* copy of CG(function_table) used for compilation scripts into cache */ /* initially it contains only internal functions */ HashTable function_table; int internal_functions_count; int counted; /* the process uses shared memory */ zend_bool enabled; zend_bool locked; /* thread obtained exclusive lock */ 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 */ char system_id[32]; 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; /* 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_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 */ /* 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; /* Interned Strings Support */ char *interned_strings_start; char *interned_strings_top; char *interned_strings_end; char *interned_strings_saved_top; HashTable interned_strings; } zend_accel_shared_globals; extern zend_bool accel_startup_ok; #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_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 zend_accel_invalidate(const char *filename, int filename_len, zend_bool force); int zend_accel_script_optimize(zend_persistent_script *persistent_script); int accelerator_shm_read_lock(void); void accelerator_shm_read_unlock(void); char *accel_make_persistent_key(const char *path, int path_length, int *key_len); zend_op_array *persistent_compile_file(zend_file_handle *file_handle, int type); #if !defined(ZEND_DECLARE_INHERITED_CLASS_DELAYED) # define ZEND_DECLARE_INHERITED_CLASS_DELAYED 145 #endif #define ZEND_DECLARE_INHERITED_CLASS_DELAYED_FLAG 0x80 #define IS_ACCEL_INTERNED(str) \ ((char*)(str) >= ZCSG(interned_strings_start) && (char*)(str) < ZCSG(interned_strings_end)) zend_string *accel_new_interned_string(zend_string *str); # define ZEND_RESULT_TYPE(opline) (opline)->result_type # define ZEND_RESULT(opline) (opline)->result # define ZEND_OP1_TYPE(opline) (opline)->op1_type # define ZEND_OP1(opline) (opline)->op1 # define ZEND_OP1_CONST(opline) (*(opline)->op1.zv) # define ZEND_OP1_LITERAL(opline) (op_array)->literals[(opline)->op1.constant] # define ZEND_OP2_TYPE(opline) (opline)->op2_type # define ZEND_OP2(opline) (opline)->op2 # define ZEND_OP2_CONST(opline) (*(opline)->op2.zv) # define ZEND_OP2_LITERAL(opline) (op_array)->literals[(opline)->op2.constant] # define ZEND_DONE_PASS_TWO(op_array) (((op_array)->fn_flags & ZEND_ACC_DONE_PASS_TWO) != 0) # define ZEND_CE_FILENAME(ce) (ce)->info.user.filename # define ZEND_CE_DOC_COMMENT(ce) (ce)->info.user.doc_comment # define ZEND_CE_DOC_COMMENT_LEN(ce) (ce)->info.user.doc_comment_len #endif /* ZEND_ACCELERATOR_H */