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 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.
   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  * Library General Public License for more details.
  13  *
  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.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 /*
  28  * MT safe
  29  */
  30
  31 #include        "gmodule.h"
  32 #include        "gmoduleconf.h"
  33 #include        <errno.h>
  34 #include        <string.h>
  35
  36
  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.
  43  */
  44
  45
  46 /* --- structures --- */
  47 struct _GModule
  48 {
  49   gchar *file_name;
  50   gpointer handle;
  51   guint ref_count : 31;
  52   guint is_resident : 1;
  53   GModuleUnload unload;
  54   GModule *next;
  55 };
  56
  57
  58 /* --- prototypes --- */
  59 static gpointer         _g_module_open          (const gchar    *file_name,
  60                                                  gboolean        bind_lazy);
  61 static void             _g_module_close         (gpointer        handle,
  62                                                  gboolean        is_unref);
  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);
  71
  72
  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;
  79
  80
  81 /* --- inline functions --- */
  82 static inline GModule*
  83 g_module_find_by_handle (gpointer handle)
  84 {
  85   GModule *module;
  86   GModule *retval = NULL;
  87
  88   G_LOCK (GModule);
  89   if (main_module && main_module->handle == handle)
  90     retval = main_module;
  91   else
  92     for (module = modules; module; module = module->next)
  93       if (handle == module->handle)
  94         {
  95           retval = module;
  96           break;
  97         }
  98   G_UNLOCK (GModule);
  99
 100   return retval;
 101 }
 102
 103 static inline GModule*
 104 g_module_find_by_name (const gchar *name)
 105 {
 106   GModule *module;
 107   GModule *retval = NULL;
 108
 109   G_LOCK (GModule);
 110   for (module = modules; module; module = module->next)
 111     if (strcmp (name, module->file_name) == 0)
 112         {
 113           retval = module;
 114           break;
 115         }
 116   G_UNLOCK (GModule);
 117
 118   return retval;
 119 }
 120
 121 static inline void
 122 g_module_set_error (const gchar *error)
 123 {
 124   g_static_private_set (&module_error_private, g_strdup (error), g_free);
 125   errno = 0;
 126 }
 127
 128
 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"
 139 #else
 140 #undef  CHECK_ERROR
 141 #define CHECK_ERROR(rv) { g_module_set_error ("dynamic modules are " \
 142                                               "not supported by this system"); return rv; }
 143 static gpointer
 144 _g_module_open (const gchar     *file_name,
 145                 gboolean         bind_lazy)
 146 {
 147   return NULL;
 148 }
 149 static void
 150 _g_module_close (gpointer        handle,
 151                  gboolean        is_unref)
 152 {
 153 }
 154 static gpointer
 155 _g_module_self (void)
 156 {
 157   return NULL;
 158 }
 159 static gpointer
 160 _g_module_symbol (gpointer       handle,
 161                   const gchar   *symbol_name)
 162 {
 163   return NULL;
 164 }
 165 static gchar*
 166 _g_module_build_path (const gchar *directory,
 167                       const gchar *module_name)
 168 {
 169   return NULL;
 170 }
 171 #endif  /* no implementation */
 172
 173 /* --- functions --- */
 174 gboolean
 175 g_module_supported (void)
 176 {
 177   CHECK_ERROR (FALSE);
 178
 179   return TRUE;
 180 }
 181
 182 GModule*
 183 g_module_open (const gchar    *file_name,
 184                GModuleFlags    flags)
 185 {
 186   GModule *module;
 187   gpointer handle;
 188
 189   CHECK_ERROR (NULL);
 190
 191   if (!file_name)
 192     {
 193       G_LOCK (GModule);
 194       if (!main_module)
 195         {
 196           handle = _g_module_self ();
 197           if (handle)
 198             {
 199               main_module = g_new (GModule, 1);
 200               main_module->file_name = NULL;
 201               main_module->handle = handle;
 202               main_module->ref_count = 1;
 203               main_module->is_resident = TRUE;
 204               main_module->unload = NULL;
 205               main_module->next = NULL;
 206             }
 207         }
 208       G_UNLOCK (GModule);
 209
 210       return main_module;
 211     }
 212
 213   /* we first search the module list by name */
 214   module = g_module_find_by_name (file_name);
 215   if (module)
 216     {
 217       module->ref_count++;
 218
 219       return module;
 220     }
 221
 222   /* open the module */
 223   handle = _g_module_open (file_name, (flags & G_MODULE_BIND_LAZY) != 0);
 224   if (handle)
 225     {
 226       gchar *saved_error;
 227       GModuleCheckInit check_init;
 228       const gchar *check_failed = NULL;
 229
 230       /* search the module list by handle, since file names are not unique */
 231       module = g_module_find_by_handle (handle);
 232       if (module)
 233         {
 234           _g_module_close (module->handle, TRUE);
 235           module->ref_count++;
 236           g_module_set_error (NULL);
 237
 238           return module;
 239         }
 240
 241       saved_error = g_strdup (g_module_error ());
 242       g_module_set_error (NULL);
 243
 244       module = g_new (GModule, 1);
 245       module->file_name = g_strdup (file_name);
 246       module->handle = handle;
 247       module->ref_count = 1;
 248       module->is_resident = FALSE;
 249       module->unload = NULL;
 250       G_LOCK (GModule);
 251       module->next = modules;
 252       modules = module;
 253       G_UNLOCK (GModule);
 254
 255       /* check initialization */
 256       if (g_module_symbol (module, "g_module_check_init", (gpointer) &check_init))
 257         check_failed = check_init (module);
 258
 259       /* we don't call unload() if the initialization check failed. */
 260       if (!check_failed)
 261         g_module_symbol (module, "g_module_unload", (gpointer) &module->unload);
 262
 263       if (check_failed)
 264         {
 265           gchar *error;
 266
 267           error = g_strconcat ("GModule initialization check failed: ", check_failed, NULL);
 268           g_module_close (module);
 269           module = NULL;
 270           g_module_set_error (error);
 271           g_free (error);
 272         }
 273       else
 274         g_module_set_error (saved_error);
 275
 276       g_free (saved_error);
 277     }
 278
 279   return module;
 280 }
 281
 282 gboolean
 283 g_module_close (GModule        *module)
 284 {
 285   CHECK_ERROR (FALSE);
 286
 287   g_return_val_if_fail (module != NULL, FALSE);
 288   g_return_val_if_fail (module->ref_count > 0, FALSE);
 289
 290   module->ref_count--;
 291
 292   if (!module->ref_count && !module->is_resident && module->unload)
 293     {
 294       GModuleUnload unload;
 295
 296       unload = module->unload;
 297       module->unload = NULL;
 298       unload (module);
 299     }
 300
 301   if (!module->ref_count && !module->is_resident)
 302     {
 303       GModule *last;
 304       GModule *node;
 305
 306       last = NULL;
 307
 308       G_LOCK (GModule);
 309       node = modules;
 310       while (node)
 311         {
 312           if (node == module)
 313             {
 314               if (last)
 315                 last->next = node->next;
 316               else
 317                 modules = node->next;
 318               break;
 319             }
 320           last = node;
 321           node = last->next;
 322         }
 323       module->next = NULL;
 324       G_UNLOCK (GModule);
 325
 326       _g_module_close (module->handle, FALSE);
 327       g_free (module->file_name);
 328
 329       g_free (module);
 330     }
 331
 332   return g_module_error() == NULL;
 333 }
 334
 335 void
 336 g_module_make_resident (GModule *module)
 337 {
 338   g_return_if_fail (module != NULL);
 339
 340   module->is_resident = TRUE;
 341 }
 342
 343 gchar*
 344 g_module_error (void)
 345 {
 346   return g_static_private_get (&module_error_private);
 347 }
 348
 349 gboolean
 350 g_module_symbol (GModule        *module,
 351                  const gchar    *symbol_name,
 352                  gpointer       *symbol)
 353 {
 354   gchar *module_error;
 355   if (symbol)
 356     *symbol = NULL;
 357   CHECK_ERROR (FALSE);
 358
 359   g_return_val_if_fail (module != NULL, FALSE);
 360   g_return_val_if_fail (symbol_name != NULL, FALSE);
 361   g_return_val_if_fail (symbol != NULL, FALSE);
 362
 363 #ifdef  G_MODULE_NEED_USCORE
 364   {
 365     gchar *name;
 366
 367     name = g_strconcat ("_", symbol_name, NULL);
 368     *symbol = _g_module_symbol (module->handle, name);
 369     g_free (name);
 370   }
 371 #else   /* !G_MODULE_NEED_USCORE */
 372   *symbol = _g_module_symbol (module->handle, symbol_name);
 373 #endif  /* !G_MODULE_NEED_USCORE */
 374
 375   if ((module_error = g_module_error()))
 376     {
 377       gchar *error;
 378
 379       error = g_strconcat ("`", symbol_name, "': ", module_error, NULL);
 380       g_module_set_error (error);
 381       g_free (error);
 382       *symbol = NULL;
 383       return FALSE;
 384     }
 385
 386   return TRUE;
 387 }
 388
 389 gchar*
 390 g_module_name (GModule *module)
 391 {
 392   g_return_val_if_fail (module != NULL, NULL);
 393
 394   if (module == main_module)
 395     return "main";
 396
 397   return module->file_name;
 398 }
 399
 400 gchar*
 401 g_module_build_path (const gchar *directory,
 402                      const gchar *module_name)
 403 {
 404   g_return_val_if_fail (module_name != NULL, NULL);
 405
 406   return _g_module_build_path (directory, module_name);
 407 }