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 struct php_persistent_handle_globals
{
27 ZEND_BEGIN_MODULE_GLOBALS(raphf
)
28 struct php_persistent_handle_globals persistent_handle
;
29 ZEND_END_MODULE_GLOBALS(raphf
)
32 # define PHP_RAPHF_G ((zend_raphf_globals *) \
33 (*((void ***) tsrm_ls))[TSRM_UNSHUFFLE_RSRC_ID(raphf_globals_id)])
35 # define PHP_RAPHF_G (&raphf_globals)
38 ZEND_DECLARE_MODULE_GLOBALS(raphf
)
40 #ifndef PHP_RAPHF_DEBUG_PHANDLES
41 # define PHP_RAPHF_DEBUG_PHANDLES 0
43 #if PHP_RAPHF_DEBUG_PHANDLES
48 php_resource_factory_t
*php_resource_factory_init(php_resource_factory_t
*f
,
49 php_resource_factory_ops_t
*fops
, void *data
, void (*dtor
)(void *data
))
52 f
= emalloc(sizeof(*f
));
54 memset(f
, 0, sizeof(*f
));
56 memcpy(&f
->fops
, fops
, sizeof(*fops
));
66 unsigned php_resource_factory_addref(php_resource_factory_t
*rf
)
68 return ++rf
->refcount
;
71 void php_resource_factory_dtor(php_resource_factory_t
*f
)
80 void php_resource_factory_free(php_resource_factory_t
**f
)
83 php_resource_factory_dtor(*f
);
84 if (!(*f
)->refcount
) {
91 void *php_resource_factory_handle_ctor(php_resource_factory_t
*f
,
92 void *init_arg TSRMLS_DC
)
95 return f
->fops
.ctor(f
->data
, init_arg TSRMLS_CC
);
100 void *php_resource_factory_handle_copy(php_resource_factory_t
*f
,
101 void *handle TSRMLS_DC
)
104 return f
->fops
.copy(f
->data
, handle TSRMLS_CC
);
109 void php_resource_factory_handle_dtor(php_resource_factory_t
*f
,
110 void *handle TSRMLS_DC
)
113 f
->fops
.dtor(f
->data
, handle TSRMLS_CC
);
117 static inline php_persistent_handle_list_t
*php_persistent_handle_list_init(
118 php_persistent_handle_list_t
*list
)
121 list
= pemalloc(sizeof(*list
), 1);
124 zend_hash_init(&list
->free
, 0, NULL
, NULL
, 1);
129 static int php_persistent_handle_apply_stat(zval
*p TSRMLS_DC
, int argc
,
130 va_list argv
, zend_hash_key
*key
)
132 php_persistent_handle_list_t
*list
= Z_PTR_P(p
);
133 zval zsubentry
, *zentry
= va_arg(argv
, zval
*);
135 array_init(&zsubentry
);
136 add_assoc_long_ex(&zsubentry
, ZEND_STRS("used"), list
->used
);
137 add_assoc_long_ex(&zsubentry
, ZEND_STRS("free"),
138 zend_hash_num_elements(&list
->free
));
139 add_assoc_zval_ex(zentry
, key
->key
->val
, key
->key
->len
, &zsubentry
);
141 return ZEND_HASH_APPLY_KEEP
;
144 static int php_persistent_handle_apply_statall(zval
*p TSRMLS_DC
, int argc
,
145 va_list argv
, zend_hash_key
*key
)
147 php_persistent_handle_provider_t
*provider
= Z_PTR_P(p
);
148 HashTable
*ht
= va_arg(argv
, HashTable
*);
153 zend_hash_apply_with_arguments(&provider
->list
.free TSRMLS_CC
,
154 php_persistent_handle_apply_stat
, 1, &zentry
);
155 zend_symtable_update(ht
, key
->key
, &zentry
);
157 return ZEND_HASH_APPLY_KEEP
;
160 static int php_persistent_handle_apply_cleanup_ex(zval
*p
, void *arg TSRMLS_DC
)
162 php_resource_factory_t
*rf
= arg
;
163 void *handle
= Z_PTR_P(p
);
165 #if PHP_RAPHF_DEBUG_PHANDLES
166 fprintf(stderr
, "DESTROY: %p\n", handle
);
168 php_resource_factory_handle_dtor(rf
, handle TSRMLS_CC
);
169 return ZEND_HASH_APPLY_REMOVE
;
172 static int php_persistent_handle_apply_cleanup(zval
*p
, void *arg TSRMLS_DC
)
174 php_resource_factory_t
*rf
= arg
;
175 php_persistent_handle_list_t
*list
= Z_PTR_P(p
);
177 zend_hash_apply_with_argument(&list
->free
,
178 php_persistent_handle_apply_cleanup_ex
, rf TSRMLS_CC
);
180 return ZEND_HASH_APPLY_KEEP
;
182 zend_hash_destroy(&list
->free
);
183 #if PHP_RAPHF_DEBUG_PHANDLES
184 fprintf(stderr
, "LSTFREE: %p\n", list
);
187 return ZEND_HASH_APPLY_REMOVE
;
190 static inline void php_persistent_handle_list_dtor(
191 php_persistent_handle_list_t
*list
,
192 php_persistent_handle_provider_t
*provider TSRMLS_DC
)
194 #if PHP_RAPHF_DEBUG_PHANDLES
195 fprintf(stderr
, "LSTDTOR: %p\n", list
);
197 zend_hash_apply_with_argument(&list
->free
,
198 php_persistent_handle_apply_cleanup_ex
, &provider
->rf TSRMLS_CC
);
199 zend_hash_destroy(&list
->free
);
202 static inline void php_persistent_handle_list_free(
203 php_persistent_handle_list_t
**list
,
204 php_persistent_handle_provider_t
*provider TSRMLS_DC
)
206 php_persistent_handle_list_dtor(*list
, provider TSRMLS_CC
);
207 #if PHP_RAPHF_DEBUG_PHANDLES
208 fprintf(stderr
, "LSTFREE: %p\n", *list
);
214 static int php_persistent_handle_list_apply_dtor(zval
*p
,
215 void *provider TSRMLS_DC
)
217 php_persistent_handle_list_t
*list
= Z_PTR_P(p
);
218 php_persistent_handle_list_free(&list
, provider TSRMLS_CC
);
220 return ZEND_HASH_APPLY_REMOVE
;
223 static inline php_persistent_handle_list_t
*php_persistent_handle_list_find(
224 php_persistent_handle_provider_t
*provider
, const char *ident_str
,
225 size_t ident_len TSRMLS_DC
)
227 php_persistent_handle_list_t
*list
;
229 list
= zend_symtable_str_find_ptr(&provider
->list
.free
, ident_str
,
233 #if PHP_RAPHF_DEBUG_PHANDLES
234 fprintf(stderr
, "LSTFIND: %p\n", list
);
239 if ((list
= php_persistent_handle_list_init(NULL
))) {
243 if (zend_symtable_str_update(&provider
->list
.free
, ident_str
, ident_len
,
245 #if PHP_RAPHF_DEBUG_PHANDLES
246 fprintf(stderr
, "LSTFIND: %p (new)\n", list
);
250 php_persistent_handle_list_free(&list
, provider TSRMLS_CC
);
256 static int php_persistent_handle_apply_cleanup_all(zval
*p TSRMLS_DC
, int argc
,
257 va_list argv
, zend_hash_key
*key
)
259 php_persistent_handle_provider_t
*provider
= Z_PTR_P(p
);
260 const char *ident_str
= va_arg(argv
, const char *);
261 size_t ident_len
= va_arg(argv
, size_t);
262 php_persistent_handle_list_t
*list
;
264 if (ident_str
&& ident_len
) {
265 if ((list
= php_persistent_handle_list_find(provider
, ident_str
,
266 ident_len TSRMLS_CC
))) {
267 zend_hash_apply_with_argument(&list
->free
,
268 php_persistent_handle_apply_cleanup_ex
,
269 &provider
->rf TSRMLS_CC
);
272 zend_hash_apply_with_argument(&provider
->list
.free
,
273 php_persistent_handle_apply_cleanup
, &provider
->rf TSRMLS_CC
);
276 return ZEND_HASH_APPLY_KEEP
;
279 static void php_persistent_handle_hash_dtor(zval
*p
)
281 php_persistent_handle_provider_t
*provider
= Z_PTR_P(p
);
284 zend_hash_apply_with_argument(&provider
->list
.free
,
285 php_persistent_handle_list_apply_dtor
, provider TSRMLS_CC
);
286 zend_hash_destroy(&provider
->list
.free
);
287 php_resource_factory_dtor(&provider
->rf
);
291 ZEND_RESULT_CODE
php_persistent_handle_provide(const char *name_str
,
292 size_t name_len
, php_resource_factory_ops_t
*fops
, void *data
,
293 void (*dtor
)(void *) TSRMLS_DC
)
295 php_persistent_handle_provider_t
*provider
= pemalloc(sizeof(*provider
), 1);
297 if (php_persistent_handle_list_init(&provider
->list
)) {
298 if (php_resource_factory_init(&provider
->rf
, fops
, data
, dtor
)) {
301 #if PHP_RAPHF_DEBUG_PHANDLES
302 fprintf(stderr
, "PROVIDE: %p %s\n", PHP_RAPHF_G
, name_str
);
305 ZVAL_PTR(&p
, provider
);
306 if (zend_symtable_str_update(&PHP_RAPHF_G
->persistent_handle
.hash
,
307 name_str
, name_len
, &p
)) {
310 php_resource_factory_dtor(&provider
->rf
);
317 php_persistent_handle_factory_t
*php_persistent_handle_concede(
318 php_persistent_handle_factory_t
*a
, const char *name_str
,
319 size_t name_len
, const char *ident_str
, size_t ident_len
,
320 php_persistent_handle_wakeup_t wakeup
,
321 php_persistent_handle_retire_t retire TSRMLS_DC
)
323 php_persistent_handle_factory_t
*free_a
= NULL
;
326 free_a
= a
= emalloc(sizeof(*a
));
328 memset(a
, 0, sizeof(*a
));
330 a
->provider
= zend_symtable_str_find_ptr(&PHP_RAPHF_G
->persistent_handle
.hash
,
331 name_str
, name_len
+1);
334 a
->ident
.str
= estrndup(ident_str
, ident_len
);
335 a
->ident
.len
= ident_len
;
341 a
->free_on_abandon
= 1;
350 #if PHP_RAPHF_DEBUG_PHANDLES
351 fprintf(stderr
, "CONCEDE: %p %p (%s) (%s)\n", PHP_RAPHF_G
,
352 a
? a
->provider
: NULL
, name_str
, ident_str
);
358 void php_persistent_handle_abandon(php_persistent_handle_factory_t
*a
)
360 zend_bool f
= a
->free_on_abandon
;
362 #if PHP_RAPHF_DEBUG_PHANDLES
363 fprintf(stderr
, "ABANDON: %p\n", a
->provider
);
369 memset(a
, 0, sizeof(*a
));
375 void *php_persistent_handle_acquire(php_persistent_handle_factory_t
*a
,
376 void *init_arg TSRMLS_DC
)
382 php_persistent_handle_list_t
*list
;
384 list
= php_persistent_handle_list_find(a
->provider
, a
->ident
.str
,
385 a
->ident
.len TSRMLS_CC
);
387 zend_hash_internal_pointer_end(&list
->free
);
388 key
= zend_hash_get_current_key(&list
->free
, NULL
, &index
, 0);
389 p
= zend_hash_get_current_data(&list
->free
);
390 if (p
&& HASH_KEY_NON_EXISTENT
!= key
) {
393 a
->wakeup(a
, &handle TSRMLS_CC
);
395 zend_hash_index_del(&list
->free
, index
);
397 handle
= php_resource_factory_handle_ctor(&a
->provider
->rf
,
400 #if PHP_RAPHF_DEBUG_PHANDLES
401 fprintf(stderr
, "CREATED: %p\n", handle
);
404 ++a
->provider
->list
.used
;
412 void *php_persistent_handle_accrete(php_persistent_handle_factory_t
*a
,
413 void *handle TSRMLS_DC
)
415 void *new_handle
= NULL
;
416 php_persistent_handle_list_t
*list
;
418 new_handle
= php_resource_factory_handle_copy(&a
->provider
->rf
,
421 list
= php_persistent_handle_list_find(a
->provider
, a
->ident
.str
,
422 a
->ident
.len TSRMLS_CC
);
426 ++a
->provider
->list
.used
;
432 void php_persistent_handle_release(php_persistent_handle_factory_t
*a
,
433 void *handle TSRMLS_DC
)
435 php_persistent_handle_list_t
*list
;
437 list
= php_persistent_handle_list_find(a
->provider
, a
->ident
.str
,
438 a
->ident
.len TSRMLS_CC
);
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 TSRMLS_CC
);
447 a
->retire(a
, &handle TSRMLS_CC
);
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 TSRMLS_DC
)
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
,
465 name_str
, name_len
+1);
468 if (ident_str
&& ident_len
) {
469 list
= php_persistent_handle_list_find(provider
, ident_str
,
470 ident_len TSRMLS_CC
);
472 zend_hash_apply_with_argument(&list
->free
,
473 php_persistent_handle_apply_cleanup_ex
,
474 &provider
->rf TSRMLS_CC
);
477 zend_hash_apply_with_argument(&provider
->list
.free
,
478 php_persistent_handle_apply_cleanup
,
479 &provider
->rf TSRMLS_CC
);
483 zend_hash_apply_with_arguments(
484 &PHP_RAPHF_G
->persistent_handle
.hash TSRMLS_CC
,
485 php_persistent_handle_apply_cleanup_all
, 2, ident_str
,
490 HashTable
*php_persistent_handle_statall(HashTable
*ht TSRMLS_DC
)
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 TSRMLS_CC
,
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
) TSRMLS_CC
)) {
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() TSRMLS_CC
, "|s!s!",
542 &name_str
, &name_len
, &ident_str
, &ident_len
)) {
543 php_persistent_handle_cleanup(name_str
, name_len
, ident_str
,
544 ident_len TSRMLS_CC
);
548 static const zend_function_entry raphf_functions
[] = {
549 ZEND_NS_FENTRY("raphf", stat_persistent_handles
,
550 ZEND_FN(raphf_stat_persistent_handles
),
551 ai_raphf_stat_persistent_handles
, 0)
552 ZEND_NS_FENTRY("raphf", clean_persistent_handles
,
553 ZEND_FN(raphf_clean_persistent_handles
),
554 ai_raphf_clean_persistent_handles
, 0)
559 STD_PHP_INI_ENTRY("raphf.persistent_handle.limit", "-1", PHP_INI_SYSTEM
,
560 OnUpdateLong
, persistent_handle
.limit
, zend_raphf_globals
,
564 static HashTable
*php_persistent_handles_global_hash
;
566 static PHP_GINIT_FUNCTION(raphf
)
568 raphf_globals
->persistent_handle
.limit
= -1;
570 zend_hash_init(&raphf_globals
->persistent_handle
.hash
, 0, NULL
,
571 php_persistent_handle_hash_dtor
, 1);
572 if (php_persistent_handles_global_hash
) {
573 zend_hash_copy(&raphf_globals
->persistent_handle
.hash
,
574 php_persistent_handles_global_hash
, NULL
);
578 static PHP_GSHUTDOWN_FUNCTION(raphf
)
580 zend_hash_destroy(&raphf_globals
->persistent_handle
.hash
);
583 PHP_MINIT_FUNCTION(raphf
)
585 php_persistent_handles_global_hash
= &PHP_RAPHF_G
->persistent_handle
.hash
;
586 REGISTER_INI_ENTRIES();
590 PHP_MSHUTDOWN_FUNCTION(raphf
)
592 UNREGISTER_INI_ENTRIES();
593 php_persistent_handles_global_hash
= NULL
;
597 static int php_persistent_handle_apply_info_ex(zval
*p TSRMLS_DC
, int argc
,
598 va_list argv
, zend_hash_key
*key
)
600 php_persistent_handle_list_t
*list
= Z_PTR_P(p
);
601 zend_hash_key
*super_key
= va_arg(argv
, zend_hash_key
*);
602 char used
[21], free
[21];
604 slprintf(used
, sizeof(used
), "%u", list
->used
);
605 slprintf(free
, sizeof(free
), "%d", zend_hash_num_elements(&list
->free
));
607 php_info_print_table_row(4, super_key
->key
->val
, key
->key
->val
, used
, free
);
609 return ZEND_HASH_APPLY_KEEP
;
612 static int php_persistent_handle_apply_info(zval
*p TSRMLS_DC
, int argc
,
613 va_list argv
, zend_hash_key
*key
)
615 php_persistent_handle_provider_t
*provider
= Z_PTR_P(p
);
617 zend_hash_apply_with_arguments(&provider
->list
.free TSRMLS_CC
,
618 php_persistent_handle_apply_info_ex
, 1, key
);
620 return ZEND_HASH_APPLY_KEEP
;
623 PHP_MINFO_FUNCTION(raphf
)
625 php_info_print_table_start();
626 php_info_print_table_header(2,
627 "Resource and persistent handle factory support", "enabled");
628 php_info_print_table_row(2, "Extension version", PHP_RAPHF_VERSION
);
629 php_info_print_table_end();
631 php_info_print_table_start();
632 php_info_print_table_colspan_header(4, "Persistent handles in this "
639 php_info_print_table_header(4, "Provider", "Ident", "Used", "Free");
640 zend_hash_apply_with_arguments(
641 &PHP_RAPHF_G
->persistent_handle
.hash TSRMLS_CC
,
642 php_persistent_handle_apply_info
, 0);
643 php_info_print_table_end();
645 DISPLAY_INI_ENTRIES();
648 zend_module_entry raphf_module_entry
= {
649 STANDARD_MODULE_HEADER
,
653 PHP_MSHUTDOWN(raphf
),
658 ZEND_MODULE_GLOBALS(raphf
),
660 PHP_GSHUTDOWN(raphf
),
662 STANDARD_MODULE_PROPERTIES_EX
666 #ifdef COMPILE_DL_RAPHF
667 ZEND_GET_MODULE(raphf
)
676 * vim600: noet sw=4 ts=4 fdm=marker
677 * vim<600: noet sw=4 ts=4