(__nss_lookup): Return 1 if this was the last module.
[kopensolaris-gnu/glibc.git] / nss / nsswitch.c
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.
4
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.
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
13    Library General Public License for more details.
14
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.  */
19
20 #include <ctype.h>
21 #include <dlfcn.h>
22 #include <errno.h>
23 #include <netdb.h>
24 #include <bits/libc-lock.h>
25 #include <link.h>       /* We need some help from ld.so.  */
26 #include <search.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #if !defined DO_STATIC_NSS || defined PIC
32 # include <gnu/lib-names.h>
33 #endif
34
35 #include "nsswitch.h"
36
37 /* Prototypes for the local functions.  */
38 static void *nss_lookup_function (service_user *ni, const char *fct_name)
39      internal_function;
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)
43      internal_function;
44 static service_library *nss_new_service (name_database *database,
45                                          const char *name) internal_function;
46
47
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
54
55 /* Structure to map database name to variable.  */
56 static struct
57 {
58   const char *name;
59   service_user **dbp;
60 } databases[] =
61 {
62 #define DEFINE_DATABASE(name)                                                 \
63   { #name, &__nss_##name##_database },
64 #include "databases.def"
65 #undef DEFINE_DATABASE
66 };
67
68
69 __libc_lock_define_initialized (static, lock)
70
71
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;
75 #endif
76
77 /* The root of the whole data base.  */
78 static name_database *service_table;
79
80
81 /* -1 == database not found
82     0 == database entry pointer stored */
83 int
84 __nss_database_lookup (const char *database, const char *alternate_name,
85                        const char *defconfig, service_user **ni)
86 {
87   /* Prevent multiple threads to change the service table.  */
88   __libc_lock_lock (lock);
89
90   /* Reconsider database variable in case some other thread called
91      `__nss_configure_lookup' while we waited for the lock.  */
92   if (*ni != NULL)
93     {
94       __libc_lock_unlock (lock);
95       return 0;
96     }
97
98   /* Are we initialized yet?  */
99   if (service_table == NULL)
100     /* Read config file.  */
101     service_table = nss_parse_file (_PATH_NSSWITCH_CONF);
102
103   /* Test whether configuration data is available.  */
104   if (service_table != NULL)
105     {
106       /* Return first `service_user' entry for DATABASE.  */
107       name_database_entry *entry;
108
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;
114
115       if (*ni == NULL && alternate_name != NULL)
116         /* We haven't found an entry so far.  Try to find it with the
117            alternative name.  */
118         for (entry = service_table->entry; entry != NULL; entry = entry->next)
119           if (strcmp (alternate_name, entry->name) == 0)
120             *ni = entry->service;
121     }
122
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.
125
126      DEFCONFIG specifies the default service list for this database,
127      or null to use the most common default.  */
128   if (*ni == NULL)
129     *ni = nss_parse_service_list (defconfig
130                                   ?: "nis [NOTFOUND=return] files");
131
132   __libc_lock_unlock (lock);
133
134   return 0;
135 }
136
137
138 /* -1 == not found
139     0 == adjusted for next function
140     1 == finished */
141 int
142 __nss_lookup (service_user **ni, const char *fct_name, void **fctp)
143 {
144   *fctp = nss_lookup_function (*ni, fct_name);
145
146   while (*fctp == NULL
147          && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_CONTINUE
148          && (*ni)->next != NULL)
149     {
150       *ni = (*ni)->next;
151
152       *fctp = nss_lookup_function (*ni, fct_name);
153     }
154
155   return *fctp != NULL ? 0 : (*ni)->next == NULL ? 1 : -1;
156 }
157
158
159 /* -1 == not found
160     0 == adjusted for next function
161     1 == finished */
162 int
163 __nss_next (service_user **ni, const char *fct_name, void **fctp, int status,
164             int all_values)
165 {
166   if (all_values)
167     {
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)
172         return 1;
173     }
174   else
175     {
176       /* This is really only for debugging.  */
177        if (NSS_STATUS_TRYAGAIN > status || status > NSS_STATUS_RETURN)
178          __libc_fatal ("illegal status in " __FUNCTION__);
179
180        if (nss_next_action (*ni, status) == NSS_ACTION_RETURN)
181          return 1;
182     }
183
184   if ((*ni)->next == NULL)
185     return -1;
186
187   do
188     {
189       *ni = (*ni)->next;
190
191       *fctp = nss_lookup_function (*ni, fct_name);
192     }
193   while (*fctp == NULL
194          && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_CONTINUE
195          && (*ni)->next != NULL);
196
197   return *fctp != NULL ? 0 : -1;
198 }
199
200
201 int
202 __nss_configure_lookup (const char *dbname, const char *service_line)
203 {
204   service_user *new_db;
205   size_t cnt;
206
207   for (cnt = 0; cnt < sizeof databases; ++cnt)
208     {
209       int cmp = strcmp (dbname, databases[cnt].name);
210       if (cmp == 0)
211         break;
212       if (cmp < 0)
213         {
214           __set_errno (EINVAL);
215           return -1;
216         }
217     }
218
219   if (cnt == sizeof databases)
220     {
221       __set_errno (EINVAL);
222       return -1;
223     }
224
225   /* Test whether it is really used.  */
226   if (databases[cnt].dbp == NULL)
227     /* Nothing to do, but we could do.  */
228     return 0;
229
230   /* Try to generate new data.  */
231   new_db = nss_parse_service_list (service_line);
232   if (new_db == NULL)
233     {
234       /* Illegal service specification.  */
235       __set_errno (EINVAL);
236       return -1;
237     }
238
239   /* Prevent multiple threads to change the service table.  */
240   __libc_lock_lock (lock);
241
242   /* Install new rules.  */
243   *databases[cnt].dbp = new_db;
244
245   __libc_lock_unlock (lock);
246
247   return 0;
248 }
249
250
251 #if !defined DO_STATIC_NSS || defined PIC
252 static int
253 nss_dlerror_run (void (*operate) (void *), void *args)
254 {
255   char *last_errstring = NULL;
256   const char *last_object_name = NULL;
257   int result;
258
259   (void) _dl_catch_error (&last_errstring, &last_object_name, operate, args);
260
261   result = last_errstring != NULL;
262   if (result)
263     free (last_errstring);
264
265   return result;
266 }
267
268
269 struct do_open_args
270 {
271   /* Argument to do_open.  */
272   char *shlib_name;
273   service_user *ni;
274 };
275
276 struct get_sym_args
277 {
278   /* Arguments to get_sym.  */
279   struct link_map *map;
280   char *name;
281
282   /* Return values of get_sym.  */
283   ElfW(Addr) loadbase;
284   const ElfW(Sym) *ref;
285 };
286
287 static void
288 do_open (void *a)
289 {
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);
293 }
294
295 static void
296 get_sym (void *a)
297 {
298   struct get_sym_args *args = (struct get_sym_args *) a;
299   struct link_map *scope[2] = { args->map, NULL };
300   args->ref = NULL;
301   args->loadbase = _dl_lookup_symbol (args->name, &args->ref,
302                                       scope, args->map->l_name, 0);
303 }
304 #endif
305
306 /* Comparison function for searching NI->known tree.  */
307 static int
308 known_compare (const void *p1, const void *p2)
309 {
310   return p1 == p2 ? 0 : strcmp (*(const char *const *) p1,
311                                 *(const char *const *) p2);
312 }
313
314
315 static void *
316 internal_function
317 nss_lookup_function (service_user *ni, const char *fct_name)
318 {
319   void **found, *result;
320
321   /* We now modify global data.  Protect it.  */
322   __libc_lock_lock (lock);
323
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).  */
332
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;
337   else
338     {
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.  */
343
344       known_function *known = malloc (sizeof *known);
345       if (! known)
346         {
347         remove_from_tree:
348           /* Oops.  We can't instantiate this node properly.
349              Remove it from the tree.  */
350           __tdelete (&fct_name, (void **) &ni->known, &known_compare);
351           result = NULL;
352         }
353       else
354         {
355           /* Point the tree node at this new structure.  */
356           *found = known;
357           known->fct_name = fct_name;
358
359           if (ni->library == NULL)
360             {
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,
368                                              ni->name);
369               if (ni->library == NULL)
370                 {
371                   /* This only happens when out of memory.  */
372                   free (known);
373                   goto remove_from_tree;
374                 }
375             }
376
377 #if !defined DO_STATIC_NSS || defined PIC
378           if (ni->library->lib_handle == NULL)
379             {
380               /* Load the shared library.  */
381               size_t shlen = (7 + strlen (ni->library->name) + 3
382                               + strlen (__nss_shlib_revision) + 1);
383
384               struct do_open_args args;
385               args.shlib_name = __alloca (shlen);
386               args.ni = ni;
387
388               /* Construct shared object name.  */
389               __stpcpy (__stpcpy (__stpcpy (__stpcpy (args.shlib_name,
390                                                       "libnss_"),
391                                             ni->library->name),
392                                   ".so"),
393                         __nss_shlib_revision);
394
395               if (nss_dlerror_run (do_open, &args) != 0)
396                 /* Failed to load the library.  */
397                 ni->library->lib_handle = (void *) -1l;
398             }
399
400           if (ni->library->lib_handle == (void *) -1l)
401             /* Library not found => function not found.  */
402             result = NULL;
403           else
404             {
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;
411
412               /* Construct the function name.  */
413               __stpcpy (__stpcpy (__stpcpy (__stpcpy (args.name, "_nss_"),
414                                             ni->library->name),
415                                   "_"),
416                         fct_name);
417
418               /* Look up the symbol.  */
419               result = (nss_dlerror_run (get_sym, &args) ? NULL
420                         : (void *) (args.loadbase + args.ref->st_value));
421             }
422 #else
423           /* We can't get function address dynamically in static linking. */
424           {
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"
434 # undef DEFINE_ENT
435 # undef DEFINE_GET
436 # undef DEFINE_GETBY
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[] =
446               {
447 # include "function.def"
448                 { NULL, NULL }
449               };
450             size_t namlen = (5 + strlen (ni->library->name) + 1
451                              + strlen (fct_name) + 1);
452             char name[namlen];
453
454             /* Construct the function name.  */
455             __stpcpy (__stpcpy (__stpcpy (name, ni->library->name),
456                                 "_"),
457                       fct_name);
458
459             result = NULL;
460             for (tp = &tbl[0]; tp->fname; tp++)
461               if (strcmp (tp->fname, name) == 0)
462                 {
463                   result = tp->fp;
464                   break;
465                 }
466           }
467 #endif
468
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;
472         }
473     }
474
475   /* Remove the lock.  */
476   __libc_lock_unlock (lock);
477
478   return result;
479 }
480
481
482 static name_database *
483 internal_function
484 nss_parse_file (const char *fname)
485 {
486   FILE *fp;
487   name_database *result;
488   name_database_entry *last;
489   char *line;
490   size_t len;
491
492   /* Open the configuration file.  */
493   fp = fopen (fname, "r");
494   if (fp == NULL)
495     return NULL;
496
497   result = (name_database *) malloc (sizeof (name_database));
498   if (result == NULL)
499     return NULL;
500
501   result->entry = NULL;
502   result->library = NULL;
503   last = NULL;
504   line = NULL;
505   len = 0;
506   do
507     {
508       name_database_entry *this;
509       ssize_t n;
510       char *cp;
511
512       n = __getline (&line, &len, fp);
513       if (n < 0)
514         break;
515       if (line[n - 1] == '\n')
516         line[n - 1] = '\0';
517
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, '#');
522       if (cp != NULL)
523         *cp = '\0';
524
525       /* If the line is blank it is ignored.  */
526       if (line[0] == '\0')
527         continue;
528
529       /* Each line completely specifies the actions for a database.  */
530       this = nss_getline (line);
531       if (this != NULL)
532         {
533           if (last != NULL)
534             last->next = this;
535           else
536             result->entry = this;
537
538           last = this;
539         }
540     }
541   while (!feof (fp));
542
543   /* Free the buffer.  */
544   free (line);
545   /* Close configuration file.  */
546   fclose (fp);
547
548   return result;
549 }
550
551
552 /* Read the source names:
553         `( <source> ( "[" "!"? (<status> "=" <action> )+ "]" )? )*'
554    */
555 static service_user *
556 internal_function
557 nss_parse_service_list (const char *line)
558 {
559   service_user *result = NULL, **nextp = &result;
560
561   while (1)
562     {
563       service_user *new_service;
564       const char *name;
565
566       while (isspace (line[0]))
567         ++line;
568       if (line[0] == '\0')
569         /* No source specified.  */
570         return result;
571
572       /* Read <source> identifier.  */
573       name = line;
574       while (line[0] != '\0' && !isspace (line[0]) && line[0] != '[')
575         ++line;
576       if (name == line)
577         return result;
578
579
580       new_service = (service_user *) malloc (sizeof (service_user));
581       if (new_service == NULL)
582         return result;
583       else
584         {
585           char *source = (char *) malloc (line - name + 1);
586           if (source == NULL)
587             {
588               free (new_service);
589               return result;
590             }
591           *((char *) __mempcpy (source, name, line - name)) = '\0';
592
593           new_service->name = source;
594         }
595
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;
605
606       while (isspace (line[0]))
607         ++line;
608
609       if (line[0] == '[')
610         {
611           /* Read criterions.  */
612           do
613             ++line;
614           while (line[0] != '\0' && isspace (line[0]));
615
616           do
617             {
618               int not;
619               enum nss_status status;
620               lookup_actions action;
621
622               /* Grok ! before name to mean all statii but that one.  */
623               if (not = line[0] == '!')
624                 ++line;
625
626               /* Read status name.  */
627               name = line;
628               while (line[0] != '\0' && !isspace (line[0]) && line[0] != '='
629                      && line[0] != ']')
630                 ++line;
631
632               /* Compare with known statii.  */
633               if (line - name == 7)
634                 {
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;
639                   else
640                     return result;
641                 }
642               else if (line - name == 8)
643                 {
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;
648                   else
649                     return result;
650                 }
651               else
652                 return result;
653
654               while (isspace (line[0]))
655                 ++line;
656               if (line[0] != '=')
657                 return result;
658               do
659                 ++line;
660               while (isspace (line[0]));
661
662               name = line;
663               while (line[0] != '\0' && !isspace (line[0]) && line[0] != '='
664                      && line[0] != ']')
665                 ++line;
666
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;
672               else
673                 return result;
674
675               if (not)
676                 {
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;
685                 }
686               else
687                 new_service->actions[2 + status] = action;
688
689               /* Skip white spaces.  */
690               while (isspace (line[0]))
691                 ++line;
692             }
693           while (line[0] != ']');
694
695           /* Skip the ']'.  */
696           ++line;
697         }
698
699       *nextp = new_service;
700       nextp = &new_service->next;
701     }
702 }
703
704 static name_database_entry *
705 internal_function
706 nss_getline (char *line)
707 {
708   const char *name;
709   name_database_entry *result;
710
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]))
716     ++line;
717
718   /* Recognize `<database> ":"'.  */
719   name = line;
720   while (line[0] != '\0' && !isspace (line[0]) && line[0] != ':')
721     ++line;
722   if (line[0] == '\0' || name == line)
723     /* Syntax error.  */
724     return NULL;
725   *line++ = '\0';
726
727   result = (name_database_entry *) malloc (sizeof (name_database_entry));
728   if (result == NULL)
729     return NULL;
730
731   /* Save the database name.  */
732   {
733     const size_t len = strlen (name) + 1;
734     char *new = malloc (len);
735     if (new == NULL)
736       {
737         free (result);
738         return NULL;
739       }
740     result->name = memcpy (new, name, len);
741   }
742
743   /* Parse the list of services.  */
744   result->service = nss_parse_service_list (line);
745
746   result->next = NULL;
747   return result;
748 }
749
750
751 static service_library *
752 internal_function
753 nss_new_service (name_database *database, const char *name)
754 {
755   service_library **currentp = &database->library;
756
757   while (*currentp != NULL)
758     {
759       if (strcmp ((*currentp)->name, name) == 0)
760         return *currentp;
761       currentp = &(*currentp)->next;
762     }
763
764   /* We have to add the new service.  */
765   *currentp = (service_library *) malloc (sizeof (service_library));
766   if (*currentp == NULL)
767     return NULL;
768
769   (*currentp)->name = name;
770   (*currentp)->lib_handle = NULL;
771   (*currentp)->next = NULL;
772
773   return *currentp;
774 }