summary view of all disk caches (cache_dirs) combined More...

#include <Disks.h>

Inheritance diagram for Store::Disks:
Collaboration diagram for Store::Disks:

Public Member Functions

 Disks ()
 
virtual void create () override
 create system resources needed for this store to operate in the future More...
 
virtual void init () override
 
virtual StoreEntryget (const cache_key *) override
 
virtual uint64_t maxSize () const override
 
virtual uint64_t minSize () const override
 the minimum size the store will shrink to via normal housekeeping More...
 
virtual uint64_t currentSize () const override
 current size More...
 
virtual uint64_t currentCount () const override
 the total number of objects stored right now More...
 
virtual int64_t maxObjectSize () const override
 the maximum size of a storable object; -1 if unlimited More...
 
virtual void getStats (StoreInfoStats &stats) const override
 collect statistics More...
 
virtual void stat (StoreEntry &) const override
 
virtual void sync () override
 prepare for shutdown More...
 
virtual void reference (StoreEntry &) override
 somebody needs this entry (many cache replacement policies need to know) More...
 
virtual bool dereference (StoreEntry &e) override
 
virtual void updateHeaders (StoreEntry *) override
 make stored metadata and HTTP headers the same as in the given entry More...
 
virtual void maintain () override
 perform regular periodic maintenance; TODO: move to UFSSwapDir::Maintain More...
 
virtual bool anchorToCache (StoreEntry &e, bool &inSync) override
 
virtual bool updateAnchored (StoreEntry &) override
 
virtual void evictCached (StoreEntry &) override
 
virtual void evictIfFound (const cache_key *) override
 
virtual int callback () override
 called once every main loop iteration; TODO: Move to UFS code. More...
 
void configure ()
 update configuration, including limits (re)calculation More...
 
int64_t accumulateMore (const StoreEntry &) const
 
bool hasReadableEntry (const StoreEntry &) const
 whether any of disk caches has entry with e.key More...
 

Static Public Member Functions

static void Parse (DiskConfig &)
 parses a single cache_dir configuration line More...
 
static void Dump (const DiskConfig &, StoreEntry &, const char *name)
 prints the configuration into the provided StoreEntry More...
 
static bool SmpAware ()
 whether any disk cache is SMP-aware More...
 
static SwapDirSelectSwapDir (const StoreEntry *)
 

Private Member Functions

SwapDirstore (int const x) const
 

Static Private Member Functions

static SwapDirDir (int const idx)
 

Private Attributes

int64_t largestMinimumObjectSize
 maximum of all Disk::minObjectSize()s More...
 
int64_t largestMaximumObjectSize
 maximum of all Disk::maxObjectSize()s More...
 
int64_t secondLargestMaximumObjectSize
 the second-biggest Disk::maxObjectSize() More...
 

Detailed Description

Definition at line 18 of file Disks.h.

Constructor & Destructor Documentation

◆ Disks()

Store::Disks::Disks ( )

Definition at line 169 of file Disks.cc.

Member Function Documentation

◆ accumulateMore()

int64_t Store::Disks::accumulateMore ( const StoreEntry entry) const

Additional unknown-size entry bytes required by disks in order to reduce the risk of selecting the wrong disk cache for the growing entry.

Definition at line 480 of file Disks.cc.

References MemObject::availableForSwapOut(), debugs, and StoreEntry::mem_obj.

◆ anchorToCache()

bool Store::Disks::anchorToCache ( StoreEntry ,
bool &   
)
overridevirtual

If Transients entry cannot be attached to this storage, return false. If the entry is not found, return false. Otherwise, return true after tying the entry to this cache and setting inSync to updateAnchored().

Reimplemented from Store::Controlled.

Definition at line 613 of file Disks.cc.

References Store::Disk::active(), Store::Controlled::anchorToCache(), SquidConfig::cacheSwap, Config, debugs, and Store::DiskConfig::n_configured.

◆ callback()

int Store::Disks::callback ( )
overridevirtual

Reimplemented from Store::Storage.

Definition at line 189 of file Disks.cc.

References SquidConfig::cacheSwap, Config, fatal(), and Store::DiskConfig::n_configured.

◆ configure()

◆ create()

void Store::Disks::create ( )
overridevirtual

◆ currentCount()

uint64_t Store::Disks::currentCount ( ) const
overridevirtual

Implements Store::Storage.

Definition at line 362 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

◆ currentSize()

uint64_t Store::Disks::currentSize ( ) const
overridevirtual

Implements Store::Storage.

Definition at line 349 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

◆ dereference()

bool Store::Disks::dereference ( StoreEntry e)
overridevirtual

somebody no longer needs this entry (usually after calling reference()) return false iff the idle entry should be destroyed

Implements Store::Controlled.

Definition at line 552 of file Disks.cc.

References Store::Disk::dereference(), and StoreEntry::disk().

◆ Dir()

SwapDir & Store::Disks::Dir ( int const  idx)
staticprivate

Definition at line 183 of file Disks.cc.

References SwapDirByIndex().

◆ Dump()

void Store::Disks::Dump ( const DiskConfig swap,
StoreEntry entry,
const char *  name 
)
static

