php-src/Zend/zend_objects_API.c

/*
   +----------------------------------------------------------------------+
   | 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$ */

#include "zend.h"
#include "zend_globals.h"
#include "zend_variables.h"
#include "zend_API.h"
#include "zend_objects_API.h"	

ZEND_API void zend_objects_store_init(zend_objects_store *objects, zend_uint init_size)
{
	objects->object_buckets = (zend_object **) emalloc(init_size * sizeof(zend_object*));
	objects->top = 1; /* Skip 0 so that handles are true */
	objects->size = init_size;
	objects->free_list_head = -1;
	memset(&objects->object_buckets[0], 0, sizeof(zend_object*));
}

ZEND_API void zend_objects_store_destroy(zend_objects_store *objects)
{
	efree(objects->object_buckets);
	objects->object_buckets = NULL;
}

ZEND_API void zend_objects_store_call_destructors(zend_objects_store *objects TSRMLS_DC)
{
	zend_uint i = 1;

	for (i = 1; i < objects->top ; i++) {
		zend_object *obj = objects->object_buckets[i];

		if (IS_VALID(obj)) {
			if (!(obj->gc.u.v.flags & IS_OBJ_DESTRUCTOR_CALLED)) {
				obj->gc.u.v.flags |= IS_OBJ_DESTRUCTOR_CALLED;
				obj->gc.refcount++;
				obj->handlers->dtor_obj(obj TSRMLS_CC);
				obj->gc.refcount--;
			}
		}
	}
}

ZEND_API void zend_objects_store_mark_destructed(zend_objects_store *objects TSRMLS_DC)
{
	zend_uint i;

	if (!objects->object_buckets) {
		return;
	}
	for (i = 1; i < objects->top ; i++) {
		zend_object *obj = objects->object_buckets[i];

		if (IS_VALID(obj)) {
			obj->gc.u.v.flags |= IS_OBJ_DESTRUCTOR_CALLED;
		}
	}
}

ZEND_API void zend_objects_store_free_object_storage(zend_objects_store *objects TSRMLS_DC)
{
	zend_uint i = 1;

	for (i = 1; i < objects->top ; i++) {
		zend_object *obj = objects->object_buckets[i];

		if (IS_VALID(obj)) {
			objects->object_buckets[i] = SET_INVALID(obj);
			if (obj->handlers->free_obj) {
				obj->handlers->free_obj(obj TSRMLS_CC);
			}
			/* Not adding to free list as we are shutting down anyway */
		}
	}
}


/* Store objects API */

ZEND_API void zend_objects_store_put(zend_object *object TSRMLS_DC)
{
	int handle;

	if (EG(objects_store).free_list_head != -1) {
		handle = EG(objects_store).free_list_head;
		EG(objects_store).free_list_head = GET_BUCKET_NUMBER(EG(objects_store).object_buckets[handle]);
	} else {
		if (EG(objects_store).top == EG(objects_store).size) {
			EG(objects_store).size <<= 1;
			EG(objects_store).object_buckets = (zend_object **) erealloc(EG(objects_store).object_buckets, EG(objects_store).size * sizeof(zend_object*));
		}
		handle = EG(objects_store).top++;
	}
	object->handle = handle;
	EG(objects_store).object_buckets[handle] = object;
}

#define ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle)															\
            SET_BUCKET_NUMBER(EG(objects_store).object_buckets[handle], EG(objects_store).free_list_head);	\
			EG(objects_store).free_list_head = handle;

ZEND_API void zend_objects_store_free(zend_object *object TSRMLS_DC) /* {{{ */
{
	int handle = object->handle;

	if (object->handlers->free_obj) {
		object->handlers->free_obj(object TSRMLS_CC);
	}
	ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle);
}
/* }}} */

ZEND_API void zend_objects_store_del(zend_object *object TSRMLS_DC) /* {{{ */
{
	/*	Make sure we hold a reference count during the destructor call
		otherwise, when the destructor ends the storage might be freed
		when the refcount reaches 0 a second time
	 */
	if (EG(objects_store).object_buckets &&
	    IS_VALID(EG(objects_store).object_buckets[object->handle])) {
		if (object->gc.refcount == 0) {
			int failure = 0;

			if (!(object->gc.u.v.flags & IS_OBJ_DESTRUCTOR_CALLED)) {
				object->gc.u.v.flags |= IS_OBJ_DESTRUCTOR_CALLED;

				if (object->handlers->dtor_obj) {
					object->gc.refcount++;
					zend_try {
						object->handlers->dtor_obj(object TSRMLS_CC);
					} zend_catch {
						failure = 1;
					} zend_end_try();
					object->gc.refcount--;
				}
			}
			
			if (object->gc.refcount == 0) {
				zend_uint handle = object->handle;

				if (object->handlers->free_obj) {
					zend_try {
						object->handlers->free_obj(object TSRMLS_CC);
					} zend_catch {
						failure = 1;
					} zend_end_try();
				}
				ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle);
			}
			
			if (failure) {
				zend_bailout();
			}
		} else {
			object->gc.refcount--;
		}
	}
}
/* }}} */

