Sun Jun 23 19:42:05 1996 Ulrich Drepper <drepper@cygnus.com>
[kopensolaris-gnu/glibc.git] / nss / nsswitch.h
1 /* Copyright (C) 1996 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA.  */
18
19 #ifndef _NSSWITCH_H
20 #define _NSSWITCH_H     1
21
22 /* This is an *internal* header.  */
23
24 #include <arpa/nameser.h>
25 #include <netinet/in.h>
26 #include <resolv.h>
27 #include <search.h>
28
29
30 /* Revision number of NSS interface (must be a string).  */
31 #define NSS_SHLIB_REVISION ".1"
32
33
34 /* Possible results of lookup using a nss_* function.  */
35 enum nss_status
36 {
37   NSS_STATUS_TRYAGAIN = -2,
38   NSS_STATUS_UNAVAIL,
39   NSS_STATUS_NOTFOUND,
40   NSS_STATUS_SUCCESS,
41 };
42
43
44 /* Actions performed after lookup finished.  */
45 typedef enum
46 {
47   NSS_ACTION_CONTINUE,
48   NSS_ACTION_RETURN
49 } lookup_actions;
50
51
52 typedef struct service_library
53 {
54   /* Name of service (`files', `dns', `nis', ...).  */
55   const char *name;
56   /* Pointer to the loaded shared library.  */
57   void *lib_handle;
58   /* And the link to the next entry.  */
59   struct service_library *next;
60 } service_library;
61
62
63 /* For mappng a function name to a function pointer.  */
64 typedef struct
65 {
66   const char *fct_name;
67   void *fct_ptr;
68 } known_function;
69
70
71 typedef struct service_user
72 {
73   /* Name of the service (`files', `dns', `nis', ...).  */
74   const char *name;
75   /* Action according to result.  */
76   lookup_actions actions[4];
77   /* Link to the underlying library object.  */
78   service_library *library;
79   /* Collection of known functions.  */
80   struct entry *known;
81   /* And the link to the next entry.  */
82   struct service_user *next;
83 } service_user;
84
85 /* To access the action based on the status value use this macro.  */
86 #define nss_next_action(ni, status) ((ni)->actions[2 + status])
87
88
89 typedef struct name_database_entry
90 {
91   /* Name of the database.  */
92   const char *name;
93   /* List of service to be used.  */
94   service_user *service;
95   /* And the link to the next entry.  */
96   struct name_database_entry *next;
97 } name_database_entry;
98
99
100 typedef struct name_database
101 {
102   /* List of all known databases.  */
103   name_database_entry *entry;
104   /* List of libraries with service implementation.  */
105   service_library *library;
106 } name_database;
107
108
109 /* Interface functions for NSS.  */
110
111 /* Get the data structure representing the specified database.  More
112    than one function can use the database.  */
113 int __nss_database_lookup (const char *database, service_user **ni);
114
115
116 /* Put first function with name FCT_NAME for SERVICE in FCTP.  The
117    position is remembered in NI.  The function returns a value < 0 if
118    an error occured or no such function exists.  */
119 int __nss_lookup (service_user **ni, const char *fct_name, void **fctp);
120
121 /* Determine the next step in the lookup process according to the
122    result STATUS of the call to the last function returned by
123    `__nss_lookup' or `__nss_next'.  NI specifies the last function
124    examined.  The function return a value > 0 if the process should
125    stop with the last result of the last function call to be the
126    result of the entire lookup.  The returned valie is 0 if there is
127    another function to use and < 0 if an error occured.
128
129    If ALL_VALUES is nonzero, the return value will not be > 0 as long as
130    there is a possibility the lookup process can ever use following
131    services.  In other words, only if all four lookup results have
132    the action RETURN associated the lookup process stops before the
133    natural end.  */
134 int __nss_next (service_user **ni, const char *fct_name, void **fctp,
135                 int status, int all_values);
136
137
138 #endif  /* nsswitch.h */