(cache_add): Take additional parameter specifying
[kopensolaris-gnu/glibc.git] / nscd / cache.c
index efac4b3..2faaf34 100644 (file)
@@ -1,26 +1,26 @@
-/* Copyright (c) 1998, 1999, 2003, 2004 Free Software Foundation, Inc.
+/* Copyright (c) 1998, 1999, 2003-2007, 2008 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
 
-   The GNU C Library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Lesser General Public
-   License as published by the Free Software Foundation; either
-   version 2.1 of the License, or (at your option) any later version.
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published
+   by the Free Software Foundation; version 2 of the License, or
+   (at your option) any later version.
 
-   The GNU C Library is distributed in the hope that it will be useful,
+   This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Lesser General Public License for more details.
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
-   You should have received a copy of the GNU Lesser General Public
-   License along with the GNU C Library; if not, write to the Free
-   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-   02111-1307 USA.  */
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software Foundation,
+   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
 
 #include <assert.h>
 #include <atomic.h>
 #include <errno.h>
 #include <error.h>
+#include <inttypes.h>
 #include <limits.h>
 #include <stdlib.h>
 #include <string.h>
 #include "dbg_log.h"
 
 
+/* Wrapper functions with error checking for standard functions.  */
+extern void *xcalloc (size_t n, size_t s);
+
+
 /* Number of times a value is reloaded without being used.  UINT_MAX
    means unlimited.  */
 unsigned int reload_count = DEFAULT_RELOAD_LIMIT;
 
 
+static void (*const readdfcts[LASTREQ]) (struct database_dyn *,
+                                        struct hashentry *,
+                                        struct datahead *) =
+{
+  [GETPWBYNAME] = readdpwbyname,
+  [GETPWBYUID] = readdpwbyuid,
+  [GETGRBYNAME] = readdgrbyname,
+  [GETGRBYGID] = readdgrbygid,
+  [GETHOSTBYNAME] = readdhstbyname,
+  [GETHOSTBYNAMEv6] = readdhstbynamev6,
+  [GETHOSTBYADDR] = readdhstbyaddr,
+  [GETHOSTBYADDRv6] = readdhstbyaddrv6,
+  [GETAI] = readdhstai,
+  [INITGROUPS] = readdinitgroups,
+  [GETSERVBYNAME] = readdservbyname,
+  [GETSERVBYPORT] = readdservbyport
+};
+
+
 /* Search the cache for a matching entry and return it when found.  If
    this fails search the negative cache and return (void *) -1 if this
    search was successful.  Otherwise return NULL.
@@ -112,7 +135,7 @@ cache_search (request_type type, void *key, size_t len,
 int
 cache_add (int type, const void *key, size_t len, struct datahead *packet,
           bool first, struct database_dyn *table,
-          uid_t owner)
+          uid_t owner, bool prune_wakeup)
 {
   if (__builtin_expect (debug_level >= 2, 0))
     {
@@ -126,16 +149,29 @@ cache_add (int type, const void *key, size_t len, struct datahead *packet,
 
       dbg_log (_("add new entry \"%s\" of type %s for %s to cache%s"),
               str, serv2str[type], dbnames[table - dbs],
-              first ? " (first)" : "");
+              first ? _(" (first)") : "");
     }
 
   unsigned long int hash = __nis_hash (key, len) % table->head->module;
   struct hashentry *newp;
 
-  newp = mempool_alloc (table, sizeof (struct hashentry));
+  newp = mempool_alloc (table, sizeof (struct hashentry), IDX_record_data);
   /* If we cannot allocate memory, just do not do anything.  */
   if (newp == NULL)
-    return -1;
+    {
+      ++table->head->addfailed;
+
+      /* If necessary mark the entry as unusable so that lookups will
+        not use it.  */
+      if (first)
+       packet->usable = false;
+
+      /* Mark the in-flight memory as unused.  */
+      for (enum in_flight idx = 0; idx < IDX_record_data; ++idx)
+       mem_in_flight.block[idx].dbidx = -1;
+
+      return -1;
+    }
 
   newp->type = type;
   newp->first = first;
