fix leak.
[platform/upstream/glib.git] / 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_unduped (gchar *error)
128 {
129   g_static_private_set (&module_error_private, error, g_free);
130   errno = 0;
131 }
132
133 static inline void
134 g_module_set_error (const gchar *error)
135 {
136   g_module_set_error_unduped (g_strdup (error));
137 }
138
139
140 /* --- include platform specifc code --- */
141 #define SUPPORT_OR_RETURN(rv)   { g_module_set_error (NULL); }
142 #if     (G_MODULE_IMPL == G_MODULE_IMPL_DL)
143 #include "gmodule-dl.c"
144 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_DLD)
145 #include "gmodule-dld.c"
146 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_WIN32)
147 #include "gmodule-win32.c"
148 #elif   (G_MODULE_IMPL == G_MODULE_IMPL_DYLD)
149 #include "gmodule-dyld.c"
150 #else
151 #undef  SUPPORT_OR_RETURN
152 #define SUPPORT_OR_RETURN(rv)   { g_module_set_error ("dynamic modules are " \
153                                               "not supported by this system"); return rv; }
154 static gpointer
155 _g_module_open (const gchar     *file_name,
156                 gboolean         bind_lazy)
157 {
158   return NULL;
159 }
160 static void
161 _g_module_close (gpointer        handle,
162                  gboolean        is_unref)
163 {
164 }
165 static gpointer
166 _g_module_self (void)
167 {
168   return NULL;
169 }
170 static gpointer
171 _g_module_symbol (gpointer       handle,
172                   const gchar   *symbol_name)
173 {
174   return NULL;
175 }
176 static gchar*
177 _g_module_build_path (const gchar *directory,
178                       const gchar *module_name)
179 {
180   return NULL;
181 }
182 #endif  /* no implementation */
183
184 /* --- functions --- */
185 gboolean
186 g_module_supported (void)
187 {
188   SUPPORT_OR_RETURN (FALSE);
189   
190   return TRUE;
191 }
192
193 static gchar*
194 parse_libtool_archive (const gchar* libtool_name)
195 {
196   const gint TOKEN_DLNAME = G_TOKEN_LAST + 1;
197   const gint TOKEN_INSTALLED = G_TOKEN_LAST + 2;
198   const gint TOKEN_LIBDIR = G_TOKEN_LAST + 3;
199   gchar *lt_dlname = NULL;
200   gboolean lt_installed = TRUE;
201   gchar *lt_libdir = NULL;
202   gchar *name;
203   GTokenType token;
204   GScanner *scanner;
205   
206   int fd = open (libtool_name, O_RDONLY, 0);
207   if (fd < 0)
208     {
209       g_module_set_error_unduped (g_strdup_printf ("failed to open libtool archive \"%s\"", libtool_name));   
210       return NULL;
211     }
212   /* search libtool's dlname specification  */
213   scanner = g_scanner_new (NULL);
214   g_scanner_input_file (scanner, fd);
215   scanner->config->symbol_2_token = TRUE;
216   g_scanner_scope_add_symbol (scanner, 0, "dlname", 
217                               GUINT_TO_POINTER (TOKEN_DLNAME));
218   g_scanner_scope_add_symbol (scanner, 0, "installed", 
219                               GUINT_TO_POINTER (TOKEN_INSTALLED));
220   g_scanner_scope_add_symbol (scanner, 0, "libdir", 
221                               GUINT_TO_POINTER (TOKEN_LIBDIR));
222   while (!g_scanner_eof (scanner))
223     {
224       token = g_scanner_get_next_token (scanner);
225       if (token == TOKEN_DLNAME || token == TOKEN_INSTALLED || 
226           token == TOKEN_LIBDIR)
227         {
228           if (g_scanner_get_next_token (scanner) != '=' ||
229               g_scanner_get_next_token (scanner) != 
230               (token == TOKEN_INSTALLED ? 
231                G_TOKEN_IDENTIFIER : G_TOKEN_STRING))
232             {
233               g_module_set_error_unduped (g_strdup_printf ("unable to parse libtool archive \"%s\"", libtool_name));
234
235               g_free (lt_dlname);
236               g_free (lt_libdir);
237               g_scanner_destroy (scanner);
238               close (fd);
239
240               return NULL;
241             }
242           else
243             {
244               if (token == TOKEN_DLNAME)
245                 {
246                   g_free (lt_dlname);
247                   lt_dlname = g_strdup (scanner->value.v_string);
248                 }
249               else if (token == TOKEN_INSTALLED)
250                 lt_installed = 
251                   strcmp (scanner->value.v_identifier, "yes") == 0;
252               else /* token == TOKEN_LIBDIR */
253                 {
254                   g_free (lt_libdir);
255                   lt_libdir = g_strdup (scanner->value.v_string);
256                 }
257             }
258         }      
259     }
260
261   if (!lt_installed)
262     {
263       gchar *dir = g_path_get_dirname (libtool_name);
264       g_free (lt_libdir);
265       lt_libdir = g_strconcat (dir, G_DIR_SEPARATOR_S ".libs", NULL);
266       g_free (dir);
267     }
268
269   name = g_strconcat (lt_libdir, G_DIR_SEPARATOR_S, lt_dlname, NULL);
270   
271   g_free (lt_dlname);
272   g_free (lt_libdir);
273   g_scanner_destroy (scanner);
274   close (fd);
275
276   return name;
277 }
278
279 static inline gboolean
280 str_check_suffix (const gchar* string,
281                   const gchar* suffix)
282 {
283   gsize string_len = strlen (string);    
284   gsize suffix_len = strlen (suffix);    
285
286   return string_len >= suffix_len && 
287     strcmp (string + string_len - suffix_len, suffix) == 0;
288 }
289
290 static GStaticRecMutex g_module_global_lock = G_STATIC_REC_MUTEX_INIT;
291
292 GModule*
293 g_module_open (const gchar    *file_name,
294                GModuleFlags    flags)
295 {
296   GModule *module;
297   gpointer handle = NULL;
298   gchar *name = NULL;
299   
300   SUPPORT_OR_RETURN (NULL);
301   
302   g_static_rec_mutex_lock (&g_module_global_lock);
303   if (!file_name)
304     {      
305       if (!main_module)
306         {
307           handle = _g_module_self ();
308           if (handle)
309             {
310               main_module = g_new (GModule, 1);
311               main_module->file_name = NULL;
312               main_module->handle = handle;
313               main_module->ref_count = 1;
314               main_module->is_resident = TRUE;
315               main_module->unload = NULL;
316               main_module->next = NULL;
317             }
318         }
319
320       g_static_rec_mutex_unlock (&g_module_global_lock);
321       return main_module;
322     }
323   
324   /* we first search the module list by name */
325   module = g_module_find_by_name (file_name);
326   if (module)
327     {
328       module->ref_count++;
329       
330       g_static_rec_mutex_unlock (&g_module_global_lock);
331       return module;
332     }
333
334   /* check whether we have a readable file right away */
335   if (g_file_test (file_name, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR))
336     name = g_strdup (file_name);
337   /* try completing file name with standard library suffix */
338   if (!name)
339     {
340       name = g_strconcat (file_name, "." G_MODULE_SUFFIX, NULL);
341       if (!g_file_test (file_name, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR))
342         {
343           g_free (name);
344           name = NULL;
345         }
346     }
347   /* try completing by appending libtool suffix */
348   if (!name)
349     {
350       name = g_strconcat (file_name, ".la", NULL);
351       if (!g_file_test (name, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR))
352         {
353           g_free (name);
354           name = NULL;
355         }
356     }
357   /* we can't access() the file, lets hope the platform backends finds
358    * it via library paths
359    */
360   if (!name)
361     {
362       gchar *dot = strrchr (file_name, '.');
363       gchar *slash = strrchr (file_name, G_DIR_SEPARATOR);
364       
365       /* make sure the name has a suffix */
366       if (!dot || dot < slash)
367         name = g_strconcat (file_name, "." G_MODULE_SUFFIX, NULL);
368       else
369         name = g_strdup (file_name);
370     }
371
372   /* ok, try loading the module */
373   if (name)
374     {
375       /* if it's a libtool archive, figure library file to load */
376       if (str_check_suffix (name, ".la")) /* libtool archive? */
377         {
378           gchar *real_name = parse_libtool_archive (name);
379
380           /* real_name might be NULL, but then module error is already set */
381           g_free (name);
382           name = real_name;
383         }
384       if (name)
385         handle = _g_module_open (name, (flags & G_MODULE_BIND_LAZY) != 0);
386     }
387   else
388     g_module_set_error_unduped (g_strdup_printf ("unable to access file \"%s\"", file_name));
389   g_free (name);
390
391   if (handle)
392     {
393       gchar *saved_error;
394       GModuleCheckInit check_init;
395       const gchar *check_failed = NULL;
396       
397       /* search the module list by handle, since file names are not unique */
398       module = g_module_find_by_handle (handle);
399       if (module)
400         {
401           _g_module_close (module->handle, TRUE);
402           module->ref_count++;
403           g_module_set_error (NULL);
404           
405           g_static_rec_mutex_unlock (&g_module_global_lock);
406           return module;
407         }
408       
409       saved_error = g_strdup (g_module_error ());
410       g_module_set_error (NULL);
411       
412       module = g_new (GModule, 1);
413       module->file_name = g_strdup (file_name);
414       module->handle = handle;
415       module->ref_count = 1;
416       module->is_resident = FALSE;
417       module->unload = NULL;
418       module->next = modules;
419       modules = module;
420       
421       /* check initialization */
422       if (g_module_symbol (module, "g_module_check_init", (gpointer) &check_init))
423         check_failed = check_init (module);
424       
425       /* we don't call unload() if the initialization check failed. */
426       if (!check_failed)
427         g_module_symbol (module, "g_module_unload", (gpointer) &module->unload);
428       
429       if (check_failed)
430         {
431           gchar *error;
432
433           error = g_strconcat ("GModule initialization check failed: ", check_failed, NULL);
434           g_module_close (module);
435           module = NULL;
436           g_module_set_error (error);
437           g_free (error);
438         }
439       else
440         g_module_set_error (saved_error);
441
442       g_free (saved_error);
443     }
444
445   g_static_rec_mutex_unlock (&g_module_global_lock);
446   return module;
447 }
448
449 gboolean
450 g_module_close (GModule        *module)
451 {
452   SUPPORT_OR_RETURN (FALSE);
453   
454   g_return_val_if_fail (module != NULL, FALSE);
455   g_return_val_if_fail (module->ref_count > 0, FALSE);
456   
457   g_static_rec_mutex_lock (&g_module_global_lock);
458
459   module->ref_count--;
460   
461   if (!module->ref_count && !module->is_resident && module->unload)
462     {
463       GModuleUnload unload;
464
465       unload = module->unload;
466       module->unload = NULL;
467       unload (module);
468     }
469
470   if (!module->ref_count && !module->is_resident)
471     {
472       GModule *last;
473       GModule *node;
474       
475       last = NULL;
476       
477       node = modules;
478       while (node)
479         {
480           if (node == module)
481             {
482               if (last)
483                 last->next = node->next;
484               else
485                 modules = node->next;
486               break;
487             }
488           last = node;
489           node = last->next;
490         }
491       module->next = NULL;
492       
493       _g_module_close (module->handle, FALSE);
494       g_free (module->file_name);
495       
496       g_free (module);
497     }
498   
499   g_static_rec_mutex_unlock (&g_module_global_lock);
500   return g_module_error() == NULL;
501 }
502
503 void
504 g_module_make_resident (GModule *module)
505 {
506   g_return_if_fail (module != NULL);
507
508   module->is_resident = TRUE;
509 }
510
511 G_CONST_RETURN gchar*
512 g_module_error (void)
513 {
514   return g_static_private_get (&module_error_private);
515 }
516
517 gboolean
518 g_module_symbol (GModule        *module,
519                  const gchar    *symbol_name,
520                  gpointer       *symbol)
521 {
522   const gchar *module_error;
523
524   if (symbol)
525     *symbol = NULL;
526   SUPPORT_OR_RETURN (FALSE);
527   
528   g_return_val_if_fail (module != NULL, FALSE);
529   g_return_val_if_fail (symbol_name != NULL, FALSE);
530   g_return_val_if_fail (symbol != NULL, FALSE);
531   
532   g_static_rec_mutex_lock (&g_module_global_lock);
533
534 #ifdef  G_MODULE_NEED_USCORE
535   {
536     gchar *name;
537
538     name = g_strconcat ("_", symbol_name, NULL);
539     *symbol = _g_module_symbol (module->handle, name);
540     g_free (name);
541   }
542 #else   /* !G_MODULE_NEED_USCORE */
543   *symbol = _g_module_symbol (module->handle, symbol_name);
544 #endif  /* !G_MODULE_NEED_USCORE */
545   
546   module_error = g_module_error ();
547   if (module_error)
548     {
549       gchar *error;
550
551       error = g_strconcat ("`", symbol_name, "': ", module_error, NULL);
552       g_module_set_error (error);
553       g_free (error);
554       *symbol = NULL;
555     }
556   
557   g_static_rec_mutex_unlock (&g_module_global_lock);
558   return !module_error;
559 }
560
561 G_CONST_RETURN gchar*
562 g_module_name (GModule *module)
563 {
564   g_return_val_if_fail (module != NULL, NULL);
565   
566   if (module == main_module)
567     return "main";
568   
569   return module->file_name;
570 }
571
572 gchar*
573 g_module_build_path (const gchar *directory,
574                      const gchar *module_name)
575 {
576   g_return_val_if_fail (module_name != NULL, NULL);
577   
578   return _g_module_build_path (directory, module_name);
579 }