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