php-src/Zend/zend_variables.h

/*
   +----------------------------------------------------------------------+
   | Zend Engine                                                          |
   +----------------------------------------------------------------------+
   | Copyright (c) 1998-2014 Zend Technologies Ltd. (http://www.zend.com) |
   +----------------------------------------------------------------------+
   | This source file is subject to version 2.00 of the Zend 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.zend.com/license/2_00.txt.                                |
   | If you did not receive a copy of the Zend license and are unable to  |
   | obtain it through the world-wide-web, please send a note to          |
   | license@zend.com so we can mail you a copy immediately.              |
   +----------------------------------------------------------------------+
   | Authors: Andi Gutmans <andi@zend.com>                                |
   |          Zeev Suraski <zeev@zend.com>                                |
   +----------------------------------------------------------------------+
*/

/* $Id$ */

#ifndef ZEND_VARIABLES_H
#define ZEND_VARIABLES_H


BEGIN_EXTERN_C()

ZEND_API void _zval_dtor_func(zend_refcounted *p ZEND_FILE_LINE_DC);
ZEND_API void _zval_dtor_func_for_ptr(zend_refcounted *p ZEND_FILE_LINE_DC);

static zend_always_inline void _zval_dtor(zval *zvalue ZEND_FILE_LINE_DC)
{
	if (!Z_REFCOUNTED_P(zvalue)) {
		return;
	}
	_zval_dtor_func(Z_COUNTED_P(zvalue) ZEND_FILE_LINE_RELAY_CC);
}

static zend_always_inline void _zval_ptr_dtor_nogc(zval *zval_ptr ZEND_FILE_LINE_DC)
{
	if (Z_REFCOUNTED_P(zval_ptr) && !Z_DELREF_P(zval_ptr)) {
		_zval_dtor_func_for_ptr(Z_COUNTED_P(zval_ptr) ZEND_FILE_LINE_CC);
	}
}

ZEND_API void _zval_copy_ctor_func(zval *zvalue ZEND_FILE_LINE_DC);

#define zval_copy_ctor_func(zv) _zval_copy_ctor_func(zv ZEND_FILE_LINE_CC)

static zend_always_inline void _zval_copy_ctor(zval *zvalue ZEND_FILE_LINE_DC)
{
	if (Z_REFCOUNTED_P(zvalue) || Z_IMMUTABLE_P(zvalue)) {
		if (Z_COPYABLE_P(zvalue) || Z_IMMUTABLE_P(zvalue)) {
			_zval_copy_ctor_func(zvalue ZEND_FILE_LINE_RELAY_CC);
		} else {
			Z_ADDREF_P(zvalue);
		}
	}
}

static zend_always_inline void _zval_opt_copy_ctor(zval *zvalue ZEND_FILE_LINE_DC)
{
	if (Z_OPT_REFCOUNTED_P(zvalue) || Z_OPT_IMMUTABLE_P(zvalue)) {
		if (Z_OPT_COPYABLE_P(zvalue) || Z_OPT_IMMUTABLE_P(zvalue)) {
			_zval_copy_ctor_func(zvalue ZEND_FILE_LINE_RELAY_CC);
		} else {
			Z_ADDREF_P(zvalue);
		}
	}
}

static zend_always_inline void _zval_copy_ctor_no_imm(zval *zvalue ZEND_FILE_LINE_DC)
{
	if (Z_REFCOUNTED_P(zvalue)) {
		if (Z_COPYABLE_P(zvalue)) {
			_zval_copy_ctor_func(zvalue ZEND_FILE_LINE_RELAY_CC);
		} else {
			Z_ADDREF_P(zvalue);
		}
	}
}

static zend_always_inline void _zval_opt_copy_ctor_no_imm(zval *zvalue ZEND_FILE_LINE_DC)
{
	if (Z_OPT_REFCOUNTED_P(zvalue)) {
		if (Z_OPT_COPYABLE_P(zvalue)) {
			_zval_copy_ctor_func(zvalue ZEND_FILE_LINE_RELAY_CC);
		} else {
			Z_ADDREF_P(zvalue);
		}
	}
}

