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