Don't use nested function. Call _dl_catch_error with additional
[kopensolaris-gnu/glibc.git] / nss / nsswitch.c
1 /* Copyright (C) 1996, 1997 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 <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 #include <gnu/lib-names.h>
31
32 #include "nsswitch.h"
33
34 /* Prototypes for the local functions.  */
35 static void *nss_lookup_function (service_user *ni, const char *fct_name);
36 static name_database *nss_parse_file (const char *fname);
37 static name_database_entry *nss_getline (char *line);
38 static service_user *nss_parse_service_list (const char *line);
39 static service_library *nss_new_service (name_database *database,
40                                          const char *name);
41
42
43 /* Declare external database variables.  */
44 #define DEFINE_DATABASE(name)                                                 \
45   extern service_user *__nss_##name##_database;                               \
46   weak_extern (__nss_##name##_database)
47 #include "databases.def"
48 #undef DEFINE_DATABASE
49
50 /* Structure to map database name to variable.  */
51 static struct
52 {
53   const char *name;
54   service_user **dbp;
55 } databases[] =
56 {
57 #define DEFINE_DATABASE(name)                                                 \
58   { #name, &__nss_##name##_database },
59 #include "databases.def"
60 #undef DEFINE_DATABASE
61 };
62
63
64 __libc_lock_define_initialized (static, lock)
65
66
67 /* String with revision number of the shared object files.  */
68 static const char *const __nss_shlib_revision = LIBNSS_FILES_SO + 15;
69
70 /* The root of the whole data base.  */
71 static name_database *service_table;
72
73
74 /* -1 == database not found
75     0 == database entry pointer stored */
76 int
77 __nss_database_lookup (const char *database, const char *alternate_name,
78                        const char *defconfig, service_user **ni)
79 {
80   /* Prevent multiple threads to change the service table.  */
81   __libc_lock_lock (lock);
82
83   /* Reconsider database variable in case some other thread called
84      `__nss_configure_lookup' while we waited for the lock.  */
85   if (*ni != NULL)
86     {
87       __libc_lock_unlock (lock);
88       return 0;
89     }
90
91   /* Are we initialized yet?  */
92   if (service_table == NULL)
93     /* Read config file.  */
94     service_table = nss_parse_file (_PATH_NSSWITCH_CONF);
95
96   /* Test whether configuration data is available.  */
97   if (service_table != NULL)
98     {
99       /* Return first `service_user' entry for DATABASE.  */
100       name_database_entry *entry;
101
102       /* XXX Could use some faster mechanism here.  But each database is
103          only requested once and so this might not be critical.  */
104       for (entry = service_table->entry; entry != NULL; entry = entry->next)
105         if (strcmp (database, entry->name) == 0)
106           *ni = entry->service;
107
108       if (*ni == NULL && alternate_name != NULL)
109         /* We haven't found an entry so far.  Try to find it with the
110            alternative name.  */
111         for (entry = service_table->entry; entry != NULL; entry = entry->next)
112           if (strcmp (alternate_name, entry->name) == 0)
113             *ni = entry->service;
114     }
115
116   /* No configuration data is available, either because nsswitch.conf
117      doesn't exist or because it doesn't has a line for this database.
118
119      DEFCONFIG specifies the default service list for this database,
120      or null to use the most common default.  */
121   if (*ni == NULL)
122     *ni = nss_parse_service_list (defconfig
123                                   ?: "nis [NOTFOUND=return] files");
124
125   __libc_lock_unlock (lock);
126
127   return 0;
128 }
129
130
131 /* -1 == not found
132     0 == adjusted for next function */
133 int
134 __nss_lookup (service_user **ni, const char *fct_name, void **fctp)
135 {
136   *fctp = nss_lookup_function (*ni, fct_name);
137
138   while (*fctp == NULL
139          && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_CONTINUE
140          && (*ni)->next != NULL)
141     {
142       *ni = (*ni)->next;
143
144       *fctp = nss_lookup_function (*ni, fct_name);
145     }
146
147   return *fctp != NULL ? 0 : -1;
148 }
149
150
151 /* -1 == not found
152     0 == adjusted for next function
153     1 == finished */
154 int
155 __nss_next (service_user **ni, const char *fct_name, void **fctp, int status,
156             int all_values)
157 {
158   if (all_values)
159     {
160       if (nss_next_action (*ni, NSS_STATUS_TRYAGAIN) == NSS_ACTION_RETURN
161           && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_RETURN
162           && nss_next_action (*ni, NSS_STATUS_NOTFOUND) == NSS_ACTION_RETURN
163           && nss_next_action (*ni, NSS_STATUS_SUCCESS) == NSS_ACTION_RETURN)
164         return 1;
165     }
166   else
167     {
168       /* This is really only for debugging.  */
169        if (NSS_STATUS_TRYAGAIN > status || status > NSS_STATUS_RETURN)
170          __libc_fatal ("illegal status in " __FUNCTION__);
171
172        if (nss_next_action (*ni, status) == NSS_ACTION_RETURN)
173          return 1;
174     }
175
176   if ((*ni)->next == NULL)
177     return -1;
178
179   do
180     {
181       *ni = (*ni)->next;
182
183       *fctp = nss_lookup_function (*ni, fct_name);
184     }
185   while (*fctp == NULL
186          && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_CONTINUE
187          && (*ni)->next != NULL);
188
189   return *fctp != NULL ? 0 : -1;
190 }
191
192
193 int
194 __nss_configure_lookup (const char *dbname, const char *service_line)
195 {
196   service_user *new_db;
197   size_t cnt;
198
199   for (cnt = 0; cnt < sizeof databases; ++cnt)
200     {
201       int cmp = strcmp (dbname, databases[cnt].name);
202       if (cmp == 0)
203         break;
204       if (cmp < 0)
205         {
206           __set_errno (EINVAL);
207           return -1;
208         }
209     }
210
211   if (cnt == sizeof databases)
212     {
213       __set_errno (EINVAL);
214       return -1;
215     }
216
217   /* Test whether it is really used.  */
218   if (databases[cnt].dbp == NULL)
219     /* Nothing to do, but we could do.  */
220     return 0;
221
222   /* Try to generate new data.  */
223   new_db = nss_parse_service_list (service_line);
224   if (new_db == NULL)
225     {
226       /* Illegal service specification.  */
227       __set_errno (EINVAL);
228       return -1;
229     }
230
231   /* Prevent multiple threads to change the service table.  */
232   __libc_lock_lock (lock);
233
234   /* Install new rules.  */
235   *databases[cnt].dbp = new_db;
236
237   __libc_lock_unlock (lock);
238
239   return 0;
240 }
241
242
243 static int
244 nss_dlerror_run (void (*operate) (void *), void *args)
245 {
246   char *last_errstring = NULL;
247   const char *last_object_name = NULL;
248   int result;
249
250   (void) _dl_catch_error (&last_errstring, &last_object_name, operate, args);
251
252   result = last_errstring != NULL;
253   if (result)
254     free (last_errstring);
255
256   return result;
257 }
258
259
260 struct do_open_args
261 {
262   /* Argument to do_open.  */
263   char *shlib_name;
264   service_user *ni;
265 };
266
267 struct get_sym_args
268 {
269   /* Arguments to get_sym.  */
270   struct link_map *map;
271   char *name;
272
273   /* Return values of get_sym.  */
274   ElfW(Addr) loadbase;
275   const ElfW(Sym) *ref;
276 };
277
278 static void
279 do_open (void *a)
280 {
281   struct do_open_args *args = (struct do_open_args *) a;
282   /* Open and relocate the shared object.  */
283   args->ni->library->lib_handle = _dl_open (args->shlib_name, RTLD_LAZY);
284 }
285
286 static void
287 get_sym (void *a)
288 {
289   struct get_sym_args *args = (struct get_sym_args *) a;
290   struct link_map *scope[2] = { args->map, NULL };
291   args->ref = NULL;
292   args->loadbase = _dl_lookup_symbol (args->name, &args->ref,
293                                       scope, args->map->l_name, 0);
294 }
295
296 /* Comparison function for searching NI->known tree.  */
297 static int
298 known_compare (const void *p1, const void *p2)
299 {
300   return p1 == p2 ? 0 : strcmp (*(const char *const *) p1,
301                                 *(const char *const *) p2);
302 }
303
304
305 static void *
306 nss_lookup_function (service_user *ni, const char *fct_name)
307 {
308   void **found, *result;
309
310   /* We now modify global data.  Protect it.  */
311   __libc_lock_lock (lock);
312
313   /* Search the tree of functions previously requested.  Data in the
314      tree are `known_function' structures, whose first member is a
315      `const char *', the lookup key.  The search returns a pointer to
316      the tree node structure; the first member of the is a pointer to
317      our structure (i.e. what will be a `known_function'); since the
318      first member of that is the lookup key string, &FCT_NAME is close
319      enough to a pointer to our structure to use as a lookup key that
320      will be passed to `known_compare' (above).  */
321
322   found = __tsearch (&fct_name, (void **) &ni->known, &known_compare);
323   if (*found != &fct_name)
324     /* The search found an existing structure in the tree.  */
325     result = ((known_function *) *found)->fct_ptr;
326   else
327     {
328       /* This name was not known before.  Now we have a node in the tree
329          (in the proper sorted position for FCT_NAME) that points to
330          &FCT_NAME instead of any real `known_function' structure.
331          Allocate a new structure and fill it in.  */
332
333       known_function *known = malloc (sizeof *known);
334       if (! known)
335         {
336         remove_from_tree:
337           /* Oops.  We can't instantiate this node properly.
338              Remove it from the tree.  */
339           __tdelete (&fct_name, (void **) &ni->known, &known_compare);
340           result = NULL;
341         }
342       else
343         {
344           /* Point the tree node at this new structure.  */
345           *found = known;
346           known->fct_name = fct_name;
347
348           if (ni->library == NULL)
349             {
350               /* This service has not yet been used.  Fetch the service
351                  library for it, creating a new one if need be.  If there
352                  is no service table from the file, this static variable
353                  holds the head of the service_library list made from the
354                  default configuration.  */
355               static name_database default_table;
356               ni->library = nss_new_service (service_table ?: &default_table,
357                                              ni->name);
358               if (ni->library == NULL)
359                 {
360                   /* This only happens when out of memory.  */
361                   free (known);
362                   goto remove_from_tree;
363                 }
364             }
365
366           if (ni->library->lib_handle == NULL)
367             {
368               /* Load the shared library.  */
369               size_t shlen = (7 + strlen (ni->library->name) + 3
370                               + strlen (__nss_shlib_revision) + 1);
371
372               struct do_open_args args;
373               args.shlib_name = __alloca (shlen);
374               args.ni = ni;
375
376               /* Construct shared object name.  */
377               __stpcpy (__stpcpy (__stpcpy (__stpcpy (args.shlib_name,
378                                                       "libnss_"),
379                                             ni->library->name),
380                                   ".so"),
381                         __nss_shlib_revision);
382
383               if (nss_dlerror_run (do_open, &args) != 0)
384                 /* Failed to load the library.  */
385                 ni->library->lib_handle = (void *) -1l;
386             }
387
388           if (ni->library->lib_handle == (void *) -1l)
389             /* Library not found => function not found.  */
390             result = NULL;
391           else
392             {
393               /* Get the desired function.  Again,  GNU ld.so magic ahead.  */
394               size_t namlen = (5 + strlen (ni->library->name) + 1
395                                + strlen (fct_name) + 1);
396               struct get_sym_args args;
397               args.name = __alloca (namlen);
398               args.map = ni->library->lib_handle;
399
400               /* Construct the function name.  */
401               __stpcpy (__stpcpy (__stpcpy (__stpcpy (args.name, "_nss_"),
402                                             ni->library->name),
403                                   "_"),
404                         fct_name);
405
406               /* Look up the symbol.  */
407               result = (nss_dlerror_run (get_sym, &args) ? NULL
408                         : (void *) (args.loadbase + args.ref->st_value));
409             }
410
411           /* Remember function pointer for later calls.  Even if null, we
412              record it so a second try needn't search the library again.  */
413           known->fct_ptr = result;
414         }
415     }
416
417   /* Remove the lock.  */
418   __libc_lock_unlock (lock);
419
420   return result;
421 }
422
423
424 static name_database *
425 nss_parse_file (const char *fname)
426 {
427   FILE *fp;
428   name_database *result;
429   name_database_entry *last;
430   char *line;
431   size_t len;
432
433   /* Open the configuration file.  */
434   fp = fopen (fname, "r");
435   if (fp == NULL)
436     return NULL;
437
438   result = (name_database *) malloc (sizeof (name_database));
439   if (result == NULL)
440     return NULL;
441
442   result->entry = NULL;
443   result->library = NULL;
444   last = NULL;
445   line = NULL;
446   len = 0;
447   do
448     {
449       name_database_entry *this;
450       ssize_t n;
451       char *cp;
452
453       n = __getline (&line, &len, fp);
454       if (n < 0)
455         break;
456       if (line[n - 1] == '\n')
457         line[n - 1] = '\0';
458
459       /* Because the file format does not know any form of quoting we
460          can search forward for the next '#' character and if found
461          make it terminating the line.  */
462       cp = strchr (line, '#');
463       if (cp != NULL)
464         *cp = '\0';
465
466       /* If the line is blank it is ignored.  */
467       if (line[0] == '\0')
468         continue;
469
470       /* Each line completely specifies the actions for a database.  */
471       this = nss_getline (line);
472       if (this != NULL)
473         {
474           if (last != NULL)
475             last->next = this;
476           else
477             result->entry = this;
478
479           last = this;
480         }
481     }
482   while (!feof (fp));
483
484   /* Free the buffer.  */
485   free (line);
486   /* Close configuration file.  */
487   fclose (fp);
488
489   return result;
490 }
491
492
493 /* Read the source names:
494         `( <source> ( "[" "!"? (<status> "=" <action> )+ "]" )? )*'
495    */
496 static service_user *
497 nss_parse_service_list (const char *line)
498 {
499   service_user *result = NULL, **nextp = &result;
500
501   while (1)
502     {
503       service_user *new_service;
504       const char *name;
505
506       while (isspace (line[0]))
507         ++line;
508       if (line[0] == '\0')
509         /* No source specified.  */
510         return result;
511
512       /* Read <source> identifier.  */
513       name = line;
514       while (line[0] != '\0' && !isspace (line[0]) && line[0] != '[')
515         ++line;
516       if (name == line)
517         return result;
518
519
520       new_service = (service_user *) malloc (sizeof (service_user));
521       if (new_service == NULL)
522         return result;
523       else
524         {
525           char *source = (char *) malloc (line - name + 1);
526           if (source == NULL)
527             {
528               free (new_service);
529               return result;
530             }
531           memcpy (source, name, line - name);
532           source[line - name] = '\0';
533
534           new_service->name = source;
535         }
536
537       /* Set default actions.  */
538       new_service->actions[2 + NSS_STATUS_TRYAGAIN] = NSS_ACTION_CONTINUE;
539       new_service->actions[2 + NSS_STATUS_UNAVAIL] = NSS_ACTION_CONTINUE;
540       new_service->actions[2 + NSS_STATUS_NOTFOUND] = NSS_ACTION_CONTINUE;
541       new_service->actions[2 + NSS_STATUS_SUCCESS] = NSS_ACTION_RETURN;
542       new_service->actions[2 + NSS_STATUS_RETURN] = NSS_ACTION_RETURN;
543       new_service->library = NULL;
544       new_service->known = NULL;
545       new_service->next = NULL;
546
547       while (isspace (line[0]))
548         ++line;
549
550       if (line[0] == '[')
551         {
552           /* Read criterions.  */
553           do
554             ++line;
555           while (line[0] != '\0' && isspace (line[0]));
556
557           do
558             {
559               int not;
560               enum nss_status status;
561               lookup_actions action;
562
563               /* Grok ! before name to mean all statii but that one.  */
564               if (not = line[0] == '!')
565                 ++line;
566
567               /* Read status name.  */
568               name = line;
569               while (line[0] != '\0' && !isspace (line[0]) && line[0] != '='
570                      && line[0] != ']')
571                 ++line;
572
573               /* Compare with known statii.  */
574               if (line - name == 7)
575                 {
576                   if (__strncasecmp (name, "SUCCESS", 7) == 0)
577                     status = NSS_STATUS_SUCCESS;
578                   else if (__strncasecmp (name, "UNAVAIL", 7) == 0)
579                     status = NSS_STATUS_UNAVAIL;
580                   else
581                     return result;
582                 }
583               else if (line - name == 8)
584                 {
585                   if (__strncasecmp (name, "NOTFOUND", 8) == 0)
586                     status = NSS_STATUS_NOTFOUND;
587                   else if (__strncasecmp (name, "TRYAGAIN", 8) == 0)
588                     status = NSS_STATUS_TRYAGAIN;
589                   else
590                     return result;
591                 }
592               else
593                 return result;
594
595               while (isspace (line[0]))
596                 ++line;
597               if (line[0] != '=')
598                 return result;
599               do
600                 ++line;
601               while (isspace (line[0]));
602
603               name = line;
604               while (line[0] != '\0' && !isspace (line[0]) && line[0] != '='
605                      && line[0] != ']')
606                 ++line;
607
608               if (line - name == 6 && __strncasecmp (name, "RETURN", 6) == 0)
609                 action = NSS_ACTION_RETURN;
610               else if (line - name == 8
611                        && __strncasecmp (name, "CONTINUE", 8) == 0)
612                 action = NSS_ACTION_CONTINUE;
613               else
614                 return result;
615
616               if (not)
617                 {
618                   /* Save the current action setting for this status,
619                      set them all to the given action, and reset this one.  */
620                   const lookup_actions save = new_service->actions[2 + status];
621                   new_service->actions[2 + NSS_STATUS_TRYAGAIN] = action;
622                   new_service->actions[2 + NSS_STATUS_UNAVAIL] = action;
623                   new_service->actions[2 + NSS_STATUS_NOTFOUND] = action;
624                   new_service->actions[2 + NSS_STATUS_SUCCESS] = action;
625                   new_service->actions[2 + status] = save;
626                 }
627               else
628                 new_service->actions[2 + status] = action;
629
630               /* Skip white spaces.  */
631               while (isspace (line[0]))
632                 ++line;
633             }
634           while (line[0] != ']');
635
636           /* Skip the ']'.  */
637           ++line;
638         }
639
640       *nextp = new_service;
641       nextp = &new_service->next;
642     }
643 }
644
645 static name_database_entry *
646 nss_getline (char *line)
647 {
648   const char *name;
649   name_database_entry *result;
650
651   /* Ignore leading white spaces.  ATTENTION: this is different from
652      what is implemented in Solaris.  The Solaris man page says a line
653      beginning with a white space character is ignored.  We regard
654      this as just another misfeature in Solaris.  */
655   while (isspace (line[0]))
656     ++line;
657
658   /* Recognize `<database> ":"'.  */
659   name = line;
660   while (line[0] != '\0' && !isspace (line[0]) && line[0] != ':')
661     ++line;
662   if (line[0] == '\0' || name == line)
663     /* Syntax error.  */
664     return NULL;
665   *line++ = '\0';
666
667   result = (name_database_entry *) malloc (sizeof (name_database_entry));
668   if (result == NULL)
669     return NULL;
670
671   /* Save the database name.  */
672   {
673     const size_t len = strlen (name) + 1;
674     char *new = malloc (len);
675     if (new == NULL)
676       {
677         free (result);
678         return NULL;
679       }
680     result->name = memcpy (new, name, len);
681   }
682
683   /* Parse the list of services.  */
684   result->service = nss_parse_service_list (line);
685
686   result->next = NULL;
687   return result;
688 }
689
690
691 static service_library *
692 nss_new_service (name_database *database, const char *name)
693 {
694   service_library **currentp = &database->library;
695
696   while (*currentp != NULL)
697     {
698       if (strcmp ((*currentp)->name, name) == 0)
699         return *currentp;
700       currentp = &(*currentp)->next;
701     }
702
703   /* We have to add the new service.  */
704   *currentp = (service_library *) malloc (sizeof (service_library));
705   if (*currentp == NULL)
706     return NULL;
707
708   (*currentp)->name = name;
709   (*currentp)->lib_handle = NULL;
710   (*currentp)->next = NULL;
711
712   return *currentp;
713 }