ZEND_API int zval_copy_static_var(zval *p TSRMLS_DC, int num_args, va_list args, zend_hash_key *key);

ZEND_API int zend_print_variable(zval *var TSRMLS_DC);
ZEND_API void _zval_ptr_dtor(zval *zval_ptr ZEND_FILE_LINE_DC);
ZEND_API void _zval_internal_dtor_for_ptr(zval *zvalue ZEND_FILE_LINE_DC);
ZEND_API void _zval_internal_dtor(zval *zvalue ZEND_FILE_LINE_DC);
ZEND_API void _zval_internal_ptr_dtor(zval *zvalue ZEND_FILE_LINE_DC);
ZEND_API void _zval_dtor_wrapper(zval *zvalue);
#define zval_copy_ctor(zvalue) _zval_copy_ctor((zvalue) ZEND_FILE_LINE_CC)
#define zval_opt_copy_ctor(zvalue) _zval_opt_copy_ctor((zvalue) ZEND_FILE_LINE_CC)
#define zval_copy_ctor_no_imm(zvalue) _zval_copy_ctor_no_imm((zvalue) ZEND_FILE_LINE_CC)
#define zval_opt_copy_ctor_no_imm(zvalue) _zval_opt_copy_ctor_no_imm((zvalue) ZEND_FILE_LINE_CC)
#define zval_dtor(zvalue) _zval_dtor((zvalue) ZEND_FILE_LINE_CC)
#define zval_ptr_dtor(zval_ptr) _zval_ptr_dtor((zval_ptr) ZEND_FILE_LINE_CC)
#define zval_ptr_dtor_nogc(zval_ptr) _zval_ptr_dtor_nogc((zval_ptr) ZEND_FILE_LINE_CC)
#define zval_internal_dtor(zvalue) _zval_internal_dtor((zvalue) ZEND_FILE_LINE_CC)
#define zval_internal_ptr_dtor(zvalue) _zval_internal_ptr_dtor((zvalue) ZEND_FILE_LINE_CC)
#define zval_dtor_wrapper _zval_dtor_wrapper

#if ZEND_DEBUG
ZEND_API void _zval_copy_ctor_wrapper(zval *zvalue);
ZEND_API void _zval_ptr_dtor_wrapper(zval *zval_ptr);
ZEND_API void _zval_internal_dtor_wrapper(zval *zvalue);
ZEND_API void _zval_internal_ptr_dtor_wrapper(zval *zvalue);
#define zval_copy_ctor_wrapper _zval_copy_ctor_wrapper
#define zval_ptr_dtor_wrapper _zval_ptr_dtor_wrapper
#define zval_internal_dtor_wrapper _zval_internal_dtor_wrapper
#define zval_internal_ptr_dtor_wrapper _zval_internal_ptr_dtor_wrapper
#else
#define zval_copy_ctor_wrapper _zval_copy_ctor_func
#define zval_ptr_dtor_wrapper _zval_ptr_dtor
#define zval_internal_dtor_wrapper _zval_internal_dtor
#define zval_internal_ptr_dtor_wrapper _zval_internal_ptr_dtor
#endif

ZEND_API void zval_add_ref(zval *p);
ZEND_API void zval_add_ref_unref(zval *p);

END_EXTERN_C()

#define ZVAL_DESTRUCTOR zval_dtor_wrapper
#define ZVAL_PTR_DTOR zval_ptr_dtor_wrapper
#define ZVAL_INTERNAL_DTOR zval_internal_dtor_wrapper
#define ZVAL_INTERNAL_PTR_DTOR zval_internal_ptr_dtor_wrapper
#define ZVAL_COPY_CTOR zval_copy_ctor_wrapper

#endif

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * indent-tabs-mode: t
 * End:
 */
Zend Library 1999-04-07 18:10:10 +00:00			`/*`
			`+----------------------------------------------------------------------+`
			`\| Zend Engine \|`
			`+----------------------------------------------------------------------+`
