1 /* 2 +----------------------------------------------------------------------+ 3 | Zend OPcache | 4 +----------------------------------------------------------------------+ 5 | Copyright (c) The PHP Group | 6 +----------------------------------------------------------------------+ 7 | This source file is subject to version 3.01 of the PHP license, | 8 | that is bundled with this package in the file LICENSE, and is | 9 | available through the world-wide-web at the following url: | 10 | http://www.php.net/license/3_01.txt | 11 | If you did not receive a copy of the PHP license and are unable to | 12 | obtain it through the world-wide-web, please send a note to | 13 | license@php.net so we can mail you a copy immediately. | 14 +----------------------------------------------------------------------+ 15 | Authors: Andi Gutmans <andi@php.net> | 16 | Zeev Suraski <zeev@php.net> | 17 | Stanislav Malyshev <stas@zend.com> | 18 | Dmitry Stogov <dmitry@php.net> | 19 +----------------------------------------------------------------------+ 20 */ 21 22 #ifndef ZEND_ACCELERATOR_H 23 #define ZEND_ACCELERATOR_H 24 25 #ifdef HAVE_CONFIG_H 26 # include <config.h> 27 #endif 28 29 #define ACCELERATOR_PRODUCT_NAME "Zend OPcache" 30 /* 2 - added Profiler support, on 20010712 */ 31 /* 3 - added support for Optimizer's encoded-only-files mode */ 32 /* 4 - works with the new Optimizer, that supports the file format with licenses */ 33 /* 5 - API 4 didn't really work with the license-enabled file format. v5 does. */ 34 /* 6 - Monitor was removed from ZendPlatform.so, to a module of its own */ 35 /* 7 - Optimizer was embedded into Accelerator */ 36 /* 8 - Standalone Open Source Zend OPcache */ 37 #define ACCELERATOR_API_NO 8 38 39 #if ZEND_WIN32 40 # include "zend_config.w32.h" 41 #else 42 #include "zend_config.h" 43 # include <sys/time.h> 44 # include <sys/resource.h> 45 #endif 46 47 #if HAVE_UNISTD_H 48 # include "unistd.h" 49 #endif 50 51 #include "zend_extensions.h" 52 #include "zend_compile.h" 53 54 #include "Optimizer/zend_optimizer.h" 55 #include "zend_accelerator_hash.h" 56 #include "zend_accelerator_debug.h" 57 58 #ifndef PHPAPI 59 # ifdef ZEND_WIN32 60 # define PHPAPI __declspec(dllimport) 61 # else 62 # define PHPAPI 63 # endif 64 #endif 65 66 #ifndef ZEND_EXT_API 67 # ifdef ZEND_WIN32 68 # define ZEND_EXT_API __declspec(dllexport) 69 # elif defined(__GNUC__) && __GNUC__ >= 4 70 # define ZEND_EXT_API __attribute__ ((visibility("default"))) 71 # else 72 # define ZEND_EXT_API 73 # endif 74 #endif 75 76 #ifdef ZEND_WIN32 77 # ifndef MAXPATHLEN 78 # include "win32/ioutil.h" 79 # define MAXPATHLEN PHP_WIN32_IOUTIL_MAXPATHLEN 80 # endif 81 # include <direct.h> 82 #else 83 # ifndef MAXPATHLEN 84 # define MAXPATHLEN 4096 85 # endif 86 # include <sys/param.h> 87 #endif 88 89 /*** file locking ***/ 90 #ifndef ZEND_WIN32 91 extern int lock_file; 92 #endif 93 94 #if defined(ZEND_WIN32) 95 # define ENABLE_FILE_CACHE_FALLBACK 1 96 #else 97 # define ENABLE_FILE_CACHE_FALLBACK 0 98 #endif 99 100 #if ZEND_WIN32 101 typedef unsigned __int64 accel_time_t; 102 #else 103 typedef time_t accel_time_t; 104 #endif 105 106 typedef enum _zend_accel_restart_reason { 107 ACCEL_RESTART_OOM, /* restart because of out of memory */ 108 ACCEL_RESTART_HASH, /* restart because of hash overflow */ 109 ACCEL_RESTART_USER /* restart scheduled by opcache_reset() */ 110 } zend_accel_restart_reason; 111 112 typedef struct _zend_recorded_warning { 113 int type; 114 uint32_t error_lineno; 115 zend_string *error_filename; 116 zend_string *error_message; 117 } zend_recorded_warning; 118 119 typedef struct _zend_persistent_script { 120 zend_script script; 121 zend_long compiler_halt_offset; /* position of __HALT_COMPILER or -1 */ 122 int ping_auto_globals_mask; /* which autoglobals are used by the script */ 123 accel_time_t timestamp; /* the script modification time */ 124 zend_bool corrupted; 125 zend_bool is_phar; 126 zend_bool empty; 127 uint32_t num_warnings; 128 zend_recorded_warning **warnings; 129 130 void *mem; /* shared memory area used by script structures */ 131 size_t size; /* size of used shared memory */ 132 void *arena_mem; /* part that should be copied into process */ 133 size_t arena_size; 134 135 /* All entries that shouldn't be counted in the ADLER32 136 * checksum must be declared in this struct 137 */ 138 struct zend_persistent_script_dynamic_members { 139 time_t last_used; 140 #ifdef ZEND_WIN32 141 LONGLONG hits; 142 #else 143 zend_ulong hits; 144 #endif 145 unsigned int memory_consumption; 146 unsigned int checksum; 147 time_t revalidate; 148 } dynamic_members; 149 } zend_persistent_script; 150 151 typedef struct _zend_accel_directives { 152 zend_long memory_consumption; 153 zend_long max_accelerated_files; 154 double max_wasted_percentage; 155 char *user_blacklist_filename; 156 zend_long consistency_checks; 157 zend_long force_restart_timeout; 158 zend_bool use_cwd; 159 zend_bool ignore_dups; 160 zend_bool validate_timestamps; 161 zend_bool revalidate_path; 162 zend_bool save_comments; 163 zend_bool record_warnings; 164 zend_bool protect_memory; 165 zend_bool file_override_enabled; 166 zend_bool enable_cli; 167 zend_bool validate_permission; 168 #ifndef ZEND_WIN32 169 zend_bool validate_root; 170 #endif 171 zend_ulong revalidate_freq; 172 zend_ulong file_update_protection; 173 char *error_log; 174 #ifdef ZEND_WIN32 175 char *mmap_base; 176 #endif 177 char *memory_model; 178 zend_long log_verbosity_level; 179 180 zend_long optimization_level; 181 zend_long opt_debug_level; 182 zend_long max_file_size; 183 zend_long interned_strings_buffer; 184 char *restrict_api; 185 #ifndef ZEND_WIN32 186 char *lockfile_path; 187 #endif 188 char *file_cache; 189 zend_bool file_cache_only; 190 zend_bool file_cache_consistency_checks; 191 #if ENABLE_FILE_CACHE_FALLBACK 192 zend_bool file_cache_fallback; 193 #endif 194 #ifdef HAVE_HUGE_CODE_PAGES 195 zend_bool huge_code_pages; 196 #endif 197 char *preload; 198 #ifndef ZEND_WIN32 199 char *preload_user; 200 #endif 201 #ifdef ZEND_WIN32 202 char *cache_id; 203 #endif 204 } zend_accel_directives; 205 206 typedef struct _zend_accel_globals { 207 int counted; /* the process uses shared memory */ 208 zend_bool enabled; 209 zend_bool locked; /* thread obtained exclusive lock */ 210 zend_bool accelerator_enabled; /* accelerator enabled for current request */ 211 zend_bool pcre_reseted; 212 HashTable bind_hash; /* prototype and zval lookup table */ 213 zend_accel_directives accel_directives; 214 zend_string *cwd; /* current working directory or NULL */ 215 zend_string *include_path; /* current value of "include_path" directive */ 216 char include_path_key[32]; /* key of current "include_path" */ 217 char cwd_key[32]; /* key of current working directory */ 218 int include_path_key_len; 219 int include_path_check; 220 int cwd_key_len; 221 int cwd_check; 222 int auto_globals_mask; 223 time_t request_time; 224 time_t last_restart_time; /* used to synchronize SHM and in-process caches */ 225 HashTable xlat_table; 226 #ifndef ZEND_WIN32 227 zend_ulong root_hash; 228 #endif 229 /* preallocated shared-memory block to save current script */ 230 void *mem; 231 void *arena_mem; 232 zend_persistent_script *current_persistent_script; 233 zend_bool is_immutable_class; 234 /* Temporary storage for warnings before they are moved into persistent_script. */ 235 zend_bool record_warnings; 236 uint32_t num_warnings; 237 zend_recorded_warning **warnings; 238 /* cache to save hash lookup on the same INCLUDE opcode */ 239 const zend_op *cache_opline; 240 zend_persistent_script *cache_persistent_script; 241 /* preallocated buffer for keys */ 242 int key_len; 243 char key[MAXPATHLEN * 8]; 244 } zend_accel_globals; 245 246 typedef struct _zend_string_table { 247 uint32_t nTableMask; 248 uint32_t nNumOfElements; 249 zend_string *start; 250 zend_string *top; 251 zend_string *end; 252 zend_string *saved_top; 253 } zend_string_table; 254 255 typedef struct _zend_accel_shared_globals { 256 /* Cache Data Structures */ 257 zend_ulong hits; 258 zend_ulong misses; 259 zend_ulong blacklist_misses; 260 zend_ulong oom_restarts; /* number of restarts because of out of memory */ 261 zend_ulong hash_restarts; /* number of restarts because of hash overflow */ 262 zend_ulong manual_restarts; /* number of restarts scheduled by opcache_reset() */ 263 zend_accel_hash hash; /* hash table for cached scripts */ 264 265 size_t map_ptr_last; 266 267 /* Directives & Maintenance */ 268 time_t start_time; 269 time_t last_restart_time; 270 time_t force_restart_time; 271 zend_bool accelerator_enabled; 272 zend_bool restart_pending; 273 zend_accel_restart_reason restart_reason; 274 zend_bool cache_status_before_restart; 275 #ifdef ZEND_WIN32 276 LONGLONG mem_usage; 277 LONGLONG restart_in; 278 #endif 279 zend_bool restart_in_progress; 280 281 /* Preloading */ 282 zend_persistent_script *preload_script; 283 zend_persistent_script **saved_scripts; 284 285 /* uninitialized HashTable Support */ 286 uint32_t uninitialized_bucket[-HT_MIN_MASK]; 287 288 /* Tracing JIT */ 289 void *jit_traces; 290 const void **jit_exit_groups; 291 292 /* Interned Strings Support (must be the last element) */ 293 zend_string_table interned_strings; 294 } zend_accel_shared_globals; 295 296 #ifdef ZEND_WIN32 297 extern char accel_uname_id[32]; 298 #endif 299 extern zend_bool accel_startup_ok; 300 extern zend_bool file_cache_only; 301 #if ENABLE_FILE_CACHE_FALLBACK 302 extern zend_bool fallback_process; 303 #endif 304 305 extern zend_accel_shared_globals *accel_shared_globals; 306 #define ZCSG(element) (accel_shared_globals->element) 307 308 #ifdef ZTS 309 # define ZCG(v) ZEND_TSRMG(accel_globals_id, zend_accel_globals *, v) 310 extern int accel_globals_id; 311 # ifdef COMPILE_DL_OPCACHE 312 ZEND_TSRMLS_CACHE_EXTERN() 313 # endif 314 #else 315 # define ZCG(v) (accel_globals.v) 316 extern zend_accel_globals accel_globals; 317 #endif 318 319 extern char *zps_api_failure_reason; 320 321 void accel_shutdown(void); 322 zend_result accel_activate(INIT_FUNC_ARGS); 323 zend_result accel_post_deactivate(void); 324 void zend_accel_schedule_restart(zend_accel_restart_reason reason); 325 void zend_accel_schedule_restart_if_necessary(zend_accel_restart_reason reason); 326 accel_time_t zend_get_file_handle_timestamp(zend_file_handle *file_handle, size_t *size); 327 int validate_timestamp_and_record(zend_persistent_script *persistent_script, zend_file_handle *file_handle); 328 int validate_timestamp_and_record_ex(zend_persistent_script *persistent_script, zend_file_handle *file_handle); 329 int zend_accel_invalidate(const char *filename, size_t filename_len, zend_bool force); 330 int accelerator_shm_read_lock(void); 331 void accelerator_shm_read_unlock(void); 332 333 char *accel_make_persistent_key(const char *path, size_t path_length, int *key_len); 334 zend_op_array *persistent_compile_file(zend_file_handle *file_handle, int type); 335 336 #define IS_ACCEL_INTERNED(str) \ 337 ((char*)(str) >= (char*)ZCSG(interned_strings).start && (char*)(str) < (char*)ZCSG(interned_strings).top) 338 339 zend_string* ZEND_FASTCALL accel_new_interned_string(zend_string *str); 340 341 /* memory write protection */ 342 #define SHM_PROTECT() \ 343 do { \ 344 if (ZCG(accel_directives).protect_memory) { \ 345 zend_accel_shared_protect(1); \ 346 } \ 347 } while (0) 348 349 #define SHM_UNPROTECT() \ 350 do { \ 351 if (ZCG(accel_directives).protect_memory) { \ 352 zend_accel_shared_protect(0); \ 353 } \ 354 } while (0) 355 356 #endif /* ZEND_ACCELERATOR_H */ 357