#include <StoreSwapLogData.h>

Collaboration diagram for StoreSwapLogData:

Public Types

typedef int64_t SwappedTime
 type to use for storing time-related members; must be signed More...
 

Public Member Functions

 StoreSwapLogData ()
 
bool sane () const
 consistency self-check: whether the data appears to make sense More...
 
void finalize ()
 call this before storing the log entry More...
 

Public Attributes

uint8_t op
 
SwapChecksum24 checksum
 
sfileno swap_filen
 
SwappedTime timestamp
 
SwappedTime lastref
 
SwappedTime expires
 
SwappedTime lastmod
 
uint64_t swap_file_sz
 
uint16_t refcount
 
uint16_t flags
 
unsigned char key [SQUID_MD5_DIGEST_LENGTH]
 

Private Member Functions

 MEMPROXY_CLASS (StoreSwapLogData)
 

Detailed Description

Defines the structure of a binary swap.state file entry for UFS stores. TODO: Move to fs/ufs
Note
StoreSwapLogData entries are written in native machine byte order They are not necessarily portable across architectures.

Definition at line 85 of file StoreSwapLogData.h.

Member Typedef Documentation

Definition at line 91 of file StoreSwapLogData.h.

Constructor & Destructor Documentation

StoreSwapLogData::StoreSwapLogData ( )

Definition at line 52 of file StoreSwapLogData.cc.

Member Function Documentation

void StoreSwapLogData::finalize ( )
StoreSwapLogData::MEMPROXY_CLASS ( StoreSwapLogData  )
private
bool StoreSwapLogData::sane ( ) const

Member Data Documentation

SwapChecksum24 StoreSwapLogData::checksum

Fingerprint to weed out bogus/corrupted swap.state entries.

Definition at line 110 of file StoreSwapLogData.h.

Referenced by finalize(), and sane().

SwappedTime StoreSwapLogData::expires

The value of the response's Expires: header, if any. If the response does not have an Expires: header, this is set to -1. If the response has an invalid (unparseable) Expires: header, it is also set to -1. There are some cases where Squid sets expires to -2. This happens for the internal "netdb" object and for FTP URL responses.

Definition at line 144 of file StoreSwapLogData.h.

Referenced by Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), sane(), and UFSCleanLog::write().

uint16_t StoreSwapLogData::flags

A copy of the StoreEntry flags field. Used as a sanity check when rebuilding the cache at startup. Objects that have the KEY_PRIVATE flag set are not added back to the cache.

Definition at line 171 of file StoreSwapLogData.h.

Referenced by Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), and UFSCleanLog::write().

SwappedTime StoreSwapLogData::lastmod

The value of the response's Last-modified: header, if any. This is set to -1 if there is no Last-modified: header, or if it is unparseable.

Definition at line 151 of file StoreSwapLogData.h.

Referenced by Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), sane(), and UFSCleanLog::write().

SwappedTime StoreSwapLogData::lastref

The last time that a client requested this object.

Definition at line 133 of file StoreSwapLogData.h.

Referenced by Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), sane(), and UFSCleanLog::write().

uint8_t StoreSwapLogData::op

Either SWAP_LOG_ADD when an object is added to the disk storage, or SWAP_LOG_DEL when an object is deleted.

Definition at line 105 of file StoreSwapLogData.h.

Referenced by cacheIndexScan(), Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), sane(), and UFSCleanLog::write().

uint16_t StoreSwapLogData::refcount

The number of times that this object has been accessed (referenced). Since its a 16-bit quantity, it is susceptible to overflow if a single object is accessed 65,536 times before being replaced.

Definition at line 164 of file StoreSwapLogData.h.

Referenced by Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), and UFSCleanLog::write().

uint64_t StoreSwapLogData::swap_file_sz

This is the number of bytes that the object occupies on disk. It includes the Squid "swap file header".

Definition at line 157 of file StoreSwapLogData.h.

Referenced by finalize(), Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), sane(), and UFSCleanLog::write().

sfileno StoreSwapLogData::swap_filen

The 32-bit file number which maps to a pathname. Only the low 24-bits are relevant. The high 8-bits are used as an index to an array of storage directories, and are set at run time because the order of storage directories may change over time.

Definition at line 119 of file StoreSwapLogData.h.

Referenced by finalize(), Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), sane(), and UFSCleanLog::write().

SwappedTime StoreSwapLogData::timestamp

A Unix time value that represents the time when the origin server generated this response. If the response has a valid Date: header, this timestamp corresponds to that time. Otherwise, it is set to the Squid process time when the response is read (as soon as the end of headers are found).

Definition at line 128 of file StoreSwapLogData.h.

Referenced by Fs::Ufs::UFSSwapDir::logEntry(), UFSSwapLogParser_v1_32bs::ReadRecord(), Fs::Ufs::RebuildState::rebuildFromSwapLog(), sane(), and UFSCleanLog::write().


The documentation for this class was generated from the following files:

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors