2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2013, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
19 #include "ext/standard/info.h"
20 #include "php_raphf.h"
22 #ifndef PHP_RAPHF_TEST
23 # define PHP_RAPHF_TEST 0
26 struct php_persistent_handle_globals
{
31 ZEND_BEGIN_MODULE_GLOBALS(raphf
)
32 struct php_persistent_handle_globals persistent_handle
;
33 ZEND_END_MODULE_GLOBALS(raphf
)
36 # define PHP_RAPHF_G ((zend_raphf_globals *) \
37 (*((void ***) tsrm_get_ls_cache()))[TSRM_UNSHUFFLE_RSRC_ID(raphf_globals_id)])
39 # define PHP_RAPHF_G (&raphf_globals)
42 ZEND_DECLARE_MODULE_GLOBALS(raphf
)
44 #ifndef PHP_RAPHF_DEBUG_PHANDLES
45 # define PHP_RAPHF_DEBUG_PHANDLES 0
47 #if PHP_RAPHF_DEBUG_PHANDLES
52 php_resource_factory_t
*php_resource_factory_init(php_resource_factory_t
*f
,
53 php_resource_factory_ops_t
*fops
, void *data
, void (*dtor
)(void *data
))
56 f
= emalloc(sizeof(*f
));
58 memset(f
, 0, sizeof(*f
));
60 memcpy(&f
->fops
, fops
, sizeof(*fops
));
70 unsigned php_resource_factory_addref(php_resource_factory_t
*rf
)
72 return ++rf
->refcount
;
75 void php_resource_factory_dtor(php_resource_factory_t
*f
)
84 void php_resource_factory_free(php_resource_factory_t
**f
)
87 php_resource_factory_dtor(*f
);
88 if (!(*f
)->refcount
) {
95 void *php_resource_factory_handle_ctor(php_resource_factory_t
*f
, void *init_arg
)
98 return f
->fops
.ctor(f
->data
, init_arg
);
103 void *php_resource_factory_handle_copy(php_resource_factory_t
*f
, void *handle
)
106 return f
->fops
.copy(f
->data
, handle
);
111 void php_resource_factory_handle_dtor(php_resource_factory_t
*f
, void *handle
)
114 f
->fops
.dtor(f
->data
, handle
);
118 static inline php_persistent_handle_list_t
*php_persistent_handle_list_init(
119 php_persistent_handle_list_t
*list
)
122 list
= pemalloc(sizeof(*list
), 1);
125 zend_hash_init(&list
->free
, 0, NULL
, NULL
, 1);
130 static int php_persistent_handle_apply_stat(zval
*p
, int argc
, va_list argv
,
133 php_persistent_handle_list_t
*list
= Z_PTR_P(p
);
134 zval zsubentry
, *zentry
= va_arg(argv
, zval
*);
136 array_init(&zsubentry
);
137 add_assoc_long_ex(&zsubentry
, ZEND_STRL("used"), list
->used
);
138 add_assoc_long_ex(&zsubentry
, ZEND_STRL("free"),
139 zend_hash_num_elements(&list
->free
));
141 add_assoc_zval_ex(zentry
, key
->key
->val
, key
->key
->len
, &zsubentry
);
143 add_index_zval(zentry
, key
->h
, &zsubentry
);
145 return ZEND_HASH_APPLY_KEEP
;
148 static int php_persistent_handle_apply_statall(zval
*p
, int argc
, va_list argv
,
151 php_persistent_handle_provider_t
*provider
= Z_PTR_P(p
);
152 HashTable
*ht
= va_arg(argv
, HashTable
*);
157 zend_hash_apply_with_arguments(&provider
->list
.free
,
158 php_persistent_handle_apply_stat
, 1, &zentry
);
161 zend_hash_update(ht
, key
->key
, &zentry
);
163 zend_hash_index_update(ht
, key
->h
, &zentry
);
166 return ZEND_HASH_APPLY_KEEP
;
169 static int php_persistent_handle_apply_cleanup_ex(zval
*p
, void *arg
)
171 php_resource_factory_t
*rf
= arg
;
172 void *handle
= Z_PTR_P(p
);
174 #if PHP_RAPHF_DEBUG_PHANDLES
175 fprintf(stderr
, "DESTROY: %p\n", handle
);
177 php_resource_factory_handle_dtor(rf
, handle
);
178 return ZEND_HASH_APPLY_REMOVE
;
181 static int php_persistent_handle_apply_cleanup(zval
*p
, void *arg
)
183 php_resource_factory_t
*rf
= arg
;
184 php_persistent_handle_list_t
*list
= Z_PTR_P(p
);
186 zend_hash_apply_with_argument(&list
->free
,
187 php_persistent_handle_apply_cleanup_ex
, rf
);
189 return ZEND_HASH_APPLY_KEEP
;
191 zend_hash_destroy(&list
->free
);
192 #if PHP_RAPHF_DEBUG_PHANDLES
193 fprintf(stderr
, "LSTFREE: %p\n", list
);
196 return ZEND_HASH_APPLY_REMOVE
;
199 static inline void php_persistent_handle_list_dtor(
200 php_persistent_handle_list_t
*list
,
201 php_persistent_handle_provider_t
*provider
)
203 #if PHP_RAPHF_DEBUG_PHANDLES
204 fprintf(stderr
, "LSTDTOR: %p\n", list
);
206 zend_hash_apply_with_argument(&list
->free
,
207 php_persistent_handle_apply_cleanup_ex
, &provider
->rf
);
208 zend_hash_destroy(&list
->free
);
211 static inline void php_persistent_handle_list_free(
212 php_persistent_handle_list_t
**list
,
213 php_persistent_handle_provider_t
*provider
)
215 php_persistent_handle_list_dtor(*list
, provider
);
216 #if PHP_RAPHF_DEBUG_PHANDLES
217 fprintf(stderr
, "LSTFREE: %p\n", *list
);
223 static int php_persistent_handle_list_apply_dtor(zval
*p
, void *provider
)
225 php_persistent_handle_list_t
*list
= Z_PTR_P(p
);
227 php_persistent_handle_list_free(&list
, provider
);
229 return ZEND_HASH_APPLY_REMOVE
;
232 static inline php_persistent_handle_list_t
*php_persistent_handle_list_find(
233 php_persistent_handle_provider_t
*provider
, const char *ident_str
,
236 php_persistent_handle_list_t
*list
;
238 list
= zend_symtable_str_find_ptr(&provider
->list
.free
, ident_str
, ident_len
);
241 #if PHP_RAPHF_DEBUG_PHANDLES
242 fprintf(stderr
, "LSTFIND: %p\n", list
);
247 if ((list
= php_persistent_handle_list_init(NULL
))) {
251 if (zend_symtable_str_update(&provider
->list
.free
, ident_str
, ident_len
,
253 #if PHP_RAPHF_DEBUG_PHANDLES
254 fprintf(stderr
, "LSTFIND: %p (new)\n", list
);
258 php_persistent_handle_list_free(&list
, provider
);
264 static int php_persistent_handle_apply_cleanup_all(zval
*p
, int argc
,
265 va_list argv
, zend_hash_key
*key
)
267 php_persistent_handle_provider_t
*provider
= Z_PTR_P(p
);
268 const char *ident_str
= va_arg(argv
, const char *);
269 size_t ident_len
= va_arg(argv
, size_t);
270 php_persistent_handle_list_t
*list
;
272 if (ident_str
&& ident_len
) {
273 if ((list
= php_persistent_handle_list_find(provider
, ident_str
,
275 zend_hash_apply_with_argument(&list
->free
,
276 php_persistent_handle_apply_cleanup_ex
,
280 zend_hash_apply_with_argument(&provider
->list
.free
,
281 php_persistent_handle_apply_cleanup
, &provider
->rf
);
284 return ZEND_HASH_APPLY_KEEP
;
287 static void php_persistent_handle_hash_dtor(zval
*p
)
289 php_persistent_handle_provider_t
*provider
= Z_PTR_P(p
);
291 zend_hash_apply_with_argument(&provider
->list
.free
,
292 php_persistent_handle_list_apply_dtor
, provider
);
293 zend_hash_destroy(&provider
->list
.free
);
294 php_resource_factory_dtor(&provider
->rf
);
298 ZEND_RESULT_CODE
php_persistent_handle_provide(const char *name_str
,
299 size_t name_len
, php_resource_factory_ops_t
*fops
, void *data
,
300 void (*dtor
)(void *))
302 php_persistent_handle_provider_t
*provider
= pemalloc(sizeof(*provider
), 1);
304 if (php_persistent_handle_list_init(&provider
->list
)) {
305 if (php_resource_factory_init(&provider
->rf
, fops
, data
, dtor
)) {
308 #if PHP_RAPHF_DEBUG_PHANDLES
309 fprintf(stderr
, "PROVIDE: %p %s\n", PHP_RAPHF_G
, name_str
);
312 ZVAL_PTR(&p
, provider
);
313 if (zend_symtable_str_update(&PHP_RAPHF_G
->persistent_handle
.hash
,
314 name_str
, name_len
, &p
)) {
317 php_resource_factory_dtor(&provider
->rf
);
325 php_persistent_handle_factory_t
*php_persistent_handle_concede(
326 php_persistent_handle_factory_t
*a
, const char *name_str
,
327 size_t name_len
, const char *ident_str
, size_t ident_len
,
328 php_persistent_handle_wakeup_t wakeup
,
329 php_persistent_handle_retire_t retire
)
331 php_persistent_handle_factory_t
*free_a
= NULL
;
334 free_a
= a
= emalloc(sizeof(*a
));
336 memset(a
, 0, sizeof(*a
));
338 a
->provider
= zend_symtable_str_find_ptr(&PHP_RAPHF_G
->persistent_handle
.hash
,
342 a
->ident
.str
= estrndup(ident_str
, ident_len
);
343 a
->ident
.len
= ident_len
;
349 a
->free_on_abandon
= 1;
358 #if PHP_RAPHF_DEBUG_PHANDLES
359 fprintf(stderr
, "CONCEDE: %p %p (%s) (%s)\n", PHP_RAPHF_G
,
360 a
? a
->provider
: NULL
, name_str
, ident_str
);
366 void php_persistent_handle_abandon(php_persistent_handle_factory_t
*a
)
368 zend_bool f
= a
->free_on_abandon
;
370 #if PHP_RAPHF_DEBUG_PHANDLES
371 fprintf(stderr
, "ABANDON: %p\n", a
->provider
);
377 memset(a
, 0, sizeof(*a
));
383 void *php_persistent_handle_acquire(php_persistent_handle_factory_t
*a
, void *init_arg
)
389 php_persistent_handle_list_t
*list
;
391 list
= php_persistent_handle_list_find(a
->provider
, a
->ident
.str
, a
->ident
.len
);
393 zend_hash_internal_pointer_end(&list
->free
);
394 key
= zend_hash_get_current_key(&list
->free
, NULL
, &index
);
395 p
= zend_hash_get_current_data(&list
->free
);
396 if (p
&& HASH_KEY_NON_EXISTENT
!= key
) {
399 a
->wakeup(a
, &handle
);
401 zend_hash_index_del(&list
->free
, index
);
403 handle
= php_resource_factory_handle_ctor(&a
->provider
->rf
, init_arg
);
405 #if PHP_RAPHF_DEBUG_PHANDLES
406 fprintf(stderr
, "CREATED: %p\n", handle
);
409 ++a
->provider
->list
.used
;
417 void *php_persistent_handle_accrete(php_persistent_handle_factory_t
*a
, void *handle
)
419 void *new_handle
= NULL
;
420 php_persistent_handle_list_t
*list
;
422 new_handle
= php_resource_factory_handle_copy(&a
->provider
->rf
, handle
);
424 list
= php_persistent_handle_list_find(a
->provider
, a
->ident
.str
, a
->ident
.len
);
428 ++a
->provider
->list
.used
;
434 void php_persistent_handle_release(php_persistent_handle_factory_t
*a
, void *handle
)
436 php_persistent_handle_list_t
*list
;
438 list
= php_persistent_handle_list_find(a
->provider
, a
->ident
.str
, a
->ident
.len
);
440 if (a
->provider
->list
.used
>= PHP_RAPHF_G
->persistent_handle
.limit
) {
441 #if PHP_RAPHF_DEBUG_PHANDLES
442 fprintf(stderr
, "DESTROY: %p\n", handle
);
444 php_resource_factory_handle_dtor(&a
->provider
->rf
, handle
);
447 a
->retire(a
, &handle
);
449 zend_hash_next_index_insert_ptr(&list
->free
, handle
);
452 --a
->provider
->list
.used
;
457 void php_persistent_handle_cleanup(const char *name_str
, size_t name_len
,
458 const char *ident_str
, size_t ident_len
)
460 php_persistent_handle_provider_t
*provider
;
461 php_persistent_handle_list_t
*list
;
463 if (name_str
&& name_len
) {
464 provider
= zend_symtable_str_find_ptr(&PHP_RAPHF_G
->persistent_handle
.hash
,
468 if (ident_str
&& ident_len
) {
469 list
= php_persistent_handle_list_find(provider
, ident_str
,
472 zend_hash_apply_with_argument(&list
->free
,
473 php_persistent_handle_apply_cleanup_ex
,
477 zend_hash_apply_with_argument(&provider
->list
.free
,
478 php_persistent_handle_apply_cleanup
,
483 zend_hash_apply_with_arguments(
484 &PHP_RAPHF_G
->persistent_handle
.hash
,
485 php_persistent_handle_apply_cleanup_all
, 2, ident_str
,
490 HashTable
*php_persistent_handle_statall(HashTable
*ht
)
492 if (zend_hash_num_elements(&PHP_RAPHF_G
->persistent_handle
.hash
)) {
495 zend_hash_init(ht
, 0, NULL
, ZVAL_PTR_DTOR
, 0);
497 zend_hash_apply_with_arguments(
498 &PHP_RAPHF_G
->persistent_handle
.hash
,
499 php_persistent_handle_apply_statall
, 1, ht
);
507 static php_resource_factory_ops_t php_persistent_handle_resource_factory_ops
= {
508 (php_resource_factory_handle_ctor_t
) php_persistent_handle_acquire
,
509 (php_resource_factory_handle_copy_t
) php_persistent_handle_accrete
,
510 (php_resource_factory_handle_dtor_t
) php_persistent_handle_release
513 php_resource_factory_ops_t
*php_persistent_handle_get_resource_factory_ops(void)
515 return &php_persistent_handle_resource_factory_ops
;
518 ZEND_BEGIN_ARG_INFO_EX(ai_raphf_stat_persistent_handles
, 0, 0, 0)
520 static PHP_FUNCTION(raphf_stat_persistent_handles
)
522 if (SUCCESS
== zend_parse_parameters_none()) {
523 object_init(return_value
);
524 if (php_persistent_handle_statall(HASH_OF(return_value
))) {
527 zval_dtor(return_value
);
532 ZEND_BEGIN_ARG_INFO_EX(ai_raphf_clean_persistent_handles
, 0, 0, 0)
533 ZEND_ARG_INFO(0, name
)
534 ZEND_ARG_INFO(0, ident
)
536 static PHP_FUNCTION(raphf_clean_persistent_handles
)
538 char *name_str
= NULL
, *ident_str
= NULL
;
539 int name_len
= 0, ident_len
= 0;
541 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS(), "|s!s!",
542 &name_str
, &name_len
, &ident_str
, &ident_len
)) {
543 php_persistent_handle_cleanup(name_str
, name_len
, ident_str
, ident_len
);
548 # include "php_raphf_test.c"
551 static const zend_function_entry raphf_functions
[] = {
552 ZEND_NS_FENTRY("raphf", stat_persistent_handles
,
553 ZEND_FN(raphf_stat_persistent_handles
),
554 ai_raphf_stat_persistent_handles
, 0)
555 ZEND_NS_FENTRY("raphf", clean_persistent_handles
,
556 ZEND_FN(raphf_clean_persistent_handles
),
557 ai_raphf_clean_persistent_handles
, 0)
559 ZEND_NS_FENTRY("raphf", provide
, ZEND_FN(raphf_provide
), NULL
, 0)
560 ZEND_NS_FENTRY("raphf", conceal
, ZEND_FN(raphf_conceal
), NULL
, 0)
561 ZEND_NS_FENTRY("raphf", concede
, ZEND_FN(raphf_concede
), NULL
, 0)
562 ZEND_NS_FENTRY("raphf", dispute
, ZEND_FN(raphf_dispute
), NULL
, 0)
563 ZEND_NS_FENTRY("raphf", handle_ctor
, ZEND_FN(raphf_handle_ctor
), NULL
, 0)
564 ZEND_NS_FENTRY("raphf", handle_copy
, ZEND_FN(raphf_handle_copy
), NULL
, 0)
565 ZEND_NS_FENTRY("raphf", handle_dtor
, ZEND_FN(raphf_handle_dtor
), NULL
, 0)
571 STD_PHP_INI_ENTRY("raphf.persistent_handle.limit", "-1", PHP_INI_SYSTEM
,
572 OnUpdateLong
, persistent_handle
.limit
, zend_raphf_globals
,
576 static HashTable
*php_persistent_handles_global_hash
;
578 static PHP_GINIT_FUNCTION(raphf
)
580 raphf_globals
->persistent_handle
.limit
= -1;
582 zend_hash_init(&raphf_globals
->persistent_handle
.hash
, 0, NULL
,
583 php_persistent_handle_hash_dtor
, 1);
584 if (php_persistent_handles_global_hash
) {
585 zend_hash_copy(&raphf_globals
->persistent_handle
.hash
,
586 php_persistent_handles_global_hash
, NULL
);
590 static PHP_GSHUTDOWN_FUNCTION(raphf
)
592 zend_hash_destroy(&raphf_globals
->persistent_handle
.hash
);
595 PHP_MINIT_FUNCTION(raphf
)
597 php_persistent_handles_global_hash
= &PHP_RAPHF_G
->persistent_handle
.hash
;
600 PHP_MINIT(raphf_test
)(INIT_FUNC_ARGS_PASSTHRU
);
603 REGISTER_INI_ENTRIES();
607 PHP_MSHUTDOWN_FUNCTION(raphf
)
610 PHP_MSHUTDOWN(raphf_test
)(SHUTDOWN_FUNC_ARGS_PASSTHRU
);
613 UNREGISTER_INI_ENTRIES();
614 php_persistent_handles_global_hash
= NULL
;
618 static int php_persistent_handle_apply_info_ex(zval
*p
, int argc
,
619 va_list argv
, zend_hash_key
*key
)
621 php_persistent_handle_list_t
*list
= Z_PTR_P(p
);
622 zend_hash_key
*super_key
= va_arg(argv
, zend_hash_key
*);
623 char used
[21], free
[21];
625 slprintf(used
, sizeof(used
), "%u", list
->used
);
626 slprintf(free
, sizeof(free
), "%d", zend_hash_num_elements(&list
->free
));
628 php_info_print_table_row(4, super_key
->key
->val
, key
->key
->val
, used
, free
);
630 return ZEND_HASH_APPLY_KEEP
;
633 static int php_persistent_handle_apply_info(zval
*p
, int argc
,
634 va_list argv
, zend_hash_key
*key
)
636 php_persistent_handle_provider_t
*provider
= Z_PTR_P(p
);
638 zend_hash_apply_with_arguments(&provider
->list
.free
,
639 php_persistent_handle_apply_info_ex
, 1, key
);
641 return ZEND_HASH_APPLY_KEEP
;
644 PHP_MINFO_FUNCTION(raphf
)
646 php_info_print_table_start();
647 php_info_print_table_header(2,
648 "Resource and persistent handle factory support", "enabled");
649 php_info_print_table_row(2, "Extension version", PHP_RAPHF_VERSION
);
650 php_info_print_table_end();
652 php_info_print_table_start();
653 php_info_print_table_colspan_header(4, "Persistent handles in this "
660 php_info_print_table_header(4, "Provider", "Ident", "Used", "Free");
661 zend_hash_apply_with_arguments(
662 &PHP_RAPHF_G
->persistent_handle
.hash
,
663 php_persistent_handle_apply_info
, 0);
664 php_info_print_table_end();
666 DISPLAY_INI_ENTRIES();
669 zend_module_entry raphf_module_entry
= {
670 STANDARD_MODULE_HEADER
,
674 PHP_MSHUTDOWN(raphf
),
679 ZEND_MODULE_GLOBALS(raphf
),
681 PHP_GSHUTDOWN(raphf
),
683 STANDARD_MODULE_PROPERTIES_EX
687 #ifdef COMPILE_DL_RAPHF
688 ZEND_GET_MODULE(raphf
)
696 * vim600: noet sw=4 ts=4 fdm=marker
697 * vim<600: noet sw=4 ts=4