Rewrite of the low-level of gconv.
[kopensolaris-gnu/glibc.git] / iconv / gconv_dl.c
1 /* Handle loading/unloading of shared object for transformation.
2    Copyright (C) 1997, 1998 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1997.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Library General Public License as
8    published by the Free Software Foundation; either version 2 of the
9    License, or (at your option) any later version.
10
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Library General Public License for more details.
15
16    You should have received a copy of the GNU Library General Public
17    License along with the GNU C Library; see the file COPYING.LIB.  If not,
18    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19    Boston, MA 02111-1307, USA.  */
20
21 #include <dlfcn.h>
22 #include <inttypes.h>
23 #include <search.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <bits/libc-lock.h>
27 #include <elf/ldsodefs.h>
28 #include <sys/param.h>
29
30 #include <gconv_int.h>
31
32
33 /* This is a tuning parameter.  If a transformation module is not used
34    anymore it gets not immediately unloaded.  Instead we wait a certain
35    number of load attempts for further modules.  If none of the
36    subsequent load attempts name the same object it finally gets unloaded.
37    Otherwise it is still available which hopefully is the frequent case.
38    The following number is the number of unloading attempts we wait
39    before unloading.  */
40 #define TRIES_BEFORE_UNLOAD     2
41
42
43 /* Array of loaded objects.  This is shared by all threads so we have
44    to use semaphores to access it.  */
45 static void *loaded;
46
47
48
49 /* Comparison function for searching `loaded_object' tree.  */
50 static int
51 known_compare (const void *p1, const void *p2)
52 {
53   const struct gconv_loaded_object *s1 =
54     (const struct gconv_loaded_object *) p1;
55   const struct gconv_loaded_object *s2 =
56     (const struct gconv_loaded_object *) p2;
57
58   return (intptr_t) s1->handle - (intptr_t) s2->handle;
59 }
60
61
62 static void
63 do_open (void *a)
64 {
65   struct gconv_loaded_object *args = (struct gconv_loaded_object *) a;
66   /* Open and relocate the shared object.  */
67   args->handle = _dl_open (args->name, RTLD_LAZY);
68 }
69
70
71 static int
72 internal_function
73 dlerror_run (void (*operate) (void *), void *args)
74 {
75   char *last_errstring = NULL;
76   int result;
77
78   (void) _dl_catch_error (&last_errstring, operate, args);
79
80   result = last_errstring != NULL;
81   if (result)
82     free (last_errstring);
83
84   return result;
85 }
86
87
88 struct get_sym_args
89 {
90   /* Arguments to get_sym.  */
91   struct link_map *map;
92   const char *name;
93
94   /* Return values of get_sym.  */
95   ElfW(Addr) loadbase;
96   const ElfW(Sym) *ref;
97 };
98
99 static void
100 internal_function
101 get_sym (void *a)
102 {
103   struct get_sym_args *args = (struct get_sym_args *) a;
104   struct link_map *scope[2] = { args->map, NULL };
105   args->ref = NULL;
106   args->loadbase = _dl_lookup_symbol (args->name, &args->ref,
107                                       scope, args->map->l_name, 0);
108 }
109
110
111 static void *
112 internal_function
113 find_func (void *handle, const char *name)
114 {
115   struct get_sym_args args;
116
117   args.map = handle;
118   args.name = name;
119
120   return (dlerror_run (get_sym, &args) ? NULL
121           : (void *) (args.loadbase + args.ref->st_value));
122 }
123
124
125
126 /* Open the gconv database if necessary.  A non-negative return value
127    means success.  */
128 struct gconv_loaded_object *
129 internal_function
130 __gconv_find_shlib (const char *name)
131 {
132   struct gconv_loaded_object *found;
133
134   /* Search the tree of shared objects previously requested.  Data in
135      the tree are `loaded_object' structures, whose first member is a
136      `const char *', the lookup key.  The search returns a pointer to
137      the tree node structure; the first member of the is a pointer to
138      our structure (i.e. what will be a `loaded_object'); since the
139      first member of that is the lookup key string, &FCT_NAME is close
140      enough to a pointer to our structure to use as a lookup key that
141      will be passed to `known_compare' (above).  */
142
143   found = __tfind (&name, &loaded, known_compare);
144   if (found == NULL)
145     {
146       /* This name was not known before.  */
147       found = malloc (sizeof (struct gconv_loaded_object));
148       if (found != NULL)
149         {
150           /* Point the tree node at this new structure.  */
151           found->name = name;
152           found->counter = -TRIES_BEFORE_UNLOAD - 1;
153           found->handle = NULL;
154
155           if (__tsearch (found, &loaded, known_compare) == NULL)
156             {
157               /* Something went wrong while inserting the entry.  */
158               free (found);
159               found = NULL;
160             }
161         }
162     }
163
164   /* Try to load the shared object if the usage count is 0.  This
165      implies that if the shared object is not loadable, the handle is
166      NULL and the usage count > 0.  */
167   if (found != NULL)
168     {
169       if (found->counter < -TRIES_BEFORE_UNLOAD)
170         {
171           if (dlerror_run (do_open, found) == 0)
172             {
173               found->fct = find_func (found->handle, "gconv");
174               if (found->fct == NULL)
175                 {
176                   /* Argh, no conversion function.  There is something
177                      wrong here.  */
178                   __gconv_release_shlib (found);
179                   found = NULL;
180                 }
181               else
182                 {
183                   found->init_fct = find_func (found->handle, "gconv_init");
184                   found->end_fct = find_func (found->handle, "gconv_end");
185
186                   /* We have succeeded in loading the shared object.  */
187                   found->counter = 1;
188                 }
189             }
190           else
191             /* Error while loading the shared object.  */
192             found = NULL;
193         }
194       else if (found->handle != NULL)
195         found->counter = MAX (found->counter + 1, 1);
196     }
197
198   return found;
199 }
200
201
202 /* This is very ugly but the tsearch functions provide no way to pass
203    information to the walker function.  So we use a global variable.
204    It is MT safe since we use a lock.  */
205 static struct gconv_loaded_object *release_handle;
206
207 static void
208 do_release_shlib (const void *nodep, VISIT value, int level)
209 {
210   struct gconv_loaded_object *obj = *(struct gconv_loaded_object **) nodep;
211
212   if (value != preorder && value != leaf)
213     return;
214
215   if (obj == release_handle)
216     /* This is the object we want to unload.  Now set the release
217        counter to zero.  */
218     obj->counter = 0;
219   else if (obj->counter <= 0)
220     {
221       if (--obj->counter < -TRIES_BEFORE_UNLOAD && obj->handle != NULL)
222         {
223           /* Unload the shared object.  We don't use the trick to
224              catch errors since in the case an error is signalled
225              something is really wrong.  */
226           _dl_close (obj->handle);
227
228           obj->handle = NULL;
229         }
230     }
231 }
232
233
234 /* Notify system that a shared object is not longer needed.  */
235 int
236 internal_function
237 __gconv_release_shlib (struct gconv_loaded_object *handle)
238 {
239   /* Urgh, this is ugly but we have no other possibility.  */
240   release_handle = handle;
241
242   /* Process all entries.  Please note that we also visit entries
243      with release counts <= 0.  This way we can finally unload them
244      if necessary.  */
245   __twalk (loaded, do_release_shlib);
246
247   return GCONV_OK;
248 }