gmodule/gmodule.c

   1 /* GMODULE - GLIB wrapper code for dynamic module loading
   2  * Copyright (C) 1998 Tim Janik
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 /*
  28  * MT safe
  29  */
  30
  31 #include "config.h"
  32
  33 #include "glib.h"
  34 #include "gmodule.h"
  35
  36 #include <errno.h>
  37 #include <string.h>
  38 #include <sys/types.h>
  39 #include <sys/stat.h>
  40 #include <fcntl.h>
  41 #ifdef HAVE_UNISTD_H
  42 #include <unistd.h>
  43 #endif
  44 #ifdef G_OS_WIN32
  45 #include <io.h>         /* For open() and close() prototypes. */
  46 #endif
  47
  48 #include "gmoduleconf.h"
  49 #include "gstdio.h"
  50
  51 /**
  52  * SECTION:modules
  53  * @title: Dynamic Loading of Modules
  54  * @short_description: portable method for dynamically loading 'plug-ins'
  55  *
  56  * These functions provide a portable way to dynamically load object files
  57  * (commonly known as 'plug-ins'). The current implementation supports all
  58  * systems that provide an implementation of dlopen() (e.g. Linux/Sun), as
  59  * well as HP-UX via its shl_load() mechanism, and Windows platforms via DLLs.
  60  *
  61  * A program which wants to use these functions must be linked to the
  62  * libraries output by the command
  63  * <command>pkg-config --libs gmodule-2.0</command>.
  64  *
  65  * To use them you must first determine whether dynamic loading
  66  * is supported on the platform by calling g_module_supported().
  67  * If it is, you can open a module with g_module_open(),
  68  * find the module's symbols (e.g. function names) with g_module_symbol(),
  69  * and later close the module with g_module_close().
  70  * g_module_name() will return the file name of a currently opened module.
  71  *
  72  * If any of the above functions fail, the error status can be found with
  73  * g_module_error().
  74  *
  75  * The #GModule implementation features reference counting for opened modules,
  76  * and supports hook functions within a module which are called when the
  77  * module is loaded and unloaded (see #GModuleCheckInit and #GModuleUnload).
  78  *
  79  * If your module introduces static data to common subsystems in the running
  80  * program, e.g. through calling
  81  * <literal>g_quark_from_static_string ("my-module-stuff")</literal>,
  82  * it must ensure that it is never unloaded, by calling g_module_make_resident().
  83  *
  84  * <example>
  85  * <title>Calling a function defined in a <structname>GModule</structname></title>
  86  * <programlisting>
  87  * /&ast; the function signature for 'say_hello' &ast;/
  88  * typedef void (* SayHelloFunc) (const char *message);
  89  *
  90  * gboolean
  91  * just_say_hello (const char *filename, GError **error)
  92  * {
  93  *   SayHelloFunc  say_hello;
  94  *   GModule      *module;
  95  *
  96  *   module = g_module_open (filename, G_MODULE_BIND_LAZY);
  97  *   if (!module)
  98  *     {
  99  *       g_set_error (error, FOO_ERROR, FOO_ERROR_BLAH,
 100  *                    "&percnt;s", g_module_error ());
 101  *       return FALSE;
 102  *     }
 103  *
 104  *   if (!g_module_symbol (module, "say_hello", (gpointer *)&amp;say_hello))
 105  *     {
 106  *       g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN,
 107  *                    "&percnt;s: &percnt;s", filename, g_module_error ());
 108  *       if (!g_module_close (module))
 109  *         g_warning ("&percnt;s: &percnt;s", filename, g_module_error ());
 110  *       return FALSE;
 111  *     }
 112  *
 113  *   if (say_hello == NULL)
 114  *     {
 115  *       g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN,
 116  *                    "symbol say_hello is NULL");
 117  *       if (!g_module_close (module))
 118  *         g_warning ("&percnt;s: &percnt;s", filename, g_module_error ());
 119  *       return FALSE;
 120  *     }
 121  *
 122  *   /&ast; call our function in the module &ast;/
 123  *   say_hello ("Hello world!");
 124  *
 125  *   if (!g_module_close (module))
 126  *     g_warning ("&percnt;s: &percnt;s", filename, g_module_error ());
 127  *   return TRUE;
 128  *  }
 129  * </programlisting>
 130  * </example>
 131  */
 132
 133 /**
 134  * GModule:
 135  *
 136  * The #GModule struct is an opaque data structure to represent a
 137  * <link linkend="glib-Dynamic-Loading-of-Modules">Dynamically-Loaded
 138  * Module</link>. It should only be accessed via the following functions.
 139  */
 140
 141 /**
 142  * GModuleCheckInit:
 143  * @module: the #GModule corresponding to the module which has just been loaded
 144  *
 145  * Specifies the type of the module initialization function.
 146  * <indexterm zone="g-module-check-init"><primary>g_module_check_init</primary></indexterm>
 147  * If a module contains a function named g_module_check_init() it is called
 148  * automatically when the module is loaded. It is passed the #GModule structure
 149  * and should return %NULL on success or a string describing the initialization
 150  * error.
 151  *
 152  * Returns: %NULL on success, or a string describing the initialization error
 153  */
 154
 155 /**
 156  * GModuleUnload:
 157  * @module: the #GModule about to be unloaded
 158  *
 159  * <indexterm zone="g-module-unload"><primary>g_module_unload</primary></indexterm>
 160  * Specifies the type of the module function called when it is unloaded.
 161  * If a module contains a function named g_module_unload() it is called
 162  * automatically when the module is unloaded.
 163  * It is passed the #GModule structure.
 164  */
 165
 166 /**
 167  * G_MODULE_SUFFIX:
 168  *
 169  * Expands to the proper shared library suffix for the current platform
 170  * without the leading dot. For the most Unices and Linux this is "so",
 171  * for some HP-UX versions this is "sl" and for Windows this is "dll".
 172  */
 173
 174 /**
 175  * G_MODULE_EXPORT:
 176  *
 177  * Used to declare functions exported by modules. This is a no-op on Linux
 178  * and Unices, but when compiling for Windows, it marks a symbol to be
 179  * exported from the library or executable being built.
 180  */
 181
 182 /**
 183  * G_MODULE_IMPORT:
 184  *
 185  * Used to declare functions imported from modules.
 186  */
 187
 188 /* We maintain a list of modules, so we can reference count them.
 189  * That's needed because some platforms don't support references counts on
 190  * modules e.g. the shl_* implementation of HP-UX
 191  * (http://www.stat.umn.edu/~luke/xls/projects/dlbasics/dlbasics.html).
 192  * Also, the module for the program itself is kept seperatedly for
 193  * faster access and because it has special semantics.
 194  */
 195
 196
 197 /* --- structures --- */
 198 struct _GModule
 199 {
 200   gchar *file_name;
 201 #if defined (G_OS_WIN32) && !defined(_WIN64)
 202   gchar *cp_file_name;
 203 #endif
 204   gpointer handle;
 205   guint ref_count : 31;
 206   guint is_resident : 1;
 207   GModuleUnload unload;
 208   GModule *next;
 209 };
 210
 211
 212 /* --- prototypes --- */
 213 static gpointer         _g_module_open          (const gchar    *file_name,
 214                                                  gboolean        bind_lazy,
 215                                                  gboolean        bind_local);
 216 static void             _g_module_close         (gpointer        handle,
 217                                                  gboolean        is_unref);
 218 static gpointer         _g_module_self          (void);
 219 static gpointer         _g_module_symbol        (gpointer        handle,
 220                                                  const gchar    *symbol_name);
 221 static gchar*           _g_module_build_path    (const gchar    *directory,
 222                                                  const gchar    *module_name);
 223 static inline void      g_module_set_error      (const gchar    *error);
 224 static inline GModule*  g_module_find_by_handle (gpointer        handle);
 225 static inline GModule*  g_module_find_by_name   (const gchar    *name);
 226
 227
 228 /* --- variables --- */
 229 static GModule       *modules = NULL;
 230 static GModule       *main_module = NULL;
 231 static GPrivate       module_error_private = G_PRIVATE_INIT (g_free);
 232 static gboolean       module_debug_initialized = FALSE;
 233 static guint          module_debug_flags = 0;
 234
 235
 236 /* --- inline functions --- */
 237 static inline GModule*
 238 g_module_find_by_handle (gpointer handle)
 239 {
 240   GModule *module;
 241   GModule *retval = NULL;
 242
 243   if (main_module && main_module->handle == handle)
 244     retval = main_module;
 245   else
 246     for (module = modules; module; module = module->next)
 247       if (handle == module->handle)
 248         {
 249           retval = module;
 250           break;
 251         }
 252
 253   return retval;
 254 }
 255
 256 static inline GModule*
 257 g_module_find_by_name (const gchar *name)
 258 {
 259   GModule *module;
 260   GModule *retval = NULL;
 261
 262   for (module = modules; module; module = module->next)
 263     if (strcmp (name, module->file_name) == 0)
 264         {
 265           retval = module;
 266           break;
 267         }
 268
 269   return retval;
 270 }
 271
 272 static inline void
 273 g_module_set_error_unduped (gchar *error)
 274 {
 275   g_private_replace (&module_error_private, error);
 276   errno = 0;
 277 }
 278
 279 static inline void
 280 g_module_set_error (const gchar *error)
 281 {
 282   g_module_set_error_unduped (g_strdup (error));
 283 }
 284
 285
 286 /* --- include platform specifc code --- */
 287 #define SUPPORT_OR_RETURN(rv)   { g_module_set_error (NULL); }
 288 #if     (G_MODULE_IMPL == G_MODULE_IMPL_DL)
 289 #include "gmodule-dl.c"
 290 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_DLD)
 291 #include "gmodule-dld.c"
 292 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_WIN32)
 293 #include "gmodule-win32.c"
 294 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_DYLD)
 295 #include "gmodule-dyld.c"
 296 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_AR)
 297 #include "gmodule-ar.c"
 298 #else
 299 #undef  SUPPORT_OR_RETURN
 300 #define SUPPORT_OR_RETURN(rv)   { g_module_set_error ("dynamic modules are " \
 301                                               "not supported by this system"); return rv; }
 302 static gpointer
 303 _g_module_open (const gchar     *file_name,
 304                 gboolean         bind_lazy,
 305                 gboolean         bind_local)
 306 {
 307   return NULL;
 308 }
 309 static void
 310 _g_module_close (gpointer        handle,
 311                  gboolean        is_unref)
 312 {
 313 }
 314 static gpointer
 315 _g_module_self (void)
 316 {
 317   return NULL;
 318 }
 319 static gpointer
 320 _g_module_symbol (gpointer       handle,
 321                   const gchar   *symbol_name)
 322 {
 323   return NULL;
 324 }
 325 static gchar*
 326 _g_module_build_path (const gchar *directory,
 327                       const gchar *module_name)
 328 {
 329   return NULL;
 330 }
 331 #endif  /* no implementation */
 332
 333 /* --- functions --- */
 334
 335 /**
 336  * g_module_supported:
 337  *
 338  * Checks if modules are supported on the current platform.
 339  *
 340  * Returns: %TRUE if modules are supported
 341  */
 342 gboolean
 343 g_module_supported (void)
 344 {
 345   SUPPORT_OR_RETURN (FALSE);
 346
 347   return TRUE;
 348 }
 349
 350 static gchar*
 351 parse_libtool_archive (const gchar* libtool_name)
 352 {
 353   const guint TOKEN_DLNAME = G_TOKEN_LAST + 1;
 354   const guint TOKEN_INSTALLED = G_TOKEN_LAST + 2;
 355   const guint TOKEN_LIBDIR = G_TOKEN_LAST + 3;
 356   gchar *lt_dlname = NULL;
 357   gboolean lt_installed = TRUE;
 358   gchar *lt_libdir = NULL;
 359   gchar *name;
 360   GTokenType token;
 361   GScanner *scanner;
 362
 363   int fd = g_open (libtool_name, O_RDONLY, 0);
 364   if (fd < 0)
 365     {
 366       gchar *display_libtool_name = g_filename_display_name (libtool_name);
 367       g_module_set_error_unduped (g_strdup_printf ("failed to open libtool archive \"%s\"", display_libtool_name));
 368       g_free (display_libtool_name);
 369       return NULL;
 370     }
 371   /* search libtool's dlname specification  */
 372   scanner = g_scanner_new (NULL);
 373   g_scanner_input_file (scanner, fd);
 374   scanner->config->symbol_2_token = TRUE;
 375   g_scanner_scope_add_symbol (scanner, 0, "dlname",
 376                               GUINT_TO_POINTER (TOKEN_DLNAME));
 377   g_scanner_scope_add_symbol (scanner, 0, "installed",
 378                               GUINT_TO_POINTER (TOKEN_INSTALLED));
 379   g_scanner_scope_add_symbol (scanner, 0, "libdir",
 380                               GUINT_TO_POINTER (TOKEN_LIBDIR));
 381   while (!g_scanner_eof (scanner))
 382     {
 383       token = g_scanner_get_next_token (scanner);
 384       if (token == TOKEN_DLNAME || token == TOKEN_INSTALLED ||
 385           token == TOKEN_LIBDIR)
 386         {
 387           if (g_scanner_get_next_token (scanner) != '=' ||
 388               g_scanner_get_next_token (scanner) !=
 389               (token == TOKEN_INSTALLED ?
 390                G_TOKEN_IDENTIFIER : G_TOKEN_STRING))
 391             {
 392               gchar *display_libtool_name = g_filename_display_name (libtool_name);
 393               g_module_set_error_unduped (g_strdup_printf ("unable to parse libtool archive \"%s\"", display_libtool_name));
 394               g_free (display_libtool_name);
 395
 396               g_free (lt_dlname);
 397               g_free (lt_libdir);
 398               g_scanner_destroy (scanner);
 399               close (fd);
 400
 401               return NULL;
 402             }
 403           else
 404             {
 405               if (token == TOKEN_DLNAME)
 406                 {
 407                   g_free (lt_dlname);
 408                   lt_dlname = g_strdup (scanner->value.v_string);
 409                 }
 410               else if (token == TOKEN_INSTALLED)
 411                 lt_installed =
 412                   strcmp (scanner->value.v_identifier, "yes") == 0;
 413               else /* token == TOKEN_LIBDIR */
 414                 {
 415                   g_free (lt_libdir);
 416                   lt_libdir = g_strdup (scanner->value.v_string);
 417                 }
 418             }
 419         }
 420     }
 421
 422   if (!lt_installed)
 423     {
 424       gchar *dir = g_path_get_dirname (libtool_name);
 425       g_free (lt_libdir);
 426       lt_libdir = g_strconcat (dir, G_DIR_SEPARATOR_S ".libs", NULL);
 427       g_free (dir);
 428     }
 429
 430   name = g_strconcat (lt_libdir, G_DIR_SEPARATOR_S, lt_dlname, NULL);
 431
 432   g_free (lt_dlname);
 433   g_free (lt_libdir);
 434   g_scanner_destroy (scanner);
 435   close (fd);
 436
 437   return name;
 438 }
 439
 440 static inline gboolean
 441 str_check_suffix (const gchar* string,
 442                   const gchar* suffix)
 443 {
 444   gsize string_len = strlen (string);
 445   gsize suffix_len = strlen (suffix);
 446
 447   return string_len >= suffix_len &&
 448     strcmp (string + string_len - suffix_len, suffix) == 0;
 449 }
 450
 451 enum
 452 {
 453   G_MODULE_DEBUG_RESIDENT_MODULES = 1 << 0,
 454   G_MODULE_DEBUG_BIND_NOW_MODULES = 1 << 1
 455 };
 456
 457 static void
 458 _g_module_debug_init (void)
 459 {
 460   const GDebugKey keys[] = {
 461     { "resident-modules", G_MODULE_DEBUG_RESIDENT_MODULES },
 462     { "bind-now-modules", G_MODULE_DEBUG_BIND_NOW_MODULES }
 463   };
 464   const gchar *env;
 465
 466   env = g_getenv ("G_DEBUG");
 467
 468   module_debug_flags =
 469     !env ? 0 : g_parse_debug_string (env, keys, G_N_ELEMENTS (keys));
 470
 471   module_debug_initialized = TRUE;
 472 }
 473
 474 static GRecMutex g_module_global_lock;
 475
 476 GModule*
 477 g_module_open (const gchar    *file_name,
 478                GModuleFlags    flags)
 479 {
 480   GModule *module;
 481   gpointer handle = NULL;
 482   gchar *name = NULL;
 483
 484   SUPPORT_OR_RETURN (NULL);
 485
 486   g_rec_mutex_lock (&g_module_global_lock);
 487
 488   if (G_UNLIKELY (!module_debug_initialized))
 489     _g_module_debug_init ();
 490
 491   if (module_debug_flags & G_MODULE_DEBUG_BIND_NOW_MODULES)
 492     flags &= ~G_MODULE_BIND_LAZY;
 493
 494   if (!file_name)
 495     {
 496       if (!main_module)
 497         {
 498           handle = _g_module_self ();
 499           if (handle)
 500             {
 501               main_module = g_new (GModule, 1);
 502               main_module->file_name = NULL;
 503 #if defined (G_OS_WIN32) && !defined(_WIN64)
 504               main_module->cp_file_name = NULL;
 505 #endif
 506               main_module->handle = handle;
 507               main_module->ref_count = 1;
 508               main_module->is_resident = TRUE;
 509               main_module->unload = NULL;
 510               main_module->next = NULL;
 511             }
 512         }
 513       else
 514         main_module->ref_count++;
 515
 516       g_rec_mutex_unlock (&g_module_global_lock);
 517       return main_module;
 518     }
 519
 520   /* we first search the module list by name */
 521   module = g_module_find_by_name (file_name);
 522   if (module)
 523     {
 524       module->ref_count++;
 525
 526       g_rec_mutex_unlock (&g_module_global_lock);
 527       return module;
 528     }
 529
 530   /* check whether we have a readable file right away */
 531   if (g_file_test (file_name, G_FILE_TEST_IS_REGULAR))
 532     name = g_strdup (file_name);
 533   /* try completing file name with standard library suffix */
 534   if (!name)
 535     {
 536       name = g_strconcat (file_name, "." G_MODULE_SUFFIX, NULL);
 537       if (!g_file_test (name, G_FILE_TEST_IS_REGULAR))
 538         {
 539           g_free (name);
 540           name = NULL;
 541         }
 542     }
 543   /* try completing by appending libtool suffix */
 544   if (!name)
 545     {
 546       name = g_strconcat (file_name, ".la", NULL);
 547       if (!g_file_test (name, G_FILE_TEST_IS_REGULAR))
 548         {
 549           g_free (name);
 550           name = NULL;
 551         }
 552     }
 553   /* we can't access() the file, lets hope the platform backends finds
 554    * it via library paths
 555    */
 556   if (!name)
 557     {
 558       gchar *dot = strrchr (file_name, '.');
 559       gchar *slash = strrchr (file_name, G_DIR_SEPARATOR);
 560
 561       /* make sure the name has a suffix */
 562       if (!dot || dot < slash)
 563         name = g_strconcat (file_name, "." G_MODULE_SUFFIX, NULL);
 564       else
 565         name = g_strdup (file_name);
 566     }
 567
 568   /* ok, try loading the module */
 569   if (name)
 570     {
 571       /* if it's a libtool archive, figure library file to load */
 572       if (str_check_suffix (name, ".la")) /* libtool archive? */
 573         {
 574           gchar *real_name = parse_libtool_archive (name);
 575
 576           /* real_name might be NULL, but then module error is already set */
 577           if (real_name)
 578             {
 579               g_free (name);
 580               name = real_name;
 581             }
 582         }
 583       if (name)
 584         handle = _g_module_open (name, (flags & G_MODULE_BIND_LAZY) != 0,
 585                         (flags & G_MODULE_BIND_LOCAL) != 0);
 586     }
 587   else
 588     {
 589       gchar *display_file_name = g_filename_display_name (file_name);
 590       g_module_set_error_unduped (g_strdup_printf ("unable to access file \"%s\"", display_file_name));
 591       g_free (display_file_name);
 592     }
 593   g_free (name);
 594
 595   if (handle)
 596     {
 597       gchar *saved_error;
 598       GModuleCheckInit check_init;
 599       const gchar *check_failed = NULL;
 600
 601       /* search the module list by handle, since file names are not unique */
 602       module = g_module_find_by_handle (handle);
 603       if (module)
 604         {
 605           _g_module_close (module->handle, TRUE);
 606           module->ref_count++;
 607           g_module_set_error (NULL);
 608
 609           g_rec_mutex_unlock (&g_module_global_lock);
 610           return module;
 611         }
 612
 613       saved_error = g_strdup (g_module_error ());
 614       g_module_set_error (NULL);
 615
 616       module = g_new (GModule, 1);
 617       module->file_name = g_strdup (file_name);
 618 #if defined (G_OS_WIN32) && !defined(_WIN64)
 619       module->cp_file_name = g_locale_from_utf8 (file_name, -1,
 620                                                  NULL, NULL, NULL);
 621 #endif
 622       module->handle = handle;
 623       module->ref_count = 1;
 624       module->is_resident = FALSE;
 625       module->unload = NULL;
 626       module->next = modules;
 627       modules = module;
 628
 629       /* check initialization */
 630       if (g_module_symbol (module, "g_module_check_init", (gpointer) &check_init) && check_init != NULL)
 631         check_failed = check_init (module);
 632
 633       /* we don't call unload() if the initialization check failed. */
 634       if (!check_failed)
 635         g_module_symbol (module, "g_module_unload", (gpointer) &module->unload);
 636
 637       if (check_failed)
 638         {
 639           gchar *error;
 640
 641           error = g_strconcat ("GModule (", file_name, ") ",
 642                                "initialization check failed: ",
 643                                check_failed, NULL);
 644           g_module_close (module);
 645           module = NULL;
 646           g_module_set_error (error);
 647           g_free (error);
 648         }
 649       else
 650         g_module_set_error (saved_error);
 651
 652       g_free (saved_error);
 653     }
 654
 655   if (module != NULL &&
 656       (module_debug_flags & G_MODULE_DEBUG_RESIDENT_MODULES))
 657     g_module_make_resident (module);
 658
 659   g_rec_mutex_unlock (&g_module_global_lock);
 660   return module;
 661 }
 662
 663 #if defined (G_OS_WIN32) && !defined(_WIN64)
 664
 665 #undef g_module_open
 666
 667 /**
 668  * GModuleFlags:
 669  * @G_MODULE_BIND_LAZY: specifies that symbols are only resolved when
 670  *     needed. The default action is to bind all symbols when the module
 671  *     is loaded.
 672  * @G_MODULE_BIND_LOCAL: specifies that symbols in the module should
 673  *     not be added to the global name space. The default action on most
 674  *     platforms is to place symbols in the module in the global name space,
 675  *     which may cause conflicts with existing symbols.
 676  * @G_MODULE_BIND_MASK: mask for all flags.
 677  *
 678  * Flags passed to g_module_open().
 679  * Note that these flags are not supported on all platforms.
 680  */
 681
 682 /**
 683  * g_module_open:
 684  * @file_name: (allow-none): the name of the file containing the module, or %NULL
 685  *     to obtain a #GModule representing the main program itself
 686  * @flags: the flags used for opening the module. This can be the
 687  *     logical OR of any of the #GModuleFlags
 688  *
 689  * Opens a module. If the module has already been opened,
 690  * its reference count is incremented.
 691  *
 692  * First of all g_module_open() tries to open @file_name as a module.
 693  * If that fails and @file_name has the ".la"-suffix (and is a libtool
 694  * archive) it tries to open the corresponding module. If that fails
 695  * and it doesn't have the proper module suffix for the platform
 696  * (#G_MODULE_SUFFIX), this suffix will be appended and the corresponding
 697  * module will be opended. If that fails and @file_name doesn't have the
 698  * ".la"-suffix, this suffix is appended and g_module_open() tries to open
 699  * the corresponding module. If eventually that fails as well, %NULL is
 700  * returned.
 701  *
 702  * Returns: a #GModule on success, or %NULL on failure
 703  */
 704 GModule *
 705 g_module_open (const gchar  *file_name,
 706                GModuleFlags  flags)
 707 {
 708   gchar *utf8_file_name = g_locale_to_utf8 (file_name, -1, NULL, NULL, NULL);
 709   GModule *retval = g_module_open_utf8 (utf8_file_name, flags);
 710
 711   g_free (utf8_file_name);
 712
 713   return retval;
 714 }
 715
 716 #endif
 717
 718 /**
 719  * g_module_close:
 720  * @module: a #GModule to close
 721  *
 722  * Closes a module.
 723  *
 724  * Returns: %TRUE on success
 725  */
 726 gboolean
 727 g_module_close (GModule *module)
 728 {
 729   SUPPORT_OR_RETURN (FALSE);
 730
 731   g_return_val_if_fail (module != NULL, FALSE);
 732   g_return_val_if_fail (module->ref_count > 0, FALSE);
 733
 734   g_rec_mutex_lock (&g_module_global_lock);
 735
 736   module->ref_count--;
 737
 738   if (!module->ref_count && !module->is_resident && module->unload)
 739     {
 740       GModuleUnload unload;
 741
 742       unload = module->unload;
 743       module->unload = NULL;
 744       unload (module);
 745     }
 746
 747   if (!module->ref_count && !module->is_resident)
 748     {
 749       GModule *last;
 750       GModule *node;
 751
 752       last = NULL;
 753
 754       node = modules;
 755       while (node)
 756         {
 757           if (node == module)
 758             {
 759               if (last)
 760                 last->next = node->next;
 761               else
 762                 modules = node->next;
 763               break;
 764             }
 765           last = node;
 766           node = last->next;
 767         }
 768       module->next = NULL;
 769
 770       _g_module_close (module->handle, FALSE);
 771       g_free (module->file_name);
 772 #if defined (G_OS_WIN32) && !defined(_WIN64)
 773       g_free (module->cp_file_name);
 774 #endif
 775       g_free (module);
 776     }
 777
 778   g_rec_mutex_unlock (&g_module_global_lock);
 779   return g_module_error() == NULL;
 780 }
 781
 782 /**
 783  * g_module_make_resident:
 784  * @module: a #GModule to make permanently resident
 785  *
 786  * Ensures that a module will never be unloaded.
 787  * Any future g_module_close() calls on the module will be ignored.
 788  */
 789 void
 790 g_module_make_resident (GModule *module)
 791 {
 792   g_return_if_fail (module != NULL);
 793
 794   module->is_resident = TRUE;
 795 }
 796
 797 /**
 798  * g_module_error:
 799  *
 800  * Gets a string describing the last module error.
 801  *
 802  * Returns: a string describing the last module error
 803  */
 804 const gchar *
 805 g_module_error (void)
 806 {
 807   return g_private_get (&module_error_private);
 808 }
 809
 810 /**
 811  * g_module_symbol:
 812  * @module: a #GModule
 813  * @symbol_name: the name of the symbol to find
 814  * @symbol: returns the pointer to the symbol value
 815  *
 816  * Gets a symbol pointer from a module, such as one exported
 817  * by #G_MODULE_EXPORT. Note that a valid symbol can be %NULL.
 818  *
 819  * Returns: %TRUE on success
 820  */
 821 gboolean
 822 g_module_symbol (GModule     *module,
 823                  const gchar *symbol_name,
 824                  gpointer    *symbol)
 825 {
 826   const gchar *module_error;
 827
 828   if (symbol)
 829     *symbol = NULL;
 830   SUPPORT_OR_RETURN (FALSE);
 831
 832   g_return_val_if_fail (module != NULL, FALSE);
 833   g_return_val_if_fail (symbol_name != NULL, FALSE);
 834   g_return_val_if_fail (symbol != NULL, FALSE);
 835
 836   g_rec_mutex_lock (&g_module_global_lock);
 837
 838 #ifdef  G_MODULE_NEED_USCORE
 839   {
 840     gchar *name;
 841
 842     name = g_strconcat ("_", symbol_name, NULL);
 843     *symbol = _g_module_symbol (module->handle, name);
 844     g_free (name);
 845   }
 846 #else   /* !G_MODULE_NEED_USCORE */
 847   *symbol = _g_module_symbol (module->handle, symbol_name);
 848 #endif  /* !G_MODULE_NEED_USCORE */
 849
 850   module_error = g_module_error ();
 851   if (module_error)
 852     {
 853       gchar *error;
 854
 855       error = g_strconcat ("'", symbol_name, "': ", module_error, NULL);
 856       g_module_set_error (error);
 857       g_free (error);
 858       *symbol = NULL;
 859     }
 860
 861   g_rec_mutex_unlock (&g_module_global_lock);
 862   return !module_error;
 863 }
 864
 865 /**
 866  * g_module_name:
 867  * @module: a #GModule
 868  *
 869  * Returns the filename that the module was opened with.
 870  *
 871  * If @module refers to the application itself, "main" is returned.
 872  *
 873  * Returns: (transfer none): the filename of the module
 874  */
 875 const gchar *
 876 g_module_name (GModule *module)
 877 {
 878   g_return_val_if_fail (module != NULL, NULL);
 879
 880   if (module == main_module)
 881     return "main";
 882
 883   return module->file_name;
 884 }
 885
 886 #if defined (G_OS_WIN32) && !defined(_WIN64)
 887
 888 #undef g_module_name
 889
 890 const gchar *
 891 g_module_name (GModule *module)
 892 {
 893   g_return_val_if_fail (module != NULL, NULL);
 894
 895   if (module == main_module)
 896     return "main";
 897
 898   return module->cp_file_name;
 899 }
 900
 901 #endif
 902
 903 /**
 904  * g_module_build_path:
 905  * @directory: the directory where the module is. This can be %NULL
 906  *     or the empty string to indicate that the standard platform-specific
 907  *     directories will be used, though that is not recommended
 908  * @module_name: the name of the module
 909  *
 910  * A portable way to build the filename of a module. The platform-specific
 911  * prefix and suffix are added to the filename, if needed, and the result
 912  * is added to the directory, using the correct separator character.
 913  *
 914  * The directory should specify the directory where the module can be found.
 915  * It can be %NULL or an empty string to indicate that the module is in a
 916  * standard platform-specific directory, though this is not recommended
 917  * since the wrong module may be found.
 918  *
 919  * For example, calling g_module_build_path() on a Linux system with a
 920  * @directory of <filename>/lib</filename> and a @module_name of "mylibrary"
 921  * will return <filename>/lib/libmylibrary.so</filename>. On a Windows system,
 922  * using <filename>\Windows</filename> as the directory it will return
 923  * <filename>\Windows\mylibrary.dll</filename>.
 924  *
 925  * Returns: the complete path of the module, including the standard library
 926  *     prefix and suffix. This should be freed when no longer needed
 927  */
 928 gchar *
 929 g_module_build_path (const gchar *directory,
 930                      const gchar *module_name)
 931 {
 932   g_return_val_if_fail (module_name != NULL, NULL);
 933
 934   return _g_module_build_path (directory, module_name);
 935 }