src/store_rebuild.h

   1 #ifndef SQUID_STORE_REBUILD_H_
   2 #define SQUID_STORE_REBUILD_H_
   3 /*
   4  * DEBUG: section 20    Store Rebuild Routines
   5  * AUTHOR: Duane Wessels
   6  *
   7  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   8  * ----------------------------------------------------------
   9  *
  10  *  Squid is the result of efforts by numerous individuals from
  11  *  the Internet community; see the CONTRIBUTORS file for full
  12  *  details.   Many organizations have provided support for Squid's
  13  *  development; see the SPONSORS file for full details.  Squid is
  14  *  Copyrighted (C) 2001 by the Regents of the University of
  15  *  California; see the COPYRIGHT file for full details.  Squid
  16  *  incorporates software developed and/or copyrighted by other
  17  *  sources; see the CREDITS file for full details.
  18  *
  19  *  This program is free software; you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation; either version 2 of the License, or
  22  *  (at your option) any later version.
  23  *
  24  *  This program is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  32  *
  33  */
  34
  35 // currently a POD
  36 class StoreRebuildData
  37 {
  38 public:
  39     int objcount;       /* # objects successfully reloaded */
  40     int expcount;       /* # objects expired */
  41     int scancount;      /* # entries scanned or read from state file */
  42     int clashcount;     /* # swapfile clashes avoided */
  43     int dupcount;       /* # duplicates purged */
  44     int cancelcount;        /* # SWAP_LOG_DEL objects purged */
  45     int invalid;        /* # bad lines */
  46     int badflags;       /* # bad e->flags */
  47     int bad_log_op;
  48     int zero_object_sz;
  49 };
  50
  51 void storeRebuildStart(void);
  52 void storeRebuildComplete(StoreRebuildData *);
  53 void storeRebuildProgress(int sd_index, int total, int sofar);
  54
  55 /// loads entry from disk; fills supplied memory buffer on success
  56 bool storeRebuildLoadEntry(int fd, int diskIndex, MemBuf &buf, StoreRebuildData &counts);
  57 /// parses entry buffer and validates entry metadata; fills e on success
  58 bool storeRebuildParseEntry(MemBuf &buf, StoreEntry &e, cache_key *key, StoreRebuildData &counts, uint64_t expectedSize);
  59 /// checks whether the loaded entry should be kept; updates counters
  60 bool storeRebuildKeepEntry(const StoreEntry &e, const cache_key *key, StoreRebuildData &counts);
  61
  62 #endif /* SQUID_STORE_REBUILD_H_ */