nscd/aicache.c

   1 /* Cache handling for host lookup.
   2    Copyright (C) 2004-2008, 2009, 2010, 2011 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Ulrich Drepper <drepper@redhat.com>, 2004.
   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 <assert.h>
  21 #include <errno.h>
  22 #include <libintl.h>
  23 #include <netdb.h>
  24 #include <nss.h>
  25 #include <string.h>
  26 #include <time.h>
  27 #include <unistd.h>
  28 #include <sys/mman.h>
  29
  30 #include "dbg_log.h"
  31 #include "nscd.h"
  32 #ifdef HAVE_SENDFILE
  33 # include <kernel-features.h>
  34 #endif
  35
  36
  37 typedef enum nss_status (*nss_gethostbyname4_r)
  38   (const char *name, struct gaih_addrtuple **pat,
  39    char *buffer, size_t buflen, int *errnop,
  40    int *h_errnop, int32_t *ttlp);
  41 typedef enum nss_status (*nss_gethostbyname3_r)
  42   (const char *name, int af, struct hostent *host,
  43    char *buffer, size_t buflen, int *errnop,
  44    int *h_errnop, int32_t *, char **);
  45 typedef enum nss_status (*nss_getcanonname_r)
  46   (const char *name, char *buffer, size_t buflen, char **result,
  47    int *errnop, int *h_errnop);
  48
  49
  50 static const ai_response_header notfound =
  51 {
  52   .version = NSCD_VERSION,
  53   .found = 0,
  54   .naddrs = 0,
  55   .addrslen = 0,
  56   .canonlen = 0,
  57   .error = 0
  58 };
  59
  60
  61 static time_t
  62 addhstaiX (struct database_dyn *db, int fd, request_header *req,
  63            void *key, uid_t uid, struct hashentry *const he,
  64            struct datahead *dh)
  65 {
  66   /* Search for the entry matching the key.  Please note that we don't
  67      look again in the table whether the dataset is now available.  We
  68      simply insert it.  It does not matter if it is in there twice.  The
  69      pruning function only will look at the timestamp.  */
  70
  71   /* We allocate all data in one memory block: the iov vector,
  72      the response header and the dataset itself.  */
  73   struct dataset
  74   {
  75     struct datahead head;
  76     ai_response_header resp;
  77     char strdata[0];
  78   } *dataset = NULL;
  79
  80   if (__builtin_expect (debug_level > 0, 0))
  81     {
  82       if (he == NULL)
  83         dbg_log (_("Haven't found \"%s\" in hosts cache!"), (char *) key);
  84       else
  85         dbg_log (_("Reloading \"%s\" in hosts cache!"), (char *) key);
  86     }
  87
  88   static service_user *hosts_database;
  89   service_user *nip = NULL;
  90   int no_more;
  91   int rc6 = 0;
  92   int rc4 = 0;
  93   int herrno = 0;
  94
  95   if (hosts_database != NULL)
  96     {
  97       nip = hosts_database;
  98       no_more = 0;
  99     }
 100   else
 101     no_more = __nss_database_lookup ("hosts", NULL,
 102                                      "dns [!UNAVAIL=return] files", &nip);
 103
 104   if (__res_maybe_init (&_res, 0) == -1)
 105             no_more = 1;
 106
 107   /* If we are looking for both IPv4 and IPv6 address we don't want
 108      the lookup functions to automatically promote IPv4 addresses to
 109      IPv6 addresses.  Currently this is decided by setting the
 110      RES_USE_INET6 bit in _res.options.  */
 111   int old_res_options = _res.options;
 112   _res.options &= ~RES_USE_INET6;
 113
 114   size_t tmpbuf6len = 1024;
 115   char *tmpbuf6 = alloca (tmpbuf6len);
 116   size_t tmpbuf4len = 0;
 117   char *tmpbuf4 = NULL;
 118   int32_t ttl = INT32_MAX;
 119   ssize_t total = 0;
 120   char *key_copy = NULL;
 121   bool alloca_used = false;
 122   time_t timeout = MAX_TIMEOUT_VALUE;
 123
 124   while (!no_more)
 125     {
 126       void *cp;
 127       int status[2] = { NSS_STATUS_UNAVAIL, NSS_STATUS_UNAVAIL };
 128       int naddrs = 0;
 129       size_t addrslen = 0;
 130       char *canon = NULL;
 131       size_t canonlen;
 132
 133       nss_gethostbyname4_r fct4 = __nss_lookup_function (nip,
 134                                                          "gethostbyname4_r");
 135       if (fct4 != NULL)
 136         {
 137           struct gaih_addrtuple atmem;
 138           struct gaih_addrtuple *at;
 139           while (1)
 140             {
 141               at = &atmem;
 142               rc6 = 0;
 143               herrno = 0;
 144               status[1] = DL_CALL_FCT (fct4, (key, &at, tmpbuf6, tmpbuf6len,
 145                                               &rc6, &herrno, &ttl));
 146               if (rc6 != ERANGE || (herrno != NETDB_INTERNAL
 147                                     && herrno != TRY_AGAIN))
 148                 break;
 149               tmpbuf6 = extend_alloca (tmpbuf6, tmpbuf6len, 2 * tmpbuf6len);
 150             }
 151
 152           if (rc6 != 0 && herrno == NETDB_INTERNAL)
 153             goto out;
 154
 155           if (status[1] != NSS_STATUS_SUCCESS)
 156             goto next_nip;
 157
 158           /* We found the data.  Count the addresses and the size.  */
 159           for (const struct gaih_addrtuple *at2 = at = &atmem; at2 != NULL;
 160                at2 = at2->next)
 161             {
 162               ++naddrs;
 163               /* We do not handle anything other than IPv4 and IPv6
 164                  addresses.  The getaddrinfo implementation does not
 165                  either so it is not worth trying to do more.  */
 166               if (at2->family == AF_INET)
 167                 addrslen += INADDRSZ;
 168               else if (at2->family == AF_INET6)
 169                 addrslen += IN6ADDRSZ;
 170             }
 171           canon = at->name;
 172           canonlen = strlen (canon) + 1;
 173
 174           total = sizeof (*dataset) + naddrs + addrslen + canonlen;
 175
 176           /* Now we can allocate the data structure.  If the TTL of the
 177              entry is reported as zero do not cache the entry at all.  */
 178           if (ttl != 0 && he == NULL)
 179             dataset = (struct dataset *) mempool_alloc (db, total
 180                                                         + req->key_len, 1);
 181
 182           if (dataset == NULL)
 183             {
 184               /* We cannot permanently add the result in the moment.  But
 185                  we can provide the result as is.  Store the data in some
 186                  temporary memory.  */
 187               dataset = (struct dataset *) alloca (total + req->key_len);
 188
 189               /* We cannot add this record to the permanent database.  */
 190               alloca_used = true;
 191             }
 192
 193           /* Fill in the address and address families.  */
 194           char *addrs = dataset->strdata;
 195           uint8_t *family = (uint8_t *) (addrs + addrslen);
 196
 197           for (const struct gaih_addrtuple *at2 = at; at2 != NULL;
 198                at2 = at2->next)
 199             {
 200               *family++ = at2->family;
 201               if (at2->family == AF_INET)
 202                 addrs = mempcpy (addrs, at2->addr, INADDRSZ);
 203               else if (at2->family == AF_INET6)
 204                 addrs = mempcpy (addrs, at2->addr, IN6ADDRSZ);
 205             }
 206
 207           cp = family;
 208         }
 209       else
 210         {
 211           /* Prefer the function which also returns the TTL and
 212              canonical name.  */
 213           nss_gethostbyname3_r fct = __nss_lookup_function (nip,
 214                                                             "gethostbyname3_r");
 215           if (fct == NULL)
 216             fct = __nss_lookup_function (nip, "gethostbyname2_r");
 217
 218           if (fct == NULL)
 219             goto next_nip;
 220
 221           struct hostent th[2];
 222
 223           /* Collect IPv6 information first.  */
 224           while (1)
 225             {
 226               rc6 = 0;
 227               status[0] = DL_CALL_FCT (fct, (key, AF_INET6, &th[0], tmpbuf6,
 228                                              tmpbuf6len, &rc6, &herrno, &ttl,
 229                                              &canon));
 230               if (rc6 != ERANGE || herrno != NETDB_INTERNAL)
 231                 break;
 232               tmpbuf6 = extend_alloca (tmpbuf6, tmpbuf6len, 2 * tmpbuf6len);
 233             }
 234
 235           if (rc6 != 0 && herrno == NETDB_INTERNAL)
 236             goto out;
 237
 238           /* If the IPv6 lookup has been successful do not use the
 239              buffer used in that lookup, use a new one.  */
 240           if (status[0] == NSS_STATUS_SUCCESS && rc6 == 0)
 241             {
 242               tmpbuf4len = 512;
 243               tmpbuf4 = alloca (tmpbuf4len);
 244             }
 245           else
 246             {
 247               tmpbuf4len = tmpbuf6len;
 248               tmpbuf4 = tmpbuf6;
 249             }
 250
 251           /* Next collect IPv4 information.  */
 252           while (1)
 253             {
 254               rc4 = 0;
 255               status[1] = DL_CALL_FCT (fct, (key, AF_INET, &th[1], tmpbuf4,
 256                                              tmpbuf4len, &rc4, &herrno,
 257                                              ttl == INT32_MAX ? &ttl : NULL,
 258                                              canon == NULL ? &canon : NULL));
 259               if (rc4 != ERANGE || herrno != NETDB_INTERNAL)
 260                 break;
 261               tmpbuf4 = extend_alloca (tmpbuf4, tmpbuf4len, 2 * tmpbuf4len);
 262             }
 263
 264           if (rc4 != 0 && herrno == NETDB_INTERNAL)
 265             goto out;
 266
 267           if (status[0] != NSS_STATUS_SUCCESS
 268               && status[1] != NSS_STATUS_SUCCESS)
 269             goto next_nip;
 270
 271           /* We found the data.  Count the addresses and the size.  */
 272           for (int j = 0; j < 2; ++j)
 273             if (status[j] == NSS_STATUS_SUCCESS)
 274               for (int i = 0; th[j].h_addr_list[i] != NULL; ++i)
 275                 {
 276                   ++naddrs;
 277                   addrslen += th[j].h_length;
 278                 }
 279
 280           if (canon == NULL)
 281             {
 282               /* Determine the canonical name.  */
 283               nss_getcanonname_r cfct;
 284               cfct = __nss_lookup_function (nip, "getcanonname_r");
 285               if (cfct != NULL)
 286                 {
 287                   const size_t max_fqdn_len = 256;
 288                   char *buf = alloca (max_fqdn_len);
 289                   char *s;
 290                   int rc;
 291
 292                   if (DL_CALL_FCT (cfct, (key, buf, max_fqdn_len, &s,
 293                                           &rc, &herrno))
 294                       == NSS_STATUS_SUCCESS)
 295                     canon = s;
 296                   else
 297                     /* Set to name now to avoid using gethostbyaddr.  */
 298                     canon = key;
 299                 }
 300               else
 301                 {
 302                   struct hostent *hstent = NULL;
 303                   int herrno;
 304                   struct hostent hstent_mem;
 305                   void *addr;
 306                   size_t addrlen;
 307                   int addrfamily;
 308
 309                   if (status[1] == NSS_STATUS_SUCCESS)
 310                     {
 311                       addr = th[1].h_addr_list[0];
 312                       addrlen = sizeof (struct in_addr);
 313                       addrfamily = AF_INET;
 314                     }
 315                   else
 316                     {
 317                       addr = th[0].h_addr_list[0];
 318                       addrlen = sizeof (struct in6_addr);
 319                       addrfamily = AF_INET6;
 320                     }
 321
 322                   size_t tmpbuflen = 512;
 323                   char *tmpbuf = alloca (tmpbuflen);
 324                   int rc;
 325                   while (1)
 326                     {
 327                       rc = __gethostbyaddr2_r (addr, addrlen, addrfamily,
 328                                                &hstent_mem, tmpbuf, tmpbuflen,
 329                                                &hstent, &herrno, NULL);
 330                       if (rc != ERANGE || herrno != NETDB_INTERNAL)
 331                         break;
 332                       tmpbuf = extend_alloca (tmpbuf, tmpbuflen,
 333                                               tmpbuflen * 2);
 334                     }
 335
 336                   if (rc == 0)
 337                     {
 338                       if (hstent != NULL)
 339                         canon = hstent->h_name;
 340                       else
 341                         canon = key;
 342                     }
 343                 }
 344             }
 345
 346           canonlen = canon == NULL ? 0 : (strlen (canon) + 1);
 347
 348           total = sizeof (*dataset) + naddrs + addrslen + canonlen;
 349
 350
 351           /* Now we can allocate the data structure.  If the TTL of the
 352              entry is reported as zero do not cache the entry at all.  */
 353           if (ttl != 0 && he == NULL)
 354             dataset = (struct dataset *) mempool_alloc (db, total
 355                                                         + req->key_len, 1);
 356
 357           if (dataset == NULL)
 358             {
 359               /* We cannot permanently add the result in the moment.  But
 360                  we can provide the result as is.  Store the data in some
 361                  temporary memory.  */
 362               dataset = (struct dataset *) alloca (total + req->key_len);
 363
 364               /* We cannot add this record to the permanent database.  */
 365               alloca_used = true;
 366             }
 367
 368           /* Fill in the address and address families.  */
 369           char *addrs = dataset->strdata;
 370           uint8_t *family = (uint8_t *) (addrs + addrslen);
 371
 372           for (int j = 0; j < 2; ++j)
 373             if (status[j] == NSS_STATUS_SUCCESS)
 374               for (int i = 0; th[j].h_addr_list[i] != NULL; ++i)
 375                 {
 376                   addrs = mempcpy (addrs, th[j].h_addr_list[i],
 377                                    th[j].h_length);
 378                   *family++ = th[j].h_addrtype;
 379                 }
 380
 381           cp = family;
 382         }
 383
 384       /* Fill in the rest of the dataset.  */
 385       dataset->head.allocsize = total + req->key_len;
 386       dataset->head.recsize = total - offsetof (struct dataset, resp);
 387       dataset->head.notfound = false;
 388       dataset->head.nreloads = he == NULL ? 0 : (dh->nreloads + 1);
 389       dataset->head.usable = true;
 390
 391       /* Compute the timeout time.  */
 392       dataset->head.ttl = ttl == INT32_MAX ? db->postimeout : ttl;
 393       timeout = dataset->head.timeout = time (NULL) + dataset->head.ttl;
 394
 395       dataset->resp.version = NSCD_VERSION;
 396       dataset->resp.found = 1;
 397       dataset->resp.naddrs = naddrs;
 398       dataset->resp.addrslen = addrslen;
 399       dataset->resp.canonlen = canonlen;
 400       dataset->resp.error = NETDB_SUCCESS;
 401
 402       if (canon != NULL)
 403         cp = mempcpy (cp, canon, canonlen);
 404
 405       key_copy = memcpy (cp, key, req->key_len);
 406
 407       assert (cp == (char *) dataset + total);
 408
 409       /* Now we can determine whether on refill we have to create a
 410          new record or not.  */
 411       if (he != NULL)
 412         {
 413           assert (fd == -1);
 414
 415           if (total + req->key_len == dh->allocsize
 416               && total - offsetof (struct dataset, resp) == dh->recsize
 417               && memcmp (&dataset->resp, dh->data,
 418                          dh->allocsize - offsetof (struct dataset,
 419                                                    resp)) == 0)
 420             {
 421               /* The data has not changed.  We will just bump the
 422                  timeout value.  Note that the new record has been
 423                  allocated on the stack and need not be freed.  */
 424               dh->timeout = dataset->head.timeout;
 425               dh->ttl = dataset->head.ttl;
 426               ++dh->nreloads;
 427             }
 428           else
 429             {
 430               /* We have to create a new record.  Just allocate
 431                  appropriate memory and copy it.  */
 432               struct dataset *newp
 433                 = (struct dataset *) mempool_alloc (db, total + req->key_len,
 434                                                     1);
 435               if (__builtin_expect (newp != NULL, 1))
 436                 {
 437                   /* Adjust pointer into the memory block.  */
 438                   key_copy = (char *) newp + (key_copy - (char *) dataset);
 439
 440                   dataset = memcpy (newp, dataset, total + req->key_len);
 441                   alloca_used = false;
 442                 }
 443
 444               /* Mark the old record as obsolete.  */
 445               dh->usable = false;
 446             }
 447         }
 448       else
 449         {
 450           /* We write the dataset before inserting it to the database
 451              since while inserting this thread might block and so
 452              would unnecessarily let the receiver wait.  */
 453           assert (fd != -1);
 454
 455 #ifdef HAVE_SENDFILE
 456           if (__builtin_expect (db->mmap_used, 1) && !alloca_used)
 457             {
 458               assert (db->wr_fd != -1);
 459               assert ((char *) &dataset->resp > (char *) db->data);
 460               assert ((char *) dataset - (char *) db->head + total
 461                       <= (sizeof (struct database_pers_head)
 462                           + db->head->module * sizeof (ref_t)
 463                           + db->head->data_size));
 464 # ifndef __ASSUME_SENDFILE
 465               ssize_t written;
 466               written =
 467 # endif
 468                 sendfileall (fd, db->wr_fd, (char *) &dataset->resp
 469                              - (char *) db->head, dataset->head.recsize);
 470 # ifndef __ASSUME_SENDFILE
 471               if (written == -1 && errno == ENOSYS)
 472                 goto use_write;
 473 # endif
 474             }
 475           else
 476 # ifndef __ASSUME_SENDFILE
 477           use_write:
 478 # endif
 479 #endif
 480             writeall (fd, &dataset->resp, dataset->head.recsize);
 481         }
 482
 483       goto out;
 484
 485 next_nip:
 486       if (nss_next_action (nip, status[1]) == NSS_ACTION_RETURN)
 487         break;
 488
 489       if (nip->next == NULL)
 490         no_more = -1;
 491       else
 492         nip = nip->next;
 493     }
 494
 495   /* No result found.  Create a negative result record.  */
 496   if (he != NULL && rc4 == EAGAIN)
 497     {
 498       /* If we have an old record available but cannot find one now
 499          because the service is not available we keep the old record
 500          and make sure it does not get removed.  */
 501       if (reload_count != UINT_MAX && dh->nreloads == reload_count)
 502         /* Do not reset the value if we never not reload the record.  */
 503         dh->nreloads = reload_count - 1;
 504
 505       /* Reload with the same time-to-live value.  */
 506       timeout = dh->timeout = time (NULL) + dh->ttl;
 507     }
 508   else
 509     {
 510       /* We have no data.  This means we send the standard reply for
 511          this case.  */
 512       total = sizeof (notfound);
 513
 514       if (fd != -1)
 515         TEMP_FAILURE_RETRY (send (fd, &notfound, total, MSG_NOSIGNAL));
 516
 517       /* If we cannot permanently store the result, so be it.  */
 518       if (__builtin_expect (db->negtimeout == 0, 0))
 519         {
 520           /* Mark the old entry as obsolete.  */
 521           if (dh != NULL)
 522             dh->usable = false;
 523           dataset = NULL;
 524         }
 525       else if ((dataset = mempool_alloc (db, (sizeof (struct dataset)
 526                                               + req->key_len), 1)) != NULL)
 527         {
 528           dataset->head.allocsize = sizeof (struct dataset) + req->key_len;
 529           dataset->head.recsize = total;
 530           dataset->head.notfound = true;
 531           dataset->head.nreloads = 0;
 532           dataset->head.usable = true;
 533
 534           /* Compute the timeout time.  */
 535           timeout = dataset->head.timeout = time (NULL) + db->negtimeout;
 536           dataset->head.ttl = db->negtimeout;
 537
 538           /* This is the reply.  */
 539           memcpy (&dataset->resp, &notfound, total);
 540
 541           /* Copy the key data.  */
 542           key_copy = memcpy (dataset->strdata, key, req->key_len);
 543         }
 544    }
 545
 546  out:
 547   _res.options |= old_res_options & RES_USE_INET6;
 548
 549   if (dataset != NULL && !alloca_used)
 550     {
 551       /* If necessary, we also propagate the data to disk.  */
 552       if (db->persistent)
 553         {
 554           // XXX async OK?
 555           uintptr_t pval = (uintptr_t) dataset & ~pagesize_m1;
 556           msync ((void *) pval,
 557                  ((uintptr_t) dataset & pagesize_m1) + total + req->key_len,
 558                  MS_ASYNC);
 559         }
 560
 561       (void) cache_add (req->type, key_copy, req->key_len, &dataset->head,
 562                         true, db, uid, he == NULL);
 563
 564       pthread_rwlock_unlock (&db->lock);
 565
 566       /* Mark the old entry as obsolete.  */
 567       if (dh != NULL)
 568         dh->usable = false;
 569     }
 570
 571   return timeout;
 572 }
 573
 574
 575 void
 576 addhstai (struct database_dyn *db, int fd, request_header *req, void *key,
 577           uid_t uid)
 578 {
 579   addhstaiX (db, fd, req, key, uid, NULL, NULL);
 580 }
 581
 582
 583 time_t
 584 readdhstai (struct database_dyn *db, struct hashentry *he, struct datahead *dh)
 585 {
 586   request_header req =
 587     {
 588       .type = GETAI,
 589       .key_len = he->len
 590     };
 591
 592   return addhstaiX (db, -1, &req, db->data + he->key, he->owner, he, dh);
 593 }