Adopt for gconv_int.h introduction.
[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 /* Structure describing one loaded shared object.  This normally are
44    objects to perform conversation but as a special case the db shared
45    object is also handled.  */
46 struct loaded_object
47 {
48   /* Name of the object.  */
49   const char *name;
50
51   /* Reference counter for the db functionality.  If no conversion is
52      needed we unload the db library.  */
53   int counter;
54
55   /* The handle for the shared object.  */
56   void *handle;
57 };
58
59
60 /* Array of loaded objects.  This is shared by all threads so we have
61    to use semaphores to access it.  */
62 static void *loaded;
63 __libc_lock_define_initialized (static, lock)
64
65
66
67 /* Comparison function for searching `loaded_object' tree.  */
68 static int
69 known_compare (const void *p1, const void *p2)
70 {
71   const struct loaded_object *s1 = (const struct loaded_object *) p1;
72   const struct loaded_object *s2 = (const struct loaded_object *) p2;
73
74   return (intptr_t) s1->handle - (intptr_t) s2->handle;
75 }
76
77
78 static void
79 do_open (void *a)
80 {
81   struct loaded_object *args = (struct loaded_object *) a;
82   /* Open and relocate the shared object.  */
83   args->handle = _dl_open (args->name, RTLD_LAZY);
84 }
85
86
87 static int
88 internal_function
89 dlerror_run (void (*operate) (void *), void *args)
90 {
91   char *last_errstring = NULL;
92   int result;
93
94   (void) _dl_catch_error (&last_errstring, operate, args);
95
96   result = last_errstring != NULL;
97   if (result)
98     free (last_errstring);
99
100   return result;
101 }
102
103
104 struct get_sym_args
105 {
106   /* Arguments to get_sym.  */
107   struct link_map *map;
108   const char *name;
109
110   /* Return values of get_sym.  */
111   ElfW(Addr) loadbase;
112   const ElfW(Sym) *ref;
113 };
114
115 static void
116 internal_function
117 get_sym (void *a)
118 {
119   struct get_sym_args *args = (struct get_sym_args *) a;
120   struct link_map *scope[2] = { args->map, NULL };
121   args->ref = NULL;
122   args->loadbase = _dl_lookup_symbol (args->name, &args->ref,
123                                       scope, args->map->l_name, 0);
124 }
125
126
127 void *
128 internal_function
129 __gconv_find_func (void *handle, const char *name)
130 {
131   struct get_sym_args args;
132
133   args.map = handle;
134   args.name = name;
135
136   return (dlerror_run (get_sym, &args) ? NULL
137           : (void *) (args.loadbase + args.ref->st_value));
138 }
139
140
141
142 /* Open the gconv database if necessary.  A non-negative return value
143    means success.  */
144 void *
145 internal_function
146 __gconv_find_shlib (const char *name)
147 {
148   void *result = NULL;
149   struct loaded_object *found;
150
151   /* Acquire the lock.  */
152   __libc_lock_lock (lock);
153
154   /* Search the tree of shared objects previously requested.  Data in
155      the tree are `loaded_object' structures, whose first member is a
156      `const char *', the lookup key.  The search returns a pointer to
157      the tree node structure; the first member of the is a pointer to
158      our structure (i.e. what will be a `loaded_object'); since the
159      first member of that is the lookup key string, &FCT_NAME is close
160      enough to a pointer to our structure to use as a lookup key that
161      will be passed to `known_compare' (above).  */
162
163   found = __tfind (&name, &loaded, known_compare);
164   if (found == NULL)
165     {
166       /* This name was not known before.  */
167       found = malloc (sizeof (struct loaded_object));
168       if (found != NULL)
169         {
170           /* Point the tree node at this new structure.  */
171           found->name = name;
172           found->counter = -TRIES_BEFORE_UNLOAD - 1;
173           found->handle = NULL;
174
175           if (__tsearch (found, &loaded, known_compare) == NULL)
176             {
177               /* Something went wrong while inserting the entry.  */
178               free (found);
179               found = NULL;
180             }
181         }
182     }
183
184   /* Try to load the shared object if the usage count is 0.  This
185      implies that if the shared object is not loadable, the handle is
186      NULL and the usage count > 0.  */
187   if (found != NULL)
188     {
189       if (found->counter < -TRIES_BEFORE_UNLOAD)
190         {
191           if (dlerror_run (do_open, found) == 0)
192             found->counter = 1;
193         }
194       else if (found->handle != NULL)
195         found->counter = MAX (found->counter + 1, 1);
196
197       result = found->handle;
198     }
199
200   /* Release the lock.  */
201   __libc_lock_unlock (lock);
202
203   return result;
204 }
205
206
207 /* This is very ugly but the tsearch functions provide no way to pass
208    information to the walker function.  So we use a global variable.
209    It is MT safe since we use a lock.  */
210 static void *release_handle;
211
212 static void
213 do_release_shlib (const void *nodep, VISIT value, int level)
214 {
215   struct loaded_object *obj = *(struct loaded_object **) nodep;
216
217   if (value != preorder && value != leaf)
218     return;
219
220   if (obj->handle == release_handle)
221     /* This is the object we want to unload.  Now set the release
222        counter to zero.  */
223     obj->counter = 0;
224   else if (obj->counter <= 0)
225     {
226       if (--obj->counter < -TRIES_BEFORE_UNLOAD && obj->handle != NULL)
227         {
228           /* Unload the shared object.  We don't use the trick to
229              catch errors since in the case an error is signalled
230              something is really wrong.  */
231           _dl_close ((struct link_map *) obj->handle);
232
233           obj->handle = NULL;
234         }
235     }
236 }
237
238
239 /* Notify system that a shared object is not longer needed.  */
240 int
241 internal_function
242 __gconv_release_shlib (void *handle)
243 {
244   /* Acquire the lock.  */
245   __libc_lock_lock (lock);
246
247   /* Urgh, this is ugly but we have no other possibility.  */
248   release_handle = handle;
249
250   /* Process all entries.  Please note that we also visit entries
251      with release counts <= 0.  This way we can finally unload them
252      if necessary.  */
253   __twalk (loaded, do_release_shlib);
254
255   /* Release the lock.  */
256   __libc_lock_unlock (lock);
257
258   return GCONV_OK;
259 }