1/*
2   +----------------------------------------------------------------------+
3   | Zend Engine                                                          |
4   +----------------------------------------------------------------------+
5   | Copyright (c) 1998-2014 Zend Technologies Ltd. (http://www.zend.com) |
6   +----------------------------------------------------------------------+
7   | This source file is subject to version 2.00 of the Zend 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.zend.com/license/2_00.txt.                                |
11   | If you did not receive a copy of the Zend license and are unable to  |
12   | obtain it through the world-wide-web, please send a note to          |
13   | license@zend.com 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#include "zend.h"
23#include "zend_globals.h"
24#include "zend_variables.h"
25#include "zend_API.h"
26#include "zend_objects_API.h"
27
28ZEND_API void zend_objects_store_init(zend_objects_store *objects, uint32_t init_size)
29{
30    objects->object_buckets = (zend_object **) emalloc(init_size * sizeof(zend_object*));
31    objects->top = 1; /* Skip 0 so that handles are true */
32    objects->size = init_size;
33    objects->free_list_head = -1;
34    memset(&objects->object_buckets[0], 0, sizeof(zend_object*));
35}
36
37ZEND_API void zend_objects_store_destroy(zend_objects_store *objects)
38{
39    efree(objects->object_buckets);
40    objects->object_buckets = NULL;
41}
42
43ZEND_API void zend_objects_store_call_destructors(zend_objects_store *objects TSRMLS_DC)
44{
45    uint32_t i;
46
47    for (i = 1; i < objects->top ; i++) {
48        zend_object *obj = objects->object_buckets[i];
49
50        if (IS_OBJ_VALID(obj)) {
51            if (!(GC_FLAGS(obj) & IS_OBJ_DESTRUCTOR_CALLED)) {
52                GC_FLAGS(obj) |= IS_OBJ_DESTRUCTOR_CALLED;
53                GC_REFCOUNT(obj)++;
54                obj->handlers->dtor_obj(obj TSRMLS_CC);
55                GC_REFCOUNT(obj)--;
56            }
57        }
58    }
59}
60
61ZEND_API void zend_objects_store_mark_destructed(zend_objects_store *objects TSRMLS_DC)
62{
63    uint32_t i;
64
65    if (!objects->object_buckets) {
66        return;
67    }
68    for (i = 1; i < objects->top ; i++) {
69        zend_object *obj = objects->object_buckets[i];
70
71        if (IS_OBJ_VALID(obj)) {
72            GC_FLAGS(obj) |= IS_OBJ_DESTRUCTOR_CALLED;
73        }
74    }
75}
76
77ZEND_API void zend_objects_store_free_object_storage(zend_objects_store *objects TSRMLS_DC)
78{
79    uint32_t i;
80
81    /* Free object properties but don't free object their selves */
82    for (i = objects->top - 1; i > 0 ; i--) {
83        zend_object *obj = objects->object_buckets[i];
84
85        if (IS_OBJ_VALID(obj)) {
86            if (!(GC_FLAGS(obj) & IS_OBJ_FREE_CALLED)) {
87                GC_FLAGS(obj) |= IS_OBJ_FREE_CALLED;
88                if (obj->handlers->free_obj) {
89                    GC_REFCOUNT(obj)++;
90                    obj->handlers->free_obj(obj TSRMLS_CC);
91                    GC_REFCOUNT(obj)--;
92                }
93            }
94        }
95    }
96
97    /* Now free objects theirselves */
98    for (i = 1; i < objects->top ; i++) {
99        zend_object *obj = objects->object_buckets[i];
100
101        if (IS_OBJ_VALID(obj)) {
102            /* Not adding to free list as we are shutting down anyway */
103            void *ptr = ((char*)obj) - obj->handlers->offset;
104            GC_REMOVE_FROM_BUFFER(obj);
105            efree(ptr);
106        }
107    }
108}
109
110
111/* Store objects API */
112
113ZEND_API void zend_objects_store_put(zend_object *object TSRMLS_DC)
114{
115    int handle;
116
117    if (EG(objects_store).free_list_head != -1) {
118        handle = EG(objects_store).free_list_head;
119        EG(objects_store).free_list_head = GET_OBJ_BUCKET_NUMBER(EG(objects_store).object_buckets[handle]);
120    } else {
121        if (EG(objects_store).top == EG(objects_store).size) {
122            EG(objects_store).size <<= 1;
123            EG(objects_store).object_buckets = (zend_object **) erealloc(EG(objects_store).object_buckets, EG(objects_store).size * sizeof(zend_object*));
124        }
125        handle = EG(objects_store).top++;
126    }
127    object->handle = handle;
128    EG(objects_store).object_buckets[handle] = object;
129}
130
131#define ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle)                                                         \
132            SET_OBJ_BUCKET_NUMBER(EG(objects_store).object_buckets[handle], EG(objects_store).free_list_head);  \
133            EG(objects_store).free_list_head = handle;
134
135ZEND_API void zend_objects_store_free(zend_object *object TSRMLS_DC) /* {{{ */
136{
137    uint32_t handle = object->handle;
138    void *ptr = ((char*)object) - object->handlers->offset;
139
140    GC_REMOVE_FROM_BUFFER(object);
141    efree(ptr);
142    ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle);
143}
144/* }}} */
145
146ZEND_API void zend_objects_store_del(zend_object *object TSRMLS_DC) /* {{{ */
147{
148    /*  Make sure we hold a reference count during the destructor call
149        otherwise, when the destructor ends the storage might be freed
150        when the refcount reaches 0 a second time
151     */
152    if (EG(objects_store).object_buckets &&
153        IS_OBJ_VALID(EG(objects_store).object_buckets[object->handle])) {
154        if (GC_REFCOUNT(object) == 0) {
155            int failure = 0;
156
157            if (!(GC_FLAGS(object) & IS_OBJ_DESTRUCTOR_CALLED)) {
158                GC_FLAGS(object) |= IS_OBJ_DESTRUCTOR_CALLED;
159
160                if (object->handlers->dtor_obj) {
161                    GC_REFCOUNT(object)++;
162                    zend_try {
163                        object->handlers->dtor_obj(object TSRMLS_CC);
164                    } zend_catch {
165                        failure = 1;
166                    } zend_end_try();
167                    GC_REFCOUNT(object)--;
168                }
169            }
170
171            if (GC_REFCOUNT(object) == 0) {
172                uint32_t handle = object->handle;
173                void *ptr;
174
175                EG(objects_store).object_buckets[handle] = SET_OBJ_INVALID(object);
176                if (!(GC_FLAGS(object) & IS_OBJ_FREE_CALLED)) {
177                    GC_FLAGS(object) |= IS_OBJ_FREE_CALLED;
178                    if (object->handlers->free_obj) {
179                        zend_try {
180                            GC_REFCOUNT(object)++;
181                            object->handlers->free_obj(object TSRMLS_CC);
182                            GC_REFCOUNT(object)--;
183                        } zend_catch {
184                            failure = 1;
185                        } zend_end_try();
186                    }
187                }
188                ptr = ((char*)object) - object->handlers->offset;
189                GC_REMOVE_FROM_BUFFER(object);
190                efree(ptr);
191                ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle);
192            }
193
194            if (failure) {
195                zend_bailout();
196            }
197        } else {
198            GC_REFCOUNT(object)--;
199        }
200    }
201}
202/* }}} */
203
204/* zend_object_store_set_object:
205 * It is ONLY valid to call this function from within the constructor of an
206 * overloaded object.  Its purpose is to set the object pointer for the object
207 * when you can't possibly know its value until you have parsed the arguments
208 * from the constructor function.  You MUST NOT use this function for any other
209 * weird games, or call it at any other time after the object is constructed.
210 * */
211ZEND_API void zend_object_store_set_object(zval *zobject, zend_object *object TSRMLS_DC)
212{
213    EG(objects_store).object_buckets[Z_OBJ_HANDLE_P(zobject)] = object;
214}
215
216/* Called when the ctor was terminated by an exception */
217ZEND_API void zend_object_store_ctor_failed(zend_object *obj TSRMLS_DC)
218{
219    GC_FLAGS(obj) |= IS_OBJ_DESTRUCTOR_CALLED;
220}
221
222/* Proxy objects workings */
223typedef struct _zend_proxy_object {
224    zend_object std;
225    zval object;
226    zval property;
227} zend_proxy_object;
228
229static zend_object_handlers zend_object_proxy_handlers;
230
231ZEND_API void zend_objects_proxy_destroy(zend_object *object TSRMLS_DC)
232{
233}
234
235ZEND_API void zend_objects_proxy_free_storage(zend_proxy_object *object TSRMLS_DC)
236{
237    zval_ptr_dtor(&object->object);
238    zval_ptr_dtor(&object->property);
239    efree(object);
240}
241
242ZEND_API void zend_objects_proxy_clone(zend_proxy_object *object, zend_proxy_object **object_clone TSRMLS_DC)
243{
244    *object_clone = emalloc(sizeof(zend_proxy_object));
245    (*object_clone)->object = object->object;
246    (*object_clone)->property = object->property;
247    Z_ADDREF_P(&(*object_clone)->property);
248    Z_ADDREF_P(&(*object_clone)->object);
249}
250
251ZEND_API zend_object *zend_object_create_proxy(zval *object, zval *member TSRMLS_DC)
252{
253    zend_proxy_object *obj = emalloc(sizeof(zend_proxy_object));
254
255    GC_REFCOUNT(obj) = 1;
256    GC_TYPE_INFO(obj) = IS_OBJECT;
257    obj->std.ce = NULL;
258    obj->std.properties = NULL;
259    obj->std.guards = NULL;
260    obj->std.handlers = &zend_object_proxy_handlers;
261
262    ZVAL_COPY(&obj->object, object);
263    ZVAL_DUP(&obj->property, member);
264
265    return (zend_object*)obj;
266}
267
268ZEND_API void zend_object_proxy_set(zval *property, zval *value TSRMLS_DC)
269{
270    zend_proxy_object *probj = (zend_proxy_object*)Z_OBJ_P(property);
271
272    if (Z_OBJ_HT(probj->object) && Z_OBJ_HT(probj->object)->write_property) {
273        Z_OBJ_HT(probj->object)->write_property(&probj->object, &probj->property, value, NULL TSRMLS_CC);
274    } else {
275        zend_error(E_WARNING, "Cannot write property of object - no write handler defined");
276    }
277}
278
279ZEND_API zval* zend_object_proxy_get(zval *property, zval *rv TSRMLS_DC)
280{
281    zend_proxy_object *probj = (zend_proxy_object*)Z_OBJ_P(property);
282
283    if (Z_OBJ_HT(probj->object) && Z_OBJ_HT(probj->object)->read_property) {
284        return Z_OBJ_HT(probj->object)->read_property(&probj->object, &probj->property, BP_VAR_R, NULL, rv TSRMLS_CC);
285    } else {
286        zend_error(E_WARNING, "Cannot read property of object - no read handler defined");
287    }
288
289    return NULL;
290}
291
292ZEND_API zend_object_handlers *zend_get_std_object_handlers(void)
293{
294    return &std_object_handlers;
295}
296
297static zend_object_handlers zend_object_proxy_handlers = {
298    ZEND_OBJECTS_STORE_HANDLERS,
299
300    NULL,                       /* read_property */
301    NULL,                       /* write_property */
302    NULL,                       /* read dimension */
303    NULL,                       /* write_dimension */
304    NULL,                       /* get_property_ptr_ptr */
305    zend_object_proxy_get,      /* get */
306    zend_object_proxy_set,      /* set */
307    NULL,                       /* has_property */
308    NULL,                       /* unset_property */
309    NULL,                       /* has_dimension */
310    NULL,                       /* unset_dimension */
311    NULL,                       /* get_properties */
312    NULL,                       /* get_method */
313    NULL,                       /* call_method */
314    NULL,                       /* get_constructor */
315    NULL,                       /* get_class_entry */
316    NULL,                       /* get_class_name */
317    NULL,                       /* compare_objects */
318    NULL,                       /* cast_object */
319    NULL,                       /* count_elements */
320};
321
322
323/*
324 * Local variables:
325 * tab-width: 4
326 * c-basic-offset: 4
327 * indent-tabs-mode: t
328 * End:
329 */
330