#include <Controller.h>

Inheritance diagram for Store::Controller:
Collaboration diagram for Store::Controller:

Public Member Functions

 Controller ()
 
virtual ~Controller () override
 
virtual void create () override
 create system resources needed for this store to operate in the future More...
 
virtual void init () 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 maintain () override
 perform regular periodic maintenance; TODO: move to UFSSwapDir::Maintain More...
 
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...
 
virtual bool smpAware () const override
 
StoreEntryfind (const cache_key *)
 
StoreEntrypeek (const cache_key *)
 
StoreEntryfindCallback (const cache_key *)
 
bool markedForDeletion (const cache_key *key) const
 
bool markedForDeletionAndAbandoned (const StoreEntry &) const
 
bool hasReadableDiskEntry (const StoreEntry &) const
 whether there is a disk entry with e.key More...
 
int64_t accumulateMore (StoreEntry &) const
 
void updateLimits ()
 slowly calculate (and cache) hi/lo watermarks and similar limits More...
 
void handleIdleEntry (StoreEntry &)
 called when the entry is no longer needed by any transaction More...
 
void freeMemorySpace (const int spaceRequired)
 
void memoryOut (StoreEntry &, const bool preserveSwappable)
 called to get rid of no longer needed entry data in RAM, if any More...
 
void updateOnNotModified (StoreEntry *old, const StoreEntry &newer)
 update old entry metadata and HTTP headers using a newer entry More...
 
bool allowCollapsing (StoreEntry *, const RequestFlags &, const HttpRequestMethod &)
 tries to make the entry available for collapsing future requests More...
 
void addReading (StoreEntry *, const cache_key *)
 
void addWriting (StoreEntry *, const cache_key *)
 
bool transientsReader (const StoreEntry &) const
 whether the entry is in "reading from Transients" I/O state More...
 
bool transientsWriter (const StoreEntry &) const
 whether the entry is in "writing to Transients" I/O state More...
 
void transientsCompleteWriting (StoreEntry &)
 marks the entry completed for collapsed requests More...
 
void syncCollapsed (const sfileno)
 Update local intransit entry after changes made by appending worker. More...
 
void stopSharing (StoreEntry &)
 stop any current (and prevent any future) SMP sharing of the given entry More...
 
int transientReaders (const StoreEntry &) const
 number of the transient entry readers some time ago More...
 
void transientsDisconnect (StoreEntry &)
 disassociates the entry from the intransit table More...
 
void memoryDisconnect (StoreEntry &)
 disassociates the entry from the memory cache, preserving cached data More...
 
StoreSearchsearch ()
 

Static Public Attributes

static int store_dirs_rebuilding = 1
 the number of cache_dirs being rebuilt; TODO: move to Disks::Rebuilding More...
 

Private Member Functions

bool memoryCacheHasSpaceFor (const int pagesRequired) const
 whether the memory cache is allowed to store that many additional pages More...
 
void referenceBusy (StoreEntry &e)
 update reference counters of the recently touched entry More...
 
bool dereferenceIdle (StoreEntry &, bool wantsLocalMemory)
 dereference() an idle entry and return true if the entry should be deleted More...
 
void allowSharing (StoreEntry &, const cache_key *)
 indexes and adds SMP-tracking for an ephemeral peek() result More...
 
StoreEntrypeekAtLocal (const cache_key *)
 
void memoryEvictCached (StoreEntry &)
 
void transientsUnlinkByKeyIfFound (const cache_key *)
 
bool keepForLocalMemoryCache (StoreEntry &e) const
 whether e should be kept in local RAM for possible future caching More...
 
bool anchorToCache (StoreEntry &e, bool &inSync)
 
void checkTransients (const StoreEntry &) const
 

Private Attributes

DisksswapDir
 summary view of all disk caches More...
 
MemorymemStore
 memory cache More...
 
Transientstransients
 
int memoryPagesDebt_ = 0
 Hack: Relays page shortage from freeMemorySpace() to handleIdleEntry(). More...
 

Detailed Description

Public Store interface. Coordinates the work of memory/disk/transient stores and hides their individual existence/differences from the callers.

Definition at line 22 of file Controller.h.

Constructor & Destructor Documentation

Store::Controller::Controller ( )

Definition at line 36 of file Controller.cc.

References assert, and store_table.

Store::Controller::~Controller ( )
overridevirtual

Definition at line 44 of file Controller.cc.

References destroyStoreEntry, hashFreeItems(), hashFreeMemory(), and store_table.

Member Function Documentation

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

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

Definition at line 432 of file Controller.cc.

Referenced by StoreEntry::mayStartSwapOut().

void Store::Controller::addReading ( StoreEntry e,
const cache_key key 
)

register a being-read StoreEntry (to optimize concurrent cache reads and to receive remote DELETE events)

Definition at line 692 of file Controller.cc.

References StoreEntry::hashInsert(), and Store::ioReading.