Bump year 2014-01-03 03:08:10 +00:00			`\| Copyright (c) 1998-2014 Zend Technologies Ltd. (http://www.zend.com) \|`
Zend Library 1999-04-07 18:10:10 +00:00			`+----------------------------------------------------------------------+`
Update headers. 2001-12-11 15:16:21 +00:00			`\| This source file is subject to version 2.00 of the Zend license, \|`
License update 1999-07-16 14:58:16 +00:00			`\| that is bundled with this package in the file LICENSE, and is \|`
updating license information in the headers. 2003-06-10 20:04:29 +00:00			`\| available through the world-wide-web at the following url: \|`
Update headers. 2001-12-11 15:16:21 +00:00			`\| http://www.zend.com/license/2_00.txt. \|`
License update 1999-07-16 14:58:16 +00:00			`\| If you did not receive a copy of the Zend license and are unable to \|`
			`\| obtain it through the world-wide-web, please send a note to \|`
			`\| license@zend.com so we can mail you a copy immediately. \|`
Zend Library 1999-04-07 18:10:10 +00:00			`+----------------------------------------------------------------------+`
			`\| Authors: Andi Gutmans <andi@zend.com> \|`
- Fix the header (thanks Johannes) 2008-07-20 15:10:24 +00:00			`\| Zeev Suraski <zeev@zend.com> \|`
Zend Library 1999-04-07 18:10:10 +00:00			`+----------------------------------------------------------------------+`
			`*/`

- Added some missing CVS $Id$ tags, headers and footers. 2003-02-01 01:49:15 +00:00			`/* $Id$ */`
License update 1999-07-16 14:58:16 +00:00
Replace macros which begin with an underscore through an appropiately named macro. 2000-07-03 00:55:36 +00:00			`#ifndef ZEND_VARIABLES_H`
			`#define ZEND_VARIABLES_H`
Zend Library 1999-04-07 18:10:10 +00:00

Ok, call me crazy, because I probably am. Thread safe version now uses a C++ scanner object. Works fully. 1999-04-23 03:32:33 +00:00			`BEGIN_EXTERN_C()`
- Apply Thies and Sterling's patch which doesn't call ctor/dtor functions - for types which don't require it (BOOL/NULL/LONG/DOUBLE) - Breaks serialization!!! 2004-09-26 20:03:54 +00:00
Refactored GC (incomplete) 2014-03-19 13:00:28 +00:00			`ZEND_API void _zval_dtor_func(zend_refcounted *p ZEND_FILE_LINE_DC);`
			`ZEND_API void _zval_dtor_func_for_ptr(zend_refcounted *p ZEND_FILE_LINE_DC);`
- Apply Thies and Sterling's patch which doesn't call ctor/dtor functions - for types which don't require it (BOOL/NULL/LONG/DOUBLE) - Breaks serialization!!! 2004-09-26 20:03:54 +00:00
Added a number of small performance tweaks and optimizations . ZEND_RECV now always has IS_CV as its result . ZEND_CATCH now has to be used only with constant class names . ZEND_FETCH_DIM_? may fetch array and dimension operans in a different order 2010-04-20 11:16:39 +00:00			`static zend_always_inline void _zval_dtor(zval *zvalue ZEND_FILE_LINE_DC)`
- Apply Thies and Sterling's patch which doesn't call ctor/dtor functions - for types which don't require it (BOOL/NULL/LONG/DOUBLE) - Breaks serialization!!! 2004-09-26 20:03:54 +00:00			`{`
Use better data structures (incomplete) 2014-02-10 06:04:30 +00:00			`if (!Z_REFCOUNTED_P(zvalue)) {`
- WS fix 2008-07-20 12:47:34 +00:00			`return;`
			`}`
Refactored GC (incomplete) 2014-03-19 13:00:28 +00:00			`_zval_dtor_func(Z_COUNTED_P(zvalue) ZEND_FILE_LINE_RELAY_CC);`
- Apply Thies and Sterling's patch which doesn't call ctor/dtor functions - for types which don't require it (BOOL/NULL/LONG/DOUBLE) - Breaks serialization!!! 2004-09-26 20:03:54 +00:00			`}`

