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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
|
/*
File: cache.c -- add response caching
Copyright (C) 1999 by Wolfgang Zekoll <wzk@quietsche-entchen.de>
This source 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; either version 2, or (at your option)
any later version.
This source 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 General Public License for more details.
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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <time.h>
#include "common.h"
#include "dns.h"
#include "cache.h"
#include "lib.h"
#include "dns.h"
/*
* Cache time calculations are done in seconds. CACHE_TIMEUNIT
* defines a minute. You might want to set it to 1 for
* debugging.
*/
#define CACHE_TIMEUNIT 60
/*
* DNS queries that have been answered positively are stored for
* CACHE_TIME, errors for only CACHE_NEGTIME minutes. Reusing
* a positive answer resets the entry's expire time. After
* CACHE_MAXTIME the item is removed anyway.
*/
#define CACHE_NEGTIME ( 5 * CACHE_TIMEUNIT)
#define CACHE_TIME ( 60 * CACHE_TIMEUNIT)
#define CACHE_MAXTIME (6 * 60 * CACHE_TIMEUNIT)
/*
* The expire function can be called as often as wanted.
* It will however wait CACHE_MINCYCLE between two
* expire runs.
*/
#define CACHE_MINCYCLE (5 * CACHE_TIMEUNIT)
/*
* If after an expire the cache holds more than CACHE_HIGHWATER
* items the oldest items are removed until there are only
* CACHE_LOWWATER left.
*/
#define CACHE_HIGHWATER 1000
#define CACHE_LOWWATER 800
typedef struct _cache {
unsigned int code;
char *name; /* Objectname */
int type, class; /* Query type and class. */
int positive; /* Positive or error response? */
unsigned long created;
unsigned long lastused;
unsigned long expires;
dnsheader_t *p; /* The DNS packet with decoded header */
struct _cache *next, *prev;
} cache_t;
char cache_param[200] = "";
int cache_onoff = 1;
long cache_highwater = CACHE_HIGHWATER;
long cache_lowwater = CACHE_LOWWATER;
static cache_t *cachelist = NULL;
static cache_t *lastcache = NULL;
static int cache_hits = 0;
static int cache_misses = 0;
static int free_cx(cache_t *cx)
{
free_packet(cx->p);
free(cx->name);
free(cx);
return (0);
}
static cache_t *create_cx(dnsheader_t *x, rr_t *query)
{
cache_t *cx;
cx = malloc(sizeof(cache_t));
memset(cx, 0, sizeof(cache_t));
cx->name = strdup(query->name);
cx->code = get_stringcode(cx->name);
cx->positive = x->ancount;
cx->type = query->type;
cx->class = query->class;
cx->p = x;
cx->lastused = time(NULL);
return (cx);
}
static cache_t *append_cx(cache_t *cx)
{
if (lastcache == NULL) {
cachelist = cx;
lastcache = cx;
}
else {
lastcache->next = cx;
cx->prev = lastcache;
lastcache = cx;
}
cx->created = time(NULL);
log_debug("cache: added %s, type= %d, class: %d, ans= %d\n",
cx->name, cx->type, cx->class, cx->p->ancount);
return (cx);
}
static cache_t *remove_cx(cache_t *cx)
{
if (cx->next != NULL) {
cx->next->prev = cx->prev;
}
else {
lastcache = cx->prev;
}
if (cx->prev != NULL) {
cx->prev->next = cx->next;
}
else {
cachelist = cx->next;
}
return (cx);
}
/*
* cache_dnspacket()
*
* In: packet - the response packet to cache.
* len - length of the response packet.
*
* Returns: 0, all the time.
*
* Take the response packet and look if it meets some basic
* conditions for caching. If so put the entire response into
* our cache.
*/
int cache_dnspacket(void *packet, int len)
{
dnsheader_t *x;
rr_t query;
cache_t *cx = NULL;
if ((cache_onoff == 0) ||
(parse_query(&query, packet, len) == NULL) ||
(query.flags.b.question == 0) ||
(*query.name == 0)) {
return (0);
}
x = parse_packet(packet, len);
/* get_dnsquery(x, &query); */
/*
* Ok, the packet is interesting for us. Let's put it into our
* cache list.
*/
sem_wait(&dnrd_sem);
cx = create_cx(x, &query);
append_cx(cx);
/*
* Set the expire time of the cached object.
*/
cx->lastused = time(NULL);
cx->expires = cx->lastused +
((cx->p->ancount > 0) ? CACHE_TIME : CACHE_NEGTIME);
sem_post(&dnrd_sem);
return (0);
}
/*
* cache_lookup()
*
* In/Out: packet - the query packet on input, response on output.
* len - length of the query packet.
*
* Returns: length of the response packet "cached",
* 0 if no cached response is available.
*
* Look into the query packet too see if it is a lookup request that
* might already have been cached. If so, copy the data to the
* cached pointer returning the length of the cached packet
* as return value.
*
* The function assumes that the area cached points to is
* large enough.
*/
int cache_lookup(void *packet, int len)
{
unsigned int code;
dnsheader_t *x;
rr_t query;
cache_t *cx = NULL;
if ((cache_onoff == 0) ||
(parse_query(&query, packet, len) == NULL) ||
(query.flags.b.question == 1) ||
(*query.name == 0) ||
(query.class != DNS_CLASS_INET)) {
return (0);
}
/*
* The query could be in the cache. Let's take the packet ...
*/
x = parse_packet(packet, len);
/* get_dnsquery(x, &query); */
/*
* ... and search our cache for this request.
*/
code = get_stringcode(query.name);
for (cx = cachelist; cx != NULL; cx = cx->next) {
if (cx->code == code &&
cx->type == query.type &&
cx->class == query.class &&
strcasecmp(cx->name, query.name) == 0) {
log_debug("cache: found %s, type= %d, class: %d, ans= %d\n",
cx->name, cx->type, cx->class, cx->p->ancount);
if (cx->positive > 0) {
cx->lastused = time(NULL);
cx->expires = cx->lastused + CACHE_TIME;
}
memcpy(packet + 2, cx->p->packet + 2, cx->p->len - 2);
cache_hits++;
return (cx->p->len);
}
}
cache_misses++;
return (0);
}
/*
* Item expiration
*/
/*
* cmp_cachemru() - Compare the "ages" of two cache entries.
*
* In: cx - pointer to first cache entry.
* cy - pointer to second cache entry.
*
* Returns: >0 if cx is older than cy
* <0 if cx is younger than cy
* 0 if cx is equal to cy
*/
static int cmp_cachemru(const void *x, const void * y)
{
const cache_t **cx = (const cache_t **)x;
const cache_t **cy = (const cache_t **)y;
return ((*cy)->lastused - (*cx)->lastused);
}
/*
* expire_oldest() - expire cache entries until lowwater is reached
*
* In: itemcount - number of entries in cache.
*
* Returns: 0, always.
*
* Sorts all the entries in order of age, oldest first.
* Then removes the first (itemcount - cache_lowwater) entries.
*/
static int expire_oldest(int itemcount)
{
int i, n;
cache_t *cx, **cv;
if ((n = itemcount - cache_lowwater) < 0) return (0);
cv = allocate(itemcount * sizeof(cache_t *));
for (i = 0, cx = cachelist; i < itemcount; i++, cx = cx->next) {
cv[i] = cx;
}
qsort(cv, itemcount, sizeof(cache_t *), cmp_cachemru);
for (i=0; i<n; i++) {
cx = cv[i];
remove_cx(cx);
free_cx(cx);
}
log_msg(LOG_NOTICE, "cache: %d of %d mru expired, %d remaining\n",
n, itemcount, itemcount - n);
return (0);
}
/*
* cache_expire() - Expire old entries from the cache.
*
* Returns: 0, always.
*
* When called, this function walks the entire cachelist, looking for entries
* that should be expired.
*/
int cache_expire(void)
{
int total, expired;
time_t now;
cache_t *cx, *next;
static time_t lastexpire = 0;
if (cache_onoff == 0) return (0);
/* Initialize lastexpire to the current time */
if (lastexpire == 0) lastexpire = time(NULL);
now = time(NULL);
if (now - lastexpire < CACHE_MINCYCLE) return (0);
total = 0;
expired = 0;
cx = cachelist;
while (cx != NULL) {
total += 1;
next = cx->next;
if (cx->expires < now || (now - cx->created) > CACHE_MAXTIME) {
remove_cx(cx);
free_cx(cx);
expired++;
}
cx = next;
}
log_debug("cache stats: %d entries, %d missed, %d hits",
total, cache_misses, cache_hits);
cache_misses = 0;
cache_hits = 0;
if (expired > 0) {
log_debug("cache: %d of %d expired, %d remaining\n",
expired, total, total - expired);
}
total = total - expired;
if (total > cache_highwater) {
expire_oldest(total);
}
lastexpire = now;
return (0);
}
/*
* cache_init()
*
* Returns: 0, always.
*
* Called once from main() to initialize our cache.
* Caching is turned on by default.
*/
int cache_init(void)
{
if (*cache_param != 0) {
if (strcmp(cache_param, "off") == 0) {
cache_onoff = 0;
}
else if (isdigit(*cache_param)) {
char *p = strchr(cache_param, ':');
if (p == NULL) {
cache_highwater = atoi(cache_param);
cache_lowwater = (cache_highwater * 75) / 100;
}
else {
*p++ = 0;
cache_lowwater = atoi(cache_param);
cache_highwater = atoi(p);
}
}
else {
log_msg(LOG_ERR, "invalid cache parameter: %s", cache_param);
}
}
if (cache_onoff == 0) {
log_msg(LOG_NOTICE, "caching turned off");
}
else {
if (cache_highwater < 0) {
cache_highwater = CACHE_HIGHWATER;
cache_lowwater = CACHE_LOWWATER;
}
else if (cache_lowwater > cache_highwater) {
cache_lowwater = (cache_highwater * 75) / 100;
}
log_debug("cache low/high: %d/%d", cache_lowwater, cache_highwater);
}
return (0);
}
|