Definition at line 469 of file Disks.cc.

References Store::DiskConfig::n_configured, and storeAppendPrintf().

Referenced by dump_cachedir().

◆ evictCached()

void Store::Disks::evictCached ( StoreEntry e)
overridevirtual

Prevent new get() calls from returning the matching entry. If the matching entry is unused, it may be removed from the store now. The store entry is matched using either e attachment info or e.key.

Implements Store::Storage.

Definition at line 587 of file Disks.cc.

References StoreEntry::disk(), EBIT_TEST, Store::Storage::evictCached(), StoreEntry::flags, StoreEntry::hasDisk(), KEY_PRIVATE, StoreEntry::publicKey(), storeDirSwapLog(), and SWAP_LOG_DEL.

◆ evictIfFound()

void Store::Disks::evictIfFound ( const cache_key )
overridevirtual

An evictCached() equivalent for callers that did not get() a StoreEntry. Callers with StoreEntry objects must use evictCached() instead.

Implements Store::Storage.

Definition at line 604 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

◆ get()

StoreEntry * Store::Disks::get ( const cache_key )
overridevirtual
Returns
a possibly unlocked/unregistered stored entry with key (or nil) The returned entry might not match the caller's Store ID or method. The caller must abandon()/release() the entry or register it with Root(). This method must not trigger slow I/O operations (e.g., disk swap in).

Implements Store::Controlled.

Definition at line 234 of file Disks.cc.

References SquidConfig::cacheSwap, Config, debugs, Store::DiskConfig::n_configured, and storeKeyText().

◆ getStats()

void Store::Disks::getStats ( StoreInfoStats stats) const
overridevirtual

◆ hasReadableEntry()

bool Store::Disks::hasReadableEntry ( const StoreEntry e) const

Definition at line 665 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

◆ init()

◆ maintain()

void Store::Disks::maintain ( )
overridevirtual

Implements Store::Storage.

Definition at line 565 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

◆ maxObjectSize()

int64_t Store::Disks::maxObjectSize ( ) const
overridevirtual

Implements Store::Storage.

Definition at line 375 of file Disks.cc.

◆ maxSize()

uint64_t Store::Disks::maxSize ( ) const
overridevirtual

The maximum size the store will support in normal use. Inaccuracy is permitted, but may throw estimates for memory etc out of whack.

Implements Store::Storage.

Definition at line 323 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

◆ minSize()

uint64_t Store::Disks::minSize ( ) const
overridevirtual

Implements Store::Storage.

Definition at line 336 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

◆ Parse()

◆ reference()

void Store::Disks::reference ( StoreEntry e)
overridevirtual

Implements Store::Controlled.

Definition at line 546 of file Disks.cc.

References StoreEntry::disk(), and Store::Disk::reference().

◆ SelectSwapDir()

SwapDir * Store::Disks::SelectSwapDir ( const StoreEntry e)
static

Definition at line 659 of file Disks.cc.

References storeDirSelectSwapDir.

Referenced by storeCreate().

◆ SmpAware()

bool Store::Disks::SmpAware ( )
static

Definition at line 646 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

Referenced by Store::Controller::SmpAware().

◆ stat()

void Store::Disks::stat ( StoreEntry e) const
overridevirtual

Output stats to the provided store entry. TODO: make these calls asynchronous

Implements Store::Storage.

Definition at line 533 of file Disks.cc.

References SquidConfig::cacheSwap, Config, Store::DiskConfig::n_configured, and storeAppendPrintf().

◆ store()

SwapDir * Store::Disks::store ( int const  x) const
private

Definition at line 177 of file Disks.cc.

References SwapDirByIndex().

◆ sync()

void Store::Disks::sync ( void  )
overridevirtual

Reimplemented from Store::Storage.

Definition at line 580 of file Disks.cc.

References SquidConfig::cacheSwap, Config, and Store::DiskConfig::n_configured.

◆ updateAnchored()

bool Store::Disks::updateAnchored ( StoreEntry )
overridevirtual

Update a local Transients entry with fresh info from this cache (if any). Return true iff the cache supports Transients entries and the given local Transients entry is now in sync with this storage.

Reimplemented from Store::Controlled.

Definition at line 639 of file Disks.cc.

References StoreEntry::disk(), StoreEntry::hasDisk(), and Store::Controlled::updateAnchored().

◆ updateHeaders()

void Store::Disks::updateHeaders ( StoreEntry )
overridevirtual

Reimplemented from Store::Controlled.

Definition at line 558 of file Disks.cc.

References StoreEntry::disk(), Must, and Store::Controlled::updateHeaders().

Member Data Documentation

◆ largestMaximumObjectSize

int64_t Store::Disks::largestMaximumObjectSize
private

Definition at line 67 of file Disks.h.

◆ largestMinimumObjectSize

int64_t Store::Disks::largestMinimumObjectSize
private

Definition at line 66 of file Disks.h.

◆ secondLargestMaximumObjectSize

int64_t Store::Disks::secondLargestMaximumObjectSize
private

Definition at line 68 of file Disks.h.


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors