1 /*
2 +----------------------------------------------------------------------+
3 | PHP Version 5 |
4 +----------------------------------------------------------------------+
5 | Copyright (c) 1997-2014 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@zend.com> |
16 | Zeev Suraski <zeev@zend.com> |
17 +----------------------------------------------------------------------+
18 */
19
20 /* $Id$ */
21
22 #ifndef PHP_H
23 #define PHP_H
24
25 #ifdef HAVE_DMALLOC
26 #include <dmalloc.h>
27 #endif
28
29 #define PHP_API_VERSION 20100412
30 #define PHP_HAVE_STREAMS
31 #define YYDEBUG 0
32
33 #include "php_version.h"
34 #include "zend.h"
35 #include "zend_qsort.h"
36 #include "php_compat.h"
37
38 #include "zend_API.h"
39
40 #undef sprintf
41 #define sprintf php_sprintf
42
43 /* PHP's DEBUG value must match Zend's ZEND_DEBUG value */
44 #undef PHP_DEBUG
45 #define PHP_DEBUG ZEND_DEBUG
46
47 #ifdef PHP_WIN32
48 # include "tsrm_win32.h"
49 # include "win95nt.h"
50 # ifdef PHP_EXPORTS
51 # define PHPAPI __declspec(dllexport)
52 # else
53 # define PHPAPI __declspec(dllimport)
54 # endif
55 # define PHP_DIR_SEPARATOR '\\'
56 # define PHP_EOL "\r\n"
57 #else
58 # if defined(__GNUC__) && __GNUC__ >= 4
59 # define PHPAPI __attribute__ ((visibility("default")))
60 # else
61 # define PHPAPI
62 # endif
63
64 # define THREAD_LS
65 # define PHP_DIR_SEPARATOR '/'
66 # define PHP_EOL "\n"
67 #endif
68
69 #ifdef NETWARE
70 /* For php_get_uname() function */
71 #define PHP_UNAME "NetWare"
72 #define PHP_OS PHP_UNAME
73 #endif
74
75 #if HAVE_ASSERT_H
76 #if PHP_DEBUG
77 #undef NDEBUG
78 #else
79 #ifndef NDEBUG
80 #define NDEBUG
81 #endif
82 #endif
83 #include <assert.h>
84 #else /* HAVE_ASSERT_H */
85 #define assert(expr) ((void) (0))
86 #endif /* HAVE_ASSERT_H */
87
88 #define APACHE 0
89
90 #if HAVE_UNIX_H
91 #include <unix.h>
92 #endif
93
94 #if HAVE_ALLOCA_H
95 #include <alloca.h>
96 #endif
97
98 #if HAVE_BUILD_DEFS_H
99 #include <build-defs.h>
100 #endif
101
102 /*
103 * This is a fast version of strlcpy which should be used, if you
104 * know the size of the destination buffer and if you know
105 * the length of the source string.
106 *
107 * size is the allocated number of bytes of dst
108 * src_size is the number of bytes excluding the NUL of src
109 */
110
111 #define PHP_STRLCPY(dst, src, size, src_size) \
112 { \
113 size_t php_str_len; \
114 \
115 if (src_size >= size) \
116 php_str_len = size - 1; \
117 else \
118 php_str_len = src_size; \
119 memcpy(dst, src, php_str_len); \
120 dst[php_str_len] = '\0'; \
121 }
122
123 #ifndef HAVE_STRLCPY
124 BEGIN_EXTERN_C()
125 PHPAPI size_t php_strlcpy(char *dst, const char *src, size_t siz);
126 END_EXTERN_C()
127 #undef strlcpy
128 #define strlcpy php_strlcpy
129 #endif
130
131 #ifndef HAVE_STRLCAT
132 BEGIN_EXTERN_C()
133 PHPAPI size_t php_strlcat(char *dst, const char *src, size_t siz);
134 END_EXTERN_C()
135 #undef strlcat
136 #define strlcat php_strlcat
137 #endif
138
139 #ifndef HAVE_STRTOK_R
140 BEGIN_EXTERN_C()
141 char *strtok_r(char *s, const char *delim, char **last);
142 END_EXTERN_C()
143 #endif
144
145 #ifndef HAVE_SOCKLEN_T
146 # if PHP_WIN32
147 typedef int socklen_t;
148 # else
149 typedef unsigned int socklen_t;
150 # endif
151 #endif
152
153 #define CREATE_MUTEX(a, b)
154 #define SET_MUTEX(a)
155 #define FREE_MUTEX(a)
156
157 /*
158 * Then the ODBC support can use both iodbc and Solid,
159 * uncomment this.
160 * #define HAVE_ODBC (HAVE_IODBC|HAVE_SOLID)
161 */
162
163 #include <stdlib.h>
164 #include <ctype.h>
165 #if HAVE_UNISTD_H
166 #include <unistd.h>
167 #endif
168 #if HAVE_STDARG_H
169 #include <stdarg.h>
170 #else
171 # if HAVE_SYS_VARARGS_H
172 # include <sys/varargs.h>
173 # endif
174 #endif
175
176 #ifndef va_copy
177 # ifdef __va_copy
178 # define va_copy(ap1, ap2) __va_copy((ap1), (ap2))
179 # else
180 # define va_copy(ap1, ap2) memcpy((&ap1), (&ap2), sizeof(va_list))
181 # endif
182 #endif
183
184 #include "zend_hash.h"
185 #include "zend_alloc.h"
186 #include "zend_stack.h"
187
188 #if STDC_HEADERS
189 # include <string.h>
190 #else
191 # ifndef HAVE_MEMCPY
192 # define memcpy(d, s, n) bcopy((s), (d), (n))
193 # endif
194 # ifndef HAVE_MEMMOVE
195 # define memmove(d, s, n) bcopy ((s), (d), (n))
196 # endif
197 #endif
198
199 #ifndef HAVE_STRERROR
200 char *strerror(int);
201 #endif
202
203 #if HAVE_PWD_H
204 # ifdef PHP_WIN32
205 #include "win32/param.h"
206 # else
207 #include <pwd.h>
208 #include <sys/param.h>
209 # endif
210 #endif
211
212 #if HAVE_LIMITS_H
213 #include <limits.h>
214 #endif
215
216 #ifndef LONG_MAX
217 #define LONG_MAX 2147483647L
218 #endif
219
220 #ifndef LONG_MIN
221 #define LONG_MIN (- LONG_MAX - 1)
222 #endif
223
224 #ifndef INT_MAX
225 #define INT_MAX 2147483647
226 #endif
227
228 #ifndef INT_MIN
229 #define INT_MIN (- INT_MAX - 1)
230 #endif
231
232 #define PHP_GCC_VERSION ZEND_GCC_VERSION
233 #define PHP_ATTRIBUTE_MALLOC ZEND_ATTRIBUTE_MALLOC
234 #define PHP_ATTRIBUTE_FORMAT ZEND_ATTRIBUTE_FORMAT
235
236 BEGIN_EXTERN_C()
237 #include "snprintf.h"
238 END_EXTERN_C()
239 #include "spprintf.h"
240
241 #define EXEC_INPUT_BUF 4096
242
243 #define PHP_MIME_TYPE "application/x-httpd-php"
244
245 /* macros */
246 #define STR_PRINT(str) ((str)?(str):"")
247
248 #ifndef MAXPATHLEN
249 # ifdef PATH_MAX
250 # define MAXPATHLEN PATH_MAX
251 # elif defined(MAX_PATH)
252 # define MAXPATHLEN MAX_PATH
253 # else
254 # define MAXPATHLEN 256 /* Should be safe for any weird systems that do not define it */
255 # endif
256 #endif
257
258 #if defined(__GNUC__) && __GNUC__ >= 4
259 # define php_ignore_value(x) (({ __typeof__ (x) __x = (x); (void) __x; }))
260 #else
261 # define php_ignore_value(x) ((void) (x))
262 #endif
263
264 /* global variables */
265 #if !defined(PHP_WIN32)
266 #define PHP_SLEEP_NON_VOID
267 #define php_sleep sleep
268 extern char **environ;
269 #endif /* !defined(PHP_WIN32) */
270
271 #ifdef PHP_PWRITE_64
272 ssize_t pwrite(int, void *, size_t, off64_t);
273 #endif
274
275 #ifdef PHP_PREAD_64
276 ssize_t pread(int, void *, size_t, off64_t);
277 #endif
278
279 BEGIN_EXTERN_C()
280 void phperror(char *error);
281 PHPAPI int php_write(void *buf, uint size TSRMLS_DC);
282 PHPAPI int php_printf(const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 1,
283 2);
284 PHPAPI int php_get_module_initialized(void);
285 PHPAPI void php_log_err(char *log_message TSRMLS_DC);
286 int Debug(char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 1, 2);
287 int cfgparse(void);
288 END_EXTERN_C()
289
290 #define php_error zend_error
291 #define error_handling_t zend_error_handling_t
292
BEGIN_EXTERN_C()293 BEGIN_EXTERN_C()
294 static inline ZEND_ATTRIBUTE_DEPRECATED void php_set_error_handling(error_handling_t error_handling, zend_class_entry *exception_class TSRMLS_DC)
295 {
296 zend_replace_error_handling(error_handling, exception_class, NULL TSRMLS_CC);
297 }
php_std_error_handling()298 static inline ZEND_ATTRIBUTE_DEPRECATED void php_std_error_handling() {}
299
300 PHPAPI void php_verror(const char *docref, const char *params, int type, const char *format, va_list args TSRMLS_DC) PHP_ATTRIBUTE_FORMAT(printf, 4, 0);
301
302 #ifdef ZTS
303 #define PHP_ATTR_FMT_OFFSET 1
304 #else
305 #define PHP_ATTR_FMT_OFFSET 0
306 #endif
307
308 /* PHPAPI void php_error(int type, const char *format, ...); */
309 PHPAPI void php_error_docref0(const char *docref TSRMLS_DC, int type, const char *format, ...)
310 PHP_ATTRIBUTE_FORMAT(printf, PHP_ATTR_FMT_OFFSET + 3, PHP_ATTR_FMT_OFFSET + 4);
311 PHPAPI void php_error_docref1(const char *docref TSRMLS_DC, const char *param1, int type, const char *format, ...)
312 PHP_ATTRIBUTE_FORMAT(printf, PHP_ATTR_FMT_OFFSET + 4, PHP_ATTR_FMT_OFFSET + 5);
313 PHPAPI void php_error_docref2(const char *docref TSRMLS_DC, const char *param1, const char *param2, int type, const char *format, ...)
314 PHP_ATTRIBUTE_FORMAT(printf, PHP_ATTR_FMT_OFFSET + 5, PHP_ATTR_FMT_OFFSET + 6);
315 #ifdef PHP_WIN32
316 PHPAPI void php_win32_docref2_from_error(DWORD error, const char *param1, const char *param2 TSRMLS_DC);
317 #endif
318 END_EXTERN_C()
319
320 #define php_error_docref php_error_docref0
321
322 #define zenderror phperror
323 #define zendlex phplex
324
325 #define phpparse zendparse
326 #define phprestart zendrestart
327 #define phpin zendin
328
329 #define php_memnstr zend_memnstr
330
331 /* functions */
332 BEGIN_EXTERN_C()
333 PHPAPI extern int (*php_register_internal_extensions_func)(TSRMLS_D);
334 PHPAPI int php_register_internal_extensions(TSRMLS_D);
335 PHPAPI int php_mergesort(void *base, size_t nmemb, register size_t size, int (*cmp)(const void *, const void * TSRMLS_DC) TSRMLS_DC);
336 PHPAPI void php_register_pre_request_shutdown(void (*func)(void *), void *userdata);
337 PHPAPI void php_com_initialize(TSRMLS_D);
338 PHPAPI char *php_get_current_user(TSRMLS_D);
339 END_EXTERN_C()
340
341 /* PHP-named Zend macro wrappers */
342 #define PHP_FN ZEND_FN
343 #define PHP_MN ZEND_MN
344 #define PHP_NAMED_FUNCTION ZEND_NAMED_FUNCTION
345 #define PHP_FUNCTION ZEND_FUNCTION
346 #define PHP_METHOD ZEND_METHOD
347
348 #define PHP_RAW_NAMED_FE ZEND_RAW_NAMED_FE
349 #define PHP_NAMED_FE ZEND_NAMED_FE
350 #define PHP_FE ZEND_FE
351 #define PHP_DEP_FE ZEND_DEP_FE
352 #define PHP_FALIAS ZEND_FALIAS
353 #define PHP_DEP_FALIAS ZEND_DEP_FALIAS
354 #define PHP_ME ZEND_ME
355 #define PHP_MALIAS ZEND_MALIAS
356 #define PHP_ABSTRACT_ME ZEND_ABSTRACT_ME
357 #define PHP_ME_MAPPING ZEND_ME_MAPPING
358 #define PHP_FE_END ZEND_FE_END
359
360 #define PHP_MODULE_STARTUP_N ZEND_MODULE_STARTUP_N
361 #define PHP_MODULE_SHUTDOWN_N ZEND_MODULE_SHUTDOWN_N
362 #define PHP_MODULE_ACTIVATE_N ZEND_MODULE_ACTIVATE_N
363 #define PHP_MODULE_DEACTIVATE_N ZEND_MODULE_DEACTIVATE_N
364 #define PHP_MODULE_INFO_N ZEND_MODULE_INFO_N
365
366 #define PHP_MODULE_STARTUP_D ZEND_MODULE_STARTUP_D
367 #define PHP_MODULE_SHUTDOWN_D ZEND_MODULE_SHUTDOWN_D
368 #define PHP_MODULE_ACTIVATE_D ZEND_MODULE_ACTIVATE_D
369 #define PHP_MODULE_DEACTIVATE_D ZEND_MODULE_DEACTIVATE_D
370 #define PHP_MODULE_INFO_D ZEND_MODULE_INFO_D
371
372 /* Compatibility macros */
373 #define PHP_MINIT ZEND_MODULE_STARTUP_N
374 #define PHP_MSHUTDOWN ZEND_MODULE_SHUTDOWN_N
375 #define PHP_RINIT ZEND_MODULE_ACTIVATE_N
376 #define PHP_RSHUTDOWN ZEND_MODULE_DEACTIVATE_N
377 #define PHP_MINFO ZEND_MODULE_INFO_N
378 #define PHP_GINIT ZEND_GINIT
379 #define PHP_GSHUTDOWN ZEND_GSHUTDOWN
380
381 #define PHP_MINIT_FUNCTION ZEND_MODULE_STARTUP_D
382 #define PHP_MSHUTDOWN_FUNCTION ZEND_MODULE_SHUTDOWN_D
383 #define PHP_RINIT_FUNCTION ZEND_MODULE_ACTIVATE_D
384 #define PHP_RSHUTDOWN_FUNCTION ZEND_MODULE_DEACTIVATE_D
385 #define PHP_MINFO_FUNCTION ZEND_MODULE_INFO_D
386 #define PHP_GINIT_FUNCTION ZEND_GINIT_FUNCTION
387 #define PHP_GSHUTDOWN_FUNCTION ZEND_GSHUTDOWN_FUNCTION
388
389 #define PHP_MODULE_GLOBALS ZEND_MODULE_GLOBALS
390
391
392 /* Output support */
393 #include "main/php_output.h"
394
395
396 #include "php_streams.h"
397 #include "php_memory_streams.h"
398 #include "fopen_wrappers.h"
399
400
401 /* Virtual current working directory support */
402 #include "tsrm_virtual_cwd.h"
403
404 #include "zend_constants.h"
405
406 /* connection status states */
407 #define PHP_CONNECTION_NORMAL 0
408 #define PHP_CONNECTION_ABORTED 1
409 #define PHP_CONNECTION_TIMEOUT 2
410
411 #include "php_reentrancy.h"
412
413 /* Finding offsets of elements within structures.
414 * Taken from the Apache code, which in turn, was taken from X code...
415 */
416
417 #ifndef XtOffset
418 #if defined(CRAY) || (defined(__arm) && !(defined(LINUX) || defined(__riscos__)))
419 #ifdef __STDC__
420 #define XtOffset(p_type, field) _Offsetof(p_type, field)
421 #else
422 #ifdef CRAY2
423 #define XtOffset(p_type, field) \
424 (sizeof(int)*((unsigned int)&(((p_type)NULL)->field)))
425
426 #else /* !CRAY2 */
427
428 #define XtOffset(p_type, field) ((unsigned int)&(((p_type)NULL)->field))
429
430 #endif /* !CRAY2 */
431 #endif /* __STDC__ */
432 #else /* ! (CRAY || __arm) */
433
434 #define XtOffset(p_type, field) \
435 ((long) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
436
437 #endif /* !CRAY */
438 #endif /* ! XtOffset */
439
440 #ifndef XtOffsetOf
441 #ifdef offsetof
442 #define XtOffsetOf(s_type, field) offsetof(s_type, field)
443 #else
444 #define XtOffsetOf(s_type, field) XtOffset(s_type*, field)
445 #endif
446 #endif /* !XtOffsetOf */
447
448 #endif
449
450 /*
451 * Local variables:
452 * tab-width: 4
453 * c-basic-offset: 4
454 * End:
455 * vim600: sw=4 ts=4 fdm=marker
456 * vim<600: sw=4 ts=4
457 */
458