xref: /PHP-8.3/main/php.h (revision 2eb21b0b)
1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | https://www.php.net/license/3_01.txt                                 |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Authors: Andi Gutmans <andi@php.net>                                 |
14    |          Zeev Suraski <zeev@php.net>                                 |
15    +----------------------------------------------------------------------+
16  */
17 
18 #ifndef PHP_H
19 #define PHP_H
20 
21 #ifdef HAVE_DMALLOC
22 #include <dmalloc.h>
23 #endif
24 
25 #define PHP_API_VERSION 20230831
26 #define PHP_HAVE_STREAMS
27 #define YYDEBUG 0
28 #define PHP_DEFAULT_CHARSET "UTF-8"
29 
30 #include "php_version.h"
31 #include "zend.h"
32 #include "zend_sort.h"
33 #include "php_compat.h"
34 
35 #include "zend_API.h"
36 
37 #define php_sprintf sprintf
38 
39 /* Operating system family definition */
40 #ifdef PHP_WIN32
41 # define PHP_OS_FAMILY			"Windows"
42 #elif defined(BSD) || defined(__DragonFly__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
43 # define PHP_OS_FAMILY			"BSD"
44 #elif defined(__APPLE__) || defined(__MACH__)
45 # define PHP_OS_FAMILY			"Darwin"
46 #elif defined(__sun__)
47 # define PHP_OS_FAMILY			"Solaris"
48 #elif defined(__linux__)
49 # define PHP_OS_FAMILY			"Linux"
50 #else
51 # define PHP_OS_FAMILY			"Unknown"
52 #endif
53 
54 /* PHP's DEBUG value must match Zend's ZEND_DEBUG value */
55 #undef PHP_DEBUG
56 #define PHP_DEBUG ZEND_DEBUG
57 
58 #ifdef PHP_WIN32
59 #	include "tsrm_win32.h"
60 #	ifdef PHP_EXPORTS
61 #		define PHPAPI __declspec(dllexport)
62 #	else
63 #		define PHPAPI __declspec(dllimport)
64 #	endif
65 #	define PHP_DIR_SEPARATOR '\\'
66 #	define PHP_EOL "\r\n"
67 #else
68 #	if defined(__GNUC__) && __GNUC__ >= 4
69 #		define PHPAPI __attribute__ ((visibility("default")))
70 #	else
71 #		define PHPAPI
72 #	endif
73 #	define PHP_DIR_SEPARATOR '/'
74 #	define PHP_EOL "\n"
75 #endif
76 
77 /* Windows specific defines */
78 #ifdef PHP_WIN32
79 # define PHP_PROG_SENDMAIL		"Built in mailer"
80 # define WIN32_LEAN_AND_MEAN
81 # define NOOPENFILE
82 
83 # include <io.h>
84 # include <malloc.h>
85 # include <direct.h>
86 # include <stdlib.h>
87 # include <stdio.h>
88 # include <stdarg.h>
89 # include <sys/types.h>
90 # include <process.h>
91 
92 typedef int uid_t;
93 typedef int gid_t;
94 typedef char * caddr_t;
95 typedef int pid_t;
96 
97 # define M_TWOPI        (M_PI * 2.0)
98 # define off_t			_off_t
99 
100 # define lstat(x, y)	php_sys_lstat(x, y)
101 # define chdir(path)	_chdir(path)
102 # define mkdir(a, b)	_mkdir(a)
103 # define rmdir(a)		_rmdir(a)
104 # define getpid			_getpid
105 # define php_sleep(t)	SleepEx(t*1000, TRUE)
106 
107 # ifndef getcwd
108 #  define getcwd(a, b)	_getcwd(a, b)
109 # endif
110 #endif
111 
112 #if PHP_DEBUG
113 #undef NDEBUG
114 #else
115 #ifndef NDEBUG
116 #define NDEBUG
117 #endif
118 #endif
119 #include <assert.h>
120 
121 #ifdef HAVE_UNIX_H
122 #include <unix.h>
123 #endif
124 
125 #if HAVE_ALLOCA_H
126 #include <alloca.h>
127 #endif
128 
129 #if HAVE_BUILD_DEFS_H
130 #include <build-defs.h>
131 #endif
132 
133 /*
134  * This is a fast version of strlcpy which should be used, if you
135  * know the size of the destination buffer and if you know
136  * the length of the source string.
137  *
138  * size is the allocated number of bytes of dst
139  * src_size is the number of bytes excluding the NUL of src
140  */
141 
142 #define PHP_STRLCPY(dst, src, size, src_size)	\
143 	{											\
144 		size_t php_str_len;						\
145 												\
146 		if (src_size >= size)					\
147 			php_str_len = size - 1;				\
148 		else									\
149 			php_str_len = src_size;				\
150 		memcpy(dst, src, php_str_len);			\
151 		dst[php_str_len] = '\0';				\
152 	}
153 
154 #ifndef HAVE_STRLCPY
155 BEGIN_EXTERN_C()
156 PHPAPI size_t php_strlcpy(char *dst, const char *src, size_t siz);
157 END_EXTERN_C()
158 #undef strlcpy
159 #define strlcpy php_strlcpy
160 #define HAVE_STRLCPY 1
161 #define USE_STRLCPY_PHP_IMPL 1
162 #endif
163 
164 #ifndef HAVE_STRLCAT
165 BEGIN_EXTERN_C()
166 PHPAPI size_t php_strlcat(char *dst, const char *src, size_t siz);
167 END_EXTERN_C()
168 #undef strlcat
169 #define strlcat php_strlcat
170 #define HAVE_STRLCAT 1
171 #define USE_STRLCAT_PHP_IMPL 1
172 #endif
173 
174 #ifndef HAVE_EXPLICIT_BZERO
175 BEGIN_EXTERN_C()
176 PHPAPI void php_explicit_bzero(void *dst, size_t siz);
177 END_EXTERN_C()
178 #undef explicit_bzero
179 #define explicit_bzero php_explicit_bzero
180 #endif
181 
182 BEGIN_EXTERN_C()
183 PHPAPI int php_safe_bcmp(const zend_string *a, const zend_string *b);
184 END_EXTERN_C()
185 
186 #ifndef HAVE_STRTOK_R
187 BEGIN_EXTERN_C()
188 char *strtok_r(char *s, const char *delim, char **last);
189 END_EXTERN_C()
190 #endif
191 
192 #ifndef HAVE_SOCKLEN_T
193 # ifdef PHP_WIN32
194 typedef int socklen_t;
195 # else
196 typedef unsigned int socklen_t;
197 # endif
198 #endif
199 
200 #define CREATE_MUTEX(a, b)
201 #define SET_MUTEX(a)
202 #define FREE_MUTEX(a)
203 
204 /*
205  * Then the ODBC support can use both iodbc and Solid,
206  * uncomment this.
207  * #define HAVE_ODBC (HAVE_IODBC|HAVE_SOLID)
208  */
209 
210 #include <stdlib.h>
211 #include <ctype.h>
212 #if HAVE_UNISTD_H
213 #include <unistd.h>
214 #endif
215 
216 #include <stdarg.h>
217 
218 #include "zend_hash.h"
219 #include "zend_alloc.h"
220 #include "zend_stack.h"
221 #include <string.h>
222 
223 #if HAVE_PWD_H
224 # ifdef PHP_WIN32
225 #include "win32/param.h"
226 # else
227 #include <pwd.h>
228 #include <sys/param.h>
229 # endif
230 #endif
231 
232 #include <limits.h>
233 
234 #ifndef LONG_MAX
235 #define LONG_MAX 2147483647L
236 #endif
237 
238 #ifndef LONG_MIN
239 #define LONG_MIN (- LONG_MAX - 1)
240 #endif
241 
242 #ifndef INT_MAX
243 #define INT_MAX 2147483647
244 #endif
245 
246 #ifndef INT_MIN
247 #define INT_MIN (- INT_MAX - 1)
248 #endif
249 
250 #define PHP_DOUBLE_MAX_LENGTH ZEND_DOUBLE_MAX_LENGTH
251 
252 #define PHP_GCC_VERSION ZEND_GCC_VERSION
253 #define PHP_ATTRIBUTE_MALLOC ZEND_ATTRIBUTE_MALLOC
254 #define PHP_ATTRIBUTE_FORMAT ZEND_ATTRIBUTE_FORMAT
255 
256 BEGIN_EXTERN_C()
257 #include "snprintf.h"
258 END_EXTERN_C()
259 #include "spprintf.h"
260 
261 #define EXEC_INPUT_BUF 4096
262 
263 #define PHP_MIME_TYPE "application/x-httpd-php"
264 
265 /* macros */
266 #define STR_PRINT(str)	((str)?(str):"")
267 
268 #ifndef MAXPATHLEN
269 # ifdef PHP_WIN32
270 #  include "win32/ioutil.h"
271 #  define MAXPATHLEN PHP_WIN32_IOUTIL_MAXPATHLEN
272 # elif PATH_MAX
273 #  define MAXPATHLEN PATH_MAX
274 # elif defined(MAX_PATH)
275 #  define MAXPATHLEN MAX_PATH
276 # else
277 #  define MAXPATHLEN 256    /* Should be safe for any weird systems that do not define it */
278 # endif
279 #endif
280 
281 #define php_ignore_value(x) ZEND_IGNORE_VALUE(x)
282 
283 /* global variables */
284 #ifndef PHP_WIN32
285 #define php_sleep sleep
286 extern char **environ;
287 #endif	/* ifndef PHP_WIN32 */
288 
289 #ifdef PHP_PWRITE_64
290 ssize_t pwrite(int, void *, size_t, off64_t);
291 #endif
292 
293 #ifdef PHP_PREAD_64
294 ssize_t pread(int, void *, size_t, off64_t);
295 #endif
296 
297 BEGIN_EXTERN_C()
298 void phperror(char *error);
299 PHPAPI size_t php_write(void *buf, size_t size);
300 PHPAPI size_t php_printf(const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 1, 2);
301 PHPAPI size_t php_printf_unchecked(const char *format, ...);
302 PHPAPI bool php_during_module_startup(void);
303 PHPAPI bool php_during_module_shutdown(void);
304 PHPAPI bool php_get_module_initialized(void);
305 #ifdef HAVE_SYSLOG_H
306 #include "php_syslog.h"
307 #define php_log_err(msg) php_log_err_with_severity(msg, LOG_NOTICE)
308 #else
309 #define php_log_err(msg) php_log_err_with_severity(msg, 5)
310 #endif
311 PHPAPI ZEND_COLD void php_log_err_with_severity(const char *log_message, int syslog_type_int);
312 int Debug(char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 1, 2);
313 int cfgparse(void);
314 END_EXTERN_C()
315 
316 #define php_error zend_error
317 #define error_handling_t zend_error_handling_t
318 
BEGIN_EXTERN_C()319 BEGIN_EXTERN_C()
320 static inline ZEND_ATTRIBUTE_DEPRECATED void php_set_error_handling(error_handling_t error_handling, zend_class_entry *exception_class)
321 {
322 	zend_replace_error_handling(error_handling, exception_class, NULL);
323 }
php_std_error_handling(void)324 static inline ZEND_ATTRIBUTE_DEPRECATED void php_std_error_handling(void) {}
325 
326 PHPAPI ZEND_COLD void php_verror(const char *docref, const char *params, int type, const char *format, va_list args) PHP_ATTRIBUTE_FORMAT(printf, 4, 0);
327 
328 /* PHPAPI void php_error(int type, const char *format, ...); */
329 PHPAPI ZEND_COLD void php_error_docref(const char *docref, int type, const char *format, ...)
330 	PHP_ATTRIBUTE_FORMAT(printf, 3, 4);
331 PHPAPI ZEND_COLD void php_error_docref1(const char *docref, const char *param1, int type, const char *format, ...)
332 	PHP_ATTRIBUTE_FORMAT(printf, 4, 5);
333 PHPAPI ZEND_COLD void php_error_docref2(const char *docref, const char *param1, const char *param2, int type, const char *format, ...)
334 	PHP_ATTRIBUTE_FORMAT(printf, 5, 6);
335 #ifdef PHP_WIN32
336 PHPAPI ZEND_COLD void php_win32_docref1_from_error(DWORD error, const char *param1);
337 PHPAPI ZEND_COLD void php_win32_docref2_from_error(DWORD error, const char *param1, const char *param2);
338 #endif
339 END_EXTERN_C()
340 
341 #define zenderror phperror
342 #define zendlex phplex
343 
344 #define phpparse zendparse
345 #define phprestart zendrestart
346 #define phpin zendin
347 
348 #define php_memnstr zend_memnstr
349 #define php_memnistr zend_memnistr
350 
351 /* functions */
352 BEGIN_EXTERN_C()
353 PHPAPI extern int (*php_register_internal_extensions_func)(void);
354 PHPAPI int php_register_internal_extensions(void);
355 PHPAPI void php_register_pre_request_shutdown(void (*func)(void *), void *userdata);
356 PHPAPI void php_com_initialize(void);
357 PHPAPI char *php_get_current_user(void);
358 
359 PHPAPI const char *php_get_internal_encoding(void);
360 PHPAPI const char *php_get_input_encoding(void);
361 PHPAPI const char *php_get_output_encoding(void);
362 PHPAPI extern void (*php_internal_encoding_changed)(void);
363 END_EXTERN_C()
364 
365 /* PHP-named Zend macro wrappers */
366 #define PHP_FN					ZEND_FN
367 #define PHP_MN					ZEND_MN
368 #define PHP_NAMED_FUNCTION		ZEND_NAMED_FUNCTION
369 #define PHP_FUNCTION			ZEND_FUNCTION
370 #define PHP_METHOD  			ZEND_METHOD
371 
372 #define PHP_RAW_NAMED_FE ZEND_RAW_NAMED_FE
373 #define PHP_NAMED_FE	ZEND_NAMED_FE
374 #define PHP_FE			ZEND_FE
375 #define PHP_DEP_FE      ZEND_DEP_FE
376 #define PHP_FALIAS		ZEND_FALIAS
377 #define PHP_DEP_FALIAS	ZEND_DEP_FALIAS
378 #define PHP_ME          ZEND_ME
379 #define PHP_MALIAS      ZEND_MALIAS
380 #define PHP_ABSTRACT_ME ZEND_ABSTRACT_ME
381 #define PHP_ME_MAPPING  ZEND_ME_MAPPING
382 #define PHP_FE_END      ZEND_FE_END
383 
384 #define PHP_MODULE_STARTUP_N	ZEND_MODULE_STARTUP_N
385 #define PHP_MODULE_SHUTDOWN_N	ZEND_MODULE_SHUTDOWN_N
386 #define PHP_MODULE_ACTIVATE_N	ZEND_MODULE_ACTIVATE_N
387 #define PHP_MODULE_DEACTIVATE_N	ZEND_MODULE_DEACTIVATE_N
388 #define PHP_MODULE_INFO_N		ZEND_MODULE_INFO_N
389 
390 #define PHP_MODULE_STARTUP_D	ZEND_MODULE_STARTUP_D
391 #define PHP_MODULE_SHUTDOWN_D	ZEND_MODULE_SHUTDOWN_D
392 #define PHP_MODULE_ACTIVATE_D	ZEND_MODULE_ACTIVATE_D
393 #define PHP_MODULE_DEACTIVATE_D	ZEND_MODULE_DEACTIVATE_D
394 #define PHP_MODULE_INFO_D		ZEND_MODULE_INFO_D
395 
396 /* Compatibility macros */
397 #define PHP_MINIT		ZEND_MODULE_STARTUP_N
398 #define PHP_MSHUTDOWN	ZEND_MODULE_SHUTDOWN_N
399 #define PHP_RINIT		ZEND_MODULE_ACTIVATE_N
400 #define PHP_RSHUTDOWN	ZEND_MODULE_DEACTIVATE_N
401 #define PHP_MINFO		ZEND_MODULE_INFO_N
402 #define PHP_GINIT		ZEND_GINIT
403 #define PHP_GSHUTDOWN	ZEND_GSHUTDOWN
404 
405 #define PHP_MINIT_FUNCTION		ZEND_MODULE_STARTUP_D
406 #define PHP_MSHUTDOWN_FUNCTION	ZEND_MODULE_SHUTDOWN_D
407 #define PHP_RINIT_FUNCTION		ZEND_MODULE_ACTIVATE_D
408 #define PHP_RSHUTDOWN_FUNCTION	ZEND_MODULE_DEACTIVATE_D
409 #define PHP_MINFO_FUNCTION		ZEND_MODULE_INFO_D
410 #define PHP_GINIT_FUNCTION		ZEND_GINIT_FUNCTION
411 #define PHP_GSHUTDOWN_FUNCTION	ZEND_GSHUTDOWN_FUNCTION
412 
413 #define PHP_MODULE_GLOBALS		ZEND_MODULE_GLOBALS
414 
415 
416 /* Output support */
417 #include "main/php_output.h"
418 
419 
420 #include "php_streams.h"
421 #include "php_memory_streams.h"
422 #include "fopen_wrappers.h"
423 
424 
425 /* Virtual current working directory support */
426 #include "zend_virtual_cwd.h"
427 
428 #include "zend_constants.h"
429 
430 /* connection status states */
431 #define PHP_CONNECTION_NORMAL  0
432 #define PHP_CONNECTION_ABORTED 1
433 #define PHP_CONNECTION_TIMEOUT 2
434 
435 #include "php_reentrancy.h"
436 
437 /* the following typedefs are deprecated and will be removed in PHP
438  * 9.0; use the standard C99 types instead */
439 typedef bool zend_bool;
440 typedef intptr_t zend_intptr_t;
441 typedef uintptr_t zend_uintptr_t;
442 
443 #endif
444