1/*
2   +----------------------------------------------------------------------+
3   | Zend Engine                                                          |
4   +----------------------------------------------------------------------+
5   | Copyright (c) 1998-2015 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)
44{
45    if (objects->top > 1) {
46        zend_object **obj_ptr = objects->object_buckets + 1;
47        zend_object **end = objects->object_buckets + objects->top;
48
49        do {
50            zend_object *obj = *obj_ptr;
51
52            if (IS_OBJ_VALID(obj)) {
53                if (!(GC_FLAGS(obj) & IS_OBJ_DESTRUCTOR_CALLED)) {
54                    GC_FLAGS(obj) |= IS_OBJ_DESTRUCTOR_CALLED;
55                    GC_REFCOUNT(obj)++;
56                    obj->handlers->dtor_obj(obj);
57                    GC_REFCOUNT(obj)--;
58                }
59            }
60            obj_ptr++;
61        } while (obj_ptr != end);
62    }
63}
64
65ZEND_API void zend_objects_store_mark_destructed(zend_objects_store *objects)
66{
67    if (objects->object_buckets && objects->top > 1) {
68        zend_object **obj_ptr = objects->object_buckets + 1;
69        zend_object **end = objects->object_buckets + objects->top;
70
71        do {
72            zend_object *obj = *obj_ptr;
73
74            if (IS_OBJ_VALID(obj)) {
75                GC_FLAGS(obj) |= IS_OBJ_DESTRUCTOR_CALLED;
76            }
77            obj_ptr++;
78        } while (obj_ptr != end);
79    }
80}
81
82ZEND_API void zend_objects_store_free_object_storage(zend_objects_store *objects)
83{
84    zend_object **obj_ptr, **end, *obj;
85
86    if (objects->top <= 1) {
87        return;
88    }
89
90    /* Free object contents, but don't free objects themselves */
91    end = objects->object_buckets + 1;
92    obj_ptr = objects->object_buckets + objects->top;
93
94    do {
95        obj_ptr--;
96        obj = *obj_ptr;
97        if (IS_OBJ_VALID(obj)) {
98            if (!(GC_FLAGS(obj) & IS_OBJ_FREE_CALLED)) {
99                GC_FLAGS(obj) |= IS_OBJ_FREE_CALLED;
100                if (obj->handlers->free_obj) {
101                    GC_REFCOUNT(obj)++;
102                    obj->handlers->free_obj(obj);
103                    GC_REFCOUNT(obj)--;
104                }
105            }
106        }
107    } while (obj_ptr != end);
108
109    /* Free objects themselves if they now have a refcount of 0, which means that
110     * they were previously part of a cycle. Everything else will report as a leak.
111     * Cycles are allowed because not all internal objects currently support GC. */
112    end = objects->object_buckets + objects->top;
113    while (obj_ptr != end) {
114        obj = *obj_ptr;
115        if (IS_OBJ_VALID(obj) && GC_REFCOUNT(obj) == 0) {
116            /* Not adding to free list as we are shutting down anyway */
117            void *ptr = ((char*)obj) - obj->handlers->offset;
118            GC_REMOVE_FROM_BUFFER(obj);
119            efree(ptr);
120        }
121        obj_ptr++;
122    }
123}
124
125
126/* Store objects API */
127
128ZEND_API void zend_objects_store_put(zend_object *object)
129{
130    int handle;
131
132    if (EG(objects_store).free_list_head != -1) {
133        handle = EG(objects_store).free_list_head;
134        EG(objects_store).free_list_head = GET_OBJ_BUCKET_NUMBER(EG(objects_store).object_buckets[handle]);
135    } else {
136        if (EG(objects_store).top == EG(objects_store).size) {
137            EG(objects_store).size <<= 1;
138            EG(objects_store).object_buckets = (zend_object **) erealloc(EG(objects_store).object_buckets, EG(objects_store).size * sizeof(zend_object*));
139        }
140        handle = EG(objects_store).top++;
141    }
142    object->handle = handle;
143    EG(objects_store).object_buckets[handle] = object;
144}
145
146#define ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle)                                                         \
147            SET_OBJ_BUCKET_NUMBER(EG(objects_store).object_buckets[handle], EG(objects_store).free_list_head);  \
148            EG(objects_store).free_list_head = handle;
149
150ZEND_API void zend_objects_store_free(zend_object *object) /* {{{ */
151{
152    uint32_t handle = object->handle;
153    void *ptr = ((char*)object) - object->handlers->offset;
154
155    GC_REMOVE_FROM_BUFFER(object);
156    efree(ptr);
157    ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle);
158}
159/* }}} */
160
161ZEND_API void zend_objects_store_del(zend_object *object) /* {{{ */
162{
163    /*  Make sure we hold a reference count during the destructor call
164        otherwise, when the destructor ends the storage might be freed
165        when the refcount reaches 0 a second time
166     */
167    if (EG(objects_store).object_buckets &&
168        IS_OBJ_VALID(EG(objects_store).object_buckets[object->handle])) {
169        if (GC_REFCOUNT(object) == 0) {
170            int failure = 0;
171
172            if (!(GC_FLAGS(object) & IS_OBJ_DESTRUCTOR_CALLED)) {
173                GC_FLAGS(object) |= IS_OBJ_DESTRUCTOR_CALLED;
174
175                if (object->handlers->dtor_obj) {
176                    GC_REFCOUNT(object)++;
177                    zend_try {
178                        object->handlers->dtor_obj(object);
179                    } zend_catch {
180                        failure = 1;
181                    } zend_end_try();
182                    GC_REFCOUNT(object)--;
183                }
184            }
185
186            if (GC_REFCOUNT(object) == 0) {
187                uint32_t handle = object->handle;
188                void *ptr;
189
190                EG(objects_store).object_buckets[handle] = SET_OBJ_INVALID(object);
191                if (!(GC_FLAGS(object) & IS_OBJ_FREE_CALLED)) {
192                    GC_FLAGS(object) |= IS_OBJ_FREE_CALLED;
193                    if (object->handlers->free_obj) {
194                        zend_try {
195                            GC_REFCOUNT(object)++;
196                            object->handlers->free_obj(object);
197                            GC_REFCOUNT(object)--;
198                        } zend_catch {
199                            failure = 1;
200                        } zend_end_try();
201                    }
202                }
203                ptr = ((char*)object) - object->handlers->offset;
204                GC_REMOVE_FROM_BUFFER(object);
205                efree(ptr);
206                ZEND_OBJECTS_STORE_ADD_TO_FREE_LIST(handle);
207            }
208
209            if (failure) {
210                zend_bailout();
211            }
212        } else {
213            GC_REFCOUNT(object)--;
214        }
215    }
216}
217/* }}} */
218
219/* zend_object_store_set_object:
220 * It is ONLY valid to call this function from within the constructor of an
221 * overloaded object.  Its purpose is to set the object pointer for the object
222 * when you can't possibly know its value until you have parsed the arguments
223 * from the constructor function.  You MUST NOT use this function for any other
224 * weird games, or call it at any other time after the object is constructed.
225 * */
226ZEND_API void zend_object_store_set_object(zval *zobject, zend_object *object)
227{
228    EG(objects_store).object_buckets[Z_OBJ_HANDLE_P(zobject)] = object;
229}
230
231/* Called when the ctor was terminated by an exception */
232ZEND_API void zend_object_store_ctor_failed(zend_object *obj)
233{
234    GC_FLAGS(obj) |= IS_OBJ_DESTRUCTOR_CALLED;
235}
236
237ZEND_API zend_object_handlers *zend_get_std_object_handlers(void)
238{
239    return &std_object_handlers;
240}
241
242/*
243 * Local variables:
244 * tab-width: 4
245 * c-basic-offset: 4
246 * indent-tabs-mode: t
247 * End:
248 */
249