lib/libc/citrus/citrus_module.c

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