2006-02-28 Roland McGrath <roland@redhat.com>
[kopensolaris-gnu/glibc.git] / nscd / nscd_helper.c
1 /* Copyright (C) 1998-2002,2003,2004,2005,2006 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the 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    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with the GNU C Library; if not, write to the Free
17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18    02111-1307 USA.  */
19
20 #include <assert.h>
21 #include <errno.h>
22 #include <fcntl.h>
23 #include <stdbool.h>
24 #include <time.h>
25 #include <unistd.h>
26 #include <sys/mman.h>
27 #include <sys/poll.h>
28 #include <sys/socket.h>
29 #include <sys/stat.h>
30 #include <sys/time.h>
31 #include <sys/uio.h>
32 #include <sys/un.h>
33 #include <not-cancel.h>
34 #include <nis/rpcsvc/nis.h>
35
36 #include "nscd-client.h"
37
38
39 ssize_t
40 __readall (int fd, void *buf, size_t len)
41 {
42   size_t n = len;
43   ssize_t ret;
44   do
45     {
46       ret = TEMP_FAILURE_RETRY (__read (fd, buf, n));
47       if (ret <= 0)
48         break;
49       buf = (char *) buf + ret;
50       n -= ret;
51     }
52   while (n > 0);
53   return ret < 0 ? ret : len - n;
54 }
55
56
57 ssize_t
58 __readvall (int fd, const struct iovec *iov, int iovcnt)
59 {
60   ssize_t ret = TEMP_FAILURE_RETRY (__readv (fd, iov, iovcnt));
61   if (ret <= 0)
62     return ret;
63
64   size_t total = 0;
65   for (int i = 0; i < iovcnt; ++i)
66     total += iov[i].iov_len;
67
68   if (ret < total)
69     {
70       struct iovec iov_buf[iovcnt];
71       ssize_t r = ret;
72
73       struct iovec *iovp = memcpy (iov_buf, iov, iovcnt * sizeof (*iov));
74       do
75         {
76           while (iovp->iov_len <= r)
77             {
78               r -= iovp->iov_len;
79               --iovcnt;
80               ++iovp;
81             }
82           iovp->iov_base = (char *) iovp->iov_base + r;
83           iovp->iov_len -= r;
84           r = TEMP_FAILURE_RETRY (__readv (fd, iovp, iovcnt));
85           if (r <= 0)
86             break;
87           ret += r;
88         }
89       while (ret < total);
90       if (r < 0)
91         ret = r;
92     }
93   return ret;
94 }
95
96
97 static int
98 open_socket (void)
99 {
100   int sock = __socket (PF_UNIX, SOCK_STREAM, 0);
101   if (sock < 0)
102     return -1;
103
104   /* Make socket non-blocking.  */
105   int fl = __fcntl (sock, F_GETFL);
106   if (fl != -1)
107     __fcntl (sock, F_SETFL, fl | O_NONBLOCK);
108
109   struct sockaddr_un sun;
110   sun.sun_family = AF_UNIX;
111   strcpy (sun.sun_path, _PATH_NSCDSOCKET);
112   if (__connect (sock, (struct sockaddr *) &sun, sizeof (sun)) < 0
113       && errno != EINPROGRESS)
114     goto out;
115
116   struct pollfd fds[1];
117   fds[0].fd = sock;
118   fds[0].events = POLLOUT | POLLERR | POLLHUP;
119   if (__poll (fds, 1, 5 * 1000) > 0)
120     /* Success.  We do not check for success of the connect call here.
121        If it failed, the following operations will fail.  */
122     return sock;
123
124  out:
125   close_not_cancel_no_status (sock);
126
127   return -1;
128 }
129
130
131 void
132 __nscd_unmap (struct mapped_database *mapped)
133 {
134   assert (mapped->counter == 0);
135   __munmap ((void *) mapped->head, mapped->mapsize);
136   free (mapped);
137 }
138
139
140 static int
141 wait_on_socket (int sock)
142 {
143   struct pollfd fds[1];
144   fds[0].fd = sock;
145   fds[0].events = POLLIN | POLLERR | POLLHUP;
146   int n = __poll (fds, 1, 5 * 1000);
147   if (n == -1 && __builtin_expect (errno == EINTR, 0))
148     {
149       /* Handle the case where the poll() call is interrupted by a
150          signal.  We cannot just use TEMP_FAILURE_RETRY since it might
151          lead to infinite loops.  */
152       struct timeval now;
153       (void) __gettimeofday (&now, NULL);
154       long int end = (now.tv_sec + 5) * 1000 + (now.tv_usec + 500) / 1000;
155       while (1)
156         {
157           long int timeout = end - (now.tv_sec * 1000
158                                     + (now.tv_usec + 500) / 1000);
159           n = __poll (fds, 1, timeout);
160           if (n != -1 || errno != EINTR)
161             break;
162           (void) __gettimeofday (&now, NULL);
163         }
164     }
165
166   return n;
167 }
168
169
170 /* Try to get a file descriptor for the shared meory segment
171    containing the database.  */
172 static struct mapped_database *
173 get_mapping (request_type type, const char *key,
174              struct mapped_database **mappedp)
175 {
176   struct mapped_database *result = NO_MAPPING;
177 #ifdef SCM_RIGHTS
178   const size_t keylen = strlen (key) + 1;
179   char resdata[keylen];
180   int saved_errno = errno;
181
182   int mapfd = -1;
183
184   /* Send the request.  */
185   struct iovec iov[2];
186   request_header req;
187
188   int sock = open_socket ();
189   if (sock < 0)
190     goto out;
191
192   req.version = NSCD_VERSION;
193   req.type = type;
194   req.key_len = keylen;
195
196   iov[0].iov_base = &req;
197   iov[0].iov_len = sizeof (req);
198   iov[1].iov_base = (void *) key;
199   iov[1].iov_len = keylen;
200
201   if (__builtin_expect (TEMP_FAILURE_RETRY (__writev (sock, iov, 2))
202                         != iov[0].iov_len + iov[1].iov_len, 0))
203     /* We cannot even write the request.  */
204     goto out_close2;
205
206   /* Room for the data sent along with the file descriptor.  We expect
207      the key name back.  */
208   iov[0].iov_base = resdata;
209   iov[0].iov_len = keylen;
210
211   union
212   {
213     struct cmsghdr hdr;
214     char bytes[CMSG_SPACE (sizeof (int))];
215   } buf;
216   struct msghdr msg = { .msg_iov = iov, .msg_iovlen = 1,
217                         .msg_control = buf.bytes,
218                         .msg_controllen = sizeof (buf) };
219   struct cmsghdr *cmsg = CMSG_FIRSTHDR (&msg);
220
221   cmsg->cmsg_level = SOL_SOCKET;
222   cmsg->cmsg_type = SCM_RIGHTS;
223   cmsg->cmsg_len = CMSG_LEN (sizeof (int));
224
225   /* This access is well-aligned since BUF is correctly aligned for an
226      int and CMSG_DATA preserves this alignment.  */
227   *(int *) CMSG_DATA (cmsg) = -1;
228
229   msg.msg_controllen = cmsg->cmsg_len;
230
231   if (wait_on_socket (sock) <= 0)
232     goto out_close2;
233
234 # ifndef MSG_NOSIGNAL
235 #  define MSG_NOSIGNAL 0
236 # endif
237   if (__builtin_expect (TEMP_FAILURE_RETRY (__recvmsg (sock, &msg,
238                                                        MSG_NOSIGNAL))
239                         != keylen, 0))
240     goto out_close2;
241
242   mapfd = *(int *) CMSG_DATA (cmsg);
243
244   if (__builtin_expect (CMSG_FIRSTHDR (&msg)->cmsg_len
245                         != CMSG_LEN (sizeof (int)), 0))
246     goto out_close;
247
248   struct stat64 st;
249   if (__builtin_expect (strcmp (resdata, key) != 0, 0)
250       || __builtin_expect (fstat64 (mapfd, &st) != 0, 0)
251       || __builtin_expect (st.st_size < sizeof (struct database_pers_head), 0))
252     goto out_close;
253
254   struct database_pers_head head;
255   if (__builtin_expect (TEMP_FAILURE_RETRY (__pread (mapfd, &head,
256                                                      sizeof (head), 0))
257                         != sizeof (head), 0))
258     goto out_close;
259
260   if (__builtin_expect (head.version != DB_VERSION, 0)
261       || __builtin_expect (head.header_size != sizeof (head), 0)
262       /* This really should not happen but who knows, maybe the update
263          thread got stuck.  */
264       || __builtin_expect (! head.nscd_certainly_running
265                            && head.timestamp + MAPPING_TIMEOUT < time (NULL),
266                            0))
267     goto out_close;
268
269   size_t size = (sizeof (head) + roundup (head.module * sizeof (ref_t), ALIGN)
270                  + head.data_size);
271
272   if (__builtin_expect (st.st_size < size, 0))
273     goto out_close;
274
275   /* The file is large enough, map it now.  */
276   void *mapping = __mmap (NULL, size, PROT_READ, MAP_SHARED, mapfd, 0);
277   if (__builtin_expect (mapping != MAP_FAILED, 1))
278     {
279       /* Allocate a record for the mapping.  */
280       struct mapped_database *newp = malloc (sizeof (*newp));
281       if (newp == NULL)
282         {
283           /* Ugh, after all we went through the memory allocation failed.  */
284           __munmap (mapping, size);
285           goto out_close;
286         }
287
288       newp->head = mapping;
289       newp->data = ((char *) mapping + head.header_size
290                     + roundup (head.module * sizeof (ref_t), ALIGN));
291       newp->mapsize = size;
292       /* Set counter to 1 to show it is usable.  */
293       newp->counter = 1;
294
295       result = newp;
296     }
297
298  out_close:
299   __close (mapfd);
300  out_close2:
301   __close (sock);
302  out:
303   __set_errno (saved_errno);
304 #endif  /* SCM_RIGHTS */
305
306   struct mapped_database *oldval = *mappedp;
307   *mappedp = result;
308
309   if (oldval != NULL && atomic_decrement_val (&oldval->counter) == 0)
310     __nscd_unmap (oldval);
311
312   return result;
313 }
314
315
316 struct mapped_database *
317 __nscd_get_map_ref (request_type type, const char *name,
318                     struct locked_map_ptr *mapptr, int *gc_cyclep)
319 {
320   struct mapped_database *cur = mapptr->mapped;
321   if (cur == NO_MAPPING)
322     return cur;
323
324   int cnt = 0;
325   while (atomic_compare_and_exchange_val_acq (&mapptr->lock, 1, 0) != 0)
326     {
327       // XXX Best number of rounds?
328       if (++cnt > 5)
329         return NO_MAPPING;
330
331       atomic_delay ();
332     }
333
334   cur = mapptr->mapped;
335
336   if (__builtin_expect (cur != NO_MAPPING, 1))
337     {
338       /* If not mapped or timestamp not updated, request new map.  */
339       if (cur == NULL
340           || (cur->head->nscd_certainly_running == 0
341               && cur->head->timestamp + MAPPING_TIMEOUT < time (NULL)))
342         cur = get_mapping (type, name, &mapptr->mapped);
343
344       if (__builtin_expect (cur != NO_MAPPING, 1))
345         {
346           if (__builtin_expect (((*gc_cyclep = cur->head->gc_cycle) & 1) != 0,
347                                 0))
348             cur = NO_MAPPING;
349           else
350             atomic_increment (&cur->counter);
351         }
352     }
353
354   mapptr->lock = 0;
355
356   return cur;
357 }
358
359
360 const struct datahead *
361 __nscd_cache_search (request_type type, const char *key, size_t keylen,
362                      const struct mapped_database *mapped)
363 {
364   unsigned long int hash = __nis_hash (key, keylen) % mapped->head->module;
365
366   ref_t work = mapped->head->array[hash];
367   while (work != ENDREF)
368     {
369       struct hashentry *here = (struct hashentry *) (mapped->data + work);
370
371       if (type == here->type && keylen == here->len
372           && memcmp (key, mapped->data + here->key, keylen) == 0)
373         {
374           /* We found the entry.  Increment the appropriate counter.  */
375           const struct datahead *dh
376             = (struct datahead *) (mapped->data + here->packet);
377
378           /* See whether we must ignore the entry or whether something
379              is wrong because garbage collection is in progress.  */
380           if (dh->usable && ((char *) dh + dh->allocsize
381                              <= (char *) mapped->head + mapped->mapsize))
382             return dh;
383         }
384
385       work = here->next;
386     }
387
388   return NULL;
389 }
390
391
392 /* Create a socket connected to a name. */
393 int
394 __nscd_open_socket (const char *key, size_t keylen, request_type type,
395                     void *response, size_t responselen)
396 {
397   int saved_errno = errno;
398
399   int sock = open_socket ();
400   if (sock >= 0)
401     {
402       request_header req;
403       req.version = NSCD_VERSION;
404       req.type = type;
405       req.key_len = keylen;
406
407       struct iovec vec[2];
408       vec[0].iov_base = &req;
409       vec[0].iov_len = sizeof (request_header);
410       vec[1].iov_base = (void *) key;
411       vec[1].iov_len = keylen;
412
413       ssize_t nbytes = TEMP_FAILURE_RETRY (__writev (sock, vec, 2));
414       if (nbytes == (ssize_t) (sizeof (request_header) + keylen)
415           /* Wait for data.  */
416           && wait_on_socket (sock) > 0)
417         {
418           nbytes = TEMP_FAILURE_RETRY (__read (sock, response, responselen));
419           if (nbytes == (ssize_t) responselen)
420             return sock;
421         }
422
423       close_not_cancel_no_status (sock);
424     }
425
426   __set_errno (saved_errno);
427
428   return -1;
429 }