xref: /PHP-7.4/Zend/zend_list.h (revision c7962207)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) 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@php.net>                                 |
16    |          Zeev Suraski <zeev@php.net>                                 |
17    +----------------------------------------------------------------------+
18 */
19 
20 #ifndef ZEND_LIST_H
21 #define ZEND_LIST_H
22 
23 #include "zend_hash.h"
24 #include "zend_globals.h"
25 
26 BEGIN_EXTERN_C()
27 
28 typedef void (*rsrc_dtor_func_t)(zend_resource *res);
29 #define ZEND_RSRC_DTOR_FUNC(name) void name(zend_resource *res)
30 
31 typedef struct _zend_rsrc_list_dtors_entry {
32 	rsrc_dtor_func_t list_dtor_ex;
33 	rsrc_dtor_func_t plist_dtor_ex;
34 
35 	const char *type_name;
36 
37 	int module_number;
38 	int resource_id;
39 } zend_rsrc_list_dtors_entry;
40 
41 
42 ZEND_API int zend_register_list_destructors_ex(rsrc_dtor_func_t ld, rsrc_dtor_func_t pld, const char *type_name, int module_number);
43 
44 void list_entry_destructor(zval *ptr);
45 void plist_entry_destructor(zval *ptr);
46 
47 void zend_clean_module_rsrc_dtors(int module_number);
48 ZEND_API int zend_init_rsrc_list(void); /* Exported for phar hack */
49 int zend_init_rsrc_plist(void);
50 void zend_close_rsrc_list(HashTable *ht);
51 void zend_destroy_rsrc_list(HashTable *ht);
52 int zend_init_rsrc_list_dtors(void);
53 void zend_destroy_rsrc_list_dtors(void);
54 
55 ZEND_API zval* ZEND_FASTCALL zend_list_insert(void *ptr, int type);
56 ZEND_API int ZEND_FASTCALL zend_list_free(zend_resource *res);
57 ZEND_API int ZEND_FASTCALL zend_list_delete(zend_resource *res);
58 ZEND_API int ZEND_FASTCALL zend_list_close(zend_resource *res);
59 
60 ZEND_API zend_resource *zend_register_resource(void *rsrc_pointer, int rsrc_type);
61 ZEND_API void *zend_fetch_resource(zend_resource *res, const char *resource_type_name, int resource_type);
62 ZEND_API void *zend_fetch_resource2(zend_resource *res, const char *resource_type_name, int resource_type, int resource_type2);
63 ZEND_API void *zend_fetch_resource_ex(zval *res, const char *resource_type_name, int resource_type);
64 ZEND_API void *zend_fetch_resource2_ex(zval *res, const char *resource_type_name, int resource_type, int resource_type2);
65 
66 ZEND_API const char *zend_rsrc_list_get_rsrc_type(zend_resource *res);
67 ZEND_API int zend_fetch_list_dtor_id(const char *type_name);
68 
69 ZEND_API zend_resource* zend_register_persistent_resource(const char *key, size_t key_len, void *rsrc_pointer, int rsrc_type);
70 ZEND_API zend_resource* zend_register_persistent_resource_ex(zend_string *key, void *rsrc_pointer, int rsrc_type);
71 
72 extern ZEND_API int le_index_ptr;  /* list entry type for index pointers */
73 
74 END_EXTERN_C()
75 
76 #endif
77