xref: /PHP-7.3/Zend/zend_extensions.c (revision 9afce019)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) 1998-2018 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 #include "zend_extensions.h"
21 
22 ZEND_API zend_llist zend_extensions;
23 ZEND_API uint32_t zend_extension_flags = 0;
24 static int last_resource_number;
25 
zend_load_extension(const char * path)26 int zend_load_extension(const char *path)
27 {
28 #if ZEND_EXTENSIONS_SUPPORT
29 	DL_HANDLE handle;
30 
31 	handle = DL_LOAD(path);
32 	if (!handle) {
33 #ifndef ZEND_WIN32
34 		fprintf(stderr, "Failed loading %s:  %s\n", path, DL_ERROR());
35 #else
36 		fprintf(stderr, "Failed loading %s\n", path);
37 		/* See http://support.microsoft.com/kb/190351 */
38 		fflush(stderr);
39 #endif
40 		return FAILURE;
41 	}
42 	return zend_load_extension_handle(handle, path);
43 #else
44 	fprintf(stderr, "Extensions are not supported on this platform.\n");
45 /* See http://support.microsoft.com/kb/190351 */
46 #ifdef ZEND_WIN32
47 	fflush(stderr);
48 #endif
49 	return FAILURE;
50 #endif
51 }
52 
zend_load_extension_handle(DL_HANDLE handle,const char * path)53 int zend_load_extension_handle(DL_HANDLE handle, const char *path)
54 {
55 #if ZEND_EXTENSIONS_SUPPORT
56 	zend_extension *new_extension;
57 	zend_extension_version_info *extension_version_info;
58 
59 	extension_version_info = (zend_extension_version_info *) DL_FETCH_SYMBOL(handle, "extension_version_info");
60 	if (!extension_version_info) {
61 		extension_version_info = (zend_extension_version_info *) DL_FETCH_SYMBOL(handle, "_extension_version_info");
62 	}
63 	new_extension = (zend_extension *) DL_FETCH_SYMBOL(handle, "zend_extension_entry");
64 	if (!new_extension) {
65 		new_extension = (zend_extension *) DL_FETCH_SYMBOL(handle, "_zend_extension_entry");
66 	}
67 	if (!extension_version_info || !new_extension) {
68 		fprintf(stderr, "%s doesn't appear to be a valid Zend extension\n", path);
69 /* See http://support.microsoft.com/kb/190351 */
70 #ifdef ZEND_WIN32
71 		fflush(stderr);
72 #endif
73 		DL_UNLOAD(handle);
74 		return FAILURE;
75 	}
76 
77 	/* allow extension to proclaim compatibility with any Zend version */
78 	if (extension_version_info->zend_extension_api_no != ZEND_EXTENSION_API_NO &&(!new_extension->api_no_check || new_extension->api_no_check(ZEND_EXTENSION_API_NO) != SUCCESS)) {
79 		if (extension_version_info->zend_extension_api_no > ZEND_EXTENSION_API_NO) {
80 			fprintf(stderr, "%s requires Zend Engine API version %d.\n"
81 					"The Zend Engine API version %d which is installed, is outdated.\n\n",
82 					new_extension->name,
83 					extension_version_info->zend_extension_api_no,
84 					ZEND_EXTENSION_API_NO);
85 /* See http://support.microsoft.com/kb/190351 */
86 #ifdef ZEND_WIN32
87 			fflush(stderr);
88 #endif
89 			DL_UNLOAD(handle);
90 			return FAILURE;
91 		} else if (extension_version_info->zend_extension_api_no < ZEND_EXTENSION_API_NO) {
92 			fprintf(stderr, "%s requires Zend Engine API version %d.\n"
93 					"The Zend Engine API version %d which is installed, is newer.\n"
94 					"Contact %s at %s for a later version of %s.\n\n",
95 					new_extension->name,
96 					extension_version_info->zend_extension_api_no,
97 					ZEND_EXTENSION_API_NO,
98 					new_extension->author,
99 					new_extension->URL,
100 					new_extension->name);
101 /* See http://support.microsoft.com/kb/190351 */
102 #ifdef ZEND_WIN32
103 			fflush(stderr);
104 #endif
105 			DL_UNLOAD(handle);
106 			return FAILURE;
107 		}
108 	} else if (strcmp(ZEND_EXTENSION_BUILD_ID, extension_version_info->build_id) &&
109 	           (!new_extension->build_id_check || new_extension->build_id_check(ZEND_EXTENSION_BUILD_ID) != SUCCESS)) {
110 		fprintf(stderr, "Cannot load %s - it was built with configuration %s, whereas running engine is %s\n",
111 					new_extension->name, extension_version_info->build_id, ZEND_EXTENSION_BUILD_ID);
112 /* See http://support.microsoft.com/kb/190351 */
113 #ifdef ZEND_WIN32
114 		fflush(stderr);
115 #endif
116 		DL_UNLOAD(handle);
117 		return FAILURE;
118 	} else if (zend_get_extension(new_extension->name)) {
119 		fprintf(stderr, "Cannot load %s - it was already loaded\n", new_extension->name);
120 /* See http://support.microsoft.com/kb/190351 */
121 #ifdef ZEND_WIN32
122 		fflush(stderr);
123 #endif
124 		DL_UNLOAD(handle);
125 		return FAILURE;
126 	}
127 
128 	return zend_register_extension(new_extension, handle);
129 #else
130 	fprintf(stderr, "Extensions are not supported on this platform.\n");
131 /* See http://support.microsoft.com/kb/190351 */
132 #ifdef ZEND_WIN32
133 	fflush(stderr);
134 #endif
135 	return FAILURE;
136 #endif
137 }
138 
139 
zend_register_extension(zend_extension * new_extension,DL_HANDLE handle)140 int zend_register_extension(zend_extension *new_extension, DL_HANDLE handle)
141 {
142 #if ZEND_EXTENSIONS_SUPPORT
143 	zend_extension extension;
144 
145 	extension = *new_extension;
146 	extension.handle = handle;
147 
148 	zend_extension_dispatch_message(ZEND_EXTMSG_NEW_EXTENSION, &extension);
149 
150 	zend_llist_add_element(&zend_extensions, &extension);
151 
152 	if (extension.op_array_ctor) {
153 		zend_extension_flags |= ZEND_EXTENSIONS_HAVE_OP_ARRAY_CTOR;
154 	}
155 	if (extension.op_array_dtor) {
156 		zend_extension_flags |= ZEND_EXTENSIONS_HAVE_OP_ARRAY_DTOR;
157 	}
158 	if (extension.op_array_handler) {
159 		zend_extension_flags |= ZEND_EXTENSIONS_HAVE_OP_ARRAY_HANDLER;
160 	}
161 	if (extension.op_array_persist_calc) {
162 		zend_extension_flags |= ZEND_EXTENSIONS_HAVE_OP_ARRAY_PERSIST_CALC;
163 	}
164 	if (extension.op_array_persist) {
165 		zend_extension_flags |= ZEND_EXTENSIONS_HAVE_OP_ARRAY_PERSIST;
166 	}
167 	/*fprintf(stderr, "Loaded %s, version %s\n", extension.name, extension.version);*/
168 #endif
169 
170 	return SUCCESS;
171 }
172 
173 
zend_extension_shutdown(zend_extension * extension)174 static void zend_extension_shutdown(zend_extension *extension)
175 {
176 #if ZEND_EXTENSIONS_SUPPORT
177 	if (extension->shutdown) {
178 		extension->shutdown(extension);
179 	}
180 #endif
181 }
182 
zend_extension_startup(zend_extension * extension)183 static int zend_extension_startup(zend_extension *extension)
184 {
185 #if ZEND_EXTENSIONS_SUPPORT
186 	if (extension->startup) {
187 		if (extension->startup(extension)!=SUCCESS) {
188 			return 1;
189 		}
190 		zend_append_version_info(extension);
191 	}
192 #endif
193 	return 0;
194 }
195 
196 
zend_startup_extensions_mechanism()197 int zend_startup_extensions_mechanism()
198 {
199 	/* Startup extensions mechanism */
200 	zend_llist_init(&zend_extensions, sizeof(zend_extension), (void (*)(void *)) zend_extension_dtor, 1);
201 	last_resource_number = 0;
202 	return SUCCESS;
203 }
204 
205 
zend_startup_extensions()206 int zend_startup_extensions()
207 {
208 	zend_llist_apply_with_del(&zend_extensions, (int (*)(void *)) zend_extension_startup);
209 	return SUCCESS;
210 }
211 
212 
zend_shutdown_extensions(void)213 void zend_shutdown_extensions(void)
214 {
215 	zend_llist_apply(&zend_extensions, (llist_apply_func_t) zend_extension_shutdown);
216 	zend_llist_destroy(&zend_extensions);
217 }
218 
219 
zend_extension_dtor(zend_extension * extension)220 void zend_extension_dtor(zend_extension *extension)
221 {
222 #if ZEND_EXTENSIONS_SUPPORT && !ZEND_DEBUG
223 	if (extension->handle && !getenv("ZEND_DONT_UNLOAD_MODULES")) {
224 		DL_UNLOAD(extension->handle);
225 	}
226 #endif
227 }
228 
229 
zend_extension_message_dispatcher(const zend_extension * extension,int num_args,va_list args)230 static void zend_extension_message_dispatcher(const zend_extension *extension, int num_args, va_list args)
231 {
232 	int message;
233 	void *arg;
234 
235 	if (!extension->message_handler || num_args!=2) {
236 		return;
237 	}
238 	message = va_arg(args, int);
239 	arg = va_arg(args, void *);
240 	extension->message_handler(message, arg);
241 }
242 
243 
zend_extension_dispatch_message(int message,void * arg)244 ZEND_API void zend_extension_dispatch_message(int message, void *arg)
245 {
246 	zend_llist_apply_with_arguments(&zend_extensions, (llist_apply_with_args_func_t) zend_extension_message_dispatcher, 2, message, arg);
247 }
248 
249 
zend_get_resource_handle(zend_extension * extension)250 ZEND_API int zend_get_resource_handle(zend_extension *extension)
251 {
252 	if (last_resource_number<ZEND_MAX_RESERVED_RESOURCES) {
253 		extension->resource_number = last_resource_number;
254 		return last_resource_number++;
255 	} else {
256 		return -1;
257 	}
258 }
259 
260 
zend_get_extension(const char * extension_name)261 ZEND_API zend_extension *zend_get_extension(const char *extension_name)
262 {
263 	zend_llist_element *element;
264 
265 	for (element = zend_extensions.head; element; element = element->next) {
266 		zend_extension *extension = (zend_extension *) element->data;
267 
268 		if (!strcmp(extension->name, extension_name)) {
269 			return extension;
270 		}
271 	}
272 	return NULL;
273 }
274 
275 typedef struct _zend_extension_persist_data {
276 	zend_op_array *op_array;
277 	size_t         size;
278 	char          *mem;
279 } zend_extension_persist_data;
280 
zend_extension_op_array_persist_calc_handler(zend_extension * extension,zend_extension_persist_data * data)281 static void zend_extension_op_array_persist_calc_handler(zend_extension *extension, zend_extension_persist_data *data)
282 {
283 	if (extension->op_array_persist_calc) {
284 		data->size += extension->op_array_persist_calc(data->op_array);
285 	}
286 }
287 
zend_extension_op_array_persist_handler(zend_extension * extension,zend_extension_persist_data * data)288 static void zend_extension_op_array_persist_handler(zend_extension *extension, zend_extension_persist_data *data)
289 {
290 	if (extension->op_array_persist) {
291 		size_t size = extension->op_array_persist(data->op_array, data->mem);
292 		if (size) {
293 			data->mem = (void*)((char*)data->mem + size);
294 			data->size += size;
295 		}
296 	}
297 }
298 
zend_extensions_op_array_persist_calc(zend_op_array * op_array)299 ZEND_API size_t zend_extensions_op_array_persist_calc(zend_op_array *op_array)
300 {
301 	if (zend_extension_flags & ZEND_EXTENSIONS_HAVE_OP_ARRAY_PERSIST_CALC) {
302 		zend_extension_persist_data data;
303 
304 		data.op_array = op_array;
305 		data.size = 0;
306 		data.mem  = NULL;
307 		zend_llist_apply_with_argument(&zend_extensions, (llist_apply_with_arg_func_t) zend_extension_op_array_persist_calc_handler, &data);
308 		return data.size;
309 	}
310 	return 0;
311 }
312 
zend_extensions_op_array_persist(zend_op_array * op_array,void * mem)313 ZEND_API size_t zend_extensions_op_array_persist(zend_op_array *op_array, void *mem)
314 {
315 	if (zend_extension_flags & ZEND_EXTENSIONS_HAVE_OP_ARRAY_PERSIST) {
316 		zend_extension_persist_data data;
317 
318 		data.op_array = op_array;
319 		data.size = 0;
320 		data.mem  = mem;
321 		zend_llist_apply_with_argument(&zend_extensions, (llist_apply_with_arg_func_t) zend_extension_op_array_persist_handler, &data);
322 		return data.size;
323 	}
324 	return 0;
325 }
326 
327 /*
328  * Local variables:
329  * tab-width: 4
330  * c-basic-offset: 4
331  * indent-tabs-mode: t
332  * End:
333  * vim600: sw=4 ts=4 fdm=marker
334  * vim<600: sw=4 ts=4
335  */
336