granicus.if.org Git - apache/blob - support/htcacheclean.c

   1 /* Licensed to the Apache Software Foundation (ASF) under one or more
   2  * contributor license agreements.  See the NOTICE file distributed with
   3  * this work for additional information regarding copyright ownership.
   4  * The ASF licenses this file to You under the Apache License, Version 2.0
   5  * (the "License"); you may not use this file except in compliance with
   6  * the License.  You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * htcacheclean.c: simple program for cleaning of
  19  * the disk cache of the Apache HTTP server
  20  *
  21  * Contributed by Andreas Steinmetz <ast domdv.de>
  22  * 8 Oct 2004
  23  */
  24
  25 #include "apr.h"
  26 #include "apr_lib.h"
  27 #include "apr_strings.h"
  28 #include "apr_file_io.h"
  29 #include "apr_file_info.h"
  30 #include "apr_pools.h"
  31 #include "apr_hash.h"
  32 #include "apr_thread_proc.h"
  33 #include "apr_signal.h"
  34 #include "apr_getopt.h"
  35 #include "apr_ring.h"
  36 #include "apr_date.h"
  37 #include "apr_buckets.h"
  38 #include "../modules/cache/mod_disk_cache.h"
  39
  40 #if APR_HAVE_UNISTD_H
  41 #include <unistd.h>
  42 #endif
  43 #if APR_HAVE_STDLIB_H
  44 #include <stdlib.h>
  45 #endif
  46
  47 /* define the following for debugging */
  48 #undef DEBUG
  49
  50 /*
  51  * Note: on Linux delays <= 2ms are busy waits without
  52  *       scheduling, so never use a delay <= 2ms below
  53  */
  54
  55 #define NICE_DELAY    10000     /* usecs */
  56 #define DELETE_NICE   10        /* be nice after this amount of delete ops */
  57 #define STAT_ATTEMPTS 10        /* maximum stat attempts for a file */
  58 #define STAT_DELAY    5000      /* usecs */
  59 #define HEADER        1         /* headers file */
  60 #define DATA          2         /* body file */
  61 #define TEMP          4         /* temporary file */
  62 #define HEADERDATA    (HEADER|DATA)
  63 #define MAXDEVIATION  3600      /* secs */
  64 #define SECS_PER_MIN  60
  65 #define KBYTE         1024
  66 #define MBYTE         1048576
  67 #define GBYTE         1073741824
  68
  69 #define DIRINFO (APR_FINFO_MTIME|APR_FINFO_SIZE|APR_FINFO_TYPE|APR_FINFO_LINK)
  70
  71 typedef struct _direntry {
  72     APR_RING_ENTRY(_direntry) link;
  73     int type;         /* type of file/fileset: TEMP, HEADER, DATA, HEADERDATA */
  74     apr_time_t htime; /* headers file modification time */
  75     apr_time_t dtime; /* body file modification time */
  76     apr_off_t hsize;  /* headers file size */
  77     apr_off_t dsize;  /* body or temporary file size */
  78     char *basename;   /* file/fileset base name */
  79 } DIRENTRY;
  80
  81 typedef struct _entry {
  82     APR_RING_ENTRY(_entry) link;
  83     apr_time_t expire;        /* cache entry exiration time */
  84     apr_time_t response_time; /* cache entry time of last response to client */
  85     apr_time_t htime;         /* headers file modification time */
  86     apr_time_t dtime;         /* body file modification time */
  87     apr_off_t hsize;          /* headers file size */
  88     apr_off_t dsize;          /* body or temporary file size */
  89     char *basename;           /* fileset base name */
  90 } ENTRY;
  91
  92
  93 static int delcount;    /* file deletion count for nice mode */
  94 static int interrupted; /* flag: true if SIGINT or SIGTERM occurred */
  95 static int realclean;   /* flag: true means user said apache is not running */
  96 static int verbose;     /* flag: true means print statistics */
  97 static int benice;      /* flag: true means nice mode is activated */
  98 static int dryrun;      /* flag: true means dry run, don't actually delete
  99                                  anything */
 100 static int deldirs;     /* flag: true means directories should be deleted */
 101 static int baselen;     /* string length of the path to the proxy directory */
 102 static apr_time_t now;  /* start time of this processing run */
 103
 104 static apr_file_t *errfile;   /* stderr file handle */
 105 static apr_off_t unsolicited; /* file size summary for deleted unsolicited
 106                                  files */
 107 static APR_RING_ENTRY(_entry) root; /* ENTRY ring anchor */
 108
 109 /* short program name as called */
 110 static const char *shortname = "htcacheclean";
 111
 112 #ifdef DEBUG
 113 /*
 114  * fake delete for debug purposes
 115  */
 116 #define apr_file_remove fake_file_remove
 117 static void fake_file_remove(char *pathname, apr_pool_t *p)
 118 {
 119     apr_finfo_t info;
 120
 121     /* stat and printing to simulate some deletion system load and to
 122        display what would actually have happened */
 123     apr_stat(&info, pathname, DIRINFO, p);
 124     apr_file_printf(errfile, "would delete %s" APR_EOL_STR, pathname);
 125 }
 126 #endif
 127
 128 /*
 129  * called on SIGINT or SIGTERM
 130  */
 131 static void setterm(int unused)
 132 {
 133 #ifdef DEBUG
 134     apr_file_printf(errfile, "interrupt" APR_EOL_STR);
 135 #endif
 136     interrupted = 1;
 137 }
 138
 139 /*
 140  * called in out of memory condition
 141  */
 142 static int oom(int unused)
 143 {
 144     static int called = 0;
 145
 146     /* be careful to call exit() only once */
 147     if (!called) {
 148         called = 1;
 149         exit(1);
 150     }
 151     return APR_ENOMEM;
 152 }
 153
 154 /*
 155  * print purge statistics
 156  */
 157 static void printstats(apr_off_t total, apr_off_t sum, apr_off_t max,
 158                        apr_off_t etotal, apr_off_t entries)
 159 {
 160     char ttype, stype, mtype, utype;
 161     apr_off_t tfrag, sfrag, ufrag;
 162
 163     if (!verbose) {
 164         return;
 165     }
 166
 167     ttype = 'K';
 168     tfrag = ((total * 10) / KBYTE) % 10;
 169     total /= KBYTE;
 170     if (total >= KBYTE) {
 171         ttype = 'M';
 172         tfrag = ((total * 10) / KBYTE) % 10;
 173         total /= KBYTE;
 174     }
 175
 176     stype = 'K';
 177     sfrag = ((sum * 10) / KBYTE) % 10;
 178     sum /= KBYTE;
 179     if (sum >= KBYTE) {
 180         stype = 'M';
 181         sfrag = ((sum * 10) / KBYTE) % 10;
 182         sum /= KBYTE;
 183     }
 184
 185     mtype = 'K';
 186     max /= KBYTE;
 187     if (max >= KBYTE) {
 188         mtype = 'M';
 189         max /= KBYTE;
 190     }
 191
 192     apr_file_printf(errfile, "Statistics:" APR_EOL_STR);
 193     if (unsolicited) {
 194         utype = 'K';
 195         ufrag = ((unsolicited * 10) / KBYTE) % 10;
 196         unsolicited /= KBYTE;
 197         if (unsolicited >= KBYTE) {
 198             utype = 'M';
 199             ufrag = ((unsolicited * 10) / KBYTE) % 10;
 200             unsolicited /= KBYTE;
 201         }
 202         if (!unsolicited && !ufrag) {
 203             ufrag = 1;
 204         }
 205         apr_file_printf(errfile, "unsolicited size %d.%d%c" APR_EOL_STR,
 206                         (int)(unsolicited), (int)(ufrag), utype);
 207      }
 208      apr_file_printf(errfile, "size limit %d.0%c" APR_EOL_STR,
 209                      (int)(max), mtype);
 210      apr_file_printf(errfile, "total size was %d.%d%c, total size now "
 211                               "%d.%d%c" APR_EOL_STR,
 212                      (int)(total), (int)(tfrag), ttype, (int)(sum),
 213                      (int)(sfrag), stype);
 214      apr_file_printf(errfile, "total entries was %d, total entries now %d"
 215                               APR_EOL_STR, (int)(etotal), (int)(entries));
 216 }
 217
 218 /*
 219  * delete a single file
 220  */
 221 static void delete_file(char *path, char *basename, apr_pool_t *pool)
 222 {
 223     char *nextpath;
 224     apr_pool_t *p;
 225
 226     if (dryrun) {
 227         return;
 228     }
 229
 230     /* temp pool, otherwise lots of memory could be allocated */
 231     apr_pool_create(&p, pool);
 232     nextpath = apr_pstrcat(p, path, "/", basename, NULL);
 233     apr_file_remove(nextpath, p);
 234     apr_pool_destroy(p);
 235
 236     if (benice) {
 237         if (++delcount >= DELETE_NICE) {
 238             apr_sleep(NICE_DELAY);
 239             delcount = 0;
 240         }
 241     }
 242 }
 243
 244 /*
 245  * delete cache file set
 246  */
 247 static void delete_entry(char *path, char *basename, apr_pool_t *pool)
 248 {
 249     char *nextpath;
 250     apr_pool_t *p;
 251
 252     if (dryrun) {
 253         return;
 254     }
 255
 256     /* temp pool, otherwise lots of memory could be allocated */
 257     apr_pool_create(&p, pool);
 258
 259     nextpath = apr_pstrcat(p, path, "/", basename, CACHE_HEADER_SUFFIX, NULL);
 260     apr_file_remove(nextpath, p);
 261
 262     nextpath = apr_pstrcat(p, path, "/", basename, CACHE_DATA_SUFFIX, NULL);
 263     apr_file_remove(nextpath, p);
 264
 265     apr_pool_destroy(p);
 266
 267     if (benice) {
 268         delcount += 2;
 269         if (delcount >= DELETE_NICE) {
 270             apr_sleep(NICE_DELAY);
 271             delcount = 0;
 272         }
 273     }
 274 }
 275
 276 /*
 277  * walk the cache directory tree
 278  */
 279 static int process_dir(char *path, apr_pool_t *pool)
 280 {
 281     apr_dir_t *dir;
 282     apr_pool_t *p;
 283     apr_hash_t *h;
 284     apr_hash_index_t *i;
 285     apr_file_t *fd;
 286     apr_status_t status;
 287     apr_finfo_t info;
 288     apr_size_t len;
 289     apr_time_t current, deviation;
 290     char *nextpath, *base, *ext, *orig_basename;
 291     APR_RING_ENTRY(_direntry) anchor;
 292     DIRENTRY *d, *t, *n;
 293     ENTRY *e;
 294     int skip, retries;
 295     disk_cache_info_t disk_info;
 296
 297     APR_RING_INIT(&anchor, _direntry, link);
 298     apr_pool_create(&p, pool);
 299     h = apr_hash_make(p);
 300     fd = NULL;
 301     skip = 0;
 302     deviation = MAXDEVIATION * APR_USEC_PER_SEC;
 303
 304     if (apr_dir_open(&dir, path, p) != APR_SUCCESS) {
 305         return 1;
 306     }
 307
 308     while (apr_dir_read(&info, 0, dir) == APR_SUCCESS && !interrupted) {
 309         if (!strcmp(info.name, ".") || !strcmp(info.name, "..")) {
 310             continue;
 311         }
 312         d = apr_pcalloc(p, sizeof(DIRENTRY));
 313         d->basename = apr_pstrcat(p, path, "/", info.name, NULL);
 314         APR_RING_INSERT_TAIL(&anchor, d, _direntry, link);
 315     }
 316
 317     apr_dir_close(dir);
 318
 319     if (interrupted) {
 320         return 1;
 321     }
 322
 323     skip = baselen + 1;
 324
 325     for (d = APR_RING_FIRST(&anchor);
 326          !interrupted && d != APR_RING_SENTINEL(&anchor, _direntry, link);
 327          d=n) {
 328         n = APR_RING_NEXT(d, link);
 329         base = strrchr(d->basename, '/');
 330         if (!base++) {
 331             base = d->basename;
 332         }
 333         ext = strchr(base, '.');
 334
 335         /* there may be temporary files which may be gone before
 336          * processing, always skip these if not in realclean mode
 337          */
 338         if (!ext && !realclean) {
 339             if (!strncasecmp(base, AP_TEMPFILE_BASE, AP_TEMPFILE_BASELEN)
 340                 && strlen(base) == AP_TEMPFILE_NAMELEN) {
 341                 continue;
 342             }
 343         }
 344
 345         /* this may look strange but apr_stat() may return errno which
 346          * is system dependent and there may be transient failures,
 347          * so just blindly retry for a short while
 348          */
 349         retries = STAT_ATTEMPTS;
 350         status = APR_SUCCESS;
 351         do {
 352             if (status != APR_SUCCESS) {
 353                 apr_sleep(STAT_DELAY);
 354             }
 355             status = apr_stat(&info, d->basename, DIRINFO, p);
 356         } while (status != APR_SUCCESS && !interrupted && --retries);
 357
 358         /* what may happen here is that apache did create a file which
 359          * we did detect but then does delete the file before we can
 360          * get file information, so if we don't get any file information
 361          * we will ignore the file in this case
 362          */
 363         if (status != APR_SUCCESS) {
 364             if (!realclean && !interrupted) {
 365                 continue;
 366             }
 367             return 1;
 368         }
 369
 370         if (info.filetype == APR_DIR) {
 371             /* Make a copy of the basename, as process_dir modifies it */
 372             orig_basename = apr_pstrdup(pool, d->basename);
 373             if (process_dir(d->basename, pool)) {
 374                 return 1;
 375             }
 376
 377             /* If asked to delete dirs, do so now. We don't care if it fails.
 378              * If it fails, it likely means there was something else there.
 379              */
 380             if (deldirs && !dryrun) {
 381                 apr_dir_remove(orig_basename, pool);
 382             }
 383             continue;
 384         }
 385
 386         if (info.filetype != APR_REG) {
 387             continue;
 388         }
 389
 390         if (!ext) {
 391             if (!strncasecmp(base, AP_TEMPFILE_BASE, AP_TEMPFILE_BASELEN)
 392                 && strlen(base) == AP_TEMPFILE_NAMELEN) {
 393                 d->basename += skip;
 394                 d->type = TEMP;
 395                 d->dsize = info.size;
 396                 apr_hash_set(h, d->basename, APR_HASH_KEY_STRING, d);
 397             }
 398             continue;
 399         }
 400
 401         if (!strcasecmp(ext, CACHE_HEADER_SUFFIX)) {
 402             *ext = '\0';
 403             d->basename += skip;
 404             /* if a user manually creates a '.header' file */
 405             if (d->basename[0] == '\0') {
 406                 continue;
 407             }
 408             t = apr_hash_get(h, d->basename, APR_HASH_KEY_STRING);
 409             if (t) {
 410                 d = t;
 411             }
 412             d->type |= HEADER;
 413             d->htime = info.mtime;
 414             d->hsize = info.size;
 415             apr_hash_set(h, d->basename, APR_HASH_KEY_STRING, d);
 416             continue;
 417         }
 418
 419         if (!strcasecmp(ext, CACHE_DATA_SUFFIX)) {
 420             *ext = '\0';
 421             d->basename += skip;
 422             /* if a user manually creates a '.data' file */
 423             if (d->basename[0] == '\0') {
 424                 continue;
 425             }
 426             t = apr_hash_get(h, d->basename, APR_HASH_KEY_STRING);
 427             if (t) {
 428                 d = t;
 429             }
 430             d->type |= DATA;
 431             d->dtime = info.mtime;
 432             d->dsize = info.size;
 433             apr_hash_set(h, d->basename, APR_HASH_KEY_STRING, d);
 434         }
 435     }
 436
 437     if (interrupted) {
 438         return 1;
 439     }
 440
 441     path[baselen] = '\0';
 442
 443     for (i = apr_hash_first(p, h); i && !interrupted; i = apr_hash_next(i)) {
 444         void *hvalue;
 445         apr_uint32_t format;
 446
 447         apr_hash_this(i, NULL, NULL, &hvalue);
 448         d = hvalue;
 449
 450         switch(d->type) {
 451         case HEADERDATA:
 452             nextpath = apr_pstrcat(p, path, "/", d->basename,
 453                                    CACHE_HEADER_SUFFIX, NULL);
 454             if (apr_file_open(&fd, nextpath, APR_FOPEN_READ | APR_FOPEN_BINARY,
 455                               APR_OS_DEFAULT, p) == APR_SUCCESS) {
 456                 len = sizeof(format);
 457                 if (apr_file_read_full(fd, &format, len,
 458                                        &len) == APR_SUCCESS) {
 459                     if (format == DISK_FORMAT_VERSION) {
 460                         apr_off_t offset = 0;
 461
 462                         apr_file_seek(fd, APR_SET, &offset);
 463
 464                         len = sizeof(disk_cache_info_t);
 465
 466                         if (apr_file_read_full(fd, &disk_info, len,
 467                                                &len) == APR_SUCCESS) {
 468                             apr_file_close(fd);
 469                             e = apr_palloc(pool, sizeof(ENTRY));
 470                             APR_RING_INSERT_TAIL(&root, e, _entry, link);
 471                             e->expire = disk_info.expire;
 472                             e->response_time = disk_info.response_time;
 473                             e->htime = d->htime;
 474                             e->dtime = d->dtime;
 475                             e->hsize = d->hsize;
 476                             e->dsize = d->dsize;
 477                             e->basename = apr_palloc(pool,
 478                                                      strlen(d->basename) + 1);
 479                             strcpy(e->basename, d->basename);
 480                             break;
 481                         }
 482                         else {
 483                             apr_file_close(fd);
 484                         }
 485                     }
 486                     else if (format == VARY_FORMAT_VERSION) {
 487                         /* This must be a URL that added Vary headers later,
 488                          * so kill the orphaned .data file
 489                          */
 490                         apr_file_close(fd);
 491                         apr_file_remove(apr_pstrcat(p, path, "/", d->basename,
 492                                                     CACHE_DATA_SUFFIX, NULL),
 493                                         p);
 494                     }
 495                 }
 496                 else {
 497                     apr_file_close(fd);
 498                 }
 499
 500             }
 501             /* we have a somehow unreadable headers file which is associated
 502              * with a data file. this may be caused by apache currently
 503              * rewriting the headers file. thus we may delete the file set
 504              * either in realclean mode or if the headers file modification
 505              * timestamp is not within a specified positive or negative offset
 506              * to the current time.
 507              */
 508             current = apr_time_now();
 509             if (realclean || d->htime < current - deviation
 510                 || d->htime > current + deviation) {
 511                 delete_entry(path, d->basename, p);
 512                 unsolicited += d->hsize;
 513                 unsolicited += d->dsize;
 514             }
 515             break;
 516
 517         /* single data and header files may be deleted either in realclean
 518          * mode or if their modification timestamp is not within a
 519          * specified positive or negative offset to the current time.
 520          * this handling is necessary due to possible race conditions
 521          * between apache and this process
 522          */
 523         case HEADER:
 524             current = apr_time_now();
 525             nextpath = apr_pstrcat(p, path, "/", d->basename,
 526                                    CACHE_HEADER_SUFFIX, NULL);
 527             if (apr_file_open(&fd, nextpath, APR_FOPEN_READ | APR_FOPEN_BINARY,
 528                               APR_OS_DEFAULT, p) == APR_SUCCESS) {
 529                 len = sizeof(format);
 530                 if (apr_file_read_full(fd, &format, len,
 531                                        &len) == APR_SUCCESS) {
 532                     if (format == VARY_FORMAT_VERSION) {
 533                         apr_time_t expires;
 534
 535                         len = sizeof(expires);
 536
 537                         apr_file_read_full(fd, &expires, len, &len);
 538
 539                         apr_file_close(fd);
 540
 541                         if (expires < current) {
 542                             delete_entry(path, d->basename, p);
 543                         }
 544                         break;
 545                     }
 546                 }
 547                 apr_file_close(fd);
 548             }
 549
 550             if (realclean || d->htime < current - deviation
 551                 || d->htime > current + deviation) {
 552                 delete_entry(path, d->basename, p);
 553                 unsolicited += d->hsize;
 554             }
 555             break;
 556
 557         case DATA:
 558             current = apr_time_now();
 559             if (realclean || d->dtime < current - deviation
 560                 || d->dtime > current + deviation) {
 561                 delete_entry(path, d->basename, p);
 562                 unsolicited += d->dsize;
 563             }
 564             break;
 565
 566         /* temp files may only be deleted in realclean mode which
 567          * is asserted above if a tempfile is in the hash array
 568          */
 569         case TEMP:
 570             delete_file(path, d->basename, p);
 571             unsolicited += d->dsize;
 572             break;
 573         }
 574     }
 575
 576     if (interrupted) {
 577         return 1;
 578     }
 579
 580     apr_pool_destroy(p);
 581
 582     if (benice) {
 583         apr_sleep(NICE_DELAY);
 584     }
 585
 586     if (interrupted) {
 587         return 1;
 588     }
 589
 590     return 0;
 591 }
 592
 593 /*
 594  * purge cache entries
 595  */
 596 static void purge(char *path, apr_pool_t *pool, apr_off_t max)
 597 {
 598     apr_off_t sum, total, entries, etotal;
 599     ENTRY *e, *n, *oldest;
 600
 601     sum = 0;
 602     entries = 0;
 603
 604     for (e = APR_RING_FIRST(&root);
 605          e != APR_RING_SENTINEL(&root, _entry, link);
 606          e = APR_RING_NEXT(e, link)) {
 607         sum += e->hsize;
 608         sum += e->dsize;
 609         entries++;
 610     }
 611
 612     total = sum;
 613     etotal = entries;
 614
 615     if (sum <= max) {
 616         printstats(total, sum, max, etotal, entries);
 617         return;
 618     }
 619
 620     /* process all entries with a timestamp in the future, this may
 621      * happen if a wrong system time is corrected
 622      */
 623
 624     for (e = APR_RING_FIRST(&root);
 625          e != APR_RING_SENTINEL(&root, _entry, link) && !interrupted;) {
 626         n = APR_RING_NEXT(e, link);
 627         if (e->response_time > now || e->htime > now || e->dtime > now) {
 628             delete_entry(path, e->basename, pool);
 629             sum -= e->hsize;
 630             sum -= e->dsize;
 631             entries--;
 632             APR_RING_REMOVE(e, link);
 633             if (sum <= max) {
 634                 if (!interrupted) {
 635                     printstats(total, sum, max, etotal, entries);
 636                 }
 637                 return;
 638             }
 639         }
 640         e = n;
 641     }
 642
 643     if (interrupted) {
 644         return;
 645     }
 646
 647     /* process all entries with are expired */
 648     for (e = APR_RING_FIRST(&root);
 649          e != APR_RING_SENTINEL(&root, _entry, link) && !interrupted;) {
 650         n = APR_RING_NEXT(e, link);
 651         if (e->expire != APR_DATE_BAD && e->expire < now) {
 652             delete_entry(path, e->basename, pool);
 653             sum -= e->hsize;
 654             sum -= e->dsize;
 655             entries--;
 656             APR_RING_REMOVE(e, link);
 657             if (sum <= max) {
 658                 if (!interrupted) {
 659                     printstats(total, sum, max, etotal, entries);
 660                 }
 661                 return;
 662             }
 663         }
 664         e = n;
 665     }
 666
 667     if (interrupted) {
 668          return;
 669     }
 670
 671     /* process remaining entries oldest to newest, the check for an emtpy
 672      * ring actually isn't necessary except when the compiler does
 673      * corrupt 64bit arithmetics which happend to me once, so better safe
 674      * than sorry
 675      */
 676     while (sum > max && !interrupted && !APR_RING_EMPTY(&root, _entry, link)) {
 677         oldest = APR_RING_FIRST(&root);
 678
 679         for (e = APR_RING_NEXT(oldest, link);
 680              e != APR_RING_SENTINEL(&root, _entry, link);
 681              e = APR_RING_NEXT(e, link)) {
 682             if (e->dtime < oldest->dtime) {
 683                 oldest = e;
 684             }
 685         }
 686
 687         delete_entry(path, oldest->basename, pool);
 688         sum -= oldest->hsize;
 689         sum -= oldest->dsize;
 690         entries--;
 691         APR_RING_REMOVE(oldest, link);
 692     }
 693
 694     if (!interrupted) {
 695         printstats(total, sum, max, etotal, entries);
 696     }
 697 }
 698
 699 /*
 700  * usage info
 701  */
 702 #define NL APR_EOL_STR
 703 static void usage(void)
 704 {
 705     apr_file_printf(errfile,
 706     "%s -- program for cleaning the disk cache."                             NL
 707     "Usage: %s [-Dvtrn] -pPATH -lLIMIT"                                      NL
 708     "       %s [-nti] -dINTERVAL -pPATH -lLIMIT"                             NL
 709                                                                              NL
 710     "Options:"                                                               NL
 711     "  -d   Daemonize and repeat cache cleaning every INTERVAL minutes."     NL
 712     "       This option is mutually exclusive with the -D, -v and -r"        NL
 713     "       options."                                                        NL
 714                                                                              NL
 715     "  -D   Do a dry run and don't delete anything. This option is mutually" NL
 716     "       exclusive with the -d option."                                   NL
 717                                                                              NL
 718     "  -v   Be verbose and print statistics. This option is mutually"        NL
 719     "       exclusive with the -d option."                                   NL
 720                                                                              NL
 721     "  -r   Clean thoroughly. This assumes that the Apache web server is "   NL
 722     "       not running. This option is mutually exclusive with the -d"      NL
 723     "       option and implies -t."                                          NL
 724                                                                              NL
 725     "  -n   Be nice. This causes slower processing in favour of other"       NL
 726     "       processes."                                                      NL
 727                                                                              NL
 728     "  -t   Delete all empty directories. By default only cache files are"   NL
 729     "       removed, however with some configurations the large number of"   NL
 730     "       directories created may require attention."                      NL
 731                                                                              NL
 732     "  -p   Specify PATH as the root directory of the disk cache."           NL
 733                                                                              NL
 734     "  -l   Specify LIMIT as the total disk cache size limit. Attach 'K'"    NL
 735     "       or 'M' to the number for specifying KBytes or MBytes."           NL
 736                                                                              NL
 737     "  -i   Be intelligent and run only when there was a modification of"    NL
 738     "       the disk cache. This option is only possible together with the"  NL
 739     "       -d option."                                                      NL,
 740     shortname,
 741     shortname,
 742     shortname
 743     );
 744
 745     exit(1);
 746 }
 747 #undef NL
 748
 749 /*
 750  * main
 751  */
 752 int main(int argc, const char * const argv[])
 753 {
 754     apr_off_t max;
 755     apr_time_t current, repeat, delay, previous;
 756     apr_status_t status;
 757     apr_pool_t *pool, *instance;
 758     apr_getopt_t *o;
 759     apr_finfo_t info;
 760     int retries, isdaemon, limit_found, intelligent, dowork;
 761     char opt;
 762     const char *arg;
 763     char *proxypath, *path;
 764
 765     interrupted = 0;
 766     repeat = 0;
 767     isdaemon = 0;
 768     dryrun = 0;
 769     limit_found = 0;
 770     max = 0;
 771     verbose = 0;
 772     realclean = 0;
 773     benice = 0;
 774     deldirs = 0;
 775     intelligent = 0;
 776     previous = 0; /* avoid compiler warning */
 777     proxypath = NULL;
 778
 779     if (apr_app_initialize(&argc, &argv, NULL) != APR_SUCCESS) {
 780         return 1;
 781     }
 782     atexit(apr_terminate);
 783
 784     if (argc) {
 785         shortname = apr_filepath_name_get(argv[0]);
 786     }
 787
 788     if (apr_pool_create(&pool, NULL) != APR_SUCCESS) {
 789         return 1;
 790     }
 791     apr_pool_abort_set(oom, pool);
 792     apr_file_open_stderr(&errfile, pool);
 793     apr_signal(SIGINT, setterm);
 794     apr_signal(SIGTERM, setterm);
 795
 796     apr_getopt_init(&o, pool, argc, argv);
 797
 798     while (1) {
 799         status = apr_getopt(o, "iDnvrtd:l:L:p:", &opt, &arg);
 800         if (status == APR_EOF) {
 801             break;
 802         }
 803         else if (status != APR_SUCCESS) {
 804             usage();
 805         }
 806         else {
 807             switch (opt) {
 808             case 'i':
 809                 if (intelligent) {
 810                     usage();
 811                 }
 812                 intelligent = 1;
 813                 break;
 814
 815             case 'D':
 816                 if (dryrun) {
 817                     usage();
 818                 }
 819                 dryrun = 1;
 820                 break;
 821
 822             case 'n':
 823                 if (benice) {
 824                     usage();
 825                 }
 826                 benice = 1;
 827                 break;
 828
 829             case 't':
 830                 if (deldirs) {
 831                     usage();
 832                 }
 833                 deldirs = 1;
 834                 break;
 835
 836             case 'v':
 837                 if (verbose) {
 838                     usage();
 839                 }
 840                 verbose = 1;
 841                 break;
 842
 843             case 'r':
 844                 if (realclean) {
 845                     usage();
 846                 }
 847                 realclean = 1;
 848                 deldirs = 1;
 849                 break;
 850
 851             case 'd':
 852                 if (isdaemon) {
 853                     usage();
 854                 }
 855                 isdaemon = 1;
 856                 repeat = apr_atoi64(arg);
 857                 repeat *= SECS_PER_MIN;
 858                 repeat *= APR_USEC_PER_SEC;
 859                 break;
 860
 861             case 'l':
 862                 if (limit_found) {
 863                     usage();
 864                 }
 865                 limit_found = 1;
 866
 867                 do {
 868                     apr_status_t rv;
 869                     char *end;
 870
 871                     rv = apr_strtoff(&max, arg, &end, 10);
 872                     if (rv == APR_SUCCESS) {
 873                         if ((*end == 'K' || *end == 'k') && !end[1]) {
 874                             max *= KBYTE;
 875                         }
 876                         else if ((*end == 'M' || *end == 'm') && !end[1]) {
 877                             max *= MBYTE;
 878                         }
 879                         else if ((*end == 'G' || *end == 'g') && !end[1]) {
 880                             max *= GBYTE;
 881                         }
 882                         else if (*end &&        /* neither empty nor [Bb] */
 883                                  ((*end != 'B' && *end != 'b') || end[1])) {
 884                             rv = APR_EGENERAL;
 885                         }
 886                     }
 887                     if (rv != APR_SUCCESS) {
 888                         apr_file_printf(errfile, "Invalid limit: %s"
 889                                                  APR_EOL_STR APR_EOL_STR, arg);
 890                         usage();
 891                     }
 892                 } while(0);
 893                 break;
 894
 895             case 'p':
 896                 if (proxypath) {
 897                     usage();
 898                 }
 899                 proxypath = apr_pstrdup(pool, arg);
 900                 if (apr_filepath_set(proxypath, pool) != APR_SUCCESS) {
 901                     usage();
 902                 }
 903                 break;
 904             } /* switch */
 905         } /* else */
 906     } /* while */
 907
 908     if (o->ind != argc) {
 909          usage();
 910     }
 911
 912     if (isdaemon && (repeat <= 0 || verbose || realclean || dryrun)) {
 913          usage();
 914     }
 915
 916     if (!isdaemon && intelligent) {
 917          usage();
 918     }
 919
 920     if (!proxypath || max <= 0) {
 921          usage();
 922     }
 923
 924     if (apr_filepath_get(&path, 0, pool) != APR_SUCCESS) {
 925         usage();
 926     }
 927     baselen = strlen(path);
 928
 929 #ifndef DEBUG
 930     if (isdaemon) {
 931         apr_file_close(errfile);
 932         apr_proc_detach(APR_PROC_DETACH_DAEMONIZE);
 933     }
 934 #endif
 935
 936     do {
 937         apr_pool_create(&instance, pool);
 938
 939         now = apr_time_now();
 940         APR_RING_INIT(&root, _entry, link);
 941         delcount = 0;
 942         unsolicited = 0;
 943         dowork = 0;
 944
 945         switch (intelligent) {
 946         case 0:
 947             dowork = 1;
 948             break;
 949
 950         case 1:
 951             retries = STAT_ATTEMPTS;
 952             status = APR_SUCCESS;
 953
 954             do {
 955                 if (status != APR_SUCCESS) {
 956                     apr_sleep(STAT_DELAY);
 957                 }
 958                 status = apr_stat(&info, path, APR_FINFO_MTIME, instance);
 959             } while (status != APR_SUCCESS && !interrupted && --retries);
 960
 961             if (status == APR_SUCCESS) {
 962                 previous = info.mtime;
 963                 intelligent = 2;
 964             }
 965             dowork = 1;
 966             break;
 967
 968         case 2:
 969             retries = STAT_ATTEMPTS;
 970             status = APR_SUCCESS;
 971
 972             do {
 973                 if (status != APR_SUCCESS) {
 974                     apr_sleep(STAT_DELAY);
 975                 }
 976                 status = apr_stat(&info, path, APR_FINFO_MTIME, instance);
 977             } while (status != APR_SUCCESS && !interrupted && --retries);
 978
 979             if (status == APR_SUCCESS) {
 980                 if (previous != info.mtime) {
 981                     dowork = 1;
 982                 }
 983                 previous = info.mtime;
 984                 break;
 985             }
 986             intelligent = 1;
 987             dowork = 1;
 988             break;
 989         }
 990
 991         if (dowork && !interrupted) {
 992             if (!process_dir(path, instance) && !interrupted) {
 993                 purge(path, instance, max);
 994             }
 995             else if (!isdaemon && !interrupted) {
 996                 apr_file_printf(errfile, "An error occurred, cache cleaning "
 997                                          "aborted." APR_EOL_STR);
 998                 return 1;
 999             }
1000
1001             if (intelligent && !interrupted) {
1002                 retries = STAT_ATTEMPTS;
1003                 status = APR_SUCCESS;
1004                 do {
1005                     if (status != APR_SUCCESS) {
1006                         apr_sleep(STAT_DELAY);
1007                     }
1008                     status = apr_stat(&info, path, APR_FINFO_MTIME, instance);
1009                 } while (status != APR_SUCCESS && !interrupted && --retries);
1010
1011                 if (status == APR_SUCCESS) {
1012                     previous = info.mtime;
1013                     intelligent = 2;
1014                 }
1015                 else {
1016                     intelligent = 1;
1017                 }
1018             }
1019         }
1020
1021         apr_pool_destroy(instance);
1022
1023         current = apr_time_now();
1024         if (current < now) {
1025             delay = repeat;
1026         }
1027         else if (current - now >= repeat) {
1028             delay = repeat;
1029         }
1030         else {
1031             delay = now + repeat - current;
1032         }
1033
1034         /* we can't sleep the whole delay time here apiece as this is racy
1035          * with respect to interrupt delivery - think about what happens
1036          * if we have tested for an interrupt, then get scheduled
1037          * before the apr_sleep() call and while waiting for the cpu
1038          * we do get an interrupt
1039          */
1040         if (isdaemon) {
1041             while (delay && !interrupted) {
1042                 if (delay > APR_USEC_PER_SEC) {
1043                     apr_sleep(APR_USEC_PER_SEC);
1044                     delay -= APR_USEC_PER_SEC;
1045                 }
1046                 else {
1047                     apr_sleep(delay);
1048                     delay = 0;
1049                 }
1050             }
1051         }
1052     } while (isdaemon && !interrupted);
1053
1054     if (!isdaemon && interrupted) {
1055         apr_file_printf(errfile, "Cache cleaning aborted due to user "
1056                                  "request." APR_EOL_STR);
1057         return 1;
1058     }
1059
1060     return 0;
1061 }