//???
#if 0
ZEND_API zend_object *zend_objects_store_clone_obj(zval *zobject TSRMLS_DC)
{
	zend_object *obj, *new_object;
//???	struct _store_object *obj;
//???	zend_object_handle handle = Z_OBJ_HANDLE_P(zobject);

//???	obj = &EG(objects_store).object_buckets[handle].bucket.obj;

//???	if (obj->clone == NULL) {
//???		zend_error(E_CORE_ERROR, "Trying to clone uncloneable object of class %s", Z_OBJCE_P(zobject)->name);
//???	}

    obj = Z_OBJ_P(zobject);
	new_object = obj->handlers->clone_obj(obj TSRMLS_CC);
	obj = &EG(objects_store).object_buckets[handle].bucket.obj;

	retval.handle = zend_objects_store_put(new_object, obj->dtor, obj->free_storage, obj->clone TSRMLS_CC);
	retval.handlers = Z_OBJ_HT_P(zobject);
	EG(objects_store).object_buckets[handle].bucket.obj.handlers = retval.handlers;

	return retval;
}
#endif

/* zend_object_store_set_object:
 * It is ONLY valid to call this function from within the constructor of an
 * overloaded object.  Its purpose is to set the object pointer for the object
 * when you can't possibly know its value until you have parsed the arguments
 * from the constructor function.  You MUST NOT use this function for any other
 * weird games, or call it at any other time after the object is constructed.
 * */
ZEND_API void zend_object_store_set_object(zval *zobject, zend_object *object TSRMLS_DC)
{
	EG(objects_store).object_buckets[Z_OBJ_HANDLE_P(zobject)] = object;
}

/* Called when the ctor was terminated by an exception */
ZEND_API void zend_object_store_ctor_failed(zval *zobject TSRMLS_DC)
{
	zend_object *obj = Z_OBJ_P(zobject);

	obj->gc.u.v.flags |= IS_OBJ_DESTRUCTOR_CALLED;
}

/* Proxy objects workings */
typedef struct _zend_proxy_object {
	zend_object std;
	zval object;
	zval property;
} zend_proxy_object;

static zend_object_handlers zend_object_proxy_handlers;

ZEND_API void zend_objects_proxy_destroy(zend_object *object TSRMLS_DC)
{
}

ZEND_API void zend_objects_proxy_free_storage(zend_proxy_object *object TSRMLS_DC)
{
	zval_ptr_dtor(&object->object);
	zval_ptr_dtor(&object->property);
	efree(object);
}

ZEND_API void zend_objects_proxy_clone(zend_proxy_object *object, zend_proxy_object **object_clone TSRMLS_DC)
{
	*object_clone = emalloc(sizeof(zend_proxy_object));
	(*object_clone)->object = object->object;
	(*object_clone)->property = object->property;
	Z_ADDREF_P(&(*object_clone)->property);
	Z_ADDREF_P(&(*object_clone)->object);
}

ZEND_API zend_object *zend_object_create_proxy(zval *object, zval *member TSRMLS_DC)
{
	zend_proxy_object *obj = emalloc(sizeof(zend_proxy_object));

	obj->std.gc.refcount = 1;
	obj->std.gc.u.v.type = IS_OBJECT;
	obj->std.gc.u.v.gc_info = 0;
	obj->std.ce = NULL;
	obj->std.properties = NULL;
	obj->std.guards = NULL;
	obj->std.handlers = &zend_object_proxy_handlers;
	
	ZVAL_COPY(&obj->object, object);
	ZVAL_DUP(&obj->property, member);

	return (zend_object*)obj;
}

ZEND_API void zend_object_proxy_set(zval *property, zval *value TSRMLS_DC)
{
	zend_proxy_object *probj = (zend_proxy_object*)Z_OBJ_P(property);

	if (Z_OBJ_HT(probj->object) && Z_OBJ_HT(probj->object)->write_property) {
		Z_OBJ_HT(probj->object)->write_property(&probj->object, &probj->property, value, 0 TSRMLS_CC);
	} else {
		zend_error(E_WARNING, "Cannot write property of object - no write handler defined");
	}
}

ZEND_API zval* zend_object_proxy_get(zval *property TSRMLS_DC)
{
	zend_proxy_object *probj = (zend_proxy_object*)Z_OBJ_P(property);

	if (Z_OBJ_HT(probj->object) && Z_OBJ_HT(probj->object)->read_property) {
		return Z_OBJ_HT(probj->object)->read_property(&probj->object, &probj->property, BP_VAR_R, 0, NULL TSRMLS_CC);
	} else {
		zend_error(E_WARNING, "Cannot read property of object - no read handler defined");
	}

	return NULL;
}

ZEND_API zend_object_handlers *zend_get_std_object_handlers(void)
{
	return &std_object_handlers;
}

static zend_object_handlers zend_object_proxy_handlers = {
	ZEND_OBJECTS_STORE_HANDLERS,

	NULL,						/* read_property */
	NULL,						/* write_property */
	NULL,						/* read dimension */
	NULL,						/* write_dimension */
	NULL,						/* get_property_ptr_ptr */
	zend_object_proxy_get,		/* get */
	zend_object_proxy_set,		/* set */
	NULL,						/* has_property */
	NULL,						/* unset_property */
	NULL,						/* has_dimension */
	NULL,						/* unset_dimension */
	NULL,						/* get_properties */
	NULL,						/* get_method */
	NULL,						/* call_method */
	NULL,						/* get_constructor */
	NULL,						/* get_class_entry */
	NULL,						/* get_class_name */
	NULL,						/* compare_objects */
	NULL,						/* cast_object */
	NULL,						/* count_elements */
};


/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * indent-tabs-mode: t
 * End:
 */