#include <Store.h>

Inheritance diagram for StoreEntry:
Collaboration diagram for StoreEntry:

Public Member Functions

bool checkDeferRead (int fd) const
const char * getMD5Text () const
 StoreEntry ()
 ~StoreEntry () override
MemObjectmem ()
const MemObjectmem () const
const HttpReplyhasFreshestReply () const
void write (StoreIOBuffer)
bool isEmpty () const
bool isAccepting () const
size_t bytesWanted (Range< size_t > const aRange, bool ignoreDelayPool=false) const
void completeSuccessfully (const char *whyWeAreSureWeStoredTheWholeReply)
void completeTruncated (const char *whyWeConsiderTheReplyTruncated)
void complete ()
store_client_t storeClientType () const
const char * getSerialisedMetaData (size_t &length) const
void storeErrorResponse (HttpReply *reply)
 Store a prepared error response. MemObject locks the reply object. More...
void replaceHttpReply (const HttpReplyPointer &, const bool andStartWriting=true)
void startWriting ()
bool mayStartSwapOut ()
 whether we may start writing to disk (now or in the future) More...
void trimMemory (const bool preserveSwappable)
void memOutDecision (const bool willCacheInRam)
void swapOutDecision (const MemObject::SwapOut::Decision &decision)
void storeWriterDone ()
 called when a store writer ends its work (successfully or not) More...
void abort ()
bool makePublic (const KeyScope keyScope=ksDefault)
void makePrivate (const bool shareable)
void clearPrivate ()
bool setPublicKey (const KeyScope keyScope=ksDefault)
void clearPublicKeyScope ()
const cache_keypublicKey () const
void setPrivateKey (const bool shareable, const bool permanent)
void expireNow ()
void releaseRequest (const bool shareable=false)
void negativeCache ()
bool cacheNegatively ()
void invokeHandlers ()
void cacheInMemory ()
 start or continue storing in memory cache More...
void swapOut ()
bool swappingOut () const
 whether we are in the process of writing this entry to disk More...
bool swappedOut () const
 whether the entire entry is now on disk (possibly marked for deletion) More...
bool swapoutFailed () const
 whether we failed to write this entry to disk More...
void swapOutFileClose (int how)
const char * url () const
bool checkCachable ()
int checkNegativeHit () const
int locked () const
int validToSend () const
bool memoryCachable ()
 checkCachable() and can be cached in memory More...
void createMemObject ()
void createMemObject (const char *storeId, const char *logUri, const HttpRequestMethod &aMethod)
 initialize mem_obj with URIs/method; assert if mem_obj already exists More...
void ensureMemObject (const char *storeId, const char *logUri, const HttpRequestMethod &aMethod)
 initialize mem_obj (if needed) and set URIs/method (if missing) More...
void dump (int debug_lvl) const
void hashDelete ()
void hashInsert (const cache_key *)
void registerAbortCallback (const AsyncCall::Pointer &)
 notify the StoreEntry writer of a 3rd-party initiated StoreEntry abort More...
void reset ()
void setMemStatus (mem_status_t)
bool timestampsSet ()
void unregisterAbortCallback (const char *reason)
void destroyMemObject ()
int checkTooSmall ()
void setNoDelay (bool const)
void lastModified (const time_t when)
time_t lastModified () const
const char * describeTimestamps () const
bool modifiedSince (const time_t ims, const int imslen=-1) const
bool hasIfMatchEtag (const HttpRequest &request) const
 has ETag matching at least one of the If-Match etags More...
bool hasIfNoneMatchEtag (const HttpRequest &request) const
 has ETag matching at least one of the If-None-Match etags More...
bool hasEtag (ETag &etag) const
 whether this entry has an ETag; if yes, puts ETag value into parameter More...
bool updateOnNotModified (const StoreEntry &e304)
Store::Diskdisk () const
 the disk this entry is [being] cached on; asserts for entries w/o a disk More...
bool hasDisk (const sdirno dirn=-1, const sfileno filen=-1) const
void attachToDisk (const sdirno, const sfileno, const swap_status_t)
void detachFromDisk ()
bool hasTransients () const
 whether there is a corresponding locked transients table entry More...
bool hasMemStore () const
 whether there is a corresponding locked shared memory table entry More...
bool hittingRequiresCollapsing () const
 whether this entry can feed collapsed requests and only them More...
void setCollapsingRequirement (const bool required)
 allow or forbid collapsed requests feeding More...
void * operator new (size_t byteCount)
void operator delete (void *address)
int64_t objectLen () const
int64_t contentLen () const
void lock (const char *context)
int unlock (const char *context)
int locks () const
 returns a local concurrent use counter, for debugging More...
void touch ()
 update last reference timestamp and related Store metadata More...
void release (const bool shareable=false)
void abandon (const char *context)
bool mayStartHitting () const
void deferProducer (const AsyncCall::Pointer &producer)
 call back producer when more buffer space is available More...
