1 /* Cache handling for services lookup.
2 Copyright (C) 2007, 2008 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Contributed by Ulrich Drepper <drepper@drepper.com>, 2007.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published
8 by the Free Software Foundation; version 2 of the License, or
9 (at your option) any later version.
11 This program 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
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software Foundation,
18 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
27 #include <kernel-features.h>
33 /* This is the standard reply in case the service is disabled. */
34 static const serv_response_header disabled
=
36 .version
= NSCD_VERSION
,
44 /* This is the struct describing how to write this record. */
45 const struct iovec serv_iov_disabled
=
47 .iov_base
= (void *) &disabled
,
48 .iov_len
= sizeof (disabled
)
52 /* This is the standard reply in case we haven't found the dataset. */
53 static const serv_response_header notfound
=
55 .version
= NSCD_VERSION
,
65 cache_addserv (struct database_dyn
*db
, int fd
, request_header
*req
,
66 const void *key
, struct servent
*serv
, uid_t owner
,
67 struct hashentry
*he
, struct datahead
*dh
, int errval
)
71 time_t t
= time (NULL
);
73 /* We allocate all data in one memory block: the iov vector,
74 the response header and the dataset itself. */
78 serv_response_header resp
;
82 assert (offsetof (struct dataset
, resp
) == offsetof (struct datahead
, data
));
86 if (he
!= NULL
&& errval
== EAGAIN
)
88 /* If we have an old record available but cannot find one
89 now because the service is not available we keep the old
90 record and make sure it does not get removed. */
91 if (reload_count
!= UINT_MAX
)
92 /* Do not reset the value if we never not reload the record. */
93 dh
->nreloads
= reload_count
- 1;
99 /* We have no data. This means we send the standard reply for this
101 total
= sizeof (notfound
);
103 written
= TEMP_FAILURE_RETRY (send (fd
, ¬found
, total
,
106 dataset
= mempool_alloc (db
, sizeof (struct dataset
) + req
->key_len
,
108 /* If we cannot permanently store the result, so be it. */
111 dataset
->head
.allocsize
= sizeof (struct dataset
) + req
->key_len
;
112 dataset
->head
.recsize
= total
;
113 dataset
->head
.notfound
= true;
114 dataset
->head
.nreloads
= 0;
115 dataset
->head
.usable
= true;
117 /* Compute the timeout time. */
118 dataset
->head
.timeout
= t
+ db
->negtimeout
;
120 /* This is the reply. */
121 memcpy (&dataset
->resp
, ¬found
, total
);
123 /* Copy the key data. */
124 memcpy (dataset
->strdata
, key
, req
->key_len
);
126 /* If necessary, we also propagate the data to disk. */
130 uintptr_t pval
= (uintptr_t) dataset
& ~pagesize_m1
;
131 msync ((void *) pval
,
132 ((uintptr_t) dataset
& pagesize_m1
)
133 + sizeof (struct dataset
) + req
->key_len
, MS_ASYNC
);
136 /* Now get the lock to safely insert the records. */
137 pthread_rwlock_rdlock (&db
->lock
);
139 (void) cache_add (req
->type
, &dataset
->strdata
, req
->key_len
,
140 &dataset
->head
, true, db
, owner
, he
== NULL
);
142 pthread_rwlock_unlock (&db
->lock
);
144 /* Mark the old entry as obsolete. */
149 ++db
->head
->addfailed
;
154 /* Determine the I/O structure. */
155 size_t s_name_len
= strlen (serv
->s_name
) + 1;
156 size_t s_proto_len
= strlen (serv
->s_proto
) + 1;
157 uint32_t *s_aliases_len
;
158 size_t s_aliases_cnt
;
163 /* Determine the number of aliases. */
165 for (cnt
= 0; serv
->s_aliases
[cnt
] != NULL
; ++cnt
)
167 /* Determine the length of all aliases. */
168 s_aliases_len
= (uint32_t *) alloca (s_aliases_cnt
* sizeof (uint32_t));
170 for (cnt
= 0; cnt
< s_aliases_cnt
; ++cnt
)
172 s_aliases_len
[cnt
] = strlen (serv
->s_aliases
[cnt
]) + 1;
173 total
+= s_aliases_len
[cnt
];
176 total
+= (offsetof (struct dataset
, strdata
)
179 + s_aliases_cnt
* sizeof (uint32_t));
182 /* If we refill the cache, first assume the reconrd did not
183 change. Allocate memory on the cache since it is likely
184 discarded anyway. If it turns out to be necessary to have a
185 new record we can still allocate real memory. */
186 bool alloca_used
= false;
191 dataset
= (struct dataset
*) mempool_alloc (db
,
192 total
+ req
->key_len
,
195 ++db
->head
->addfailed
;
200 /* We cannot permanently add the result in the moment. But
201 we can provide the result as is. Store the data in some
203 dataset
= (struct dataset
*) alloca (total
+ req
->key_len
);
205 /* We cannot add this record to the permanent database. */
209 dataset
->head
.allocsize
= total
+ req
->key_len
;
210 dataset
->head
.recsize
= total
- offsetof (struct dataset
, resp
);
211 dataset
->head
.notfound
= false;
212 dataset
->head
.nreloads
= he
== NULL
? 0 : (dh
->nreloads
+ 1);
213 dataset
->head
.usable
= true;
215 /* Compute the timeout time. */
216 dataset
->head
.timeout
= t
+ db
->postimeout
;
218 dataset
->resp
.version
= NSCD_VERSION
;
219 dataset
->resp
.found
= 1;
220 dataset
->resp
.s_name_len
= s_name_len
;
221 dataset
->resp
.s_proto_len
= s_proto_len
;
222 dataset
->resp
.s_port
= serv
->s_port
;
223 dataset
->resp
.s_aliases_cnt
= s_aliases_cnt
;
225 cp
= dataset
->strdata
;
227 cp
= mempcpy (cp
, serv
->s_name
, s_name_len
);
228 cp
= mempcpy (cp
, serv
->s_proto
, s_proto_len
);
229 cp
= mempcpy (cp
, s_aliases_len
, s_aliases_cnt
* sizeof (uint32_t));
231 /* Then the aliases. */
233 for (cnt
= 0; cnt
< s_aliases_cnt
; ++cnt
)
234 cp
= mempcpy (cp
, serv
->s_aliases
[cnt
], s_aliases_len
[cnt
]);
237 == dataset
->strdata
+ total
- offsetof (struct dataset
,
240 char *key_copy
= memcpy (cp
, key
, req
->key_len
);
242 /* Now we can determine whether on refill we have to create a new
248 if (total
+ req
->key_len
== dh
->allocsize
249 && total
- offsetof (struct dataset
, resp
) == dh
->recsize
250 && memcmp (&dataset
->resp
, dh
->data
,
251 dh
->allocsize
- offsetof (struct dataset
, resp
)) == 0)
253 /* The data has not changed. We will just bump the
254 timeout value. Note that the new record has been
255 allocated on the stack and need not be freed. */
256 dh
->timeout
= dataset
->head
.timeout
;
261 /* We have to create a new record. Just allocate
262 appropriate memory and copy it. */
264 = (struct dataset
*) mempool_alloc (db
, total
+ req
->key_len
,
268 /* Adjust pointers into the memory block. */
269 aliases
= (char *) newp
+ (aliases
- (char *) dataset
);
270 assert (key_copy
!= NULL
);
271 key_copy
= (char *) newp
+ (key_copy
- (char *) dataset
);
273 dataset
= memcpy (newp
, dataset
, total
+ req
->key_len
);
277 ++db
->head
->addfailed
;
279 /* Mark the old record as obsolete. */
285 /* We write the dataset before inserting it to the database
286 since while inserting this thread might block and so would
287 unnecessarily keep the receiver waiting. */
291 if (__builtin_expect (db
->mmap_used
, 1) && !alloca_used
)
293 assert (db
->wr_fd
!= -1);
294 assert ((char *) &dataset
->resp
> (char *) db
->data
);
295 assert ((char *) &dataset
->resp
- (char *) db
->head
297 <= (sizeof (struct database_pers_head
)
298 + db
->head
->module
* sizeof (ref_t
)
299 + db
->head
->data_size
));
300 written
= sendfileall (fd
, db
->wr_fd
,
301 (char *) &dataset
->resp
302 - (char *) db
->head
, total
);
303 # ifndef __ASSUME_SENDFILE
304 if (written
== -1 && errno
== ENOSYS
)
309 # ifndef __ASSUME_SENDFILE
313 written
= writeall (fd
, &dataset
->resp
, total
);
316 /* Add the record to the database. But only if it has not been
317 stored on the stack. */
320 /* If necessary, we also propagate the data to disk. */
324 uintptr_t pval
= (uintptr_t) dataset
& ~pagesize_m1
;
325 msync ((void *) pval
,
326 ((uintptr_t) dataset
& pagesize_m1
)
327 + total
+ req
->key_len
, MS_ASYNC
);
330 /* Now get the lock to safely insert the records. */
331 pthread_rwlock_rdlock (&db
->lock
);
333 (void) cache_add (req
->type
, key_copy
, req
->key_len
,
334 &dataset
->head
, true, db
, owner
, he
== NULL
);
336 pthread_rwlock_unlock (&db
->lock
);
340 if (__builtin_expect (written
!= total
, 0) && debug_level
> 0)
343 dbg_log (_("short write in %s: %s"), __FUNCTION__
,
344 strerror_r (errno
, buf
, sizeof (buf
)));
350 lookup (int type
, char *key
, struct servent
*resultbufp
, char *buffer
,
351 size_t buflen
, struct servent
**serv
)
353 char *proto
= strrchr (key
, '/');
354 if (proto
!= NULL
&& proto
!= key
)
356 key
= strndupa (key
, proto
- key
);
357 if (proto
[1] == '\0')
363 if (type
== GETSERVBYNAME
)
364 return __getservbyname_r (key
, proto
, resultbufp
, buffer
, buflen
, serv
);
366 assert (type
== GETSERVBYPORT
);
367 return __getservbyport_r (atol (key
), proto
, resultbufp
, buffer
, buflen
,
373 addservbyX (struct database_dyn
*db
, int fd
, request_header
*req
,
374 char *key
, uid_t uid
, struct hashentry
*he
, struct datahead
*dh
)
376 /* Search for the entry matching the key. Please note that we don't
377 look again in the table whether the dataset is now available. We
378 simply insert it. It does not matter if it is in there twice. The
379 pruning function only will look at the timestamp. */
380 size_t buflen
= 1024;
381 char *buffer
= (char *) alloca (buflen
);
382 struct servent resultbuf
;
383 struct servent
*serv
;
384 bool use_malloc
= false;
387 if (__builtin_expect (debug_level
> 0, 0))
390 dbg_log (_("Haven't found \"%s\" in services cache!"), key
);
392 dbg_log (_("Reloading \"%s\" in services cache!"), key
);
395 while (lookup (req
->type
, key
, &resultbuf
, buffer
, buflen
, &serv
) != 0
396 && (errval
= errno
) == ERANGE
)
400 if (__builtin_expect (buflen
> 32768, 0))
402 char *old_buffer
= buffer
;
404 buffer
= (char *) realloc (use_malloc
? buffer
: NULL
, buflen
);
407 /* We ran out of memory. We cannot do anything but
408 sending a negative response. In reality this should
413 /* We set the error to indicate this is (possibly) a
414 temporary error and that it does not mean the entry
415 is not available at all. */
422 /* Allocate a new buffer on the stack. If possible combine it
423 with the previously allocated buffer. */
424 buffer
= (char *) extend_alloca (buffer
, buflen
, 2 * buflen
);
427 cache_addserv (db
, fd
, req
, key
, serv
, uid
, he
, dh
, errval
);
435 addservbyname (struct database_dyn
*db
, int fd
, request_header
*req
,
436 void *key
, uid_t uid
)
438 addservbyX (db
, fd
, req
, key
, uid
, NULL
, NULL
);
443 readdservbyname (struct database_dyn
*db
, struct hashentry
*he
,
448 .type
= GETSERVBYNAME
,
452 addservbyX (db
, -1, &req
, db
->data
+ he
->key
, he
->owner
, he
, dh
);
457 addservbyport (struct database_dyn
*db
, int fd
, request_header
*req
,
458 void *key
, uid_t uid
)
460 addservbyX (db
, fd
, req
, key
, uid
, NULL
, NULL
);
465 readdservbyport (struct database_dyn
*db
, struct hashentry
*he
,
470 .type
= GETSERVBYPORT
,
474 addservbyX (db
, -1, &req
, db
->data
+ he
->key
, he
->owner
, he
, dh
);