Skip to content

Commit 49ea143

Browse files
dstogovdstogov
committed
Encapsulate reference-counting primitives.
Prohibit direct update of GC_REFCOUNT(), GC_SET_REFCOUNT(), GC_ADDREF() and GC_DELREF() shoukf be instead. Added mactros to validate reference-counting (disabled for now). These macros are going to be used to eliminate race-condintions during reference-counting on data shared between threads.
1 parent 1ab0d82 commit 49ea143

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+408
-345
lines changed

‎Zend/zend.c

+4
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ void (*zend_on_timeout)(int seconds);
8383
static void (*zend_message_dispatcher_p)(zend_long message, const void *data);
8484
static zval *(*zend_get_configuration_directive_p)(zend_string *name);
8585

86+
#if ZEND_RC_DEBUG
87+
ZEND_API zend_bool zend_rc_debug = 0;
88+
#endif
89+
8690
static ZEND_INI_MH(OnUpdateErrorReporting) /* {{{ */
8791
{
8892
if (!new_value) {

‎Zend/zend_API.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1250,7 +1250,7 @@ static zend_always_inline int zend_parse_arg_array_ht(zval *arg, HashTable **des
12501250
&& Z_OBJ_P(arg)->properties
12511251
&& UNEXPECTED(GC_REFCOUNT(Z_OBJ_P(arg)->properties) > 1)) {
12521252
if (EXPECTED(!(GC_FLAGS(Z_OBJ_P(arg)->properties) & IS_ARRAY_IMMUTABLE))) {
1253-
GC_REFCOUNT(Z_OBJ_P(arg)->properties)--;
1253+
GC_DELREF(Z_OBJ_P(arg)->properties);
12541254
}
12551255
Z_OBJ_P(arg)->properties = zend_array_dup(Z_OBJ_P(arg)->properties);
12561256
}

‎Zend/zend_ast.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ ZEND_API zend_ast_ref *zend_ast_copy(zend_ast *ast)
559559
tree_size = zend_ast_tree_size(ast) + sizeof(zend_ast_ref);
560560
ref = emalloc(tree_size);
561561
zend_ast_tree_copy(ast, GC_AST(ref));
562-
GC_REFCOUNT(ref) = 1;
562+
GC_SET_REFCOUNT(ref, 1);
563563
GC_TYPE_INFO(ref) = IS_CONSTANT_AST;
564564
return ref;
565565
}

‎Zend/zend_closures.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ ZEND_METHOD(Closure, call)
171171

172172
if (fci_cache.function_handler->common.fn_flags & ZEND_ACC_GENERATOR) {
173173
/* copied upon generator creation */
174-
--GC_REFCOUNT(&closure->std);
174+
GC_DELREF(&closure->std);
175175
} else if (ZEND_USER_CODE(my_function.type) && closure->func.common.scope != Z_OBJCE_P(newthis)) {
176176
efree(my_function.op_array.run_time_cache);
177177
}

‎Zend/zend_compile.c

+2-2
Original file line numberDiff line numberDiff line change
@@ -1061,7 +1061,7 @@ ZEND_API void function_add_ref(zend_function *function) /* {{{ */
10611061
}
10621062
if (op_array->static_variables) {
10631063
if (!(GC_FLAGS(op_array->static_variables) & IS_ARRAY_IMMUTABLE)) {
1064-
GC_REFCOUNT(op_array->static_variables)++;
1064+
GC_ADDREF(op_array->static_variables);
10651065
}
10661066
}
10671067
op_array->run_time_cache = NULL;
@@ -4256,7 +4256,7 @@ static void zend_compile_static_var_common(zend_ast *var_ast, zval *value, zend_
42564256

42574257
if (GC_REFCOUNT(CG(active_op_array)->static_variables) > 1) {
42584258
if (!(GC_FLAGS(CG(active_op_array)->static_variables) & IS_ARRAY_IMMUTABLE)) {
4259-
GC_REFCOUNT(CG(active_op_array)->static_variables)--;
4259+
GC_DELREF(CG(active_op_array)->static_variables);
42604260
}
42614261
CG(active_op_array)->static_variables = zend_array_dup(CG(active_op_array)->static_variables);
42624262
}

‎Zend/zend_exceptions.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ void zend_exception_set_previous(zend_object *exception, zend_object *add_previo
100100
previous = zend_read_property_ex(base_ce, ex, ZSTR_KNOWN(ZEND_STR_PREVIOUS), 1, &rv);
101101
if (Z_TYPE_P(previous) == IS_NULL) {
102102
zend_update_property_ex(base_ce, ex, ZSTR_KNOWN(ZEND_STR_PREVIOUS), &pv);
103-
GC_REFCOUNT(add_previous)--;
103+
GC_DELREF(add_previous);
104104
return;
105105
}
106106
ex = previous;

‎Zend/zend_execute.c

+8-8
Original file line numberDiff line numberDiff line change
@@ -593,11 +593,11 @@ static inline void zend_assign_to_variable_reference(zval *variable_ptr, zval *v
593593
}
594594

595595
ref = Z_REF_P(value_ptr);
596-
GC_REFCOUNT(ref)++;
596+
GC_ADDREF(ref);
597597
if (Z_REFCOUNTED_P(variable_ptr)) {
598598
zend_refcounted *garbage = Z_COUNTED_P(variable_ptr);
599599

600-
if (--GC_REFCOUNT(garbage) == 0) {
600+
if (GC_DELREF(garbage) == 0) {
601601
ZVAL_REF(variable_ptr, ref);
602602
zval_dtor_func(garbage);
603603
return;
@@ -1894,7 +1894,7 @@ static zend_always_inline void zend_fetch_property_address(zval *result, zval *c
18941894
} else if (EXPECTED(zobj->properties != NULL)) {
18951895
if (UNEXPECTED(GC_REFCOUNT(zobj->properties) > 1)) {
18961896
if (EXPECTED(!(GC_FLAGS(zobj->properties) & IS_ARRAY_IMMUTABLE))) {
1897-
GC_REFCOUNT(zobj->properties)--;
1897+
GC_DELREF(zobj->properties);
18981898
}
18991899
zobj->properties = zend_array_dup(zobj->properties);
19001900
}
@@ -2080,7 +2080,7 @@ static zend_always_inline void i_free_compiled_variables(zend_execute_data *exec
20802080
while (EXPECTED(cv != end)) {
20812081
if (Z_REFCOUNTED_P(cv)) {
20822082
zend_refcounted *r = Z_COUNTED_P(cv);
2083-
if (!--GC_REFCOUNT(r)) {
2083+
if (!GC_DELREF(r)) {
20842084
ZVAL_NULL(cv);
20852085
zval_dtor_func(r);
20862086
} else {
@@ -2428,7 +2428,7 @@ static void cleanup_unfinished_calls(zend_execute_data *execute_data, uint32_t o
24282428

24292429
if (ZEND_CALL_INFO(call) & ZEND_CALL_RELEASE_THIS) {
24302430
if (ZEND_CALL_INFO(call) & ZEND_CALL_CTOR) {
2431-
GC_REFCOUNT(Z_OBJ(call->This))--;
2431+
GC_DELREF(Z_OBJ(call->This));
24322432
if (GC_REFCOUNT(Z_OBJ(call->This)) == 1) {
24332433
zend_object_store_ctor_failed(Z_OBJ(call->This));
24342434
}
@@ -2618,14 +2618,14 @@ static zend_never_inline zend_execute_data *zend_init_dynamic_call_object(zval *
26182618
if (fbc->common.fn_flags & ZEND_ACC_CLOSURE) {
26192619
/* Delay closure destruction until its invocation */
26202620
ZEND_ASSERT(GC_TYPE((zend_object*)fbc->common.prototype) == IS_OBJECT);
2621-
GC_REFCOUNT((zend_object*)fbc->common.prototype)++;
2621+
GC_ADDREF((zend_object*)fbc->common.prototype);
26222622
call_info |= ZEND_CALL_CLOSURE;
26232623
if (fbc->common.fn_flags & ZEND_ACC_FAKE_CLOSURE) {
26242624
call_info |= ZEND_CALL_FAKE_CLOSURE;
26252625
}
26262626
} else if (object) {
26272627
call_info |= ZEND_CALL_RELEASE_THIS;
2628-
GC_REFCOUNT(object)++; /* For $this pointer */
2628+
GC_ADDREF(object); /* For $this pointer */
26292629
}
26302630
} else {
26312631
zend_throw_error(NULL, "Function name must be a string");
@@ -2721,7 +2721,7 @@ static zend_never_inline zend_execute_data *zend_init_dynamic_call_array(zend_ar
27212721
object = NULL;
27222722
} else {
27232723
call_info |= ZEND_CALL_RELEASE_THIS;
2724-
GC_REFCOUNT(object)++; /* For $this pointer */
2724+
GC_ADDREF(object); /* For $this pointer */
27252725
}
27262726
}
27272727
} else {

‎Zend/zend_execute.h

+5-5
Original file line numberDiff line numberDiff line change
@@ -85,19 +85,19 @@ static zend_always_inline zval* zend_assign_to_variable(zval *variable_ptr, zval
8585
if (ZEND_CONST_COND(value_type & (IS_VAR|IS_CV), 1) && variable_ptr == value) {
8686
if (value_type == IS_VAR && ref) {
8787
ZEND_ASSERT(GC_REFCOUNT(ref) > 1);
88-
--GC_REFCOUNT(ref);
88+
GC_DELREF(ref);
8989
}
9090
return variable_ptr;
9191
}
9292
garbage = Z_COUNTED_P(variable_ptr);
93-
if (--GC_REFCOUNT(garbage) == 0) {
93+
if (GC_DELREF(garbage) == 0) {
9494
ZVAL_COPY_VALUE(variable_ptr, value);
9595
if (value_type & (IS_CONST|IS_CV)) {
9696
if (UNEXPECTED(Z_OPT_REFCOUNTED_P(variable_ptr))) {
9797
Z_ADDREF_P(variable_ptr);
9898
}
9999
} else if (ZEND_CONST_COND(value_type == IS_VAR, 1) && UNEXPECTED(ref)) {
100-
if (UNEXPECTED(--GC_REFCOUNT(ref) == 0)) {
100+
if (UNEXPECTED(GC_DELREF(ref) == 0)) {
101101
efree_size(ref, sizeof(zend_reference));
102102
} else if (Z_OPT_REFCOUNTED_P(variable_ptr)) {
103103
Z_ADDREF_P(variable_ptr);
@@ -120,7 +120,7 @@ static zend_always_inline zval* zend_assign_to_variable(zval *variable_ptr, zval
120120
Z_ADDREF_P(variable_ptr);
121121
}
122122
} else if (ZEND_CONST_COND(value_type == IS_VAR, 1) && UNEXPECTED(ref)) {
123-
if (UNEXPECTED(--GC_REFCOUNT(ref) == 0)) {
123+
if (UNEXPECTED(GC_DELREF(ref) == 0)) {
124124
efree_size(ref, sizeof(zend_reference));
125125
} else if (Z_OPT_REFCOUNTED_P(variable_ptr)) {
126126
Z_ADDREF_P(variable_ptr);
@@ -223,7 +223,7 @@ static zend_always_inline void zend_vm_stack_free_extra_args_ex(uint32_t call_in
223223
p--;
224224
if (Z_REFCOUNTED_P(p)) {
225225
zend_refcounted *r = Z_COUNTED_P(p);
226-
if (!--GC_REFCOUNT(r)) {
226+
if (!GC_DELREF(r)) {
227227
ZVAL_NULL(p);
228228
zval_dtor_func(r);
229229
} else {

‎Zend/zend_execute_API.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -774,7 +774,7 @@ int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache) /
774774
uint32_t call_info;
775775

776776
ZEND_ASSERT(GC_TYPE((zend_object*)func->op_array.prototype) == IS_OBJECT);
777-
GC_REFCOUNT((zend_object*)func->op_array.prototype)++;
777+
GC_ADDREF((zend_object*)func->op_array.prototype);
778778
call_info = ZEND_CALL_CLOSURE;
779779
if (func->common.fn_flags & ZEND_ACC_FAKE_CLOSURE) {
780780
call_info |= ZEND_CALL_FAKE_CLOSURE;

‎Zend/zend_gc.c

+21-21
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,9 @@ ZEND_API void ZEND_FASTCALL gc_possible_root(zend_refcounted *ref)
282282
if (!GC_G(gc_enabled)) {
283283
return;
284284
}
285-
GC_REFCOUNT(ref)++;
285+
GC_ADDREF(ref);
286286
gc_collect_cycles();
287-
GC_REFCOUNT(ref)--;
287+
GC_DELREF(ref);
288288
if (UNEXPECTED(GC_REFCOUNT(ref)) == 0) {
289289
zval_dtor_func(ref);
290290
return;
@@ -397,7 +397,7 @@ static void gc_scan_black(zend_refcounted *ref)
397397
while (zv != end) {
398398
if (Z_REFCOUNTED_P(zv)) {
399399
ref = Z_COUNTED_P(zv);
400-
GC_REFCOUNT(ref)++;
400+
GC_ADDREF(ref);
401401
if (GC_REF_GET_COLOR(ref) != GC_BLACK) {
402402
gc_scan_black(ref);
403403
}
@@ -406,7 +406,7 @@ static void gc_scan_black(zend_refcounted *ref)
406406
}
407407
if (EXPECTED(!ht)) {
408408
ref = Z_COUNTED_P(zv);
409-
GC_REFCOUNT(ref)++;
409+
GC_ADDREF(ref);
410410
if (GC_REF_GET_COLOR(ref) != GC_BLACK) {
411411
goto tail_call;
412412
}
@@ -424,7 +424,7 @@ static void gc_scan_black(zend_refcounted *ref)
424424
} else if (GC_TYPE(ref) == IS_REFERENCE) {
425425
if (Z_REFCOUNTED(((zend_reference*)ref)->val)) {
426426
ref = Z_COUNTED(((zend_reference*)ref)->val);
427-
GC_REFCOUNT(ref)++;
427+
GC_ADDREF(ref);
428428
if (GC_REF_GET_COLOR(ref) != GC_BLACK) {
429429
goto tail_call;
430430
}
@@ -455,7 +455,7 @@ static void gc_scan_black(zend_refcounted *ref)
455455
}
456456
if (Z_REFCOUNTED_P(zv)) {
457457
ref = Z_COUNTED_P(zv);
458-
GC_REFCOUNT(ref)++;
458+
GC_ADDREF(ref);
459459
if (GC_REF_GET_COLOR(ref) != GC_BLACK) {
460460
gc_scan_black(ref);
461461
}
@@ -467,7 +467,7 @@ static void gc_scan_black(zend_refcounted *ref)
467467
zv = Z_INDIRECT_P(zv);
468468
}
469469
ref = Z_COUNTED_P(zv);
470-
GC_REFCOUNT(ref)++;
470+
GC_ADDREF(ref);
471471
if (GC_REF_GET_COLOR(ref) != GC_BLACK) {
472472
goto tail_call;
473473
}
@@ -507,14 +507,14 @@ static void gc_mark_grey(zend_refcounted *ref)
507507
while (zv != end) {
508508
if (Z_REFCOUNTED_P(zv)) {
509509
ref = Z_COUNTED_P(zv);
510-
GC_REFCOUNT(ref)--;
510+
GC_DELREF(ref);
511511
gc_mark_grey(ref);
512512
}
513513
zv++;
514514
}
515515
if (EXPECTED(!ht)) {
516516
ref = Z_COUNTED_P(zv);
517-
GC_REFCOUNT(ref)--;
517+
GC_DELREF(ref);
518518
goto tail_call;
519519
}
520520
} else {
@@ -530,7 +530,7 @@ static void gc_mark_grey(zend_refcounted *ref)
530530
} else if (GC_TYPE(ref) == IS_REFERENCE) {
531531
if (Z_REFCOUNTED(((zend_reference*)ref)->val)) {
532532
ref = Z_COUNTED(((zend_reference*)ref)->val);
533-
GC_REFCOUNT(ref)--;
533+
GC_DELREF(ref);
534534
goto tail_call;
535535
}
536536
return;
@@ -559,7 +559,7 @@ static void gc_mark_grey(zend_refcounted *ref)
559559
}
560560
if (Z_REFCOUNTED_P(zv)) {
561561
ref = Z_COUNTED_P(zv);
562-
GC_REFCOUNT(ref)--;
562+
GC_DELREF(ref);
563563
gc_mark_grey(ref);
564564
}
565565
p++;
@@ -569,7 +569,7 @@ static void gc_mark_grey(zend_refcounted *ref)
569569
zv = Z_INDIRECT_P(zv);
570570
}
571571
ref = Z_COUNTED_P(zv);
572-
GC_REFCOUNT(ref)--;
572+
GC_DELREF(ref);
573573
goto tail_call;
574574
}
575575
}
@@ -799,7 +799,7 @@ static int gc_collect_white(zend_refcounted *ref, uint32_t *flags)
799799
while (zv != end) {
800800
if (Z_REFCOUNTED_P(zv)) {
801801
ref = Z_COUNTED_P(zv);
802-
GC_REFCOUNT(ref)++;
802+
GC_ADDREF(ref);
803803
count += gc_collect_white(ref, flags);
804804
/* count non-refcounted for compatibility ??? */
805805
} else if (Z_TYPE_P(zv) != IS_UNDEF) {
@@ -809,7 +809,7 @@ static int gc_collect_white(zend_refcounted *ref, uint32_t *flags)
809809
}
810810
if (EXPECTED(!ht)) {
811811
ref = Z_COUNTED_P(zv);
812-
GC_REFCOUNT(ref)++;
812+
GC_ADDREF(ref);
813813
goto tail_call;
814814
}
815815
} else {
@@ -828,7 +828,7 @@ static int gc_collect_white(zend_refcounted *ref, uint32_t *flags)
828828
} else if (GC_TYPE(ref) == IS_REFERENCE) {
829829
if (Z_REFCOUNTED(((zend_reference*)ref)->val)) {
830830
ref = Z_COUNTED(((zend_reference*)ref)->val);
831-
GC_REFCOUNT(ref)++;
831+
GC_ADDREF(ref);
832832
goto tail_call;
833833
}
834834
return count;
@@ -861,7 +861,7 @@ static int gc_collect_white(zend_refcounted *ref, uint32_t *flags)
861861
}
862862
if (Z_REFCOUNTED_P(zv)) {
863863
ref = Z_COUNTED_P(zv);
864-
GC_REFCOUNT(ref)++;
864+
GC_ADDREF(ref);
865865
count += gc_collect_white(ref, flags);
866866
/* count non-refcounted for compatibility ??? */
867867
} else if (Z_TYPE_P(zv) != IS_UNDEF) {
@@ -874,7 +874,7 @@ static int gc_collect_white(zend_refcounted *ref, uint32_t *flags)
874874
zv = Z_INDIRECT_P(zv);
875875
}
876876
ref = Z_COUNTED_P(zv);
877-
GC_REFCOUNT(ref)++;
877+
GC_ADDREF(ref);
878878
goto tail_call;
879879
}
880880
return count;
@@ -1118,9 +1118,9 @@ ZEND_API int zend_gc_collect_cycles(void)
11181118
if (obj->handlers->dtor_obj
11191119
&& (obj->handlers->dtor_obj != zend_objects_destroy_object
11201120
|| obj->ce->destructor)) {
1121-
GC_REFCOUNT(obj)++;
1121+
GC_ADDREF(obj);
11221122
obj->handlers->dtor_obj(obj);
1123-
GC_REFCOUNT(obj)--;
1123+
GC_DELREF(obj);
11241124
}
11251125
}
11261126
}
@@ -1154,9 +1154,9 @@ ZEND_API int zend_gc_collect_cycles(void)
11541154
if (!(GC_FLAGS(obj) & IS_OBJ_FREE_CALLED)) {
11551155
GC_FLAGS(obj) |= IS_OBJ_FREE_CALLED;
11561156
if (obj->handlers->free_obj) {
1157-
GC_REFCOUNT(obj)++;
1157+
GC_ADDREF(obj);
11581158
obj->handlers->free_obj(obj);
1159-
GC_REFCOUNT(obj)--;
1159+
GC_DELREF(obj);
11601160
}
11611161
}
11621162
SET_OBJ_BUCKET_NUMBER(EG(objects_store).object_buckets[obj->handle], EG(objects_store).free_list_head);

‎Zend/zend_generators.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ static void zend_generator_add_child(zend_generator *generator, zend_generator *
514514
if (was_leaf) {
515515
zend_generator *next = generator->node.parent;
516516
leaf->node.ptr.root = generator->node.ptr.root;
517-
++GC_REFCOUNT(&generator->std); /* we need to increment the generator refcount here as it became integrated into the tree (no leaf), but we must not increment the refcount of the *whole* path in tree */
517+
GC_ADDREF(&generator->std); /* we need to increment the generator refcount here as it became integrated into the tree (no leaf), but we must not increment the refcount of the *whole* path in tree */
518518
generator->node.ptr.leaf = leaf;
519519

520520
while (next) {
@@ -592,7 +592,7 @@ void zend_generator_yield_from(zend_generator *generator, zend_generator *from)
592592

593593
generator->node.parent = from;
594594
zend_generator_get_current(generator);
595-
--GC_REFCOUNT(&from->std);
595+
GC_DELREF(&from->std);
596596
}
597597

598598
ZEND_API zend_generator *zend_generator_update_current(zend_generator *generator, zend_generator *leaf)
@@ -658,7 +658,7 @@ ZEND_API zend_generator *zend_generator_update_current(zend_generator *generator
658658
} else {
659659
do {
660660
root = root->node.parent;
661-
++GC_REFCOUNT(&root->std);
661+
GC_ADDREF(&root->std);
662662
} while (root->node.parent);
663663
}
664664
}

0 commit comments

Comments
 (0)