void kickProducer ()
 calls back producer registered with deferProducer More...
void append (char const *, int) override
 Appends a c-string to existing packed data. More...
void vappendf (const char *, va_list) override
void buffer () override
void flush () override
void appendf (const char *fmt,...) PRINTF_FORMAT_ARG2
 Append operation with printf-style arguments. More...

Static Public Member Functions

static size_t inUseCount ()

Public Attributes

RemovalPolicyNode repl
time_t timestamp
time_t lastref
time_t expires
uint64_t swap_file_sz
uint16_t refcount
uint16_t flags
sfileno swap_filen:25
 unique ID inside a cache_dir for swapped out entries; -1 for others More...
sdirno swap_dirn:7
mem_status_t mem_status:3
ping_status_t ping_status:3
store_status_t store_status:3
swap_status_t swap_status:3
ESIElement::Pointer cachedESITree
void * key

Protected Types

typedef Store::EntryGuard EntryGuard

Protected Member Functions

void storeWritingCheckpoint ()
void checkDisk () const
 does nothing except throwing if disk-associated data members are inconsistent More...

Private Member Functions

void doAbandon (const char *context)
bool checkTooBig () const
void forcePublicKey (const cache_key *newkey)
StoreEntryadjustVary ()
const cache_keycalcPublicKey (const KeyScope keyScope)
void lengthWentBad (const char *reason)
 flags [truncated or too big] entry with ENTRY_BAD_LENGTH and releases it More...
bool validLength () const
bool hasOneOfEtags (const String &reqETags, const bool allowWeakMatch) const
 whether at least one of the request ETags matches entity ETag More...

Private Attributes

time_t lastModified_
 received Last-Modified value or -1; use lastModified() More...
unsigned short lock_count
bool shareableWhenPrivate
AsyncCall::Pointer deferredProducer
 producer callback registered with deferProducer More...

Static Private Attributes

static Mem::Allocatorpool = nullptr


std::ostream & operator<< (std::ostream &os, const StoreEntry &e)

Detailed Description

Definition at line 41 of file Store.h.

Member Typedef Documentation

◆ EntryGuard

Definition at line 306 of file Store.h.

Constructor & Destructor Documentation

◆ StoreEntry()

StoreEntry::StoreEntry ( )

Definition at line 324 of file store.cc.

◆ ~StoreEntry()

StoreEntry::~StoreEntry ( )

Definition at line 345 of file store.cc.

References debugs.

Member Function Documentation

◆ abandon()

void StoreEntry::abandon ( const char *  context)

One of the three methods to get rid of an unlocked StoreEntry object. May destroy this object if it is unlocked; does nothing otherwise. Unlike release(), may not trigger eviction of underlying store entries, but, unlike destroyStoreEntry(), does honor an earlier release request.

Definition at line 284 of file Store.h.

References doAbandon(), and locked().

Referenced by unlock().

◆ abort()

◆ adjustVary()

StoreEntry * StoreEntry::adjustVary ( )

Updates mem_obj->request->vary_headers to reflect the current Vary. The vary_headers field is used to calculate the Vary marker key. Releases the old Vary marker with an outdated key (if any).

new (locked) Vary marker StoreEntry or, if none was needed, nil
std::exceptionon failures

Definition at line 651 of file store.cc.

References assert, SBuf::clear(), SBuf::cmp(), completeSuccessfully(), HttpRequest::flags, MemObject::freshestReply(), RefCount< C >::getRaw(), Http::HDR_X_ACCELERATOR_VARY, Http::Message::header, httpMakeVaryMark(), SBuf::isEmpty(), MemObject::logUri(), makePublic(), mem_obj, HttpRequest::method, MemObject::method, HttpHeader::putStr(), replaceHttpReply(), MemObject::request, Http::scOkay, HttpReply::setHeaders(), squid_curtime, startWriting(), storeCreateEntry(), storeGetPublic(), MemObject::storeId(), TexcHere, timestampsSet(), unlock(), Http::VARY, HttpRequest::vary_headers, and MemObject::vary_headers.

Referenced by setPublicKey().

◆ append()

◆ appendf()