void Store::Controller::addWriting ( StoreEntry e,
const cache_key key 
)

register a being-written StoreEntry (to support concurrent cache reads and to receive remote DELETE events)

Definition at line 700 of file Controller.cc.

References assert, EBIT_TEST, ENTRY_SPECIAL, StoreEntry::flags, and Store::ioWriting.

Referenced by StoreEntry::setPublicKey().

bool Store::Controller::allowCollapsing ( StoreEntry e,
const RequestFlags reqFlags,
const HttpRequestMethod reqMethod 
)
void Store::Controller::allowSharing ( StoreEntry entry,
const cache_key key 
)
private

Definition at line 333 of file Controller.cc.

References StoreEntry::hasTransients(), and TexcHere.

bool Store::Controller::anchorToCache ( StoreEntry entry,
bool &  inSync 
)
private

Called for Transients entries that are not yet anchored to a cache. For cached entries, return true after synchronizing them with their cache (making inSync true on success). For not-yet-cached entries, return false.

Definition at line 801 of file Controller.cc.

References assert, debugs, and StoreEntry::hasTransients().

int Store::Controller::callback ( )
overridevirtual

Reimplemented from Store::Storage.

Reimplemented in TestStore.

Definition at line 223 of file Controller.cc.

References PROF_start, and PROF_stop.

Referenced by StoreRootEngine::checkEvents(), and DiskdIOStrategy::SEND().

void Store::Controller::checkTransients ( const StoreEntry e) const
private
void Store::Controller::create ( )
overridevirtual

Implements Store::Storage.

Definition at line 75 of file Controller.cc.

References pid, and WaitForAnyPid().

Referenced by SquidMain().

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

Implements Store::Storage.

Reimplemented in TestStore.

Definition at line 174 of file Controller.cc.

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

Implements Store::Storage.

Reimplemented in TestStore.

Definition at line 167 of file Controller.cc.

Referenced by snmp_prfProtoFn(), snmp_sysFn(), and storeDigestCalcCap().

bool Store::Controller::dereferenceIdle ( StoreEntry e,
bool  wantsLocalMemory 
)
private
void Store::Controller::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 442 of file Controller.cc.

References debugs.

Referenced by StoreEntry::release(), and StoreEntry::setPrivateKey().

void Store::Controller::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 453 of file Controller.cc.

References debugs, and storeKeyText().

Referenced by purgeEntriesByUrl().

StoreEntry * Store::Controller::find ( const cache_key key)
Returns
a locally indexed and SMP-tracked matching StoreEntry (or nil) Slower than peek() but does not restrict StoreEntry use and storage. Counts as an entry reference from the removal policy p.o.v.

Definition at line 312 of file Controller.cc.

References debugs, and NULL.

Referenced by storeGetPublic(), and storeGetPublicByRequestMethod().

StoreEntry * Store::Controller::findCallback ( const cache_key key)
Returns
matching StoreEntry associated with local ICP/HTCP transaction Warning: The returned StoreEntry is not synced and may be marked for deletion. Use it only for extracting transaction callback details. TODO: Group and return just that callback-related data instead?

Definition at line 349 of file Controller.cc.

Referenced by neighborsHtcpReply().

void Store::Controller::freeMemorySpace ( const int  spaceRequired)

Evict memory cache entries to free at least spaceRequired bytes. Should be called via storeGetMemSpace(). Unreliable: Fails if enough victims cannot be found fast enough.

Definition at line 482 of file Controller.cc.

References debugs, hot_obj_count, mem_policy, RemovalPolicy::PurgeInit, SM_PAGE_SIZE, and squid_curtime.

Referenced by storeGetMemSpace().

bool Store::Controller::hasReadableDiskEntry ( const StoreEntry e) const

Definition at line 306 of file Controller.cc.

void Store::Controller::init ( )
overridevirtual

Start preparing the store for use. To check readiness, callers should use readable() and writable() methods.

Implements Store::Storage.

Reimplemented in TestStore.

Definition at line 58 of file Controller.cc.

References SquidConfig::collapsed_forwarding, Config, IamWorkerProcess(), MemStore::init(), Transients::init(), SquidConfig::memShared, SquidConfig::onoff, and UsingSmp().

Referenced by testRock::storeInit(), storeInit(), testStoreHashIndex::testSearch(), testStoreController::testSearch(), and testUfs::testUfsSearch().

void Store::Controller::maintain ( )
overridevirtual

Implements Store::Storage.

Reimplemented in TestStore.

Definition at line 89 of file Controller.cc.

References DBG_CRITICAL, debugs, PROF_start, PROF_stop, Store::Root(), and squid_curtime.

Referenced by Store::Maintain().

bool Store::Controller::markedForDeletion ( const cache_key key) const

Whether a transient entry with the given public key exists and (but) was marked for removal some time ago; get(key) returns nil in such cases.

Definition at line 290 of file Controller.cc.

Referenced by Ipc::StoreMapAnchor::setKey().

