gmodule/gmodule-dl.c

   1 /* GMODULE - GLIB wrapper code for dynamic module loading
   2  * Copyright (C) 1998, 2000 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 <dlfcn.h>
  32
  33 /* Perl includes <nlist.h> and <link.h> instead of <dlfcn.h> on some systmes? */
  34
  35
  36 /* dlerror() is not implemented on all systems
  37  */
  38 #ifndef G_MODULE_HAVE_DLERROR
  39 #  ifdef __NetBSD__
  40 #    define dlerror()   g_strerror (errno)
  41 #  else /* !__NetBSD__ */
  42 /* could we rely on errno's state here? */
  43 #    define dlerror()   "unknown dl-error"
  44 #  endif /* !__NetBSD__ */
  45 #endif  /* G_MODULE_HAVE_DLERROR */
  46
  47 /* some flags are missing on some systems, so we provide
  48  * harmless defaults.
  49  * The Perl sources say, RTLD_LAZY needs to be defined as (1),
  50  * at least for Solaris 1.
  51  *
  52  * Mandatory:
  53  * RTLD_LAZY   - resolve undefined symbols as code from the dynamic library
  54  *               is executed.
  55  * RTLD_NOW    - resolve all undefined symbols before dlopen returns, and fail
  56  *               if this cannot be done.
  57  * Optionally:
  58  * RTLD_GLOBAL - the external symbols defined in the library will be made
  59  *               available to subsequently loaded libraries.
  60  */
  61 #ifndef RTLD_GLOBAL
  62 #define RTLD_GLOBAL     0
  63 #endif  /* RTLD_GLOBAL */
  64 #ifndef RTLD_LAZY
  65 #define RTLD_LAZY       1
  66 #endif  /* RTLD_LAZY */
  67 #ifndef RTLD_NOW
  68 #define RTLD_NOW        0
  69 #endif  /* RTLD_NOW */
  70
  71
  72 /* --- functions --- */
  73 static gchar*
  74 fetch_dlerror (void)
  75 {
  76   gchar *msg = dlerror ();
  77
  78   /* make sure we always return an error message != NULL */
  79
  80   return msg ? msg : "unknown dl-error";
  81 }
  82
  83 static gpointer
  84 _g_module_open (const gchar *file_name,
  85                 gboolean     bind_lazy)
  86 {
  87   gpointer handle;
  88
  89   handle = dlopen (file_name, RTLD_GLOBAL | (bind_lazy ? RTLD_LAZY : RTLD_NOW));
  90   if (!handle)
  91     g_module_set_error (fetch_dlerror ());
  92
  93   return handle;
  94 }
  95
  96 static gpointer
  97 _g_module_self (void)
  98 {
  99   gpointer handle;
 100
 101   /* to query symbols from the program itself, special link options
 102    * are required on some systems.
 103    */
 104
 105   handle = dlopen (NULL, RTLD_GLOBAL | RTLD_LAZY);
 106   if (!handle)
 107     g_module_set_error (fetch_dlerror ());
 108
 109   return handle;
 110 }
 111
 112 static void
 113 _g_module_close (gpointer handle,
 114                  gboolean is_unref)
 115 {
 116   /* are there any systems out there that have dlopen()/dlclose()
 117    * without a reference count implementation?
 118    */
 119   is_unref |= 1;
 120
 121   if (is_unref)
 122     {
 123       if (dlclose (handle) != 0)
 124         g_module_set_error (fetch_dlerror ());
 125     }
 126 }
 127
 128 static gpointer
 129 _g_module_symbol (gpointer     handle,
 130                   const gchar *symbol_name)
 131 {
 132   gpointer p;
 133
 134   p = dlsym (handle, symbol_name);
 135   if (!p)
 136     g_module_set_error (fetch_dlerror ());
 137
 138   return p;
 139 }
 140
 141 static gchar*
 142 _g_module_build_path (const gchar *directory,
 143                       const gchar *module_name)
 144 {
 145   if (directory && *directory) {
 146     if (strncmp (module_name, "lib", 3) == 0)
 147       return g_strconcat (directory, "/", module_name, NULL);
 148     else
 149       return g_strconcat (directory, "/lib", module_name, ".so", NULL);
 150   } else if (strncmp (module_name, "lib", 3) == 0)
 151     return g_strdup (module_name);
 152   else
 153     return g_strconcat ("lib", module_name, ".so", NULL);
 154 }