nscd/hstcache.c

   1 /* Cache handling for host lookup.
   2    Copyright (C) 1998-2005, 2006, 2007 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
   5
   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.
  10
  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.
  15
  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.  */
  19
  20 #include <alloca.h>
  21 #include <assert.h>
  22 #include <errno.h>
  23 #include <error.h>
  24 #include <libintl.h>
  25 #include <netdb.h>
  26 #include <stdbool.h>
  27 #include <stddef.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <time.h>
  32 #include <unistd.h>
  33 #include <arpa/inet.h>
  34 #include <arpa/nameser.h>
  35 #include <sys/mman.h>
  36 #include <stackinfo.h>
  37
  38 #include "nscd.h"
  39 #include "dbg_log.h"
  40 #ifdef HAVE_SENDFILE
  41 # include <kernel-features.h>
  42 #endif
  43
  44
  45 /* This is the standard reply in case the service is disabled.  */
  46 static const hst_response_header disabled =
  47 {
  48   .version = NSCD_VERSION,
  49   .found = -1,
  50   .h_name_len = 0,
  51   .h_aliases_cnt = 0,
  52   .h_addrtype = -1,
  53   .h_length = -1,
  54   .h_addr_list_cnt = 0,
  55   .error = NETDB_INTERNAL
  56 };
  57
  58 /* This is the struct describing how to write this record.  */
  59 const struct iovec hst_iov_disabled =
  60 {
  61   .iov_base = (void *) &disabled,
  62   .iov_len = sizeof (disabled)
  63 };
  64
  65
  66 /* This is the standard reply in case we haven't found the dataset.  */
  67 static const hst_response_header notfound =
  68 {
  69   .version = NSCD_VERSION,
  70   .found = 0,
  71   .h_name_len = 0,
  72   .h_aliases_cnt = 0,
  73   .h_addrtype = -1,
  74   .h_length = -1,
  75   .h_addr_list_cnt = 0,
  76   .error = HOST_NOT_FOUND
  77 };
  78
  79
  80 static void
  81 cache_addhst (struct database_dyn *db, int fd, request_header *req,
  82               const void *key, struct hostent *hst, uid_t owner,
  83               struct hashentry *he, struct datahead *dh, int errval,
  84               int32_t ttl)
  85 {
  86   ssize_t total;
  87   ssize_t written;
  88   time_t t = time (NULL);
  89
  90   /* We allocate all data in one memory block: the iov vector,
  91      the response header and the dataset itself.  */
  92   struct dataset
  93   {
  94     struct datahead head;
  95     hst_response_header resp;
  96     char strdata[0];
  97   } *dataset;
  98
  99   assert (offsetof (struct dataset, resp) == offsetof (struct datahead, data));
 100
 101   if (hst == NULL)
 102     {
 103       if (he != NULL && errval == EAGAIN)
 104         {
 105           /* If we have an old record available but cannot find one
 106              now because the service is not available we keep the old
 107              record and make sure it does not get removed.  */
 108           if (reload_count != UINT_MAX)
 109             /* Do not reset the value if we never not reload the record.  */
 110             dh->nreloads = reload_count - 1;
 111
 112           written = total = 0;
 113         }
 114       else
 115         {
 116           /* We have no data.  This means we send the standard reply for this
 117              case.  */
 118           written = total = sizeof (notfound);
 119
 120           if (fd != -1)
 121             written = TEMP_FAILURE_RETRY (send (fd, &notfound, total,
 122                                                 MSG_NOSIGNAL));
 123
 124           dataset = mempool_alloc (db, sizeof (struct dataset) + req->key_len);
 125           /* If we cannot permanently store the result, so be it.  */
 126           if (dataset != NULL)
 127             {
 128               dataset->head.allocsize = sizeof (struct dataset) + req->key_len;
 129               dataset->head.recsize = total;
 130               dataset->head.notfound = true;
 131               dataset->head.nreloads = 0;
 132               dataset->head.usable = true;
 133
 134               /* Compute the timeout time.  */
 135               dataset->head.timeout = t + (ttl == INT32_MAX
 136                                            ? db->negtimeout : ttl);
 137
 138               /* This is the reply.  */
 139               memcpy (&dataset->resp, &notfound, total);
 140
 141               /* Copy the key data.  */
 142               memcpy (dataset->strdata, key, req->key_len);
 143
 144               /* If necessary, we also propagate the data to disk.  */
 145               if (db->persistent)
 146                 {
 147                   // XXX async OK?
 148                   uintptr_t pval = (uintptr_t) dataset & ~pagesize_m1;
 149                   msync ((void *) pval,
 150                          ((uintptr_t) dataset & pagesize_m1)
 151                          + sizeof (struct dataset) + req->key_len, MS_ASYNC);
 152                 }
 153
 154               /* Now get the lock to safely insert the records.  */
 155               pthread_rwlock_rdlock (&db->lock);
 156
 157               if (cache_add (req->type, &dataset->strdata, req->key_len,
 158                              &dataset->head, true, db, owner) < 0)
 159                 /* Ensure the data can be recovered.  */
 160                 dataset->head.usable = false;
 161
 162               pthread_rwlock_unlock (&db->lock);
 163
 164               /* Mark the old entry as obsolete.  */
 165               if (dh != NULL)
 166                 dh->usable = false;
 167             }
 168           else
 169             ++db->head->addfailed;
 170         }
 171     }
 172   else
 173     {
 174       /* Determine the I/O structure.  */
 175       size_t h_name_len = strlen (hst->h_name) + 1;
 176       size_t h_aliases_cnt;
 177       uint32_t *h_aliases_len;
 178       size_t h_addr_list_cnt;
 179       int addr_list_type;
 180       char *addresses;
 181       char *aliases;
 182       char *key_copy = NULL;
 183       char *cp;
 184       size_t cnt;
 185
 186       /* Determine the number of aliases.  */
 187       h_aliases_cnt = 0;
 188       for (cnt = 0; hst->h_aliases[cnt] != NULL; ++cnt)
 189         ++h_aliases_cnt;
 190       /* Determine the length of all aliases.  */
 191       h_aliases_len = (uint32_t *) alloca (h_aliases_cnt * sizeof (uint32_t));
 192       total = 0;
 193       for (cnt = 0; cnt < h_aliases_cnt; ++cnt)
 194         {
 195           h_aliases_len[cnt] = strlen (hst->h_aliases[cnt]) + 1;
 196           total += h_aliases_len[cnt];
 197         }
 198
 199       /* Determine the number of addresses.  */
 200       h_addr_list_cnt = 0;
 201       while (hst->h_addr_list[h_addr_list_cnt] != NULL)
 202         ++h_addr_list_cnt;
 203
 204       if (h_addr_list_cnt == 0)
 205         /* Invalid entry.  */
 206         return;
 207
 208       total += (sizeof (struct dataset)
 209                 + h_name_len
 210                 + h_aliases_cnt * sizeof (uint32_t)
 211                 + h_addr_list_cnt * hst->h_length);
 212       written = total;
 213
 214       /* If we refill the cache, first assume the reconrd did not
 215          change.  Allocate memory on the cache since it is likely
 216          discarded anyway.  If it turns out to be necessary to have a
 217          new record we can still allocate real memory.  */
 218       bool alloca_used = false;
 219       dataset = NULL;
 220
 221       /* If the record contains more than one IP address (used for
 222          load balancing etc) don't cache the entry.  This is something
 223          the current cache handling cannot handle and it is more than
 224          questionable whether it is worthwhile complicating the cache
 225          handling just for handling such a special case. */
 226       if (he == NULL && h_addr_list_cnt == 1)
 227         {
 228           dataset = (struct dataset *) mempool_alloc (db,
 229                                                       total + req->key_len);
 230           if (dataset == NULL)
 231             ++db->head->addfailed;
 232         }
 233
 234       if (dataset == NULL)
 235         {
 236           /* We cannot permanently add the result in the moment.  But
 237              we can provide the result as is.  Store the data in some
 238              temporary memory.  */
 239           dataset = (struct dataset *) alloca (total + req->key_len);
 240
 241           /* We cannot add this record to the permanent database.  */
 242           alloca_used = true;
 243         }
 244
 245       dataset->head.allocsize = total + req->key_len;
 246       dataset->head.recsize = total - offsetof (struct dataset, resp);
 247       dataset->head.notfound = false;
 248       dataset->head.nreloads = he == NULL ? 0 : (dh->nreloads + 1);
 249       dataset->head.usable = true;
 250
 251       /* Compute the timeout time.  */
 252       dataset->head.timeout = t + (ttl == INT32_MAX ? db->postimeout : ttl);
 253
 254       dataset->resp.version = NSCD_VERSION;
 255       dataset->resp.found = 1;
 256       dataset->resp.h_name_len = h_name_len;
 257       dataset->resp.h_aliases_cnt = h_aliases_cnt;
 258       dataset->resp.h_addrtype = hst->h_addrtype;
 259       dataset->resp.h_length = hst->h_length;
 260       dataset->resp.h_addr_list_cnt = h_addr_list_cnt;
 261       dataset->resp.error = NETDB_SUCCESS;
 262
 263       cp = dataset->strdata;
 264
 265       cp = mempcpy (cp, hst->h_name, h_name_len);
 266       cp = mempcpy (cp, h_aliases_len, h_aliases_cnt * sizeof (uint32_t));
 267
 268       /* The normal addresses first.  */
 269       addresses = cp;
 270       for (cnt = 0; cnt < h_addr_list_cnt; ++cnt)
 271         cp = mempcpy (cp, hst->h_addr_list[cnt], hst->h_length);
 272
 273       /* Then the aliases.  */
 274       aliases = cp;
 275       for (cnt = 0; cnt < h_aliases_cnt; ++cnt)
 276         cp = mempcpy (cp, hst->h_aliases[cnt], h_aliases_len[cnt]);
 277
 278       assert (cp
 279               == dataset->strdata + total - offsetof (struct dataset,
 280                                                       strdata));
 281
 282       /* If we are adding a GETHOSTBYNAME{,v6} entry we must be prepared
 283          that the answer we get from the NSS does not contain the key
 284          itself.  This is the case if the resolver is used and the name
 285          is extended by the domainnames from /etc/resolv.conf.  Therefore
 286          we explicitly add the name here.  */
 287       key_copy = memcpy (cp, key, req->key_len);
 288
 289       /* Now we can determine whether on refill we have to create a new
 290          record or not.  */
 291       if (he != NULL)
 292         {
 293           assert (fd == -1);
 294
 295           if (total + req->key_len == dh->allocsize
 296               && total - offsetof (struct dataset, resp) == dh->recsize
 297               && memcmp (&dataset->resp, dh->data,
 298                          dh->allocsize - offsetof (struct dataset, resp)) == 0)
 299             {
 300               /* The data has not changed.  We will just bump the
 301                  timeout value.  Note that the new record has been
 302                  allocated on the stack and need not be freed.  */
 303               assert (h_addr_list_cnt == 1);
 304               dh->timeout = dataset->head.timeout;
 305               ++dh->nreloads;
 306             }
 307           else
 308             {
 309               if (h_addr_list_cnt == 1)
 310                 {
 311                   /* We have to create a new record.  Just allocate
 312                      appropriate memory and copy it.  */
 313                   struct dataset *newp
 314                     = (struct dataset *) mempool_alloc (db,
 315                                                         total + req->key_len);
 316                   if (newp != NULL)
 317                     {
 318                       /* Adjust pointers into the memory block.  */
 319                       addresses = (char *) newp + (addresses
 320                                                    - (char *) dataset);
 321                       aliases = (char *) newp + (aliases - (char *) dataset);
 322                       assert (key_copy != NULL);
 323                       key_copy = (char *) newp + (key_copy - (char *) dataset);
 324
 325                       dataset = memcpy (newp, dataset, total + req->key_len);
 326                       alloca_used = false;
 327                     }
 328                 }
 329
 330               /* Mark the old record as obsolete.  */
 331               dh->usable = false;
 332             }
 333         }
 334       else
 335         {
 336           /* We write the dataset before inserting it to the database
 337              since while inserting this thread might block and so would
 338              unnecessarily keep the receiver waiting.  */
 339           assert (fd != -1);
 340
 341 #ifdef HAVE_SENDFILE
 342           if (__builtin_expect (db->mmap_used, 1) && !alloca_used)
 343             {
 344               assert (db->wr_fd != -1);
 345               assert ((char *) &dataset->resp > (char *) db->data);
 346               assert ((char *) &dataset->resp - (char *) db->head
 347                       + total
 348                       <= (sizeof (struct database_pers_head)
 349                           + db->head->module * sizeof (ref_t)
 350                           + db->head->data_size));
 351               written = sendfileall (fd, db->wr_fd,
 352                                      (char *) &dataset->resp
 353                                      - (char *) db->head, total);
 354 # ifndef __ASSUME_SENDFILE
 355               if (written == -1 && errno == ENOSYS)
 356                 goto use_write;
 357 # endif
 358             }
 359           else
 360 # ifndef __ASSUME_SENDFILE
 361           use_write:
 362 # endif
 363 #endif
 364             written = writeall (fd, &dataset->resp, total);
 365         }
 366
 367       /* Add the record to the database.  But only if it has not been
 368          stored on the stack.
 369
 370          If the record contains more than one IP address (used for
 371          load balancing etc) don't cache the entry.  This is something
 372          the current cache handling cannot handle and it is more than
 373          questionable whether it is worthwhile complicating the cache
 374          handling just for handling such a special case. */
 375       if (! alloca_used)
 376         {
 377           /* If necessary, we also propagate the data to disk.  */
 378           if (db->persistent)
 379             {
 380               // XXX async OK?
 381               uintptr_t pval = (uintptr_t) dataset & ~pagesize_m1;
 382               msync ((void *) pval,
 383                      ((uintptr_t) dataset & pagesize_m1)
 384                      + total + req->key_len, MS_ASYNC);
 385             }
 386
 387           addr_list_type = (hst->h_length == NS_INADDRSZ
 388                             ? GETHOSTBYADDR : GETHOSTBYADDRv6);
 389
 390           /* Now get the lock to safely insert the records.  */
 391           pthread_rwlock_rdlock (&db->lock);
 392
 393           /* NB: the following code is really complicated.  It has
 394              seemlingly duplicated code paths which do the same.  The
 395              problem is that we always must add the hash table entry
 396              with the FIRST flag set first.  Otherwise we get dangling
 397              pointers in case memory allocation fails.  */
 398           assert (hst->h_addr_list[1] == NULL);
 399
 400           /* Avoid adding names if more than one address is available.  See
 401              above for more info.  */
 402           assert (req->type == GETHOSTBYNAME
 403                   || req->type == GETHOSTBYNAMEv6
 404                   || req->type == GETHOSTBYADDR
 405                   || req->type == GETHOSTBYADDRv6);
 406
 407           if (cache_add (req->type, key_copy, req->key_len,
 408                          &dataset->head, true, db, owner) < 0)
 409             /* Could not allocate memory.  Make sure the
 410                data gets discarded.  */
 411             dataset->head.usable = false;
 412
 413           pthread_rwlock_unlock (&db->lock);
 414         }
 415     }
 416
 417   if (__builtin_expect (written != total, 0) && debug_level > 0)
 418     {
 419       char buf[256];
 420       dbg_log (_("short write in %s: %s"),  __FUNCTION__,
 421                strerror_r (errno, buf, sizeof (buf)));
 422     }
 423 }
 424
 425
 426 static int
 427 lookup (int type, void *key, struct hostent *resultbufp, char *buffer,
 428         size_t buflen, struct hostent **hst, int32_t *ttlp)
 429 {
 430   if (type == GETHOSTBYNAME)
 431     return __gethostbyname3_r (key, AF_INET, resultbufp, buffer, buflen, hst,
 432                                &h_errno, ttlp, NULL);
 433   if (type == GETHOSTBYNAMEv6)
 434     return __gethostbyname3_r (key, AF_INET6, resultbufp, buffer, buflen, hst,
 435                                &h_errno, ttlp, NULL);
 436   if (type == GETHOSTBYADDR)
 437     return __gethostbyaddr2_r (key, NS_INADDRSZ, AF_INET, resultbufp, buffer,
 438                                buflen, hst, &h_errno, ttlp);
 439   return __gethostbyaddr2_r (key, NS_IN6ADDRSZ, AF_INET6, resultbufp, buffer,
 440                              buflen, hst, &h_errno, ttlp);
 441 }
 442
 443
 444 static void
 445 addhstbyX (struct database_dyn *db, int fd, request_header *req,
 446            void *key, uid_t uid, struct hashentry *he, struct datahead *dh)
 447 {
 448   /* Search for the entry matching the key.  Please note that we don't
 449      look again in the table whether the dataset is now available.  We
 450      simply insert it.  It does not matter if it is in there twice.  The
 451      pruning function only will look at the timestamp.  */
 452   int buflen = 1024;
 453   char *buffer = (char *) alloca (buflen);
 454   struct hostent resultbuf;
 455   struct hostent *hst;
 456   bool use_malloc = false;
 457   int errval = 0;
 458   int32_t ttl = INT32_MAX;
 459
 460   if (__builtin_expect (debug_level > 0, 0))
 461     {
 462       const char *str;
 463       char buf[INET6_ADDRSTRLEN + 1];
 464       if (req->type == GETHOSTBYNAME || req->type == GETHOSTBYNAMEv6)
 465         str = key;
 466       else
 467         str = inet_ntop (req->type == GETHOSTBYADDR ? AF_INET : AF_INET6,
 468                          key, buf, sizeof (buf));
 469
 470       if (he == NULL)
 471         dbg_log (_("Haven't found \"%s\" in hosts cache!"), (char *) str);
 472       else
 473         dbg_log (_("Reloading \"%s\" in hosts cache!"), (char *) str);
 474     }
 475
 476   while (lookup (req->type, key, &resultbuf, buffer, buflen, &hst, &ttl) != 0
 477          && h_errno == NETDB_INTERNAL
 478          && (errval = errno) == ERANGE)
 479     {
 480       errno = 0;
 481
 482       if (__builtin_expect (buflen > 32768, 0))
 483         {
 484           char *old_buffer = buffer;
 485           buflen *= 2;
 486           buffer = (char *) realloc (use_malloc ? buffer : NULL, buflen);
 487           if (buffer == NULL)
 488             {
 489               /* We ran out of memory.  We cannot do anything but
 490                  sending a negative response.  In reality this should
 491                  never happen.  */
 492               hst = NULL;
 493               buffer = old_buffer;
 494
 495               /* We set the error to indicate this is (possibly) a
 496                  temporary error and that it does not mean the entry
 497                  is not available at all.  */
 498               errval = EAGAIN;
 499               break;
 500             }
 501           use_malloc = true;
 502         }
 503       else
 504         /* Allocate a new buffer on the stack.  If possible combine it
 505            with the previously allocated buffer.  */
 506         buffer = (char *) extend_alloca (buffer, buflen, 2 * buflen);
 507     }
 508
 509   cache_addhst (db, fd, req, key, hst, uid, he, dh,
 510                 h_errno == TRY_AGAIN ? errval : 0, ttl);
 511
 512   if (use_malloc)
 513     free (buffer);
 514 }
 515
 516
 517 void
 518 addhstbyname (struct database_dyn *db, int fd, request_header *req,
 519               void *key, uid_t uid)
 520 {
 521   addhstbyX (db, fd, req, key, uid, NULL, NULL);
 522 }
 523
 524
 525 void
 526 readdhstbyname (struct database_dyn *db, struct hashentry *he,
 527                 struct datahead *dh)
 528 {
 529   request_header req =
 530     {
 531       .type = GETHOSTBYNAME,
 532       .key_len = he->len
 533     };
 534
 535   addhstbyX (db, -1, &req, db->data + he->key, he->owner, he, dh);
 536 }
 537
 538
 539 void
 540 addhstbyaddr (struct database_dyn *db, int fd, request_header *req,
 541               void *key, uid_t uid)
 542 {
 543   addhstbyX (db, fd, req, key, uid, NULL, NULL);
 544 }
 545
 546
 547 void
 548 readdhstbyaddr (struct database_dyn *db, struct hashentry *he,
 549                 struct datahead *dh)
 550 {
 551   request_header req =
 552     {
 553       .type = GETHOSTBYADDR,
 554       .key_len = he->len
 555     };
 556
 557   addhstbyX (db, -1, &req, db->data + he->key, he->owner, he, dh);
 558 }
 559
 560
 561 void
 562 addhstbynamev6 (struct database_dyn *db, int fd, request_header *req,
 563                 void *key, uid_t uid)
 564 {
 565   addhstbyX (db, fd, req, key, uid, NULL, NULL);
 566 }
 567
 568
 569 void
 570 readdhstbynamev6 (struct database_dyn *db, struct hashentry *he,
 571                   struct datahead *dh)
 572 {
 573   request_header req =
 574     {
 575       .type = GETHOSTBYNAMEv6,
 576       .key_len = he->len
 577     };
 578
 579   addhstbyX (db, -1, &req, db->data + he->key, he->owner, he, dh);
 580 }
 581
 582
 583 void
 584 addhstbyaddrv6 (struct database_dyn *db, int fd, request_header *req,
 585                 void *key, uid_t uid)
 586 {
 587   addhstbyX (db, fd, req, key, uid, NULL, NULL);
 588 }
 589
 590
 591 void
 592 readdhstbyaddrv6 (struct database_dyn *db, struct hashentry *he,
 593                   struct datahead *dh)
 594 {
 595   request_header req =
 596     {
 597       .type = GETHOSTBYADDRv6,
 598       .key_len = he->len
 599     };
 600
 601   addhstbyX (db, -1, &req, db->data + he->key, he->owner, he, dh);
 602 }