1 /* Copyright (C) 1996, 1997, 1998 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3 Contributed by Ulrich Drepper <drepper@cygnus.com>, 1996.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
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
13 Library General Public License for more details.
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB. If not,
17 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA. */
24 #include <bits/libc-lock.h>
25 #include <link.h> /* We need some help from ld.so. */
31 #if !defined DO_STATIC_NSS || defined PIC
32 # include <gnu/lib-names.h>
37 /* Prototypes for the local functions. */
38 static void *nss_lookup_function (service_user *ni, const char *fct_name)
40 static name_database *nss_parse_file (const char *fname) internal_function;
41 static name_database_entry *nss_getline (char *line) internal_function;
42 static service_user *nss_parse_service_list (const char *line)
44 static service_library *nss_new_service (name_database *database,
45 const char *name) internal_function;
48 /* Declare external database variables. */
49 #define DEFINE_DATABASE(name) \
50 extern service_user *__nss_##name##_database; \
51 weak_extern (__nss_##name##_database)
52 #include "databases.def"
53 #undef DEFINE_DATABASE
55 /* Structure to map database name to variable. */
62 #define DEFINE_DATABASE(name) \
63 { #name, &__nss_##name##_database },
64 #include "databases.def"
65 #undef DEFINE_DATABASE
69 __libc_lock_define_initialized (static, lock)
72 #if !defined DO_STATIC_NSS || defined PIC
73 /* String with revision number of the shared object files. */
74 static const char *const __nss_shlib_revision = LIBNSS_FILES_SO + 15;
77 /* The root of the whole data base. */
78 static name_database *service_table;
81 /* -1 == database not found
82 0 == database entry pointer stored */
84 __nss_database_lookup (const char *database, const char *alternate_name,
85 const char *defconfig, service_user **ni)
87 /* Prevent multiple threads to change the service table. */
88 __libc_lock_lock (lock);
90 /* Reconsider database variable in case some other thread called
91 `__nss_configure_lookup' while we waited for the lock. */
94 __libc_lock_unlock (lock);
98 /* Are we initialized yet? */
99 if (service_table == NULL)
100 /* Read config file. */
101 service_table = nss_parse_file (_PATH_NSSWITCH_CONF);
103 /* Test whether configuration data is available. */
104 if (service_table != NULL)
106 /* Return first `service_user' entry for DATABASE. */
107 name_database_entry *entry;
109 /* XXX Could use some faster mechanism here. But each database is
110 only requested once and so this might not be critical. */
111 for (entry = service_table->entry; entry != NULL; entry = entry->next)
112 if (strcmp (database, entry->name) == 0)
113 *ni = entry->service;
115 if (*ni == NULL && alternate_name != NULL)
116 /* We haven't found an entry so far. Try to find it with the
118 for (entry = service_table->entry; entry != NULL; entry = entry->next)
119 if (strcmp (alternate_name, entry->name) == 0)
120 *ni = entry->service;
123 /* No configuration data is available, either because nsswitch.conf
124 doesn't exist or because it doesn't has a line for this database.
126 DEFCONFIG specifies the default service list for this database,
127 or null to use the most common default. */
129 *ni = nss_parse_service_list (defconfig
130 ?: "nis [NOTFOUND=return] files");
132 __libc_lock_unlock (lock);
139 0 == adjusted for next function
142 __nss_lookup (service_user **ni, const char *fct_name, void **fctp)
144 *fctp = nss_lookup_function (*ni, fct_name);
147 && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_CONTINUE
148 && (*ni)->next != NULL)
152 *fctp = nss_lookup_function (*ni, fct_name);
155 return *fctp != NULL ? 0 : (*ni)->next == NULL ? 1 : -1;
160 0 == adjusted for next function
163 __nss_next (service_user **ni, const char *fct_name, void **fctp, int status,
168 if (nss_next_action (*ni, NSS_STATUS_TRYAGAIN) == NSS_ACTION_RETURN
169 && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_RETURN
170 && nss_next_action (*ni, NSS_STATUS_NOTFOUND) == NSS_ACTION_RETURN
171 && nss_next_action (*ni, NSS_STATUS_SUCCESS) == NSS_ACTION_RETURN)
176 /* This is really only for debugging. */
177 if (NSS_STATUS_TRYAGAIN > status || status > NSS_STATUS_RETURN)
178 __libc_fatal ("illegal status in " __FUNCTION__);
180 if (nss_next_action (*ni, status) == NSS_ACTION_RETURN)
184 if ((*ni)->next == NULL)
191 *fctp = nss_lookup_function (*ni, fct_name);
194 && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_CONTINUE
195 && (*ni)->next != NULL);
197 return *fctp != NULL ? 0 : -1;
202 __nss_configure_lookup (const char *dbname, const char *service_line)
204 service_user *new_db;
207 for (cnt = 0; cnt < sizeof databases; ++cnt)
209 int cmp = strcmp (dbname, databases[cnt].name);
214 __set_errno (EINVAL);
219 if (cnt == sizeof databases)
221 __set_errno (EINVAL);
225 /* Test whether it is really used. */
226 if (databases[cnt].dbp == NULL)
227 /* Nothing to do, but we could do. */
230 /* Try to generate new data. */
231 new_db = nss_parse_service_list (service_line);
234 /* Illegal service specification. */
235 __set_errno (EINVAL);
239 /* Prevent multiple threads to change the service table. */
240 __libc_lock_lock (lock);
242 /* Install new rules. */
243 *databases[cnt].dbp = new_db;
245 __libc_lock_unlock (lock);
251 #if !defined DO_STATIC_NSS || defined PIC
253 nss_dlerror_run (void (*operate) (void *), void *args)
255 char *last_errstring = NULL;
256 const char *last_object_name = NULL;
259 (void) _dl_catch_error (&last_errstring, &last_object_name, operate, args);
261 result = last_errstring != NULL;
263 free (last_errstring);
271 /* Argument to do_open. */
278 /* Arguments to get_sym. */
279 struct link_map *map;
282 /* Return values of get_sym. */
284 const ElfW(Sym) *ref;
290 struct do_open_args *args = (struct do_open_args *) a;
291 /* Open and relocate the shared object. */
292 args->ni->library->lib_handle = _dl_open (args->shlib_name, RTLD_LAZY);
298 struct get_sym_args *args = (struct get_sym_args *) a;
299 struct link_map *scope[2] = { args->map, NULL };
301 args->loadbase = _dl_lookup_symbol (args->name, &args->ref,
302 scope, args->map->l_name, 0);
306 /* Comparison function for searching NI->known tree. */
308 known_compare (const void *p1, const void *p2)
310 return p1 == p2 ? 0 : strcmp (*(const char *const *) p1,
311 *(const char *const *) p2);
317 nss_lookup_function (service_user *ni, const char *fct_name)
319 void **found, *result;
321 /* We now modify global data. Protect it. */
322 __libc_lock_lock (lock);
324 /* Search the tree of functions previously requested. Data in the
325 tree are `known_function' structures, whose first member is a
326 `const char *', the lookup key. The search returns a pointer to
327 the tree node structure; the first member of the is a pointer to
328 our structure (i.e. what will be a `known_function'); since the
329 first member of that is the lookup key string, &FCT_NAME is close
330 enough to a pointer to our structure to use as a lookup key that
331 will be passed to `known_compare' (above). */
333 found = __tsearch (&fct_name, (void **) &ni->known, &known_compare);
334 if (*found != &fct_name)
335 /* The search found an existing structure in the tree. */
336 result = ((known_function *) *found)->fct_ptr;
339 /* This name was not known before. Now we have a node in the tree
340 (in the proper sorted position for FCT_NAME) that points to
341 &FCT_NAME instead of any real `known_function' structure.
342 Allocate a new structure and fill it in. */
344 known_function *known = malloc (sizeof *known);
348 /* Oops. We can't instantiate this node properly.
349 Remove it from the tree. */
350 __tdelete (&fct_name, (void **) &ni->known, &known_compare);
355 /* Point the tree node at this new structure. */
357 known->fct_name = fct_name;
359 if (ni->library == NULL)
361 /* This service has not yet been used. Fetch the service
362 library for it, creating a new one if need be. If there
363 is no service table from the file, this static variable
364 holds the head of the service_library list made from the
365 default configuration. */
366 static name_database default_table;
367 ni->library = nss_new_service (service_table ?: &default_table,
369 if (ni->library == NULL)
371 /* This only happens when out of memory. */
373 goto remove_from_tree;
377 #if !defined DO_STATIC_NSS || defined PIC
378 if (ni->library->lib_handle == NULL)
380 /* Load the shared library. */
381 size_t shlen = (7 + strlen (ni->library->name) + 3
382 + strlen (__nss_shlib_revision) + 1);
384 struct do_open_args args;
385 args.shlib_name = __alloca (shlen);
388 /* Construct shared object name. */
389 __stpcpy (__stpcpy (__stpcpy (__stpcpy (args.shlib_name,
393 __nss_shlib_revision);
395 if (nss_dlerror_run (do_open, &args) != 0)
396 /* Failed to load the library. */
397 ni->library->lib_handle = (void *) -1l;
400 if (ni->library->lib_handle == (void *) -1l)
401 /* Library not found => function not found. */
405 /* Get the desired function. Again, GNU ld.so magic ahead. */
406 size_t namlen = (5 + strlen (ni->library->name) + 1
407 + strlen (fct_name) + 1);
408 struct get_sym_args args;
409 args.name = __alloca (namlen);
410 args.map = ni->library->lib_handle;
412 /* Construct the function name. */
413 __stpcpy (__stpcpy (__stpcpy (__stpcpy (args.name, "_nss_"),
418 /* Look up the symbol. */
419 result = (nss_dlerror_run (get_sym, &args) ? NULL
420 : (void *) (args.loadbase + args.ref->st_value));
423 /* We can't get function address dynamically in static linking. */
425 # define DEFINE_ENT(h,nm) \
426 extern void _nss_##h##_get##nm##ent_r (void); \
427 extern void _nss_##h##_end##nm##ent (void); \
428 extern void _nss_##h##_set##nm##ent (void);
429 # define DEFINE_GET(h,nm) \
430 extern void _nss_##h##_get##nm##_r (void);
431 # define DEFINE_GETBY(h,nm,ky) \
432 extern void _nss_##h##_get##nm##by##ky##_r (void);
433 # include "function.def"
437 # define DEFINE_ENT(h,nm) \
438 { #h"_get"#nm"ent_r", _nss_##h##_get##nm##ent_r }, \
439 { #h"_end"#nm"ent", _nss_##h##_end##nm##ent }, \
440 { #h"_set"#nm"ent", _nss_##h##_set##nm##ent },
441 # define DEFINE_GET(h,nm) \
442 { #h"_get"#nm"_r", _nss_##h##_get##nm##_r },
443 # define DEFINE_GETBY(h,nm,ky) \
444 { #h"_get"#nm"by"#ky"_r", _nss_##h##_get##nm##by##ky##_r },
445 static struct fct_tbl { const char *fname; void *fp; } *tp, tbl[] =
447 # include "function.def"
450 size_t namlen = (5 + strlen (ni->library->name) + 1
451 + strlen (fct_name) + 1);
454 /* Construct the function name. */
455 __stpcpy (__stpcpy (__stpcpy (name, ni->library->name),
460 for (tp = &tbl[0]; tp->fname; tp++)
461 if (strcmp (tp->fname, name) == 0)
469 /* Remember function pointer for later calls. Even if null, we
470 record it so a second try needn't search the library again. */
471 known->fct_ptr = result;
475 /* Remove the lock. */
476 __libc_lock_unlock (lock);
482 static name_database *
484 nss_parse_file (const char *fname)
487 name_database *result;
488 name_database_entry *last;
492 /* Open the configuration file. */
493 fp = fopen (fname, "r");
497 result = (name_database *) malloc (sizeof (name_database));
501 result->entry = NULL;
502 result->library = NULL;
508 name_database_entry *this;
512 n = __getline (&line, &len, fp);
515 if (line[n - 1] == '\n')
518 /* Because the file format does not know any form of quoting we
519 can search forward for the next '#' character and if found
520 make it terminating the line. */
521 cp = strchr (line, '#');
525 /* If the line is blank it is ignored. */
529 /* Each line completely specifies the actions for a database. */
530 this = nss_getline (line);
536 result->entry = this;
543 /* Free the buffer. */
545 /* Close configuration file. */
552 /* Read the source names:
553 `( <source> ( "[" "!"? (<status> "=" <action> )+ "]" )? )*'
555 static service_user *
557 nss_parse_service_list (const char *line)
559 service_user *result = NULL, **nextp = &result;
563 service_user *new_service;
566 while (isspace (line[0]))
569 /* No source specified. */
572 /* Read <source> identifier. */
574 while (line[0] != '\0' && !isspace (line[0]) && line[0] != '[')
580 new_service = (service_user *) malloc (sizeof (service_user));
581 if (new_service == NULL)
585 char *source = (char *) malloc (line - name + 1);
591 *((char *) __mempcpy (source, name, line - name)) = '\0';
593 new_service->name = source;
596 /* Set default actions. */
597 new_service->actions[2 + NSS_STATUS_TRYAGAIN] = NSS_ACTION_CONTINUE;
598 new_service->actions[2 + NSS_STATUS_UNAVAIL] = NSS_ACTION_CONTINUE;
599 new_service->actions[2 + NSS_STATUS_NOTFOUND] = NSS_ACTION_CONTINUE;
600 new_service->actions[2 + NSS_STATUS_SUCCESS] = NSS_ACTION_RETURN;
601 new_service->actions[2 + NSS_STATUS_RETURN] = NSS_ACTION_RETURN;
602 new_service->library = NULL;
603 new_service->known = NULL;
604 new_service->next = NULL;
606 while (isspace (line[0]))
611 /* Read criterions. */
614 while (line[0] != '\0' && isspace (line[0]));
619 enum nss_status status;
620 lookup_actions action;
622 /* Grok ! before name to mean all statii but that one. */
623 if (not = line[0] == '!')
626 /* Read status name. */
628 while (line[0] != '\0' && !isspace (line[0]) && line[0] != '='
632 /* Compare with known statii. */
633 if (line - name == 7)
635 if (__strncasecmp (name, "SUCCESS", 7) == 0)
636 status = NSS_STATUS_SUCCESS;
637 else if (__strncasecmp (name, "UNAVAIL", 7) == 0)
638 status = NSS_STATUS_UNAVAIL;
642 else if (line - name == 8)
644 if (__strncasecmp (name, "NOTFOUND", 8) == 0)
645 status = NSS_STATUS_NOTFOUND;
646 else if (__strncasecmp (name, "TRYAGAIN", 8) == 0)
647 status = NSS_STATUS_TRYAGAIN;
654 while (isspace (line[0]))
660 while (isspace (line[0]));
663 while (line[0] != '\0' && !isspace (line[0]) && line[0] != '='
667 if (line - name == 6 && __strncasecmp (name, "RETURN", 6) == 0)
668 action = NSS_ACTION_RETURN;
669 else if (line - name == 8
670 && __strncasecmp (name, "CONTINUE", 8) == 0)
671 action = NSS_ACTION_CONTINUE;
677 /* Save the current action setting for this status,
678 set them all to the given action, and reset this one. */
679 const lookup_actions save = new_service->actions[2 + status];
680 new_service->actions[2 + NSS_STATUS_TRYAGAIN] = action;
681 new_service->actions[2 + NSS_STATUS_UNAVAIL] = action;
682 new_service->actions[2 + NSS_STATUS_NOTFOUND] = action;
683 new_service->actions[2 + NSS_STATUS_SUCCESS] = action;
684 new_service->actions[2 + status] = save;
687 new_service->actions[2 + status] = action;
689 /* Skip white spaces. */
690 while (isspace (line[0]))
693 while (line[0] != ']');
699 *nextp = new_service;
700 nextp = &new_service->next;
704 static name_database_entry *
706 nss_getline (char *line)
709 name_database_entry *result;
711 /* Ignore leading white spaces. ATTENTION: this is different from
712 what is implemented in Solaris. The Solaris man page says a line
713 beginning with a white space character is ignored. We regard
714 this as just another misfeature in Solaris. */
715 while (isspace (line[0]))
718 /* Recognize `<database> ":"'. */
720 while (line[0] != '\0' && !isspace (line[0]) && line[0] != ':')
722 if (line[0] == '\0' || name == line)
727 result = (name_database_entry *) malloc (sizeof (name_database_entry));
731 /* Save the database name. */
733 const size_t len = strlen (name) + 1;
734 char *new = malloc (len);
740 result->name = memcpy (new, name, len);
743 /* Parse the list of services. */
744 result->service = nss_parse_service_list (line);
751 static service_library *
753 nss_new_service (name_database *database, const char *name)
755 service_library **currentp = &database->library;
757 while (*currentp != NULL)
759 if (strcmp ((*currentp)->name, name) == 0)
761 currentp = &(*currentp)->next;
764 /* We have to add the new service. */
765 *currentp = (service_library *) malloc (sizeof (service_library));
766 if (*currentp == NULL)
769 (*currentp)->name = name;
770 (*currentp)->lib_handle = NULL;
771 (*currentp)->next = NULL;