Use zval_ptr_dtor_nogc to destroy literals Also move the definition of zval_ptr_dtor_nogc to zend_variables.h (from zend_execute.h/.c) as it's used in a few places. 2014-09-03 13:16:32 +00:00			`static zend_always_inline void _zval_ptr_dtor_nogc(zval *zval_ptr ZEND_FILE_LINE_DC)`
			`{`
			`if (Z_REFCOUNTED_P(zval_ptr) && !Z_DELREF_P(zval_ptr)) {`
			`_zval_dtor_func_for_ptr(Z_COUNTED_P(zval_ptr) ZEND_FILE_LINE_CC);`
			`}`
			`}`

- Make zval_copy_ctor() return void like dtor(). No one ever checks the - return value which is SUCCESS always. 2004-09-27 02:29:01 +00:00			`ZEND_API void _zval_copy_ctor_func(zval *zvalue ZEND_FILE_LINE_DC);`
- Apply Thies and Sterling's patch which doesn't call ctor/dtor functions - for types which don't require it (BOOL/NULL/LONG/DOUBLE) - Breaks serialization!!! 2004-09-26 20:03:54 +00:00
Refactored ZVAL flags usage to simplify various checks (e.g. Z_REFCOUNTED(), candidate for GC, etc) 2014-04-03 11:26:23 +00:00			`#define zval_copy_ctor_func(zv) _zval_copy_ctor_func(zv ZEND_FILE_LINE_CC)`

Added a number of small performance tweaks and optimizations . ZEND_RECV now always has IS_CV as its result . ZEND_CATCH now has to be used only with constant class names . ZEND_FETCH_DIM_? may fetch array and dimension operans in a different order 2010-04-20 11:16:39 +00:00			`static zend_always_inline void _zval_copy_ctor(zval *zvalue ZEND_FILE_LINE_DC)`
- Apply Thies and Sterling's patch which doesn't call ctor/dtor functions - for types which don't require it (BOOL/NULL/LONG/DOUBLE) - Breaks serialization!!! 2004-09-26 20:03:54 +00:00			`{`
Introduced immutable arrays. They don't need to be copyed and may be used directly from SHM. 2014-05-29 14:21:56 +00:00			`if (Z_REFCOUNTED_P(zvalue) \|\| Z_IMMUTABLE_P(zvalue)) {`
			`if (Z_COPYABLE_P(zvalue) \|\| Z_IMMUTABLE_P(zvalue)) {`
Various VM optimizations 2014-04-03 22:52:53 +00:00			`_zval_copy_ctor_func(zvalue ZEND_FILE_LINE_RELAY_CC);`
			`} else {`
			`Z_ADDREF_P(zvalue);`
			`}`
			`}`
			`}`

			`static zend_always_inline void _zval_opt_copy_ctor(zval *zvalue ZEND_FILE_LINE_DC)`
			`{`
Introduced immutable arrays. They don't need to be copyed and may be used directly from SHM. 2014-05-29 14:21:56 +00:00			`if (Z_OPT_REFCOUNTED_P(zvalue) \|\| Z_OPT_IMMUTABLE_P(zvalue)) {`
			`if (Z_OPT_COPYABLE_P(zvalue) \|\| Z_OPT_IMMUTABLE_P(zvalue)) {`
Refactored ZVAL flags usage to simplify various checks (e.g. Z_REFCOUNTED(), candidate for GC, etc) 2014-04-03 11:26:23 +00:00			`_zval_copy_ctor_func(zvalue ZEND_FILE_LINE_RELAY_CC);`
			`} else {`
			`Z_ADDREF_P(zvalue);`
			`}`
- WS fix 2008-07-20 12:47:34 +00:00			`}`
- Apply Thies and Sterling's patch which doesn't call ctor/dtor functions - for types which don't require it (BOOL/NULL/LONG/DOUBLE) - Breaks serialization!!! 2004-09-26 20:03:54 +00:00			`}`

Optimized conditions order 2014-06-02 23:54:03 +00:00			`static zend_always_inline void _zval_copy_ctor_no_imm(zval *zvalue ZEND_FILE_LINE_DC)`
			`{`
			`if (Z_REFCOUNTED_P(zvalue)) {`
			`if (Z_COPYABLE_P(zvalue)) {`
			`_zval_copy_ctor_func(zvalue ZEND_FILE_LINE_RELAY_CC);`
			`} else {`
			`Z_ADDREF_P(zvalue);`
			`}`
			`}`
			`}`

			`static zend_always_inline void _zval_opt_copy_ctor_no_imm(zval *zvalue ZEND_FILE_LINE_DC)`
			`{`
			`if (Z_OPT_REFCOUNTED_P(zvalue)) {`
			`if (Z_OPT_COPYABLE_P(zvalue)) {`
			`_zval_copy_ctor_func(zvalue ZEND_FILE_LINE_RELAY_CC);`
			`} else {`
			`Z_ADDREF_P(zvalue);`
			`}`
			`}`
			`}`

