xref: /netbsd-src/lib/libc/citrus/citrus_module.c (revision 56a34939419542e88b386b2229be7565f4f45461)
1 /*	$NetBSD: citrus_module.c,v 1.7 2008/06/14 16:01:07 tnozaki Exp $	*/
2 
3 /*-
4  * Copyright (c)1999, 2000, 2001, 2002 Citrus Project,
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 /*-
30  * Copyright (c) 1998 The NetBSD Foundation, Inc.
31  * All rights reserved.
32  *
33  * This code is derived from software contributed to The NetBSD Foundation
34  * by Paul Kranenburg.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
46  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
47  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
48  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
49  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
50  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
51  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
52  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
53  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
55  * POSSIBILITY OF SUCH DAMAGE.
56  */
57 
58 /*-
59  * Copyright (c) 1993
60  *	The Regents of the University of California.  All rights reserved.
61  *
62  * This code is derived from software contributed to Berkeley by
63  * Paul Borman at Krystal Technologies.
64  *
65  * Redistribution and use in source and binary forms, with or without
66  * modification, are permitted provided that the following conditions
67  * are met:
68  * 1. Redistributions of source code must retain the above copyright
69  *    notice, this list of conditions and the following disclaimer.
70  * 2. Redistributions in binary form must reproduce the above copyright
71  *    notice, this list of conditions and the following disclaimer in the
72  *    documentation and/or other materials provided with the distribution.
73  * 3. Neither the name of the University nor the names of its contributors
74  *    may be used to endorse or promote products derived from this software
75  *    without specific prior written permission.
76  *
77  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
78  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
79  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
80  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
81  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
82  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
83  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
84  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
85  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
86  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
87  * SUCH DAMAGE.
88  */
89 
90 #include <sys/cdefs.h>
91 #if defined(LIBC_SCCS) && !defined(lint)
92 __RCSID("$NetBSD: citrus_module.c,v 1.7 2008/06/14 16:01:07 tnozaki Exp $");
93 #endif /* LIBC_SCCS and not lint */
94 
95 #include <assert.h>
96 #include <errno.h>
97 #include <limits.h>
98 #include <string.h>
99 #include <stdio.h>
100 #include <stdlib.h>
101 #include <unistd.h>
102 #include <stddef.h>
103 #include <paths.h>
104 #include "citrus_module.h"
105 
106 #include <sys/types.h>
107 #include <dirent.h>
108 #include <dlfcn.h>
109 
110 #ifdef _I18N_DYNAMIC
111 
112 static int _getdewey(int [], char *);
113 static int _cmpndewey(int [], int, int [], int);
114 static const char *_findshlib(char *, int *, int *);
115 
116 static const char *_pathI18nModule = NULL;
117 
118 /* from libexec/ld.aout_so/shlib.c */
119 #undef major
120 #undef minor
121 #define MAXDEWEY	3	/*ELF*/
122 
123 static int
124 _getdewey(int dewey[], char *cp)
125 {
126 	int	i, n;
127 
128 	_DIAGASSERT(dewey != NULL);
129 	_DIAGASSERT(cp != NULL);
130 
131 	for (n = 0, i = 0; i < MAXDEWEY; i++) {
132 		if (*cp == '\0')
133 			break;
134 
135 		if (*cp == '.') cp++;
136 		if (*cp < '0' || '9' < *cp)
137 			return 0;
138 
139 		dewey[n++] = (int)strtol(cp, &cp, 10);
140 	}
141 
142 	return n;
143 }
144 
145 /*
146  * Compare two dewey arrays.
147  * Return -1 if `d1' represents a smaller value than `d2'.
148  * Return  1 if `d1' represents a greater value than `d2'.
149  * Return  0 if equal.
150  */
151 static int
152 _cmpndewey(int d1[], int n1, int d2[], int n2)
153 {
154 	register int	i;
155 
156 	_DIAGASSERT(d1 != NULL);
157 	_DIAGASSERT(d2 != NULL);
158 
159 	for (i = 0; i < n1 && i < n2; i++) {
160 		if (d1[i] < d2[i])
161 			return -1;
162 		if (d1[i] > d2[i])
163 			return 1;
164 	}
165 
166 	if (n1 == n2)
167 		return 0;
168 
169 	if (i == n1)
170 		return -1;
171 
172 	if (i == n2)
173 		return 1;
174 
175 	/* XXX cannot happen */
176 	return 0;
177 }
178 
179 static const char *
180 _findshlib(char *name, int *majorp, int *minorp)
181 {
182 	int		dewey[MAXDEWEY];
183 	int		ndewey;
184 	int		tmp[MAXDEWEY];
185 	int		i;
186 	int		len;
187 	char		*lname;
188 	static char	path[PATH_MAX];
189 	int		major, minor;
190 	const char	*search_dirs[1];
191 	const int	n_search_dirs = 1;
192 
193 	_DIAGASSERT(name != NULL);
194 	_DIAGASSERT(majorp != NULL);
195 	_DIAGASSERT(minorp != NULL);
196 
197 	major = *majorp;
198 	minor = *minorp;
199 	path[0] = '\0';
200 	search_dirs[0] = _pathI18nModule;
201 	len = strlen(name);
202 	lname = name;
203 
204 	ndewey = 0;
205 
206 	for (i = 0; i < n_search_dirs; i++) {
207 		DIR		*dd = opendir(search_dirs[i]);
208 		struct dirent	*dp;
209 		int		found_dot_a = 0;
210 		int		found_dot_so = 0;
211 
212 		if (dd == NULL)
213 			continue;
214 
215 		while ((dp = readdir(dd)) != NULL) {
216 			int	n;
217 
218 			if (dp->d_namlen < len + 4)
219 				continue;
220 			if (strncmp(dp->d_name, lname, (size_t)len) != 0)
221 				continue;
222 			if (strncmp(dp->d_name+len, ".so.", 4) != 0)
223 				continue;
224 
225 			if ((n = _getdewey(tmp, dp->d_name+len+4)) == 0)
226 				continue;
227 
228 			if (major != -1 && found_dot_a)
229 				found_dot_a = 0;
230 
231 			/* XXX should verify the library is a.out/ELF? */
232 
233 			if (major == -1 && minor == -1) {
234 				goto compare_version;
235 			} else if (major != -1 && minor == -1) {
236 				if (tmp[0] == major)
237 					goto compare_version;
238 			} else if (major != -1 && minor != -1) {
239 				if (tmp[0] == major) {
240 					if (n == 1 || tmp[1] >= minor)
241 						goto compare_version;
242 				}
243 			}
244 
245 			/* else, this file does not qualify */
246 			continue;
247 
248 		compare_version:
249 			if (_cmpndewey(tmp, n, dewey, ndewey) <= 0)
250 				continue;
251 
252 			/* We have a better version */
253 			found_dot_so = 1;
254 			snprintf(path, sizeof(path), "%s/%s", search_dirs[i],
255 			    dp->d_name);
256 			found_dot_a = 0;
257 			bcopy(tmp, dewey, sizeof(dewey));
258 			ndewey = n;
259 			*majorp = dewey[0];
260 			*minorp = dewey[1];
261 		}
262 		closedir(dd);
263 
264 		if (found_dot_a || found_dot_so)
265 			/*
266 			 * There's a lib in this dir; take it.
267 			 */
268 			return path[0] ? path : NULL;
269 	}
270 
271 	return path[0] ? path : NULL;
272 }
273 
274 void *
275 _citrus_find_getops(_citrus_module_t handle, const char *modname,
276 		    const char *ifname)
277 {
278 	char name[PATH_MAX];
279 	void *p;
280 
281 	_DIAGASSERT(handle != NULL);
282 	_DIAGASSERT(modname != NULL);
283 	_DIAGASSERT(ifname != NULL);
284 
285 	snprintf(name, sizeof(name), _C_LABEL_STRING("_citrus_%s_%s_getops"),
286 	    modname, ifname);
287 	p = dlsym((void *)handle, name);
288 	return p;
289 }
290 
291 int
292 _citrus_load_module(_citrus_module_t *rhandle, const char *encname)
293 {
294 	const char *p;
295 	char path[PATH_MAX];
296 	int maj, min;
297 	void *handle;
298 
299 	_DIAGASSERT(rhandle != NULL);
300 
301 	if (_pathI18nModule == NULL) {
302 		p = getenv("PATH_I18NMODULE");
303 		if (p != NULL && !issetugid()) {
304 			_pathI18nModule = strdup(p);
305 			if (_pathI18nModule == NULL)
306 				return ENOMEM;
307 		} else
308 			_pathI18nModule = _PATH_I18NMODULE;
309 	}
310 
311 	(void)snprintf(path, sizeof(path), "lib%s", encname);
312 	maj = I18NMODULE_MAJOR;
313 	min = -1;
314 	p = _findshlib(path, &maj, &min);
315 	if (!p)
316 		return (EINVAL);
317 	handle = dlopen(p, RTLD_LAZY);
318 	if (!handle)
319 		return (EINVAL);
320 
321 	*rhandle = (_citrus_module_t)handle;
322 
323 	return (0);
324 }
325 
326 void
327 _citrus_unload_module(_citrus_module_t handle)
328 {
329 	if (handle)
330 		dlclose((void *)handle);
331 }
332 #else
333 /* !_I18N_DYNAMIC */
334 
335 void *
336 /*ARGSUSED*/
337 _citrus_find_getops(_citrus_module_t handle, const char *modname,
338 		    const char *ifname)
339 {
340 	return (NULL);
341 }
342 
343 int
344 /*ARGSUSED*/
345 _citrus_load_module(_citrus_module_t *rhandle, char const *modname)
346 {
347 	return (EINVAL);
348 }
349 
350 void
351 /*ARGSUSED*/
352 _citrus_unload_module(_citrus_module_t handle)
353 {
354 }
355 #endif
356