aboutsummaryrefslogtreecommitdiff
path: root/nscd/cache.c
blob: 6492092bddace000a8260266d93cb6586191c578 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/* Copyright (c) 1998, 1999, 2003 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.

   The GNU C Library 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.

   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.  */

#include <atomic.h>
#include <errno.h>
#include <error.h>
#include <limits.h>
#include <stdlib.h>
#include <string.h>
#include <libintl.h>
#include <arpa/inet.h>
#include <rpcsvc/nis.h>
#include <sys/param.h>
#include <sys/stat.h>
#include <sys/uio.h>

#include "nscd.h"
#include "dbg_log.h"

/* 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.

   This function must be called with the read-lock held.  */
struct hashentry *
cache_search (request_type type, void *key, size_t len, struct database *table,
	      uid_t owner)
{
  unsigned long int hash = __nis_hash (key, len) % table->module;
  struct hashentry *work;

  work = table->array[hash];

  while (work != NULL)
    {
      if (type == work->type && len == work->len
	  && memcmp (key, work->key, len) == 0 && work->owner == owner)
	{
	  /* We found the entry.  Increment the appropriate counter.  */
	  if (work->data == (void *) -1)
	    ++table->neghit;
	  else
	    ++table->poshit;

	  return work;
	}

      work = work->next;
    }

  return NULL;
}

/* Add a new entry to the cache.  The return value is zero if the function
   call was successful.

   This function must be called with the read-lock held.

   We modify the table but we nevertheless only acquire a read-lock.
   This is ok since we use operations which would be safe even without
   locking, given that the `prune_cache' function never runs.  Using
   the readlock reduces the chance of conflicts.  */
void
cache_add (int type, void *key, size_t len, const void *packet, size_t total,
	   void *data, int last, time_t t, struct database *table, uid_t owner)
{
  unsigned long int hash = __nis_hash (key, len) % table->module;
  struct hashentry *newp;

  newp = malloc (sizeof (struct hashentry));
  if (newp == NULL)
    error (EXIT_FAILURE, errno, _("while allocating hash table entry"));

  newp->type = type;
  newp->len = len;
  newp->key = key;
  newp->owner = owner;
  newp->data = data;
  newp->timeout = t;
  newp->packet = packet;
  newp->total = total;

  newp->last = last;

  /* Put the new entry in the first position.  */
  do
    newp->next = table->array[hash];
  while (atomic_compare_and_exchange_bool_acq (&table->array[hash], newp,
					       newp->next));

  /* Update the statistics.  */
  if (data == (void *) -1)
    ++table->negmiss;
  else if (last)
    ++table->posmiss;
}

/* Walk through the table and remove all entries which lifetime ended.

   We have a problem here.  To actually remove the entries we must get
   the write-lock.  But since we want to keep the time we have the
   lock as short as possible we cannot simply acquire the lock when we
   start looking for timedout entries.

   Therefore we do it in two stages: first we look for entries which
   must be invalidated and remember them.  Then we get the lock and
   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 *table, time_t now)
{
  size_t cnt = table->module;
  int mark[cnt];
  int anything = 0;
  size_t first = cnt + 1;
  size_t last = 0;

  /* If this table is not actually used don't do anything.  */
  if (cnt == 0)
    return;

  /* If we check for the modification of the underlying file we invalidate
     the entries also in this case.  */
  if (table->check_file)
    {
      struct stat st;

      if (stat (table->filename, &st) < 0)
	{
	  char buf[128];
	  /* We cannot stat() the file, disable file checking if the
             file does not exist.  */
	  dbg_log (_("cannot stat() file `%s': %s"),
		   table->filename, strerror_r (errno, buf, sizeof (buf)));
	  if (errno == ENOENT)
	    table->check_file = 0;
	}
      else
	{
	  if (st.st_mtime != table->file_mtime)
	    {
	      /* The file changed.  Invalidate all entries.  */
	      now = LONG_MAX;
	      table->file_mtime = st.st_mtime;
	    }
	}
    }

  /* We run through the table and find values which are not valid anymore.

   Note that for the initial step, finding the entries to be removed,
   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.  */
  do
    {
      struct hashentry *runp = table->array[--cnt];

      mark[cnt] = 0;

      while (runp != NULL)
	{
	  if (runp->timeout < now)
	    {
	      ++mark[cnt];
	      anything = 1;
	      first = MIN (first, cnt);
	      last = MAX (last, cnt);
	    }
	  runp = runp->next;
	}
    }
  while (cnt > 0);

  if (anything)
    {
      struct hashentry *head = NULL;

      /* Now we have to get the write lock since we are about to modify
	 the table.  */
      pthread_rwlock_wrlock (&table->lock);

      while (first <= last)
	{
	  if (mark[first] > 0)
	    {
	      struct hashentry *runp;

	      while (table->array[first]->timeout < now)
		{
		  table->array[first]->dellist = head;
		  head = table->array[first];
		  table->array[first] = head->next;
		  if (--mark[first] == 0)
		    break;
		}

	      runp = table->array[first];
	      while (mark[first] > 0)
		{
		  if (runp->next->timeout < now)
		    {
		      runp->next->dellist = head;
		      head = runp->next;
		      runp->next = head->next;
		      --mark[first];
		    }
		  else
		    runp = runp->next;
		}
	    }
	  ++first;
	}

      /* It's all done.  */
      pthread_rwlock_unlock (&table->lock);

      /* And another run to free the data.  */
      do
	{
	  struct hashentry *old = head;

	  if (debug_level > 0)
	    {
	      char buf[INET6_ADDRSTRLEN];
	      const char *str;

	      if ((old->type == GETHOSTBYADDR || old->type == GETHOSTBYADDRv6)
		  && (old->last || old->data == (void *) -1))
		{
		  inet_ntop (old->type == GETHOSTBYADDR ? AF_INET : AF_INET6,
			     old->key, buf, sizeof (buf));
		  str = buf;
		}
	      else
		str = old->last ? old->key : (old->data == (void *) -1
					      ? old->key : "???");

	      dbg_log ("remove %s entry \"%s\"", serv2str[old->type], str);
	    }

	  /* Free the data structures.  */
	  if (old->data == (void *) -1)
	    free (old->key);
	  else if (old->last)
	    free (old->data);

	  head = head->dellist;

	  free (old);
	}
      while (head != NULL);
    }
}