iconv/gconv_dl.c

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