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/.
36 #include "gmoduleconf.h"
39 #include <sys/types.h>
45 #if defined (G_OS_WIN32)
46 # include <io.h> /* For open() and close() prototypes. */
49 /* We maintain a list of modules, so we can reference count them.
50 * That's needed because some platforms don't support refernce counts on
51 * modules e.g. the shl_* implementation of HP-UX
52 * (http://www.stat.umn.edu/~luke/xls/projects/dlbasics/dlbasics.html).
53 * Also, the module for the program itself is kept seperatedly for
54 * faster access and because it has special semantics.
58 /* --- structures --- */
67 guint is_resident
: 1;
73 /* --- prototypes --- */
74 static gpointer
_g_module_open (const gchar
*file_name
,
77 static void _g_module_close (gpointer handle
,
79 static gpointer
_g_module_self (void);
80 static gpointer
_g_module_symbol (gpointer handle
,
81 const gchar
*symbol_name
);
82 static gchar
* _g_module_build_path (const gchar
*directory
,
83 const gchar
*module_name
);
84 static inline void g_module_set_error (const gchar
*error
);
85 static inline GModule
* g_module_find_by_handle (gpointer handle
);
86 static inline GModule
* g_module_find_by_name (const gchar
*name
);
89 /* --- variables --- */
90 static GModule
*modules
= NULL
;
91 static GModule
*main_module
= NULL
;
92 static GStaticPrivate module_error_private
= G_STATIC_PRIVATE_INIT
;
95 /* --- inline functions --- */
96 static inline GModule
*
97 g_module_find_by_handle (gpointer handle
)
100 GModule
*retval
= NULL
;
102 if (main_module
&& main_module
->handle
== handle
)
103 retval
= main_module
;
105 for (module
= modules
; module
; module
= module
->next
)
106 if (handle
== module
->handle
)
115 static inline GModule
*
116 g_module_find_by_name (const gchar
*name
)
119 GModule
*retval
= NULL
;
121 for (module
= modules
; module
; module
= module
->next
)
122 if (strcmp (name
, module
->file_name
) == 0)
132 g_module_set_error_unduped (gchar
*error
)
134 g_static_private_set (&module_error_private
, error
, g_free
);
139 g_module_set_error (const gchar
*error
)
141 g_module_set_error_unduped (g_strdup (error
));
145 /* --- include platform specifc code --- */
146 #define SUPPORT_OR_RETURN(rv) { g_module_set_error (NULL); }
147 #if (G_MODULE_IMPL == G_MODULE_IMPL_DL)
148 #include "gmodule-dl.c"
149 #elif (G_MODULE_IMPL == G_MODULE_IMPL_DLD)
150 #include "gmodule-dld.c"
151 #elif (G_MODULE_IMPL == G_MODULE_IMPL_WIN32)
152 #include "gmodule-win32.c"
153 #elif (G_MODULE_IMPL == G_MODULE_IMPL_DYLD)
154 #include "gmodule-dyld.c"
155 #elif (G_MODULE_IMPL == G_MODULE_IMPL_AR)
156 #include "gmodule-ar.c"
158 #undef SUPPORT_OR_RETURN
159 #define SUPPORT_OR_RETURN(rv) { g_module_set_error ("dynamic modules are " \
160 "not supported by this system"); return rv; }
162 _g_module_open (const gchar
*file_name
,
169 _g_module_close (gpointer handle
,
174 _g_module_self (void)
179 _g_module_symbol (gpointer handle
,
180 const gchar
*symbol_name
)
185 _g_module_build_path (const gchar
*directory
,
186 const gchar
*module_name
)
190 #endif /* no implementation */
192 /* --- functions --- */
194 g_module_supported (void)
196 SUPPORT_OR_RETURN (FALSE
);
202 parse_libtool_archive (const gchar
* libtool_name
)
204 const guint TOKEN_DLNAME
= G_TOKEN_LAST
+ 1;
205 const guint TOKEN_INSTALLED
= G_TOKEN_LAST
+ 2;
206 const guint TOKEN_LIBDIR
= G_TOKEN_LAST
+ 3;
207 gchar
*lt_dlname
= NULL
;
208 gboolean lt_installed
= TRUE
;
209 gchar
*lt_libdir
= NULL
;
214 int fd
= g_open (libtool_name
, O_RDONLY
, 0);
217 gchar
*display_libtool_name
= g_filename_display_name (libtool_name
);
218 g_module_set_error_unduped (g_strdup_printf ("failed to open libtool archive \"%s\"", display_libtool_name
));
219 g_free (display_libtool_name
);
222 /* search libtool's dlname specification */
223 scanner
= g_scanner_new (NULL
);
224 g_scanner_input_file (scanner
, fd
);
225 scanner
->config
->symbol_2_token
= TRUE
;
226 g_scanner_scope_add_symbol (scanner
, 0, "dlname",
227 GUINT_TO_POINTER (TOKEN_DLNAME
));
228 g_scanner_scope_add_symbol (scanner
, 0, "installed",
229 GUINT_TO_POINTER (TOKEN_INSTALLED
));
230 g_scanner_scope_add_symbol (scanner
, 0, "libdir",
231 GUINT_TO_POINTER (TOKEN_LIBDIR
));
232 while (!g_scanner_eof (scanner
))
234 token
= g_scanner_get_next_token (scanner
);
235 if (token
== TOKEN_DLNAME
|| token
== TOKEN_INSTALLED
||
236 token
== TOKEN_LIBDIR
)
238 if (g_scanner_get_next_token (scanner
) != '=' ||
239 g_scanner_get_next_token (scanner
) !=
240 (token
== TOKEN_INSTALLED
?
241 G_TOKEN_IDENTIFIER
: G_TOKEN_STRING
))
243 gchar
*display_libtool_name
= g_filename_display_name (libtool_name
);
244 g_module_set_error_unduped (g_strdup_printf ("unable to parse libtool archive \"%s\"", display_libtool_name
));
245 g_free (display_libtool_name
);
249 g_scanner_destroy (scanner
);
256 if (token
== TOKEN_DLNAME
)
259 lt_dlname
= g_strdup (scanner
->value
.v_string
);
261 else if (token
== TOKEN_INSTALLED
)
263 strcmp (scanner
->value
.v_identifier
, "yes") == 0;
264 else /* token == TOKEN_LIBDIR */
267 lt_libdir
= g_strdup (scanner
->value
.v_string
);
275 gchar
*dir
= g_path_get_dirname (libtool_name
);
277 lt_libdir
= g_strconcat (dir
, G_DIR_SEPARATOR_S
".libs", NULL
);
281 name
= g_strconcat (lt_libdir
, G_DIR_SEPARATOR_S
, lt_dlname
, NULL
);
285 g_scanner_destroy (scanner
);
291 static inline gboolean
292 str_check_suffix (const gchar
* string
,
295 gsize string_len
= strlen (string
);
296 gsize suffix_len
= strlen (suffix
);
298 return string_len
>= suffix_len
&&
299 strcmp (string
+ string_len
- suffix_len
, suffix
) == 0;
302 static GStaticRecMutex g_module_global_lock
= G_STATIC_REC_MUTEX_INIT
;
305 g_module_open (const gchar
*file_name
,
309 gpointer handle
= NULL
;
312 SUPPORT_OR_RETURN (NULL
);
314 g_static_rec_mutex_lock (&g_module_global_lock
);
319 handle
= _g_module_self ();
322 main_module
= g_new (GModule
, 1);
323 main_module
->file_name
= NULL
;
325 main_module
->cp_file_name
= NULL
;
327 main_module
->handle
= handle
;
328 main_module
->ref_count
= 1;
329 main_module
->is_resident
= TRUE
;
330 main_module
->unload
= NULL
;
331 main_module
->next
= NULL
;
335 main_module
->ref_count
++;
337 g_static_rec_mutex_unlock (&g_module_global_lock
);
341 /* we first search the module list by name */
342 module
= g_module_find_by_name (file_name
);
347 g_static_rec_mutex_unlock (&g_module_global_lock
);
351 /* check whether we have a readable file right away */
352 if (g_file_test (file_name
, G_FILE_TEST_IS_REGULAR
))
353 name
= g_strdup (file_name
);
354 /* try completing file name with standard library suffix */
357 name
= g_strconcat (file_name
, "." G_MODULE_SUFFIX
, NULL
);
358 if (!g_file_test (name
, G_FILE_TEST_IS_REGULAR
))
364 /* try completing by appending libtool suffix */
367 name
= g_strconcat (file_name
, ".la", NULL
);
368 if (!g_file_test (name
, G_FILE_TEST_IS_REGULAR
))
374 /* we can't access() the file, lets hope the platform backends finds
375 * it via library paths
379 gchar
*dot
= strrchr (file_name
, '.');
380 gchar
*slash
= strrchr (file_name
, G_DIR_SEPARATOR
);
382 /* make sure the name has a suffix */
383 if (!dot
|| dot
< slash
)
384 name
= g_strconcat (file_name
, "." G_MODULE_SUFFIX
, NULL
);
386 name
= g_strdup (file_name
);
389 /* ok, try loading the module */
392 /* if it's a libtool archive, figure library file to load */
393 if (str_check_suffix (name
, ".la")) /* libtool archive? */
395 gchar
*real_name
= parse_libtool_archive (name
);
397 /* real_name might be NULL, but then module error is already set */
402 handle
= _g_module_open (name
, (flags
& G_MODULE_BIND_LAZY
) != 0,
403 (flags
& G_MODULE_BIND_LOCAL
) != 0);
407 gchar
*display_file_name
= g_filename_display_name (file_name
);
408 g_module_set_error_unduped (g_strdup_printf ("unable to access file \"%s\"", display_file_name
));
409 g_free (display_file_name
);
416 GModuleCheckInit check_init
;
417 const gchar
*check_failed
= NULL
;
419 /* search the module list by handle, since file names are not unique */
420 module
= g_module_find_by_handle (handle
);
423 _g_module_close (module
->handle
, TRUE
);
425 g_module_set_error (NULL
);
427 g_static_rec_mutex_unlock (&g_module_global_lock
);
431 saved_error
= g_strdup (g_module_error ());
432 g_module_set_error (NULL
);
434 module
= g_new (GModule
, 1);
435 module
->file_name
= g_strdup (file_name
);
437 module
->cp_file_name
= g_locale_from_utf8 (file_name
, -1,
440 module
->handle
= handle
;
441 module
->ref_count
= 1;
442 module
->is_resident
= FALSE
;
443 module
->unload
= NULL
;
444 module
->next
= modules
;
447 /* check initialization */
448 if (g_module_symbol (module
, "g_module_check_init", (gpointer
) &check_init
))
449 check_failed
= check_init (module
);
451 /* we don't call unload() if the initialization check failed. */
453 g_module_symbol (module
, "g_module_unload", (gpointer
) &module
->unload
);
459 error
= g_strconcat ("GModule initialization check failed: ", check_failed
, NULL
);
460 g_module_close (module
);
462 g_module_set_error (error
);
466 g_module_set_error (saved_error
);
468 g_free (saved_error
);
471 g_static_rec_mutex_unlock (&g_module_global_lock
);
480 g_module_open (const gchar
*file_name
,
483 gchar
*utf8_file_name
= g_locale_to_utf8 (file_name
, -1, NULL
, NULL
, NULL
);
484 GModule
*retval
= g_module_open_utf8 (utf8_file_name
, flags
);
486 g_free (utf8_file_name
);
494 g_module_close (GModule
*module
)
496 SUPPORT_OR_RETURN (FALSE
);
498 g_return_val_if_fail (module
!= NULL
, FALSE
);
499 g_return_val_if_fail (module
->ref_count
> 0, FALSE
);
501 g_static_rec_mutex_lock (&g_module_global_lock
);
505 if (!module
->ref_count
&& !module
->is_resident
&& module
->unload
)
507 GModuleUnload unload
;
509 unload
= module
->unload
;
510 module
->unload
= NULL
;
514 if (!module
->ref_count
&& !module
->is_resident
)
527 last
->next
= node
->next
;
529 modules
= node
->next
;
537 _g_module_close (module
->handle
, FALSE
);
538 g_free (module
->file_name
);
540 g_free (module
->cp_file_name
);
545 g_static_rec_mutex_unlock (&g_module_global_lock
);
546 return g_module_error() == NULL
;
550 g_module_make_resident (GModule
*module
)
552 g_return_if_fail (module
!= NULL
);
554 module
->is_resident
= TRUE
;
557 G_CONST_RETURN gchar
*
558 g_module_error (void)
560 return g_static_private_get (&module_error_private
);
564 g_module_symbol (GModule
*module
,
565 const gchar
*symbol_name
,
568 const gchar
*module_error
;
572 SUPPORT_OR_RETURN (FALSE
);
574 g_return_val_if_fail (module
!= NULL
, FALSE
);
575 g_return_val_if_fail (symbol_name
!= NULL
, FALSE
);
576 g_return_val_if_fail (symbol
!= NULL
, FALSE
);
578 g_static_rec_mutex_lock (&g_module_global_lock
);
580 #ifdef G_MODULE_NEED_USCORE
584 name
= g_strconcat ("_", symbol_name
, NULL
);
585 *symbol
= _g_module_symbol (module
->handle
, name
);
588 #else /* !G_MODULE_NEED_USCORE */
589 *symbol
= _g_module_symbol (module
->handle
, symbol_name
);
590 #endif /* !G_MODULE_NEED_USCORE */
592 module_error
= g_module_error ();
597 error
= g_strconcat ("`", symbol_name
, "': ", module_error
, NULL
);
598 g_module_set_error (error
);
603 g_static_rec_mutex_unlock (&g_module_global_lock
);
604 return !module_error
;
607 G_CONST_RETURN gchar
*
608 g_module_name (GModule
*module
)
610 g_return_val_if_fail (module
!= NULL
, NULL
);
612 if (module
== main_module
)
615 return module
->file_name
;
622 G_CONST_RETURN gchar
*
623 g_module_name (GModule
*module
)
625 g_return_val_if_fail (module
!= NULL
, NULL
);
627 if (module
== main_module
)
630 return module
->cp_file_name
;
636 g_module_build_path (const gchar
*directory
,
637 const gchar
*module_name
)
639 g_return_val_if_fail (module_name
!= NULL
, NULL
);
641 return _g_module_build_path (directory
, module_name
);