@@ -144,6 +180,7 @@ cache_add (int type, const void *key, size_t len, struct datahead *packet,
   assert (newp->key + newp->len <= table->head->first_free);
   newp->owner = owner;
   newp->packet = (char *) packet - table->data;
+  assert ((newp->packet & BLOCK_ALIGN_M1) == 0);
 
   /* Put the new entry in the first position.  */
   do
@@ -169,6 +206,38 @@ cache_add (int type, const void *key, size_t len, struct datahead *packet,
   if (nentries > table->head->maxnentries)
     table->head->maxnentries = nentries;
 
+  if (table->persistent)
+    // XXX async OK?
+    msync ((void *) table->head,
+          (char *) &table->head->array[hash] - (char *) table->head
+          + sizeof (ref_t), MS_ASYNC);
+
+  /* We do not have to worry about the pruning thread if we are
+     re-adding the data since this is done by the pruning thread.  We
+     also do not have to do anything in case this is not the first
+     time the data is entered since different data heads all have the
+     same timeout.  */
+  if (first && prune_wakeup)
+    {
+      /* Perhaps the prune thread for the table is not running in a long
+        time.  Wake it if necessary.  */
+      pthread_mutex_lock (&table->prune_lock);
+      time_t next_wakeup = table->wakeup_time;
+      bool do_wakeup = false;
+      if (next_wakeup > packet->timeout + CACHE_PRUNE_INTERVAL)
+       {
+         table->wakeup_time = packet->timeout;
+         do_wakeup = true;
+       }
+      pthread_mutex_unlock (&table->prune_lock);
+      if (do_wakeup)
+       pthread_cond_signal (&table->prune_cond);
+    }
+
+  /* Mark the in-flight memory as unused.  */
+  for (enum in_flight idx = 0; idx < IDX_last; ++idx)
+    mem_in_flight.block[idx].dbidx = -1;
+
   return 0;
 }
 
@@ -184,22 +253,32 @@ cache_add (int type, const void *key, size_t len, struct datahead *packet,
    actually remove them.  This is complicated by the way we have to
    free the data structures since some hash table entries share the same
    data.  */
-void
-prune_cache (struct database_dyn *table, time_t now)
+time_t
+prune_cache (struct database_dyn *table, time_t now, int fd)
 {
   size_t cnt = table->head->module;
 
   /* If this table is not actually used don't do anything.  */
   if (cnt == 0)
-    return;
+    {
+      if (fd != -1)
+       {
+         /* Reply to the INVALIDATE initiator.  */
+         int32_t resp = 0;
+         writeall (fd, &resp, sizeof (resp));
+       }
+
+      /* No need to do this again anytime soon.  */
+      return 24 * 60 * 60;
+    }
 
   /* If we check for the modification of the underlying file we invalidate
      the entries also in this case.  */
-  if (table->check_file)
+  if (table->check_file && now != LONG_MAX)
     {
-      struct stat st;
+      struct stat64 st;
 
-      if (stat (table->filename, &st) < 0)
+      if (stat64 (table->filename, &st) < 0)
        {
          char buf[128];
          /* We cannot stat() the file, disable file checking if the
@@ -226,12 +305,31 @@ prune_cache (struct database_dyn *table, time_t now)
      we don't need to get any lock.  It is at all timed assured that the
      linked lists are set up correctly and that no second thread prunes
      the cache.  */
-  bool mark[cnt];
+  bool *mark;
+  size_t memory_needed = cnt * sizeof (bool);
+  bool mark_use_alloca;
+  if (__builtin_expect (memory_needed <= MAX_STACK_USE, 1))
+    {
+      mark = alloca (cnt * sizeof (bool));
+      memset (mark, '\0', memory_needed);
+      mark_use_alloca = true;
+    }
+  else
+    {
+      mark = xcalloc (1, memory_needed);
+      mark_use_alloca = false;
+    }
   size_t first = cnt + 1;
   size_t last = 0;
   char *const data = table->data;
   bool any = false;
 
+  if (__builtin_expect (debug_level > 2, 0))
+    dbg_log (_("pruning %s cache; time %ld"),
+            dbnames[table - dbs], (long int) now);
+
+#define NO_TIMEOUT LONG_MAX
+  time_t next_timeout = NO_TIMEOUT;
   do
     {
       ref_t run = table->head->array[--cnt];
@@ -241,6 +339,25 @@ prune_cache (struct database_dyn *table, time_t now)
          struct hashentry *runp = (struct hashentry *) (data + run);
          struct datahead *dh = (struct datahead *) (data + runp->packet);
 
+         /* Some debug support.  */
+         if (__builtin_expect (debug_level > 2, 0))
+           {
+             char buf[INET6_ADDRSTRLEN];
+             const char *str;
+
+             if (runp->type == GETHOSTBYADDR || runp->type == GETHOSTBYADDRv6)
+               {
+                 inet_ntop (runp->type == GETHOSTBYADDR ? AF_INET : AF_INET6,
+                            data + runp->key, buf, sizeof (buf));
+                 str = buf;
+               }
+             else
+               str = data + runp->key;
+
+             dbg_log (_("considering %s entry \"%s\", timeout %" PRIu64),
+                      serv2str[runp->type], str, dh->timeout);
+           }
+
          /* Check whether the entry timed out.  */
          if (dh->timeout < now)
            {
@@ -279,51 +396,10 @@ prune_cache (struct database_dyn *table, time_t now)
                      /* Reload the value.  We do this only for the
                         initially used key, not the additionally
                         added derived value.  */
-                     switch (runp->type)
-                       {
-                       case GETPWBYNAME:
-                         readdpwbyname (table, runp, dh);
-                         break;
-
-                       case GETPWBYUID:
-                         readdpwbyuid (table, runp, dh);
-                         break;
-
-                       case GETGRBYNAME:
-                         readdgrbyname (table, runp, dh);
-                         break;
-
-                       case GETGRBYGID:
-                         readdgrbygid (table, runp, dh);
-                         break;
+                     assert (runp->type < LASTREQ
+                             && readdfcts[runp->type] != NULL);
 
-                       case GETHOSTBYNAME:
-                         readdhstbyname (table, runp, dh);
-                         break;
-
-                       case GETHOSTBYNAMEv6:
-                         readdhstbynamev6 (table, runp, dh);
-                         break;
-
-                       case GETHOSTBYADDR:
-                         readdhstbyaddr (table, runp, dh);
-                         break;
-
-                       case GETHOSTBYADDRv6:
-                         readdhstbyaddrv6 (table, runp, dh);
-                         break;
-
-                       case GETAI:
-                         readdhstai (table, runp, dh);
-                         break;
-
-                       case INITGROUPS:
-                         readdinitgroups (table, runp, dh);
-                         break;
-
-                       default:
-                         assert (! "should never happen");
-                       }
+                     readdfcts[runp->type] (table, runp, dh);
 
                      /* If the entry has been replaced, we might need
                         cleanup.  */
@@ -332,13 +408,24 @@ prune_cache (struct database_dyn *table, time_t now)
                }
            }
          else
-           assert (dh->usable);
+           {
+             assert (dh->usable);
+             next_timeout = MIN (next_timeout, dh->timeout);
+           }
 
          run = runp->next;
        }
     }
   while (cnt > 0);
 
+  if (__builtin_expect (fd != -1, 0))
+    {
+      /* Reply to the INVALIDATE initiator that the cache has been
+        invalidated.  */
+      int32_t resp = 0;
+      writeall (fd, &resp, sizeof (resp));
+    }
+
   if (first <= last)
     {
       struct hashentry *head = NULL;
@@ -358,7 +445,8 @@ prune_cache (struct database_dyn *table, time_t now)
              ref_t *old = &table->head->array[first];
              ref_t run = table->head->array[first];
 
-             while (run != ENDREF)
+             assert (run != ENDREF);
+             do
                {
                  struct hashentry *runp = (struct hashentry *) (data + run);
                  struct datahead *dh
@@ -384,6 +472,7 @@ prune_cache (struct database_dyn *table, time_t now)
                      run = runp->next;
                    }
                }
+             while (run != ENDREF);
            }
 
          ++first;
@@ -395,7 +484,7 @@ prune_cache (struct database_dyn *table, time_t now)
       /* Make sure the data is saved to disk.  */
       if (table->persistent)
        msync (table->head,
-              table->data + table->head->first_free - (char *) table->head,
+              data + table->head->first_free - (char *) table->head,
               MS_ASYNC);
 
       /* One extra pass if we do debugging.  */
@@ -411,11 +500,11 @@ prune_cache (struct database_dyn *table, time_t now)
              if (runp->type == GETHOSTBYADDR || runp->type == GETHOSTBYADDRv6)
                {
                  inet_ntop (runp->type == GETHOSTBYADDR ? AF_INET : AF_INET6,
-                            table->data + runp->key, buf, sizeof (buf));
+                            data + runp->key, buf, sizeof (buf));
                  str = buf;
                }
              else
-               str = table->data + runp->key;
+               str = data + runp->key;
 
              dbg_log ("remove %s entry \"%s\"", serv2str[runp->type], str);
 
@@ -424,7 +513,14 @@ prune_cache (struct database_dyn *table, time_t now)
        }
     }
 
+  if (__builtin_expect (! mark_use_alloca, 0))
+    free (mark);
+
   /* Run garbage collection if any entry has been removed or replaced.  */
   if (any)
     gc (table);
+
+  /* If there is no entry in the database and we therefore have no new
+     timeout value, tell the caller to wake up in 24 hours.  */
+  return next_timeout == NO_TIMEOUT ? 24 * 60 * 60 : next_timeout - now;
 }