Use better data structures (incomplete) 2014-02-10 06:04:30 +00:00			`ZEND_API int zval_copy_static_var(zval p TSRMLS_DC, int num_args, va_list args, zend_hash_key key);`
- Apply Thies and Sterling's patch which doesn't call ctor/dtor functions - for types which don't require it (BOOL/NULL/LONG/DOUBLE) - Breaks serialization!!! 2004-09-26 20:03:54 +00:00
Use zval_get_string in print_zval and propagate TSRMLS 2014-04-21 15:12:10 +00:00			`ZEND_API int zend_print_variable(zval *var TSRMLS_DC);`
Use better data structures (incomplete) 2014-02-10 06:04:30 +00:00			`ZEND_API void _zval_ptr_dtor(zval *zval_ptr ZEND_FILE_LINE_DC);`
Use better data structures (incomplete) 2014-02-17 13:59:18 +00:00			`ZEND_API void _zval_internal_dtor_for_ptr(zval *zvalue ZEND_FILE_LINE_DC);`
- Provide appropriate way to destroy internal zval's. - Allow internal zval's of type string and disallow complex types. - Define the default string for extensions at class level instead of ctor. 2003-08-24 17:32:47 +00:00			`ZEND_API void _zval_internal_dtor(zval *zvalue ZEND_FILE_LINE_DC);`
Use better data structures (incomplete) 2014-02-10 06:04:30 +00:00			`ZEND_API void _zval_internal_ptr_dtor(zval *zvalue ZEND_FILE_LINE_DC);`
Fixed bug #50519 (segfault in garbage collection when using set_error_handler and DomDocument) 2010-01-11 10:07:10 +00:00			`ZEND_API void _zval_dtor_wrapper(zval *zvalue);`
Better debug macros 1999-08-27 19:17:19 +00:00			`#define zval_copy_ctor(zvalue) _zval_copy_ctor((zvalue) ZEND_FILE_LINE_CC)`
Various VM optimizations 2014-04-03 22:52:53 +00:00			`#define zval_opt_copy_ctor(zvalue) _zval_opt_copy_ctor((zvalue) ZEND_FILE_LINE_CC)`
Optimized conditions order 2014-06-02 23:54:03 +00:00			`#define zval_copy_ctor_no_imm(zvalue) _zval_copy_ctor_no_imm((zvalue) ZEND_FILE_LINE_CC)`
			`#define zval_opt_copy_ctor_no_imm(zvalue) _zval_opt_copy_ctor_no_imm((zvalue) ZEND_FILE_LINE_CC)`
Better debug macros 1999-08-27 19:17:19 +00:00			`#define zval_dtor(zvalue) _zval_dtor((zvalue) ZEND_FILE_LINE_CC)`
			`#define zval_ptr_dtor(zval_ptr) _zval_ptr_dtor((zval_ptr) ZEND_FILE_LINE_CC)`
Use zval_ptr_dtor_nogc to destroy literals Also move the definition of zval_ptr_dtor_nogc to zend_variables.h (from zend_execute.h/.c) as it's used in a few places. 2014-09-03 13:16:32 +00:00			`#define zval_ptr_dtor_nogc(zval_ptr) _zval_ptr_dtor_nogc((zval_ptr) ZEND_FILE_LINE_CC)`
- Provide appropriate way to destroy internal zval's. - Allow internal zval's of type string and disallow complex types. - Define the default string for extensions at class level instead of ctor. 2003-08-24 17:32:47 +00:00			`#define zval_internal_dtor(zvalue) _zval_internal_dtor((zvalue) ZEND_FILE_LINE_CC)`
			`#define zval_internal_ptr_dtor(zvalue) _zval_internal_ptr_dtor((zvalue) ZEND_FILE_LINE_CC)`
