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 #ifdef HAVE_CONFIG_H
  32 # include <config.h>
  33 #endif
  34 #include        "gmodule.h"
  35 #include        "gmoduleconf.h"
  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 #if defined (G_OS_WIN32)
  45 # include <io.h>                /* For open() and close() prototypes. */
  46 #endif
  47
  48 /* We maintain a list of modules, so we can reference count them.
  49  * That's needed because some platforms don't support refernce counts on
  50  * modules e.g. the shl_* implementation of HP-UX
  51  * (http://www.stat.umn.edu/~luke/xls/projects/dlbasics/dlbasics.html).
  52  * Also, the module for the program itself is kept seperatedly for
  53  * faster access and because it has special semantics.
  54  */
  55
  56
  57 /* --- structures --- */
  58 struct _GModule
  59 {
  60   gchar *file_name;
  61   gpointer handle;
  62   guint ref_count : 31;
  63   guint is_resident : 1;
  64   GModuleUnload unload;
  65   GModule *next;
  66 };
  67
  68
  69 /* --- prototypes --- */
  70 static gpointer         _g_module_open          (const gchar    *file_name,
  71                                                  gboolean        bind_lazy);
  72 static void             _g_module_close         (gpointer        handle,
  73                                                  gboolean        is_unref);
  74 static gpointer         _g_module_self          (void);
  75 static gpointer         _g_module_symbol        (gpointer        handle,
  76                                                  const gchar    *symbol_name);
  77 static gchar*           _g_module_build_path    (const gchar    *directory,
  78                                                  const gchar    *module_name);
  79 static inline void      g_module_set_error      (const gchar    *error);
  80 static inline GModule*  g_module_find_by_handle (gpointer        handle);
  81 static inline GModule*  g_module_find_by_name   (const gchar    *name);
  82
  83
  84 /* --- variables --- */
  85 static GModule       *modules = NULL;
  86 static GModule       *main_module = NULL;
  87 static GStaticPrivate module_error_private = G_STATIC_PRIVATE_INIT;
  88
  89
  90 /* --- inline functions --- */
  91 static inline GModule*
  92 g_module_find_by_handle (gpointer handle)
  93 {
  94   GModule *module;
  95   GModule *retval = NULL;
  96
  97   if (main_module && main_module->handle == handle)
  98     retval = main_module;
  99   else
 100     for (module = modules; module; module = module->next)
 101       if (handle == module->handle)
 102         {
 103           retval = module;
 104           break;
 105         }
 106
 107   return retval;
 108 }
 109
 110 static inline GModule*
 111 g_module_find_by_name (const gchar *name)
 112 {
 113   GModule *module;
 114   GModule *retval = NULL;
 115
 116   for (module = modules; module; module = module->next)
 117     if (strcmp (name, module->file_name) == 0)
 118         {
 119           retval = module;
 120           break;
 121         }
 122
 123   return retval;
 124 }
 125
 126 static inline void
 127 g_module_set_error (const gchar *error)
 128 {
 129   g_static_private_set (&module_error_private, g_strdup (error), g_free);
 130   errno = 0;
 131 }
 132
 133
 134 /* --- include platform specifc code --- */
 135 #define SUPPORT_OR_RETURN(rv)   { g_module_set_error (NULL); }
 136 #if     (G_MODULE_IMPL == G_MODULE_IMPL_DL)
 137 #include "gmodule-dl.c"
 138 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_DLD)
 139 #include "gmodule-dld.c"
 140 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_WIN32)
 141 #include "gmodule-win32.c"
 142 #else
 143 #undef  SUPPORT_OR_RETURN
 144 #define SUPPORT_OR_RETURN(rv)   { g_module_set_error ("dynamic modules are " \
 145                                               "not supported by this system"); return rv; }
 146 static gpointer
 147 _g_module_open (const gchar     *file_name,
 148                 gboolean         bind_lazy)
 149 {
 150   return NULL;
 151 }
 152 static void
 153 _g_module_close (gpointer        handle,
 154                  gboolean        is_unref)
 155 {
 156 }
 157 static gpointer
 158 _g_module_self (void)
 159 {
 160   return NULL;
 161 }
 162 static gpointer
 163 _g_module_symbol (gpointer       handle,
 164                   const gchar   *symbol_name)
 165 {
 166   return NULL;
 167 }
 168 static gchar*
 169 _g_module_build_path (const gchar *directory,
 170                       const gchar *module_name)
 171 {
 172   return NULL;
 173 }
 174 #endif  /* no implementation */
 175
 176 /* --- functions --- */
 177 gboolean
 178 g_module_supported (void)
 179 {
 180   SUPPORT_OR_RETURN (FALSE);
 181
 182   return TRUE;
 183 }
 184
 185 static gchar*
 186 parse_libtool_archive (const gchar* libtool_name)
 187 {
 188   const gint TOKEN_DLNAME = G_TOKEN_LAST + 1;
 189   const gint TOKEN_INSTALLED = G_TOKEN_LAST + 2;
 190   const gint TOKEN_LIBDIR = G_TOKEN_LAST + 3;
 191   gchar *lt_dlname = NULL;
 192   gboolean lt_installed = TRUE;
 193   gchar *lt_libdir = NULL;
 194   gchar *name;
 195   GTokenType token;
 196   GScanner *scanner;
 197
 198   int fd = open (libtool_name, O_RDONLY, 0);
 199   if (fd < 0)
 200     {
 201       g_module_set_error ("couldn't open libtool archive");
 202       return NULL;
 203     }
 204   /* search libtool's dlname specification  */
 205   scanner = g_scanner_new (NULL);
 206   g_scanner_input_file (scanner, fd);
 207   scanner->config->symbol_2_token = TRUE;
 208   g_scanner_scope_add_symbol (scanner, 0, "dlname",
 209                               GUINT_TO_POINTER (TOKEN_DLNAME));
 210   g_scanner_scope_add_symbol (scanner, 0, "installed",
 211                               GUINT_TO_POINTER (TOKEN_INSTALLED));
 212   g_scanner_scope_add_symbol (scanner, 0, "libdir",
 213                               GUINT_TO_POINTER (TOKEN_LIBDIR));
 214   while (!g_scanner_eof (scanner))
 215     {
 216       token = g_scanner_get_next_token (scanner);
 217       if (token == TOKEN_DLNAME || token == TOKEN_INSTALLED ||
 218           token == TOKEN_LIBDIR)
 219         {
 220           if (g_scanner_get_next_token (scanner) != '=' ||
 221               g_scanner_get_next_token (scanner) !=
 222               (token == TOKEN_INSTALLED ?
 223                G_TOKEN_IDENTIFIER : G_TOKEN_STRING))
 224             {
 225               g_module_set_error ("libtool archive has unknown format");
 226
 227               g_free (lt_dlname);
 228               g_free (lt_libdir);
 229               g_scanner_destroy (scanner);
 230               close (fd);
 231
 232               return NULL;
 233             }
 234           else
 235             {
 236               if (token == TOKEN_DLNAME)
 237                 {
 238                   g_free (lt_dlname);
 239                   lt_dlname = g_strdup (scanner->value.v_string);
 240                 }
 241               else if (token == TOKEN_INSTALLED)
 242                 lt_installed =
 243                   strcmp (scanner->value.v_identifier, "yes") == 0;
 244               else /* token == TOKEN_LIBDIR */
 245                 {
 246                   g_free (lt_libdir);
 247                   lt_libdir = g_strdup (scanner->value.v_string);
 248                 }
 249             }
 250         }
 251     }
 252
 253   if (!lt_installed)
 254     {
 255       gchar *dir = g_path_get_dirname (libtool_name);
 256       g_free (lt_libdir);
 257       lt_libdir = g_strconcat (dir, G_DIR_SEPARATOR_S ".libs", NULL);
 258     }
 259
 260   name = g_module_build_path (lt_libdir, lt_dlname);
 261
 262   g_free (lt_dlname);
 263   g_free (lt_libdir);
 264   g_scanner_destroy (scanner);
 265   close (fd);
 266
 267   return name;
 268 }
 269
 270 static inline gboolean
 271 g_str_check_suffix (const gchar* string, const gchar* suffix)
 272 {
 273   guint string_len = strlen (string);
 274   guint suffix_len = strlen (suffix);
 275
 276   return string_len >= suffix_len &&
 277     strcmp (string + string_len - suffix_len, suffix) == 0;
 278 }
 279
 280 static GStaticRecMutex g_module_global_lock = G_STATIC_REC_MUTEX_INIT;
 281
 282 GModule*
 283 g_module_open (const gchar    *file_name,
 284                GModuleFlags    flags)
 285 {
 286   GModule *module;
 287   gpointer handle;
 288
 289   SUPPORT_OR_RETURN (NULL);
 290
 291   g_static_rec_mutex_lock (&g_module_global_lock);
 292   if (!file_name)
 293     {
 294       if (!main_module)
 295         {
 296           handle = _g_module_self ();
 297           if (handle)
 298             {
 299               main_module = g_new (GModule, 1);
 300               main_module->file_name = NULL;
 301               main_module->handle = handle;
 302               main_module->ref_count = 1;
 303               main_module->is_resident = TRUE;
 304               main_module->unload = NULL;
 305               main_module->next = NULL;
 306             }
 307         }
 308
 309       g_static_rec_mutex_unlock (&g_module_global_lock);
 310       return main_module;
 311     }
 312
 313   /* we first search the module list by name */
 314   module = g_module_find_by_name (file_name);
 315   if (module)
 316     {
 317       module->ref_count++;
 318
 319       g_static_rec_mutex_unlock (&g_module_global_lock);
 320       return module;
 321     }
 322
 323   /* First we try to open the module as provided */
 324   handle = _g_module_open (file_name, (flags & G_MODULE_BIND_LAZY) != 0);
 325
 326   /* If not found, we check, if it is a libtool archive */
 327   if (!handle && g_str_check_suffix (file_name, ".la"))
 328     {
 329       gchar *name = parse_libtool_archive (file_name);
 330       if (name)
 331         {
 332           handle = _g_module_open (name, (flags & G_MODULE_BIND_LAZY) != 0);
 333           g_free (name);
 334         }
 335     }
 336
 337   /* If still not found, we check, if it is a library name without suffix */
 338   if (!handle && !g_str_check_suffix (file_name, "." G_MODULE_SUFFIX))
 339     {
 340       gchar *name = g_strconcat (file_name, "." G_MODULE_SUFFIX, NULL);
 341       handle = _g_module_open (name, (flags & G_MODULE_BIND_LAZY) != 0);
 342       g_free (name);
 343     }
 344
 345   /* If still not found, we check, if it is a libtool archive name
 346    * without suffix */
 347   if (!handle && !g_str_check_suffix (file_name, ".la"))
 348     {
 349       gchar *la_name = g_strconcat (file_name, ".la", NULL);
 350       gchar *name = parse_libtool_archive (la_name);
 351       if (name)
 352         {
 353           handle = _g_module_open (name, (flags & G_MODULE_BIND_LAZY) != 0);
 354           g_free (name);
 355         }
 356       g_free (la_name);
 357     }
 358
 359   if (handle)
 360     {
 361       gchar *saved_error;
 362       GModuleCheckInit check_init;
 363       const gchar *check_failed = NULL;
 364
 365       /* search the module list by handle, since file names are not unique */
 366       module = g_module_find_by_handle (handle);
 367       if (module)
 368         {
 369           _g_module_close (module->handle, TRUE);
 370           module->ref_count++;
 371           g_module_set_error (NULL);
 372
 373           g_static_rec_mutex_unlock (&g_module_global_lock);
 374           return module;
 375         }
 376
 377       saved_error = g_strdup (g_module_error ());
 378       g_module_set_error (NULL);
 379
 380       module = g_new (GModule, 1);
 381       module->file_name = g_strdup (file_name);
 382       module->handle = handle;
 383       module->ref_count = 1;
 384       module->is_resident = FALSE;
 385       module->unload = NULL;
 386       module->next = modules;
 387       modules = module;
 388
 389       /* check initialization */
 390       if (g_module_symbol (module, "g_module_check_init", (gpointer) &check_init))
 391         check_failed = check_init (module);
 392
 393       /* we don't call unload() if the initialization check failed. */
 394       if (!check_failed)
 395         g_module_symbol (module, "g_module_unload", (gpointer) &module->unload);
 396
 397       if (check_failed)
 398         {
 399           gchar *error;
 400
 401           error = g_strconcat ("GModule initialization check failed: ", check_failed, NULL);
 402           g_module_close (module);
 403           module = NULL;
 404           g_module_set_error (error);
 405           g_free (error);
 406         }
 407       else
 408         g_module_set_error (saved_error);
 409
 410       g_free (saved_error);
 411     }
 412
 413   g_static_rec_mutex_unlock (&g_module_global_lock);
 414   return module;
 415 }
 416
 417 gboolean
 418 g_module_close (GModule        *module)
 419 {
 420   SUPPORT_OR_RETURN (FALSE);
 421
 422   g_return_val_if_fail (module != NULL, FALSE);
 423   g_return_val_if_fail (module->ref_count > 0, FALSE);
 424
 425   g_static_rec_mutex_lock (&g_module_global_lock);
 426
 427   module->ref_count--;
 428
 429   if (!module->ref_count && !module->is_resident && module->unload)
 430     {
 431       GModuleUnload unload;
 432
 433       unload = module->unload;
 434       module->unload = NULL;
 435       unload (module);
 436     }
 437
 438   if (!module->ref_count && !module->is_resident)
 439     {
 440       GModule *last;
 441       GModule *node;
 442
 443       last = NULL;
 444
 445       node = modules;
 446       while (node)
 447         {
 448           if (node == module)
 449             {
 450               if (last)
 451                 last->next = node->next;
 452               else
 453                 modules = node->next;
 454               break;
 455             }
 456           last = node;
 457           node = last->next;
 458         }
 459       module->next = NULL;
 460
 461       _g_module_close (module->handle, FALSE);
 462       g_free (module->file_name);
 463
 464       g_free (module);
 465     }
 466
 467   g_static_rec_mutex_unlock (&g_module_global_lock);
 468   return g_module_error() == NULL;
 469 }
 470
 471 void
 472 g_module_make_resident (GModule *module)
 473 {
 474   g_return_if_fail (module != NULL);
 475
 476   module->is_resident = TRUE;
 477 }
 478
 479 G_CONST_RETURN gchar*
 480 g_module_error (void)
 481 {
 482   return g_static_private_get (&module_error_private);
 483 }
 484
 485 gboolean
 486 g_module_symbol (GModule        *module,
 487                  const gchar    *symbol_name,
 488                  gpointer       *symbol)
 489 {
 490   const gchar *module_error;
 491
 492   if (symbol)
 493     *symbol = NULL;
 494   SUPPORT_OR_RETURN (FALSE);
 495
 496   g_return_val_if_fail (module != NULL, FALSE);
 497   g_return_val_if_fail (symbol_name != NULL, FALSE);
 498   g_return_val_if_fail (symbol != NULL, FALSE);
 499
 500   g_static_rec_mutex_lock (&g_module_global_lock);
 501
 502 #ifdef  G_MODULE_NEED_USCORE
 503   {
 504     gchar *name;
 505
 506     name = g_strconcat ("_", symbol_name, NULL);
 507     *symbol = _g_module_symbol (module->handle, name);
 508     g_free (name);
 509   }
 510 #else   /* !G_MODULE_NEED_USCORE */
 511   *symbol = _g_module_symbol (module->handle, symbol_name);
 512 #endif  /* !G_MODULE_NEED_USCORE */
 513
 514   module_error = g_module_error ();
 515   if (module_error)
 516     {
 517       gchar *error;
 518
 519       error = g_strconcat ("`", symbol_name, "': ", module_error, NULL);
 520       g_module_set_error (error);
 521       g_free (error);
 522       *symbol = NULL;
 523     }
 524
 525   g_static_rec_mutex_unlock (&g_module_global_lock);
 526   return !module_error;
 527 }
 528
 529 G_CONST_RETURN gchar*
 530 g_module_name (GModule *module)
 531 {
 532   g_return_val_if_fail (module != NULL, NULL);
 533
 534   if (module == main_module)
 535     return "main";
 536
 537   return module->file_name;
 538 }
 539
 540 gchar*
 541 g_module_build_path (const gchar *directory,
 542                      const gchar *module_name)
 543 {
 544   g_return_val_if_fail (module_name != NULL, NULL);
 545
 546   return _g_module_build_path (directory, module_name);
 547 }