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 Lesser 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 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser 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-2000. 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 "glibconfig.h"
36 #include <sys/types.h>
43 #include <io.h> /* For open() and close() prototypes. */
46 #include "gmoduleconf.h"
50 /* We maintain a list of modules, so we can reference count them.
51 * That's needed because some platforms don't support refernce counts on
52 * modules e.g. the shl_* implementation of HP-UX
53 * (http://www.stat.umn.edu/~luke/xls/projects/dlbasics/dlbasics.html).
54 * Also, the module for the program itself is kept seperatedly for
55 * faster access and because it has special semantics.
59 /* --- structures --- */
68 guint is_resident : 1;
74 /* --- prototypes --- */
75 static gpointer _g_module_open (const gchar *file_name,
78 static void _g_module_close (gpointer handle,
80 static gpointer _g_module_self (void);
81 static gpointer _g_module_symbol (gpointer handle,
82 const gchar *symbol_name);
83 static gchar* _g_module_build_path (const gchar *directory,
84 const gchar *module_name);
85 static inline void g_module_set_error (const gchar *error);
86 static inline GModule* g_module_find_by_handle (gpointer handle);
87 static inline GModule* g_module_find_by_name (const gchar *name);
90 /* --- variables --- */
91 static GModule *modules = NULL;
92 static GModule *main_module = NULL;
93 static GStaticPrivate module_error_private = G_STATIC_PRIVATE_INIT;
94 static gboolean module_debug_initialized = FALSE;
95 static guint module_debug_flags = 0;
98 /* --- inline functions --- */
99 static inline GModule*
100 g_module_find_by_handle (gpointer handle)
103 GModule *retval = NULL;
105 if (main_module && main_module->handle == handle)
106 retval = main_module;
108 for (module = modules; module; module = module->next)
109 if (handle == module->handle)
118 static inline GModule*
119 g_module_find_by_name (const gchar *name)
122 GModule *retval = NULL;
124 for (module = modules; module; module = module->next)
125 if (strcmp (name, module->file_name) == 0)
135 g_module_set_error_unduped (gchar *error)
137 g_static_private_set (&module_error_private, error, g_free);
142 g_module_set_error (const gchar *error)
144 g_module_set_error_unduped (g_strdup (error));
148 /* --- include platform specifc code --- */
149 #define SUPPORT_OR_RETURN(rv) { g_module_set_error (NULL); }
150 #if (G_MODULE_IMPL == G_MODULE_IMPL_DL)
151 #include "gmodule-dl.c"
152 #elif (G_MODULE_IMPL == G_MODULE_IMPL_DLD)
153 #include "gmodule-dld.c"
154 #elif (G_MODULE_IMPL == G_MODULE_IMPL_WIN32)
155 #include "gmodule-win32.c"
156 #elif (G_MODULE_IMPL == G_MODULE_IMPL_DYLD)
157 #include "gmodule-dyld.c"
158 #elif (G_MODULE_IMPL == G_MODULE_IMPL_AR)
159 #include "gmodule-ar.c"
161 #undef SUPPORT_OR_RETURN
162 #define SUPPORT_OR_RETURN(rv) { g_module_set_error ("dynamic modules are " \
163 "not supported by this system"); return rv; }
165 _g_module_open (const gchar *file_name,
172 _g_module_close (gpointer handle,
177 _g_module_self (void)
182 _g_module_symbol (gpointer handle,
183 const gchar *symbol_name)
188 _g_module_build_path (const gchar *directory,
189 const gchar *module_name)
193 #endif /* no implementation */
195 /* --- functions --- */
197 g_module_supported (void)
199 SUPPORT_OR_RETURN (FALSE);
205 parse_libtool_archive (const gchar* libtool_name)
207 const guint TOKEN_DLNAME = G_TOKEN_LAST + 1;
208 const guint TOKEN_INSTALLED = G_TOKEN_LAST + 2;
209 const guint TOKEN_LIBDIR = G_TOKEN_LAST + 3;
210 gchar *lt_dlname = NULL;
211 gboolean lt_installed = TRUE;
212 gchar *lt_libdir = NULL;
217 int fd = g_open (libtool_name, O_RDONLY, 0);
220 gchar *display_libtool_name = g_filename_display_name (libtool_name);
221 g_module_set_error_unduped (g_strdup_printf ("failed to open libtool archive \"%s\"", display_libtool_name));
222 g_free (display_libtool_name);
225 /* search libtool's dlname specification */
226 scanner = g_scanner_new (NULL);
227 g_scanner_input_file (scanner, fd);
228 scanner->config->symbol_2_token = TRUE;
229 g_scanner_scope_add_symbol (scanner, 0, "dlname",
230 GUINT_TO_POINTER (TOKEN_DLNAME));
231 g_scanner_scope_add_symbol (scanner, 0, "installed",
232 GUINT_TO_POINTER (TOKEN_INSTALLED));
233 g_scanner_scope_add_symbol (scanner, 0, "libdir",
234 GUINT_TO_POINTER (TOKEN_LIBDIR));
235 while (!g_scanner_eof (scanner))
237 token = g_scanner_get_next_token (scanner);
238 if (token == TOKEN_DLNAME || token == TOKEN_INSTALLED ||
239 token == TOKEN_LIBDIR)
241 if (g_scanner_get_next_token (scanner) != '=' ||
242 g_scanner_get_next_token (scanner) !=
243 (token == TOKEN_INSTALLED ?
244 G_TOKEN_IDENTIFIER : G_TOKEN_STRING))
246 gchar *display_libtool_name = g_filename_display_name (libtool_name);
247 g_module_set_error_unduped (g_strdup_printf ("unable to parse libtool archive \"%s\"", display_libtool_name));
248 g_free (display_libtool_name);
252 g_scanner_destroy (scanner);
259 if (token == TOKEN_DLNAME)
262 lt_dlname = g_strdup (scanner->value.v_string);
264 else if (token == TOKEN_INSTALLED)
266 strcmp (scanner->value.v_identifier, "yes") == 0;
267 else /* token == TOKEN_LIBDIR */
270 lt_libdir = g_strdup (scanner->value.v_string);
278 gchar *dir = g_path_get_dirname (libtool_name);
280 lt_libdir = g_strconcat (dir, G_DIR_SEPARATOR_S ".libs", NULL);
284 name = g_strconcat (lt_libdir, G_DIR_SEPARATOR_S, lt_dlname, NULL);
288 g_scanner_destroy (scanner);
294 static inline gboolean
295 str_check_suffix (const gchar* string,
298 gsize string_len = strlen (string);
299 gsize suffix_len = strlen (suffix);
301 return string_len >= suffix_len &&
302 strcmp (string + string_len - suffix_len, suffix) == 0;
307 G_MODULE_DEBUG_RESIDENT_MODULES = 1 << 0,
308 G_MODULE_DEBUG_BIND_NOW_MODULES = 1 << 1
312 _g_module_debug_init (void)
314 const GDebugKey keys[] = {
315 { "resident-modules", G_MODULE_DEBUG_RESIDENT_MODULES },
316 { "bind-now-modules", G_MODULE_DEBUG_BIND_NOW_MODULES }
320 env = g_getenv ("G_DEBUG");
323 !env ? 0 : g_parse_debug_string (env, keys, G_N_ELEMENTS (keys));
325 module_debug_initialized = TRUE;
328 static GStaticRecMutex g_module_global_lock = G_STATIC_REC_MUTEX_INIT;
331 g_module_open (const gchar *file_name,
335 gpointer handle = NULL;
338 SUPPORT_OR_RETURN (NULL);
340 g_static_rec_mutex_lock (&g_module_global_lock);
342 if (G_UNLIKELY (!module_debug_initialized))
343 _g_module_debug_init ();
345 if (module_debug_flags & G_MODULE_DEBUG_BIND_NOW_MODULES)
346 flags &= ~G_MODULE_BIND_LAZY;
352 handle = _g_module_self ();
355 main_module = g_new (GModule, 1);
356 main_module->file_name = NULL;
358 main_module->cp_file_name = NULL;
360 main_module->handle = handle;
361 main_module->ref_count = 1;
362 main_module->is_resident = TRUE;
363 main_module->unload = NULL;
364 main_module->next = NULL;
368 main_module->ref_count++;
370 g_static_rec_mutex_unlock (&g_module_global_lock);
374 /* we first search the module list by name */
375 module = g_module_find_by_name (file_name);
380 g_static_rec_mutex_unlock (&g_module_global_lock);
384 /* check whether we have a readable file right away */
385 if (g_file_test (file_name, G_FILE_TEST_IS_REGULAR))
386 name = g_strdup (file_name);
387 /* try completing file name with standard library suffix */
390 name = g_strconcat (file_name, "." G_MODULE_SUFFIX, NULL);
391 if (!g_file_test (name, G_FILE_TEST_IS_REGULAR))
397 /* try completing by appending libtool suffix */
400 name = g_strconcat (file_name, ".la", NULL);
401 if (!g_file_test (name, G_FILE_TEST_IS_REGULAR))
407 /* we can't access() the file, lets hope the platform backends finds
408 * it via library paths
412 gchar *dot = strrchr (file_name, '.');
413 gchar *slash = strrchr (file_name, G_DIR_SEPARATOR);
415 /* make sure the name has a suffix */
416 if (!dot || dot < slash)
417 name = g_strconcat (file_name, "." G_MODULE_SUFFIX, NULL);
419 name = g_strdup (file_name);
422 /* ok, try loading the module */
425 /* if it's a libtool archive, figure library file to load */
426 if (str_check_suffix (name, ".la")) /* libtool archive? */
428 gchar *real_name = parse_libtool_archive (name);
430 /* real_name might be NULL, but then module error is already set */
435 handle = _g_module_open (name, (flags & G_MODULE_BIND_LAZY) != 0,
436 (flags & G_MODULE_BIND_LOCAL) != 0);
440 gchar *display_file_name = g_filename_display_name (file_name);
441 g_module_set_error_unduped (g_strdup_printf ("unable to access file \"%s\"", display_file_name));
442 g_free (display_file_name);
449 GModuleCheckInit check_init;
450 const gchar *check_failed = NULL;
452 /* search the module list by handle, since file names are not unique */
453 module = g_module_find_by_handle (handle);
456 _g_module_close (module->handle, TRUE);
458 g_module_set_error (NULL);
460 g_static_rec_mutex_unlock (&g_module_global_lock);
464 saved_error = g_strdup (g_module_error ());
465 g_module_set_error (NULL);
467 module = g_new (GModule, 1);
468 module->file_name = g_strdup (file_name);
470 module->cp_file_name = g_locale_from_utf8 (file_name, -1,
473 module->handle = handle;
474 module->ref_count = 1;
475 module->is_resident = FALSE;
476 module->unload = NULL;
477 module->next = modules;
480 /* check initialization */
481 if (g_module_symbol (module, "g_module_check_init", (gpointer) &check_init) && check_init != NULL)
482 check_failed = check_init (module);
484 /* we don't call unload() if the initialization check failed. */
486 g_module_symbol (module, "g_module_unload", (gpointer) &module->unload);
492 error = g_strconcat ("GModule (",
493 file_name ? file_name : "NULL",
494 ") initialization check failed: ",
496 g_module_close (module);
498 g_module_set_error (error);
502 g_module_set_error (saved_error);
504 g_free (saved_error);
507 if (module != NULL &&
508 (module_debug_flags & G_MODULE_DEBUG_RESIDENT_MODULES))
509 g_module_make_resident (module);
511 g_static_rec_mutex_unlock (&g_module_global_lock);
520 g_module_open (const gchar *file_name,
523 gchar *utf8_file_name = g_locale_to_utf8 (file_name, -1, NULL, NULL, NULL);
524 GModule *retval = g_module_open_utf8 (utf8_file_name, flags);
526 g_free (utf8_file_name);
534 g_module_close (GModule *module)
536 SUPPORT_OR_RETURN (FALSE);
538 g_return_val_if_fail (module != NULL, FALSE);
539 g_return_val_if_fail (module->ref_count > 0, FALSE);
541 g_static_rec_mutex_lock (&g_module_global_lock);
545 if (!module->ref_count && !module->is_resident && module->unload)
547 GModuleUnload unload;
549 unload = module->unload;
550 module->unload = NULL;
554 if (!module->ref_count && !module->is_resident)
567 last->next = node->next;
569 modules = node->next;
577 _g_module_close (module->handle, FALSE);
578 g_free (module->file_name);
580 g_free (module->cp_file_name);
585 g_static_rec_mutex_unlock (&g_module_global_lock);
586 return g_module_error() == NULL;
590 g_module_make_resident (GModule *module)
592 g_return_if_fail (module != NULL);
594 module->is_resident = TRUE;
597 G_CONST_RETURN gchar*
598 g_module_error (void)
600 return g_static_private_get (&module_error_private);
604 g_module_symbol (GModule *module,
605 const gchar *symbol_name,
608 const gchar *module_error;
612 SUPPORT_OR_RETURN (FALSE);
614 g_return_val_if_fail (module != NULL, FALSE);
615 g_return_val_if_fail (symbol_name != NULL, FALSE);
616 g_return_val_if_fail (symbol != NULL, FALSE);
618 g_static_rec_mutex_lock (&g_module_global_lock);
620 #ifdef G_MODULE_NEED_USCORE
624 name = g_strconcat ("_", symbol_name, NULL);
625 *symbol = _g_module_symbol (module->handle, name);
628 #else /* !G_MODULE_NEED_USCORE */
629 *symbol = _g_module_symbol (module->handle, symbol_name);
630 #endif /* !G_MODULE_NEED_USCORE */
632 module_error = g_module_error ();
637 error = g_strconcat ("`", symbol_name, "': ", module_error, NULL);
638 g_module_set_error (error);
643 g_static_rec_mutex_unlock (&g_module_global_lock);
644 return !module_error;
647 G_CONST_RETURN gchar*
648 g_module_name (GModule *module)
650 g_return_val_if_fail (module != NULL, NULL);
652 if (module == main_module)
655 return module->file_name;
662 G_CONST_RETURN gchar*
663 g_module_name (GModule *module)
665 g_return_val_if_fail (module != NULL, NULL);
667 if (module == main_module)
670 return module->cp_file_name;
676 g_module_build_path (const gchar *directory,
677 const gchar *module_name)
679 g_return_val_if_fail (module_name != NULL, NULL);
681 return _g_module_build_path (directory, module_name);