Fixed bug #50519 (segfault in garbage collection when using set_error_handler and DomDocument) 2010-01-11 10:07:10 +00:00			`#define zval_dtor_wrapper _zval_dtor_wrapper`
Better debug macros 1999-08-27 19:17:19 +00:00
* empty log message * 1999-08-28 21:43:24 +00:00			`#if ZEND_DEBUG`
- Use zval_ctor_func() for wrapper and update the prototype to void 2004-09-27 07:04:36 +00:00			`ZEND_API void _zval_copy_ctor_wrapper(zval *zvalue);`
Use better data structures (incomplete) 2014-02-10 06:04:30 +00:00			`ZEND_API void _zval_ptr_dtor_wrapper(zval *zval_ptr);`
- Provide appropriate way to destroy internal zval's. - Allow internal zval's of type string and disallow complex types. - Define the default string for extensions at class level instead of ctor. 2003-08-24 17:32:47 +00:00			`ZEND_API void _zval_internal_dtor_wrapper(zval *zvalue);`
Use better data structures (incomplete) 2014-02-10 06:04:30 +00:00			`ZEND_API void _zval_internal_ptr_dtor_wrapper(zval *zvalue);`
Better debug macros 1999-08-27 19:17:19 +00:00			`#define zval_copy_ctor_wrapper _zval_copy_ctor_wrapper`
			`#define zval_ptr_dtor_wrapper _zval_ptr_dtor_wrapper`
- Provide appropriate way to destroy internal zval's. - Allow internal zval's of type string and disallow complex types. - Define the default string for extensions at class level instead of ctor. 2003-08-24 17:32:47 +00:00			`#define zval_internal_dtor_wrapper _zval_internal_dtor_wrapper`
			`#define zval_internal_ptr_dtor_wrapper _zval_internal_ptr_dtor_wrapper`
Better debug macros 1999-08-27 19:17:19 +00:00			`#else`
- Use zval_ctor_func() for wrapper and update the prototype to void 2004-09-27 07:04:36 +00:00			`#define zval_copy_ctor_wrapper _zval_copy_ctor_func`
Better debug macros 1999-08-27 19:17:19 +00:00			`#define zval_ptr_dtor_wrapper _zval_ptr_dtor`
- Provide appropriate way to destroy internal zval's. - Allow internal zval's of type string and disallow complex types. - Define the default string for extensions at class level instead of ctor. 2003-08-24 17:32:47 +00:00			`#define zval_internal_dtor_wrapper _zval_internal_dtor`
			`#define zval_internal_ptr_dtor_wrapper _zval_internal_ptr_dtor`
Better debug macros 1999-08-27 19:17:19 +00:00			`#endif`

Use better data structures (incomplete) 2014-02-10 06:04:30 +00:00			`ZEND_API void zval_add_ref(zval *p);`
Converting from reference to regular value 2014-02-28 07:03:05 +00:00			`ZEND_API void zval_add_ref_unref(zval *p);`
Zend Library 1999-04-07 18:10:10 +00:00
more EXTERN_C wrapping of ZEND_API prototypes 2004-02-20 08:03:27 +00:00			`END_EXTERN_C()`

Use better data structures (incomplete) 2014-02-10 06:04:30 +00:00			`#define ZVAL_DESTRUCTOR zval_dtor_wrapper`
			`#define ZVAL_PTR_DTOR zval_ptr_dtor_wrapper`
			`#define ZVAL_INTERNAL_DTOR zval_internal_dtor_wrapper`
			`#define ZVAL_INTERNAL_PTR_DTOR zval_internal_ptr_dtor_wrapper`
			`#define ZVAL_COPY_CTOR zval_copy_ctor_wrapper`
Zend Library 1999-04-07 18:10:10 +00:00
			`#endif`
- Added some missing CVS $Id$ tags, headers and footers. 2003-02-01 01:49:15 +00:00
			`/*`
			`* Local variables:`
			`* tab-width: 4`
			`* c-basic-offset: 4`
			`* indent-tabs-mode: t`
			`* End:`
			`*/`