1 /* Copyright (c) 1998, 1999, 2000, 2003, 2004, 2005, 2006, 2007, 2009, 2011
2 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Contributed by Thorsten Kukuk <kukuk@suse.de>, 1998.
6 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; if not, write to the Free
18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 /* This file defines everything that client code should need to
22 know to talk to the nscd daemon. */
24 #ifndef _NSCD_CLIENT_H
25 #define _NSCD_CLIENT_H 1
29 #include <sys/types.h>
31 #include <nscd-types.h>
35 /* Version number of the daemon interface */
36 #define NSCD_VERSION 2
38 /* Path of the file where the PID of the running system is stored. */
39 #define _PATH_NSCDPID "/var/run/nscd/nscd.pid"
41 /* Path for the Unix domain socket. */
42 #define _PATH_NSCDSOCKET "/var/run/nscd/socket"
44 /* Path for the configuration file. */
45 #define _PATH_NSCDCONF "/etc/nscd.conf"
47 /* Maximum allowed length for the key. */
48 #define MAXKEYLEN 1024
51 /* Available services. */
62 SHUTDOWN, /* Shut the server down. */
63 GETSTAT, /* Get the server statistic. */
64 INVALIDATE, /* Invalidate one special cache. */
80 /* Header common to all requests */
83 int32_t version; /* Version number of the daemon interface. */
84 request_type type; /* Service requested. */
85 int32_t key_len; /* Key length. */
89 /* Structure sent in reply to password query. Note that this struct is
90 sent also if the service is disabled or there is no record found. */
95 nscd_ssize_t pw_name_len;
96 nscd_ssize_t pw_passwd_len;
99 nscd_ssize_t pw_gecos_len;
100 nscd_ssize_t pw_dir_len;
101 nscd_ssize_t pw_shell_len;
102 } pw_response_header;
105 /* Structure sent in reply to group query. Note that this struct is
106 sent also if the service is disabled or there is no record found. */
111 nscd_ssize_t gr_name_len;
112 nscd_ssize_t gr_passwd_len;
114 nscd_ssize_t gr_mem_cnt;
115 } gr_response_header;
118 /* Structure sent in reply to host query. Note that this struct is
119 sent also if the service is disabled or there is no record found. */
124 nscd_ssize_t h_name_len;
125 nscd_ssize_t h_aliases_cnt;
128 nscd_ssize_t h_addr_list_cnt;
130 } hst_response_header;
133 /* Structure sent in reply to addrinfo query. Note that this struct is
134 sent also if the service is disabled or there is no record found. */
140 nscd_ssize_t addrslen;
141 nscd_ssize_t canonlen;
143 } ai_response_header;
145 /* Structure filled in by __nscd_getai. */
146 struct nscd_ai_result
154 /* Structure sent in reply to initgroups query. Note that this struct is
155 sent also if the service is disabled or there is no record found. */
161 } initgr_response_header;
164 /* Structure sent in reply to services query. Note that this struct is
165 sent also if the service is disabled or there is no record found. */
170 nscd_ssize_t s_name_len;
171 nscd_ssize_t s_proto_len;
172 nscd_ssize_t s_aliases_cnt;
174 } serv_response_header;
177 /* Structure send in reply to netgroup query. Note that this struct is
178 sent also if the service is disabled or there is no record found. */
183 nscd_ssize_t nresults;
184 nscd_ssize_t result_len;
185 } netgroup_response_header;
192 } innetgroup_response_header;
195 /* Type for offsets in data part of database. */
196 typedef uint32_t ref_t;
197 /* Value for invalid/no reference. */
198 #define ENDREF UINT32_MAX
200 /* Timestamp type. */
201 typedef uint64_t nscd_time_t;
203 /* Maximum timestamp. */
204 #define MAX_TIMEOUT_VALUE \
205 (sizeof (time_t) == sizeof (long int) ? LONG_MAX : INT_MAX)
207 /* Alignment requirement of the beginning of the data region. */
211 /* Head of record in data part of database. */
214 nscd_ssize_t allocsize; /* Allocated Bytes. */
215 nscd_ssize_t recsize; /* Size of the record. */
216 nscd_time_t timeout; /* Time when this entry becomes invalid. */
217 uint8_t notfound; /* Nonzero if data has not been found. */
218 uint8_t nreloads; /* Reloads without use. */
219 uint8_t usable; /* False if the entry must be ignored. */
220 uint8_t unused; /* Unused. */
221 uint32_t ttl; /* TTL value used. */
223 /* We need to have the following element aligned for the response
224 header data types and their use in the 'struct dataset' types
225 defined in the XXXcache.c files. */
228 pw_response_header pwdata;
229 gr_response_header grdata;
230 hst_response_header hstdata;
231 ai_response_header aidata;
232 initgr_response_header initgrdata;
233 serv_response_header servdata;
234 netgroup_response_header netgroupdata;
235 innetgroup_response_header innetgroupdata;
242 /* Structure for one hash table entry. */
245 request_type type:8; /* Which type of dataset. */
246 bool first; /* True if this was the original key. */
247 nscd_ssize_t len; /* Length of key. */
248 ref_t key; /* Pointer to key. */
249 int32_t owner; /* If secure table, this is the owner. */
250 ref_t next; /* Next entry in this hash bucket list. */
251 ref_t packet; /* Records for the result. */
254 struct hashentry *dellist; /* Next record to be deleted. This can be a
255 pointer since only nscd uses this field. */
256 ref_t *prevp; /* Pointer to field containing forward
262 /* Current persistent database version. */
265 /* Maximum time allowed between updates of the timestamp. */
266 #define MAPPING_TIMEOUT (5 * 60)
269 /* Used indices for the EXTRA_DATA element of 'database_pers_head'.
270 Each database has its own indices. */
271 #define NSCD_HST_IDX_CONF_TIMESTAMP 0
274 /* Header of persistent database file. */
275 struct database_pers_head
279 volatile int32_t gc_cycle;
280 volatile int32_t nscd_certainly_running;
281 volatile nscd_time_t timestamp;
282 /* Room for extensions. */
283 volatile uint32_t extra_data[4];
286 nscd_ssize_t data_size;
288 nscd_ssize_t first_free; /* Offset of first free byte in data area. */
290 nscd_ssize_t nentries;
291 nscd_ssize_t maxnentries;
292 nscd_ssize_t maxnsearched;
299 uint64_t rdlockdelayed;
300 uint64_t wrlockdelayed;
308 /* Mapped database record. */
309 struct mapped_database
311 const struct database_pers_head *head;
314 int counter; /* > 0 indicates it is usable. */
317 #define NO_MAPPING ((struct mapped_database *) -1l)
319 struct locked_map_ptr
322 struct mapped_database *mapped;
324 #define libc_locked_map_ptr(class, name) class struct locked_map_ptr name
327 /* Open socket connection to nscd server. */
328 extern int __nscd_open_socket (const char *key, size_t keylen,
329 request_type type, void *response,
330 size_t responselen) attribute_hidden;
332 /* Try to get a file descriptor for the shared meory segment
333 containing the database. */
334 extern struct mapped_database *__nscd_get_mapping (request_type type,
336 struct mapped_database **mappedp) attribute_hidden;
338 /* Get reference of mapping. */
339 extern struct mapped_database *__nscd_get_map_ref (request_type type,
341 volatile struct locked_map_ptr *mapptr,
344 /* Unmap database. */
345 extern void __nscd_unmap (struct mapped_database *mapped);
347 /* Drop reference of mapping. */
348 static inline int __nscd_drop_map_ref (struct mapped_database *map,
351 if (map != NO_MAPPING)
353 int now_cycle = map->head->gc_cycle;
354 if (__builtin_expect (now_cycle != *gc_cycle, 0))
356 /* We might have read inconsistent data. */
357 *gc_cycle = now_cycle;
361 if (atomic_decrement_val (&map->counter) == 0)
369 /* Search the mapped database. */
370 extern struct datahead *__nscd_cache_search (request_type type,
373 const struct mapped_database *mapped,
376 /* Wrappers around read, readv and write that only read/write less than LEN
377 bytes on error or EOF. */
378 extern ssize_t __readall (int fd, void *buf, size_t len)
380 extern ssize_t __readvall (int fd, const struct iovec *iov, int iovcnt)
382 extern ssize_t writeall (int fd, const void *buf, size_t len)
384 extern ssize_t sendfileall (int tofd, int fromfd, off_t off, size_t len)
387 /* Get netlink timestamp counter from mapped area or zero. */
388 extern uint32_t __nscd_get_nl_timestamp (void);