void Packable::appendf ( const char *  fmt,

Definition at line 61 of file Packable.h.

References Packable::vappendf().

Referenced by Ftp::Server::acceptDataConnection(), aclParseAccessLine(), aclParseAclList(), Format::Format::assemble(), HttpStateData::buildRequestPrefix(), clientPackRangeHdr(), clientPackTermBound(), ErrorState::compileLegacyCode(), ErrorState::Dump(), EventScheduler::dump(), dump_cachemgrpasswd(), store_client::dumpStats(), Adaptation::Icap::ModXact::encapsulateHead(), Adaptation::Icap::Xaction::fillDoneStatus(), Adaptation::Icap::ModXact::fillDoneStatus(), Adaptation::Icap::Xaction::fillPendingStatus(), Adaptation::Icap::ModXact::fillPendingStatus(), HttpStateData::getMoreRequestBody(), Ftp::Server::handleEpsvReply(), Ftp::Server::handlePasvReply(), helperDispatch(), httpHdrContRangePackInto(), httpHdrRangeRespSpecPackInto(), internalRemoteUri(), Adaptation::Icap::ModXact::makeAllowHeader(), Adaptation::Icap::OptXact::makeRequest(), Adaptation::Icap::ModXact::makeRequestHeaders(), Adaptation::Icap::ModXact::makeUsernameHeader(), memBufReport(), munge_menu_line(), munge_other_line(), Adaptation::Icap::ModXact::openChunk(), HttpRequest::pack(), Http::Stream::packChunk(), HttpRequest::packFirstLineInto(), Http::StatusLine::packInto(), HttpHdrCc::packInto(), HttpHdrScTarget::packInto(), HttpHdrRangeSpec::packInto(), Helper::Client::packStatsInto(), Acl::AllOf::parse(), Ftp::PrintReply(), Ftp::Client::sendEprt(), Ftp::Client::sendPassive(), ExternalACLLookup::Start(), Ident::Start(), MemObject::stat(), statStoreEntry(), AsyncJob::status(), BodyPipe::status(), Adaptation::Ecap::XactionRep::status(), Adaptation::Icap::ServiceRep::status(), Adaptation::Icap::Xaction::status(), Http::Tunneler::status(), Comm::TcpAcceptor::status(), Ipc::Inquirer::status(), Security::PeerConnector::status(), wordlistCat(), Ftp::Server::writeCustomReply(), Ftp::Server::writeEarlyReply(), Ftp::Server::writeErrorReply(), and Http::Tunneler::writeRequest().

◆ attachToDisk()

void StoreEntry::attachToDisk ( const sdirno  dirn,
const sfileno  fno,
const swap_status_t  status 

Makes hasDisk(dirn, filn) true. The caller should have locked the corresponding disk store entry for reading or writing.

Definition at line 1926 of file store.cc.

References checkDisk(), debugs, getMD5Text(), swap_dirn, swap_filen, swap_status, and swapStatusStr.

Referenced by Fs::Ufs::UFSSwapDir::addDiskRestore(), Rock::SwapDir::anchorEntry(), and storeSwapOutStart().

◆ buffer()

void StoreEntry::buffer ( )

◆ bytesWanted()

size_t StoreEntry::bytesWanted ( Range< size_t > const  aRange,
bool  ignoreDelayPool = false 
) const

◆ cacheInMemory()

void StoreEntry::cacheInMemory ( )

◆ cacheNegatively()

bool StoreEntry::cacheNegatively ( )

Definition at line 187 of file store.cc.

References makePublic(), and negativeCache().

Referenced by HttpStateData::haveParsedReplyHeaders().

◆ calcPublicKey()

const cache_key * StoreEntry::calcPublicKey ( const KeyScope  keyScope)

Calculates correct public key for feeding forcePublicKey(). Assumes adjustVary() has been called for this entry already.

Definition at line 638 of file store.cc.

References assert, RefCount< C >::getRaw(), mem_obj, MemObject::method, MemObject::request, MemObject::storeId(), storeKeyPublic(), and storeKeyPublicByRequest().

Referenced by clearPublicKeyScope(), and setPublicKey().

◆ checkCachable()

◆ checkDeferRead()

bool StoreEntry::checkDeferRead ( int  fd) const

Definition at line 230 of file store.cc.

References bytesWanted(), and INT_MAX.

Referenced by statObjects(), and swapOut().

◆ checkDisk()

◆ checkNegativeHit()

int StoreEntry::checkNegativeHit ( ) const

Definition at line 1286 of file store.cc.

References EBIT_TEST, ENTRY_NEGCACHED, expires, flags, squid_curtime, STORE_OK, and store_status.

Referenced by clientReplyContext::cacheHit().

◆ checkTooBig()

bool StoreEntry::checkTooBig ( ) const

◆ checkTooSmall()

◆ clearPrivate()

void StoreEntry::clearPrivate ( )

A low-level method just resetting "private key" flags. To avoid key inconsistency please use forcePublicKey() or similar instead.

Definition at line 179 of file store.cc.

References assert, EBIT_CLR, EBIT_TEST, flags, KEY_PRIVATE, RELEASE_REQUEST, and shareableWhenPrivate.

Referenced by forcePublicKey().

◆ clearPublicKeyScope()

void StoreEntry::clearPublicKeyScope ( )

Resets existing public key to a public key with default scope, releasing the old default-scope entry (if any). Does nothing if the existing public key already has default scope.

Definition at line 595 of file store.cc.

References calcPublicKey(), EBIT_TEST, flags, forcePublicKey(), hash_link::key, KEY_PRIVATE, ksDefault, and storeKeyHashCmp.

Referenced by clientReplyContext::sendClientUpstreamResponse().

◆ complete()

◆ completeSuccessfully()

void StoreEntry::completeSuccessfully ( const char *  whyWeAreSureWeStoredTheWholeReply)

Signals that the entire response has been stored and no more append() calls should be expected; cf. completeTruncated().

Definition at line 1003 of file store.cc.

References complete(), and debugs.

Referenced by adjustVary(), FwdState::completed(), ClientHttpRequest::endRequestSatisfaction(), and storeErrorResponse().

◆ completeTruncated()

void StoreEntry::completeTruncated ( const char *  whyWeConsiderTheReplyTruncated)

Signals that a partial response (if any) has been stored but no more append() calls should be expected; cf. completeSuccessfully().

Definition at line 1010 of file store.cc.

References complete(), and lengthWentBad().

Referenced by FwdState::completed(), and ClientHttpRequest::endRequestSatisfaction().

◆ contentLen()

int64_t StoreEntry::contentLen ( ) const

◆ createMemObject() [1/2]

void StoreEntry::createMemObject ( )

initialize mem_obj; assert if mem_obj already exists avoid this method in favor of createMemObject(trio)!

Definition at line 1561 of file store.cc.

References assert, and mem_obj.

Referenced by MemStore::get(), Transients::get(), Rock::SwapDir::get(), storeCreatePureEntry(), TestStoreController::testMaxSize(), TestStoreHashIndex::testMaxSize(), TestStoreController::testStats(), and TestStoreHashIndex::testStats().

◆ createMemObject() [2/2]

void StoreEntry::createMemObject ( const char *  storeId,
const char *  logUri,
const HttpRequestMethod aMethod 

Definition at line 1568 of file store.cc.

References assert, ensureMemObject(), and mem_obj.

◆ deferProducer()

void StoreEntry::deferProducer ( const AsyncCall::Pointer producer)

◆ describeTimestamps()

const char * StoreEntry::describeTimestamps ( ) const
a formatted string with entry's timestamps

Definition at line 1987 of file store.cc.

References expires, lastModified_, lastref, LOCAL_ARRAY, and timestamp.

Referenced by statStoreEntry(), and timestampsSet().

◆ destroyMemObject()

◆ detachFromDisk()

void StoreEntry::detachFromDisk ( )

Makes hasDisk() false. The caller should have unlocked the corresponding disk store entry.

Definition at line 1940 of file store.cc.

References swap_dirn, swap_filen, swap_status, and SWAPOUT_NONE.

Referenced by Rock::SwapDir::disconnect(), and Fs::Ufs::UFSSwapDir::evictCached().

◆ disk()

◆ doAbandon()

void StoreEntry::doAbandon ( const char *  context)

keep the unlocked StoreEntry object in the local store_table (if needed) or delete it (otherwise)

Definition at line 472 of file store.cc.

References assert, debugs, EBIT_TEST, flags, Store::Controller::handleIdleEntry(), locked(), release(), RELEASE_REQUEST, Store::Root(), STORE_PENDING, store_status, and storePendingNClients().

Referenced by abandon().

◆ dump()

◆ ensureMemObject()

void StoreEntry::ensureMemObject ( const char *  storeId,
const char *  logUri,
const HttpRequestMethod aMethod 

◆ expireNow()

void StoreEntry::expireNow ( )

Definition at line 759 of file store.cc.

References debugs, expires, getMD5Text(), and squid_curtime.

◆ flush()

void StoreEntry::flush ( )

flush any buffered content.

This just clears DELAY_SENDING and Invokes the handlers to begin sending anything that may be buffered.

Reimplemented from Packable.

Reimplemented in CapturingStoreEntry.

Definition at line 1598 of file store.cc.

References DELAY_SENDING, EBIT_CLR, EBIT_TEST, flags, and invokeHandlers().

Referenced by TestRock::addEntry(), Mgr::Action::fillEntry(), MimeIcon::load(), netdbBinaryExchange(), WhoisState::readReply(), startWriting(), statObjects(), storeDigestRewriteResume(), storeErrorResponse(), HttpRequest::swapOut(), and TestUfs::testUfsSearch().

◆ forcePublicKey()

void StoreEntry::forcePublicKey ( const cache_key newkey)

Unconditionally sets public key for this store entry. Releases the old entry with the same public key (if any).

Definition at line 612 of file store.cc.

References assert, clearPrivate(), debugs, hasDisk(), hash_lookup(), hashDelete(), hashInsert(), MemObject::hasUris(), hash_link::key, mem_obj, store_table, storeDirSwapLog(), storeKeyText(), and SWAP_LOG_ADD.

Referenced by clearPublicKeyScope(), and setPublicKey().

◆ getMD5Text()

◆ getSerialisedMetaData()

char const * StoreEntry::getSerialisedMetaData ( size_t length) const
a malloc()ed buffer containing a length-long packed swap header

Definition at line 1736 of file store.cc.

References Store::PackSwapMeta().

Referenced by storeSwapOutStart().

◆ hasDisk()

◆ hasEtag()

bool StoreEntry::hasEtag ( ETag etag) const

Definition at line 1848 of file store.cc.

References Http::ETAG, hasFreshestReply(), and ETag::str.

Referenced by clientReplyContext::processExpired().

◆ hasFreshestReply()

const HttpReply * StoreEntry::hasFreshestReply ( ) const
Return values
*the address of freshest reply (if mem_obj exists)
nullptrwhen mem_obj does not exist
See also

Definition at line 57 of file Store.h.

References MemObject::freshestReply(), and mem_obj.

Referenced by hasEtag(), and refreshCheck().

◆ hashDelete()

void StoreEntry::hashDelete ( )

◆ hashInsert()

void StoreEntry::hashInsert ( const cache_key someKey)

◆ hasIfMatchEtag()

bool StoreEntry::hasIfMatchEtag ( const HttpRequest request) const

◆ hasIfNoneMatchEtag()

◆ hasMemStore()

◆ hasOneOfEtags()

bool StoreEntry::hasOneOfEtags ( const String reqETags,
const bool  allowWeakMatch 
) const

◆ hasTransients()

◆ hittingRequiresCollapsing()

◆ inUseCount()

size_t StoreEntry::inUseCount ( )

◆ invokeHandlers()

◆ isAccepting()

◆ isEmpty()

bool StoreEntry::isEmpty ( ) const

◆ kickProducer()

void StoreEntry::kickProducer ( )

Definition at line 362 of file store.cc.

References deferredProducer, and ScheduleCallHere.

Referenced by store_client::copy(), and storeUnregister().

◆ lastModified() [1/2]

time_t StoreEntry::lastModified ( ) const
entry's 'effective' modification time

Definition at line 178 of file Store.h.

References lastModified_, and timestamp.

Referenced by modifiedSince(), and timestampsSet().

◆ lastModified() [2/2]

◆ lengthWentBad()

void StoreEntry::lengthWentBad ( const char *  reason)

Definition at line 995 of file store.cc.

References debugs, EBIT_SET, ENTRY_BAD_LENGTH, flags, and releaseRequest().

Referenced by complete(), and completeTruncated().

◆ lock()

◆ locked()

◆ locks()

int StoreEntry::locks ( ) const

Definition at line 269 of file Store.h.

References lock_count.

Referenced by statStoreEntry().

◆ makePrivate()

void StoreEntry::makePrivate ( const bool  shareable)

◆ makePublic()

◆ mayStartHitting()

bool StoreEntry::mayStartHitting ( ) const

May the caller commit to treating this [previously locked] entry as a cache hit?

Definition at line 288 of file Store.h.

References EBIT_TEST, flags, KEY_PRIVATE, and shareableWhenPrivate.

Referenced by clientReplyContext::cacheHit(), and clientReplyContext::handleIMSReply().

◆ mayStartSwapOut()

◆ mem() [1/2]

◆ mem() [2/2]

const MemObject & StoreEntry::mem ( ) const

Definition at line 52 of file Store.h.

References assert, and mem_obj.

◆ memoryCachable()

◆ memOutDecision()

void StoreEntry::memOutDecision ( const bool  willCacheInRam)

◆ modifiedSince()

bool StoreEntry::modifiedSince ( const time_t  ims,
const int  imslen = -1 
) const

◆ negativeCache()

void StoreEntry::negativeCache ( )

Set object for negative caching. Preserves any expiry information given by the server. In absence of proper expiry info it will set to expire immediately, or with HTTP-violations enabled the configured negative-TTL is observed

Definition at line 1307 of file store.cc.

References Config, debugs, EBIT_SET, ENTRY_NEGCACHED, expires, flags, SquidConfig::negativeTtl, and squid_curtime.

Referenced by abort(), cacheNegatively(), and storeErrorResponse().

◆ objectLen()

◆ operator delete()

void StoreEntry::operator delete ( void *  address)

Definition at line 160 of file store.cc.

◆ operator new()

void * StoreEntry::operator new ( size_t  byteCount)

Definition at line 148 of file store.cc.

References assert, and memPoolCreate.

◆ publicKey()

const cache_key * StoreEntry::publicKey ( ) const
public key (if the entry has it) or nil (otherwise)

Definition at line 113 of file Store.h.

References EBIT_TEST, flags, hash_link::key, and KEY_PRIVATE.

Referenced by Rock::SwapDir::evictCached(), MemStore::evictCached(), Store::Disks::evictCached(), and Rock::SwapDir::openStoreIO().

◆ registerAbortCallback()

void StoreEntry::registerAbortCallback ( const AsyncCall::Pointer handler)

Definition at line 1467 of file store.cc.

References MemObject::abortCallback, assert, handler(), and mem_obj.

Referenced by Ftp::Relay::Relay(), and FwdState::start().

◆ release()

void StoreEntry::release ( const bool  shareable = false)

One of the three methods to get rid of an unlocked StoreEntry object. Removes all unlocked (and marks for eventual removal all locked) Store entries, including attached and unattached entries that have our key. Also destroys us if we are unlocked or makes us private otherwise.

Definition at line 1132 of file store.cc.

References debugs, destroyStoreEntry(), Store::Controller::evictCached(), getMD5Text(), hasDisk(), LateReleaseStack, lock(), locked(), releaseRequest(), Store::Root(), Store::Controller::store_dirs_rebuilding, STORE_LOG_RELEASE, and storeLog().

Referenced by doAbandon(), Store::Controller::handleIdleEntry(), clientReplyContext::handleIMSReply(), Ftp::Gateway::haveParsedReplyHeaders(), httpMaybeRemovePublic(), Fs::Ufs::UFSSwapDir::maintain(), clientReplyContext::purgeEntry(), Client::setFinalReply(), Store::Controller::syncCollapsed(), and TestRock::testRockSwapOut().

◆ releaseRequest()

◆ replaceHttpReply()

◆ reset()

void StoreEntry::reset ( )

◆ setCollapsingRequirement()

void StoreEntry::setCollapsingRequirement ( const bool  required)

◆ setMemStatus()

◆ setNoDelay()

void StoreEntry::setNoDelay ( bool const  newValue)

Definition at line 236 of file store.cc.

References mem_obj, and MemObject::setNoDelay().

Referenced by HttpStateData::HttpStateData().

◆ setPrivateKey()

void StoreEntry::setPrivateKey ( const bool  shareable,
const bool  permanent 

Either fills this entry with private key or changes the existing key from public to private.

permanentwhether this entry should be private forever.

Definition at line 534 of file store.cc.

References assert, debugs, EBIT_SET, EBIT_TEST, Store::Controller::evictCached(), flags, getKeyCounter(), hash_lookup(), hashDelete(), hashInsert(), MemObject::hasUris(), MemObject::id, hash_link::key, KEY_PRIVATE, mem_obj, RELEASE_REQUEST, Store::Root(), shareableWhenPrivate, store_table, and storeKeyPrivate().

Referenced by releaseRequest(), and storeCreateEntry().

◆ setPublicKey()

◆ startWriting()

void StoreEntry::startWriting ( )

◆ storeClientType()

◆ storeErrorResponse()

void StoreEntry::storeErrorResponse ( HttpReply reply)

◆ storeWriterDone()

void StoreEntry::storeWriterDone ( )

◆ storeWritingCheckpoint()

void StoreEntry::storeWritingCheckpoint ( )

If needed, signal transient entry readers that no more cache changes are expected and, hence, they should switch to Plan B instead of getting stuck waiting for us to start or finish storing the entry.

Definition at line 1747 of file store.cc.

References assert, debugs, MemObject::SwapOut::decision, hasTransients(), MemObject::MemCache::io, Store::ioDone, mem_obj, MemObject::memCache, Store::Controller::noteStoppedSharedWriting(), Store::Root(), MemObject::swapout, swappingOut(), MemObject::SwapOut::swImpossible, and MemObject::SwapOut::swStarted.

Referenced by memOutDecision(), storeWriterDone(), and swapOutDecision().

◆ swapOut()

◆ swapOutDecision()

void StoreEntry::swapOutDecision ( const MemObject::SwapOut::Decision decision)

◆ swapoutFailed()

bool StoreEntry::swapoutFailed ( ) const

◆ swapOutFileClose()

void StoreEntry::swapOutFileClose ( int  how)

◆ swappedOut()

bool StoreEntry::swappedOut ( ) const

◆ swappingOut()

bool StoreEntry::swappingOut ( ) const

◆ timestampsSet()

◆ touch()

void StoreEntry::touch ( )

Definition at line 438 of file store.cc.

References lastref, and squid_curtime.

◆ trimMemory()

void StoreEntry::trimMemory ( const bool  preserveSwappable)

◆ unlock()

◆ unregisterAbortCallback()

void StoreEntry::unregisterAbortCallback ( const char *  reason)

Avoid notifying anybody about a 3rd-party initiated StoreEntry abort. Calling this method does not cancel the already queued notification. TODO: Refactor to represent the end of (shared) ownership by our writer.

Definition at line 1475 of file store.cc.

References MemObject::abortCallback, assert, AsyncCall::cancel(), and mem_obj.

Referenced by FwdState::~FwdState().

◆ updateOnNotModified()

bool StoreEntry::updateOnNotModified ( const StoreEntry e304)

Updates easily-accessible non-Store-specific parts of the entry. Use Controller::updateOnNotModified() instead of this helper.

whether anything was actually updated

Definition at line 1438 of file store.cc.

References MemObject::appliedUpdates, assert, MemObject::baseReply(), Config, debugs, MemObject::freshestReply(), Here, SquidConfig::maxReplyHeaderSize, mem_obj, HttpReply::recreateOnNotModified(), timestampsSet(), ToSBuf(), and MemObject::updateReply().

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

◆ url()

◆ validLength()

bool StoreEntry::validLength ( ) const

whether the base response has all the body bytes we expect

true for responses with unknown/unspecified body length
true for responses with the right number of accumulated body bytes

Definition at line 1190 of file store.cc.

References assert, MemObject::baseReply(), debugs, getMD5Text(), mem_obj, MemObject::method, Http::METHOD_HEAD, objectLen(), Http::scNoContent, and Http::scNotModified.

Referenced by complete().

◆ validToSend()

int StoreEntry::validToSend ( ) const

◆ vappendf()

void StoreEntry::vappendf ( const char *  fmt,
va_list  ap 

Append operation, with vsprintf(3)-style arguments.

arguments may be evaluated more than once, be careful of side-effects

XXX: This method either should not exist or should not be virtual. Kids should not be forced to re-implement vappendf() logic. That logic should be implemented once, using other [Packable] APIs. Packable is not about providing a printf(3) service. Packable is about writing opaque data to various custom destinations.

Implements Packable.

Definition at line 807 of file store.cc.

References append(), assert, fatal(), LOCAL_ARRAY, and xstrerr().

Referenced by storeAppendPrintf(), and storeAppendVPrintf().

◆ write()

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const StoreEntry e 

Definition at line 2031 of file store.cc.

Member Data Documentation

◆ cachedESITree

ESIElement::Pointer StoreEntry::cachedESITree

◆ deferredProducer

AsyncCall::Pointer StoreEntry::deferredProducer

Definition at line 335 of file Store.h.

Referenced by deferProducer(), and kickProducer().

◆ expires

◆ flags

uint16_t StoreEntry::flags

Definition at line 232 of file Store.h.

Referenced by abort(), Fs::Ufs::UFSSwapDir::addDiskRestore(), addedEntry(), Store::Controller::addWriting(), Rock::SwapDir::anchorEntry(), MemStore::anchorEntry(), asHandleReply(), buffer(), clientReplyContext::buildReplyHeader(), clientReplyContext::cacheHit(), Store::Disk::canLog(), Store::Disk::canStore(), checkCachable(), checkDisk(), checkNegativeHit(), CheckQuickAbortIsReasonable(), Store::CheckSwapMetaKey(), checkTooSmall(), Store::Controller::checkTransients(), clearPrivate(), clearPublicKeyScope(), complete(), FwdState::completed(), store_client::copy(), MemStore::copyToShm(), Store::Controller::dereferenceIdle(), FwdState::dispatch(), doAbandon(), dummy_action(), errorAppendEntry(), clientReplyContext::errorInStream(), Store::Disks::evictCached(), Ipc::StoreMapAnchor::exportInto(), flush(), Store::Controller::handleIdleEntry(), clientReplyContext::handleIMSReply(), Http::One::Server::handleReply(), HttpStateData::haveParsedReplyHeaders(), heap_add(), hittingRequiresCollapsing(), httpMaybeRemovePublic(), invokeHandlers(), isAccepting(), lengthWentBad(), MimeIcon::load(), Fs::Ufs::UFSSwapDir::logEntry(), makePublic(), FwdState::markStoredReplyAsWhole(), mayStartHitting(), mayStartSwapOut(), negativeCache(), neighborsHtcpReply(), neighborsUdpAck(), netdbExchangeHandleReply(), peerDigestFetchedEnough(), peerDigestRequest(), peerSelectIcpPing(), clientReplyContext::processExpired(), clientReplyContext::processMiss(), HttpStateData::processReply(), HttpStateData::processReplyBody(), publicKey(), HttpStateData::readReply(), Fs::Ufs::RebuildState::rebuildFromDirectory(), Store::Controller::referenceBusy(), FwdState::reforward(), refreshCheck(), releaseRequest(), clientReplyContext::replyStatus(), HttpStateData::reusableReply(), clientReplyContext::sendClientOldEntry(), clientReplyContext::sendClientUpstreamResponse(), Client::sentRequestBody(), Ipc::StoreMapAnchor::set(), setCollapsingRequirement(), Client::setFinalReply(), setMemStatus(), setPrivateKey(), setPublicKey(), MemStore::shouldCache(), statObjects(), storeCleanup(), storeClientType(), storeCreatePureEntry(), storeDigestAddable(), storeDigestDel(), storeDigestRewriteResume(), storeDirSwapLog(), storeEntryFlags(), storeRebuildParseEntry(), storeSwapInStart(), swapOut(), Store::Controller::syncCollapsed(), TestCacheManager::testRegister(), trimMemory(), Store::UnpackIndexSwapMeta(), Store::Controller::updateOnNotModified(), urnHandleReply(), validToSend(), UFSCleanLog::write(), and write().

◆ key

◆ lastModified_

time_t StoreEntry::lastModified_

Definition at line 228 of file Store.h.

Referenced by describeTimestamps(), dump(), lastModified(), reset(), and timestampsSet().

◆ lastref

◆ lock_count

unsigned short StoreEntry::lock_count

Definition at line 324 of file Store.h.

Referenced by dump(), lock(), locked(), locks(), and unlock().

◆ mem_obj

MemObject* StoreEntry::mem_obj

Definition at line 221 of file Store.h.

Referenced by abort(), Store::Disks::accumulateMore(), Transients::addEntry(), Transients::addReaderEntry(), Transients::addWriterEntry(), adjustVary(), MemStore::anchorEntry(), append(), CollapsedForwarding::Broadcast(), bytesWanted(), clientReplyContext::cacheHit(), calcPublicKey(), checkCachable(), CheckQuickAbortIsReasonable(), checkTooBig(), checkTooSmall(), FwdState::complete(), complete(), FwdState::completed(), Transients::completeWriting(), MemStore::completeWriting(), store_client::copy(), MemStore::copyFromShm(), MemStore::copyFromShmSlice(), MemStore::copyToShm(), MemStore::copyToShmSlice(), createMemObject(), Store::Controller::dereferenceIdle(), destroyMemObject(), Transients::disconnect(), MemStore::disconnect(), Rock::SwapDir::disconnect(), store_client::doCopy(), doPages(), dump(), ensureMemObject(), errorAppendEntry(), FwdState::establishTunnelThruProxy(), MemStore::evictCached(), Transients::evictCached(), store_client::fileRead(), Rock::SwapDir::finalizeSwapoutSuccess(), findPreviouslyCachedEntry(), forcePublicKey(), Transients::get(), store_client::handleBodyFromDisk(), Store::Controller::handleIdleEntry(), hasFreshestReply(), hasMemStore(), hasTransients(), Transients::hasWriter(), HttpStateData::haveParsedReplyHeaders(), heap_guessType(), HeapKeyGen_StoreEntry_GDSF(), HeapKeyGen_StoreEntry_LFUDA(), HeapKeyGen_StoreEntry_LRU(), httpMaybeRemovePublic(), invokeHandlers(), Transients::isReader(), Transients::isWriter(), Store::Controller::keepForLocalMemoryCache(), MimeIcon::load(), store_client::maybeWriteFromDiskToMemory(), mayStartSwapOut(), mem(), memoryCachable(), memOutDecision(), Transients::monitorIo(), neighborsHtcpReply(), neighborsUdpAck(), neighborsUdpPing(), objectSizeForDirSelection(), peerCountHandleIcpReply(), peerCountMcastPeersAbort(), peerCountMcastPeersCreateAndSend(), peerDigestFetchReply(), peerDigestFetchSetStats(), peerDigestSwapInCBlock(), Transients::readers(), store_client::readFromMemory(), store_client::readHeader(), HttpStateData::readReply(), Store::Controller::referenceBusy(), FwdState::reforward(), refreshCheck(), refreshCheckDigest(), refreshIsCachable(), registerAbortCallback(), repl_guessType(), replaceHttpReply(), setMemStatus(), setNoDelay(), HeapPolicyData::setPolicyNode(), LruPolicyData::setPolicyNode(), setPrivateKey(), setPublicKey(), MemStore::shouldCache(), store_client::skipHttpHeadersFromDisk(), FwdState::Start(), MemStore::startCaching(), startWriting(), statObjectsOpenfdFilter(), statObjectsVmFilter(), statStoreEntry(), Transients::status(), storeClientListAdd(), storeClientType(), storeDigestRewriteFinish(), storeDigestRewriteStart(), storeLog(), clientReplyContext::storeNotOKTransferDone(), storePendingNClients(), storeSwapInStart(), storeSwapOutFileClosed(), storeSwapOutStart(), storeUnregister(), storeWritingCheckpoint(), swapOut(), swapOutDecision(), swapOutFileClose(), Store::Controller::syncCollapsed(), TestRock::testRockSwapOut(), timestampsSet(), trimMemory(), unregisterAbortCallback(), MemStore::updateAnchored(), MemStore::updateHeaders(), updateOnNotModified(), Store::Controller::updateOnNotModified(), url(), validLength(), validToSend(), varyEvaluateMatch(), MemStore::write(), write(), and HttpStateData::wroteLast().

◆ mem_status

◆ next

◆ ping_status

◆ pool

Mem::Allocator * StoreEntry::pool = nullptr

Definition at line 322 of file Store.h.

Referenced by inUseCount().

◆ refcount

◆ repl

◆ shareableWhenPrivate

bool StoreEntry::shareableWhenPrivate

Nobody can find/lock KEY_PRIVATE entries, but some transactions (e.g., collapsed requests) find/lock a public entry before it becomes private. May such transactions start using the now-private entry they previously locked? This member should not affect transactions that already started reading from the entry.

Definition at line 331 of file Store.h.

Referenced by clearPrivate(), mayStartHitting(), releaseRequest(), and setPrivateKey().

◆ store_status

◆ swap_dirn

◆ swap_file_sz

◆ swap_filen

◆ swap_status

◆ timestamp

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






Web Site Translations