bool Store::Controller::markedForDeletionAndAbandoned ( const StoreEntry e) const

markedForDeletion() with no readers this is one method because the two conditions must be checked in the right order

Definition at line 297 of file Controller.cc.

References hash_link::key.

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

Implements Store::Storage.

Reimplemented in TestStore.

Definition at line 181 of file Controller.cc.

Referenced by MemStore::init().

uint64_t Store::Controller::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.

Reimplemented in TestStore.

Definition at line 153 of file Controller.cc.

Referenced by Store::Disks::init(), snmp_confFn(), storeDigestCalcCap(), and testStore::testMaxSize().

bool Store::Controller::memoryCacheHasSpaceFor ( const int  pagesRequired) const
private

Definition at line 473 of file Controller.cc.

References debugs, mem_node::InUseCount(), and store_pages_max.

void Store::Controller::memoryDisconnect ( StoreEntry e)

Definition at line 569 of file Controller.cc.

Referenced by StoreEntry::destroyMemObject().

void Store::Controller::memoryEvictCached ( StoreEntry e)
private

removes the entry from the memory cache XXX: Dangerous side effect: Unlocked entries lose their mem_obj.

Definition at line 558 of file Controller.cc.

References StoreEntry::destroyMemObject(), and StoreEntry::locked().

void Store::Controller::memoryOut ( StoreEntry e,
const bool  preserveSwappable 
)

Definition at line 541 of file Controller.cc.

References debugs, HERE(), and StoreEntry::trimMemory().

Referenced by StoreEntry::swapOut().

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

Implements Store::Storage.

Reimplemented in TestStore.

Definition at line 160 of file Controller.cc.

StoreEntry * Store::Controller::peek ( const cache_key key)
Returns
a matching StoreEntry not suitable for long-term use (or nil) Faster than find() but the returned entry may not receive updates, may lack information from some of the Stores, and should not be updated except that purging peek()ed entries is supported. Does not count as an entry reference from the removal policy p.o.v.

Definition at line 379 of file Controller.cc.

References debugs, HERE(), and storeKeyText().

StoreEntry * Store::Controller::peekAtLocal ( const cache_key key)
private
Returns
either an existing local reusable StoreEntry object or nil To treat remotely marked entries specially, callers ought to check markedForDeletion() first!

Definition at line 363 of file Controller.cc.

References assert, EBIT_TEST, hash_lookup(), KEY_PRIVATE, and store_table.

StoreSearch * Store::Controller::search ( )
bool Store::Controller::smpAware ( ) const
overridevirtual

whether this storage is capable of serving multiple workers; a true result does not imply [lack of] non-SMP support because [only] some SMP-aware storages also support non-SMP configss

Implements Store::Storage.

Definition at line 827 of file Controller.cc.

Referenced by clientReplyContext::processExpired().

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

Output stats to the provided store entry.

Todo:
make these calls asynchronous

Implements Store::Storage.

Reimplemented in TestStore.

Definition at line 131 of file Controller.cc.

References Math::doublePercent(), StoreEntry::inUseCount(), PRIu64, and storeAppendPrintf().

Referenced by Store::Stats().

void Store::Controller::stopSharing ( StoreEntry e)
void Store::Controller::sync ( void  )
overridevirtual

Reimplemented from Store::Storage.

Definition at line 212 of file Controller.cc.

Referenced by SquidShutdown().

int Store::Controller::transientReaders ( const StoreEntry e) const

Definition at line 598 of file Controller.cc.

References StoreEntry::hasTransients().

Referenced by CollapsedForwarding::Broadcast().

void Store::Controller::transientsCompleteWriting ( StoreEntry e)

Definition at line 587 of file Controller.cc.

References StoreEntry::hasTransients().

Referenced by MemStore::completeWriting(), and storeSwapOutFileClosed().

void Store::Controller::transientsDisconnect ( StoreEntry e)

Definition at line 605 of file Controller.cc.

Referenced by StoreEntry::destroyMemObject().

bool Store::Controller::transientsReader ( const StoreEntry e) const

Definition at line 420 of file Controller.cc.

References StoreEntry::hasTransients().

void Store::Controller::transientsUnlinkByKeyIfFound ( const cache_key )
private
bool Store::Controller::transientsWriter ( const StoreEntry e) const

Definition at line 426 of file Controller.cc.

References StoreEntry::hasTransients().

Member Data Documentation

int Store::Controller::memoryPagesDebt_ = 0
private

Definition at line 162 of file Controller.h.

Memory* Store::Controller::memStore
private

Definition at line 154 of file Controller.h.

Disks* Store::Controller::swapDir
private

Definition at line 153 of file Controller.h.

Transients* Store::Controller::transients
private

A shared table of public store entries that do not know whether they will belong to a memory cache, a disk cache, or will be uncachable when the response header comes. Used for SMP collapsed forwarding.

Definition at line 159 of file Controller.h.


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors