1 /* GMODULE - GLIB wrapper code for dynamic module loading
2 * Copyright (C) 1998 Tim Janik
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-1999. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
32 #include "gmoduleconf.h"
37 /* We maintain a list of modules, so we can reference count them.
38 * That's needed because some platforms don't support refernce counts on
39 * modules e.g. the shl_* implementation of HP-UX
40 * (http://www.stat.umn.edu/~luke/xls/projects/dlbasics/dlbasics.html).
41 * Also, the module for the program itself is kept seperatedly for
42 * faster access and because it has special semantics.
46 /* --- structures --- */
52 guint is_resident : 1;
58 /* --- prototypes --- */
59 static gpointer _g_module_open (const gchar *file_name,
61 static void _g_module_close (gpointer handle,
63 static gpointer _g_module_self (void);
64 static gpointer _g_module_symbol (gpointer handle,
65 const gchar *symbol_name);
66 static gchar* _g_module_build_path (const gchar *directory,
67 const gchar *module_name);
68 static inline void g_module_set_error (const gchar *error);
69 static inline GModule* g_module_find_by_handle (gpointer handle);
70 static inline GModule* g_module_find_by_name (const gchar *name);
73 /* --- variables --- */
74 G_LOCK_DEFINE_STATIC (GModule);
75 const char *g_log_domain_gmodule = "GModule";
76 static GModule *modules = NULL;
77 static GModule *main_module = NULL;
78 static GStaticPrivate module_error_private = G_STATIC_PRIVATE_INIT;
81 /* --- inline functions --- */
82 static inline GModule*
83 g_module_find_by_handle (gpointer handle)
86 GModule *retval = NULL;
89 if (main_module && main_module->handle == handle)
92 for (module = modules; module; module = module->next)
93 if (handle == module->handle)
103 static inline GModule*
104 g_module_find_by_name (const gchar *name)
107 GModule *retval = NULL;
110 for (module = modules; module; module = module->next)
111 if (strcmp (name, module->file_name) == 0)
122 g_module_set_error (const gchar *error)
124 g_static_private_set (&module_error_private, g_strdup (error), g_free);
129 /* --- include platform specifc code --- */
130 #define CHECK_ERROR(rv) { g_module_set_error (NULL); }
131 #if (G_MODULE_IMPL == G_MODULE_IMPL_DL)
132 #include "gmodule-dl.c"
133 #elif (G_MODULE_IMPL == G_MODULE_IMPL_DLD)
134 #include "gmodule-dld.c"
135 #elif (G_MODULE_IMPL == G_MODULE_IMPL_WIN32)
136 #include "gmodule-win32.c"
137 #elif (G_MODULE_IMPL == G_MODULE_IMPL_OS2)
138 #include "gmodule-os2.c"
141 #define CHECK_ERROR(rv) { g_module_set_error ("dynamic modules are " \
142 "not supported by this system"); return rv; }
144 _g_module_open (const gchar *file_name,
150 _g_module_close (gpointer handle,
155 _g_module_self (void)
160 _g_module_symbol (gpointer handle,
161 const gchar *symbol_name)
166 _g_module_build_path (const gchar *directory,
167 const gchar *module_name)
171 #endif /* no implementation */
173 #if defined (NATIVE_WIN32) && defined (__LCC__)
175 LibMain (void *hinstDll,
176 unsigned long dwReason,
181 #endif /* NATIVE_WIN32 && __LCC__ */
184 /* --- functions --- */
186 g_module_supported (void)
194 g_module_open (const gchar *file_name,
207 handle = _g_module_self ();
210 main_module = g_new (GModule, 1);
211 main_module->file_name = NULL;
212 main_module->handle = handle;
213 main_module->ref_count = 1;
214 main_module->is_resident = TRUE;
215 main_module->unload = NULL;
216 main_module->next = NULL;
224 /* we first search the module list by name */
225 module = g_module_find_by_name (file_name);
233 /* open the module */
234 handle = _g_module_open (file_name, (flags & G_MODULE_BIND_LAZY) != 0);
238 GModuleCheckInit check_init;
239 const gchar *check_failed = NULL;
241 /* search the module list by handle, since file names are not unique */
242 module = g_module_find_by_handle (handle);
245 _g_module_close (module->handle, TRUE);
247 g_module_set_error (NULL);
252 saved_error = g_strdup (g_module_error ());
253 g_module_set_error (NULL);
255 module = g_new (GModule, 1);
256 module->file_name = g_strdup (file_name);
257 module->handle = handle;
258 module->ref_count = 1;
259 module->is_resident = FALSE;
260 module->unload = NULL;
262 module->next = modules;
266 /* check initialization */
267 if (g_module_symbol (module, "g_module_check_init", (gpointer) &check_init))
268 check_failed = check_init (module);
270 /* we don't call unload() if the initialization check failed. */
272 g_module_symbol (module, "g_module_unload", (gpointer) &module->unload);
278 error = g_strconcat ("GModule initialization check failed: ", check_failed, NULL);
279 g_module_close (module);
281 g_module_set_error (error);
285 g_module_set_error (saved_error);
287 g_free (saved_error);
294 g_module_close (GModule *module)
298 g_return_val_if_fail (module != NULL, FALSE);
299 g_return_val_if_fail (module->ref_count > 0, FALSE);
303 if (!module->ref_count && !module->is_resident && module->unload)
305 GModuleUnload unload;
307 unload = module->unload;
308 module->unload = NULL;
312 if (!module->ref_count && !module->is_resident)
326 last->next = node->next;
328 modules = node->next;
337 _g_module_close (module->handle, FALSE);
338 g_free (module->file_name);
343 return g_module_error() == NULL;
347 g_module_make_resident (GModule *module)
349 g_return_if_fail (module != NULL);
351 module->is_resident = TRUE;
355 g_module_error (void)
357 return g_static_private_get (&module_error_private);
361 g_module_symbol (GModule *module,
362 const gchar *symbol_name,
370 g_return_val_if_fail (module != NULL, FALSE);
371 g_return_val_if_fail (symbol_name != NULL, FALSE);
372 g_return_val_if_fail (symbol != NULL, FALSE);
374 #ifdef G_MODULE_NEED_USCORE
378 name = g_strconcat ("_", symbol_name, NULL);
379 *symbol = _g_module_symbol (module->handle, name);
382 #else /* !G_MODULE_NEED_USCORE */
383 *symbol = _g_module_symbol (module->handle, symbol_name);
384 #endif /* !G_MODULE_NEED_USCORE */
386 if ((module_error = g_module_error()))
390 error = g_strconcat ("`", symbol_name, "': ", module_error, NULL);
391 g_module_set_error (error);
401 g_module_name (GModule *module)
403 g_return_val_if_fail (module != NULL, NULL);
405 if (module == main_module)
408 return module->file_name;
412 g_module_build_path (const gchar *directory,
413 const gchar *module_name)
415 g_return_val_if_fail (module_name != NULL, NULL);
417 return _g_module_build_path (directory, module_name);