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