#include <StoreMap.h>

Collaboration diagram for Ipc::StoreMap:

Classes
class	Owner
	aggregates anchor and slice owners for Init() caller convenience More...

Public Types
typedef StoreMapFileNos	FileNos

typedef StoreMapAnchor	Anchor

typedef StoreMapAnchors	Anchors

typedef sfileno	AnchorId

typedef StoreMapSlice	Slice

typedef StoreMapSlices	Slices

typedef StoreMapSliceId	SliceId

typedef StoreMapUpdate	Update

Public Member Functions
	StoreMap (const SBuf &aPath)

sfileno	fileNoByKey (const cache_key *const key) const
	computes map entry anchor position for a given entry key More...

int	compareVersions (const sfileno oldFileno, time_t newVersion) const

Anchor *	openForWriting (const cache_key *const key, sfileno &fileno)

Anchor *	openForWritingAt (sfileno fileno, bool overwriteExisting=true)

void	startAppending (const sfileno fileno)
	restrict opened for writing entry to appending operations; allow reads More...

void	closeForWriting (const sfileno fileno)
	successfully finish creating or updating the entry at fileno pos More...

void	switchWritingToReading (const sfileno fileno)
	stop writing (or updating) the locked entry and start reading it More...

void	forgetWritingEntry (const sfileno fileno)

bool	openForUpdating (Update &update, sfileno fileNoHint)
	finds and locks the Update entry for an exclusive metadata update More...

void	closeForUpdating (Update &update)
	makes updated info available to others, unlocks, and cleans up More...

void	abortUpdating (Update &update)
	undoes partial update, unlocks, and cleans up More...

const Anchor *	peekAtReader (const sfileno fileno) const

const Anchor *	peekAtWriter (const sfileno fileno) const

const Anchor &	peekAtEntry (const sfileno fileno) const

bool	freeEntry (const sfileno)

void	freeEntryByKey (const cache_key *const key)

bool	markedForDeletion (const cache_key *const)

bool	hasReadableEntry (const cache_key *const)
	whether the index contains a valid readable entry with the given key More...

const Anchor *	openForReading (const cache_key *const key, sfileno &fileno)
	opens entry (identified by key) for reading, increments read level More...

const Anchor *	openForReadingAt (const sfileno, const cache_key *const)
	opens entry (identified by sfileno) for reading, increments read level More...

void	closeForReading (const sfileno fileno)
	closes open entry after reading, decrements read level More...

void	closeForReadingAndFreeIdle (const sfileno fileno)
	same as closeForReading() but also frees the entry if it is unlocked More...

const Anchor *	openOrCreateForReading (const cache_key *, sfileno &)
	openForReading() but creates a new entry if there is no old one More...

Slice &	writeableSlice (const AnchorId anchorId, const SliceId sliceId)
	writeable slice within an entry chain created by openForWriting() More...

const Slice &	readableSlice (const AnchorId anchorId, const SliceId sliceId) const
	readable slice within an entry chain opened by openForReading() More...

Anchor &	writeableEntry (const AnchorId anchorId)
	writeable anchor for the entry created by openForWriting() More...

const Anchor &	readableEntry (const AnchorId anchorId) const
	readable anchor for the entry created by openForReading() More...

void	prepFreeSlice (const SliceId sliceId)
	prepare a chain-unaffiliated slice for being added to an entry chain More...

SliceId	sliceContaining (const sfileno fileno, const uint64_t nth) const

void	abortWriting (const sfileno fileno)
	stop writing the entry, freeing its slot for others to use if possible More...

bool	purgeOne ()
	either finds and frees an entry with at least 1 slice or returns false More...

bool	validateHit (const sfileno)

void	disableHitValidation ()

void	importSlice (const SliceId sliceId, const Slice &slice)
	copies slice to its designated position More...

bool	validEntry (const int n) const
	whether n is a valid slice coordinate More...

bool	validSlice (const int n) const
	whether n is a valid slice coordinate More...

int	entryCount () const
	number of writeable and readable entries More...

int	entryLimit () const
	maximum entryCount() possible More...

int	sliceLimit () const
	maximum number of slices possible More...

void	updateStats (ReadWriteLockStats &stats) const
	adds approximate current stats to the supplied ones More...

Static Public Member Functions
static Owner *	Init (const SBuf &path, const int slotLimit)
	initialize shared memory More...

Public Attributes
StoreMapCleaner *	cleaner
	notified before a readable entry is freed More...

Protected Attributes
const SBuf	path
	cache_dir path or similar cache name; for logging More...

Mem::Pointer< StoreMapFileNos >	fileNos
	entry inodes (starting blocks) More...

Mem::Pointer< StoreMapAnchors >	anchors
	entry inodes (starting blocks) More...

Mem::Pointer< StoreMapSlices >	slices
	chained entry pieces positions More...

Private Types
typedef std::function< bool(const sfileno name)>	NameFilter

Private Member Functions
sfileno	nameByKey (const cache_key *const key) const
	computes entry name (i.e., key hash) for a given entry key More...

sfileno	fileNoByName (const sfileno name) const
	computes anchor position for a given entry name More...

void	relocate (const sfileno name, const sfileno fileno)
	map `name` to `fileNo` More...

Anchor &	anchorAt (const sfileno fileno)

const Anchor &	anchorAt (const sfileno fileno) const

Anchor &	anchorByKey (const cache_key *const key)

Slice &	sliceAt (const SliceId sliceId)

const Slice &	sliceAt (const SliceId sliceId) const

Anchor *	openForReading (Slice &s)

bool	openKeyless (Update::Edition &edition)

void	closeForUpdateFinal (Update &update)

bool	visitVictims (const NameFilter filter)

void	freeChain (const sfileno fileno, Anchor &inode, const bool keepLock)
	unconditionally frees an already locked chain of slots, unlocking if needed More...

void	freeChainAt (SliceId sliceId, const SliceId splicingPoint)
	unconditionally frees an already locked chain of slots; no anchor maintenance More...

Private Attributes
bool	hitValidation
	whether paranoid_hit_validation should be performed More...

Detailed Description

Manages shared Store index (e.g., locking/unlocking/freeing entries) using StoreMapFileNos indexed by hashed entry keys (a.k.a. entry names), StoreMapAnchors indexed by fileno, and StoreMapSlices indexed by slice ID.

Definition at line 218 of file StoreMap.h.

Member Typedef Documentation

◆ Anchor

typedef StoreMapAnchor Ipc::StoreMap::Anchor

Definition at line 222 of file StoreMap.h.

◆ AnchorId

typedef sfileno Ipc::StoreMap::AnchorId

Definition at line 224 of file StoreMap.h.

◆ Anchors

typedef StoreMapAnchors Ipc::StoreMap::Anchors

Definition at line 223 of file StoreMap.h.

◆ FileNos

typedef StoreMapFileNos Ipc::StoreMap::FileNos

Definition at line 221 of file StoreMap.h.

◆ NameFilter

typedef std::function<bool (const sfileno name)> Ipc::StoreMap::NameFilter

private

Definition at line 386 of file StoreMap.h.

◆ Slice

typedef StoreMapSlice Ipc::StoreMap::Slice

Definition at line 225 of file StoreMap.h.

◆ SliceId

typedef StoreMapSliceId Ipc::StoreMap::SliceId

Definition at line 227 of file StoreMap.h.

◆ Slices

typedef StoreMapSlices Ipc::StoreMap::Slices

Definition at line 226 of file StoreMap.h.

◆ Update

typedef StoreMapUpdate Ipc::StoreMap::Update

Definition at line 228 of file StoreMap.h.

Constructor & Destructor Documentation

◆ StoreMap()

Ipc::StoreMap::StoreMap ( const SBuf & aPath )

Definition at line 55 of file StoreMap.cc.

References anchors, assert, debugs, entryLimit(), fileNos, path, sliceLimit(), and slices.

Member Function Documentation

◆ abortUpdating()

void Ipc::StoreMap::abortUpdating ( Update & update )

Definition at line 269 of file StoreMap.cc.

References Ipc::StoreMapUpdate::Edition::anchor, Ipc::AssertFlagIsSet(), debugs, Ipc::StoreMapUpdate::Edition::fileNo, Ipc::StoreMapUpdate::fresh, Ipc::StoreMapAnchor::lock, Ipc::StoreMapUpdate::stale, Ipc::ReadWriteLock::unlockHeaders(), and Ipc::ReadWriteLock::updating.

Referenced by MemStore::updateHeaders().

◆ abortWriting()

void Ipc::StoreMap::abortWriting ( const sfileno fileno )

Definition at line 252 of file StoreMap.cc.

References Ipc::ReadWriteLock::appending, assert, debugs, Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::stopAppendingAndRestoreExclusive(), Ipc::ReadWriteLock::unlockExclusive(), Ipc::StoreMapAnchor::waitingToBeFreed, Ipc::StoreMapAnchor::writerHalted, and Ipc::StoreMapAnchor::writing().

Referenced by MemStore::disconnect().

◆ anchorAt() [1/2]

Ipc::StoreMap::Anchor & Ipc::StoreMap::anchorAt ( const sfileno fileno )

private

Definition at line 871 of file StoreMap.cc.

References assert.

Referenced by anchorAt().

◆ anchorAt() [2/2]

const Ipc::StoreMap::Anchor & Ipc::StoreMap::anchorAt ( const sfileno fileno ) const

private

Definition at line 878 of file StoreMap.cc.

References anchorAt().

◆ anchorByKey()

Ipc::StoreMap::Anchor & Ipc::StoreMap::anchorByKey ( const cache_key *const key )

private

Definition at line 919 of file StoreMap.cc.

◆ closeForReading()

void Ipc::StoreMap::closeForReading ( const sfileno fileno )

Definition at line 497 of file StoreMap.cc.

References assert, debugs, Ipc::StoreMapAnchor::lock, Ipc::StoreMapAnchor::reading(), and Ipc::ReadWriteLock::unlockShared().

Referenced by MemStore::disconnect().

◆ closeForReadingAndFreeIdle()

void Ipc::StoreMap::closeForReadingAndFreeIdle ( const sfileno fileno )

Definition at line 506 of file StoreMap.cc.

References assert, and debugs.

Referenced by Transients::disconnect(), and Transients::get().

◆ closeForUpdateFinal()

void Ipc::StoreMap::closeForUpdateFinal ( Update & update )

private

◆ closeForUpdating()

void Ipc::StoreMap::closeForUpdating ( Update & update )

◆ closeForWriting()

void Ipc::StoreMap::closeForWriting ( const sfileno fileno )

Definition at line 201 of file StoreMap.cc.

References assert, debugs, Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::unlockExclusive(), and Ipc::StoreMapAnchor::writing().

Referenced by MemStore::completeWriting(), and Transients::disconnect().

◆ compareVersions()

int Ipc::StoreMap::compareVersions	(	const sfileno	oldFileno,
		time_t	newVersion
	)		const

Like strcmp(mapped, new), but for store entry versions/timestamps. Returns +2 if the mapped entry does not exist; -1/0/+1 otherwise. Comparison may be inaccurate unless the caller is a lock holder.

Definition at line 69 of file StoreMap.cc.

References Ipc::StoreMapAnchor::basics, Ipc::StoreMapAnchor::empty(), and Ipc::StoreMapAnchor::Basics::timestamp.

◆ disableHitValidation()

void Ipc::StoreMap::disableHitValidation ( )

inline

Definition at line 346 of file StoreMap.h.

References hitValidation.

Referenced by Transients::init().

◆ entryCount()

int Ipc::StoreMap::entryCount ( ) const

Definition at line 739 of file StoreMap.cc.

Referenced by MemStore::currentCount(), Transients::currentCount(), and MemStore::reserveSapForWriting().

◆ entryLimit()

int Ipc::StoreMap::entryLimit ( ) const

Definition at line 733 of file StoreMap.cc.

References min(), and SwapFilenMax.

Referenced by MemStore::stat(), Transients::stat(), and StoreMap().

◆ fileNoByKey()

sfileno Ipc::StoreMap::fileNoByKey ( const cache_key *const key ) const

Definition at line 912 of file StoreMap.cc.

Referenced by Transients::evictIfFound().

◆ fileNoByName()

sfileno Ipc::StoreMap::fileNoByName ( const sfileno name ) const

private

Definition at line 894 of file StoreMap.cc.

◆ forgetWritingEntry()

void Ipc::StoreMap::forgetWritingEntry ( const sfileno fileno )

unlock and "forget" openForWriting entry, making it Empty again this call does not free entry slices so the caller has to do that

Definition at line 85 of file StoreMap.cc.

References assert, debugs, Ipc::StoreMapAnchor::lock, Ipc::StoreMapAnchor::rewind(), Ipc::ReadWriteLock::unlockExclusive(), and Ipc::StoreMapAnchor::writing().

◆ freeChain()

void Ipc::StoreMap::freeChain	(	const sfileno	fileno,
		Anchor &	inode,
		const bool	keepLock
	)

private

Definition at line 375 of file StoreMap.cc.

References debugs, Ipc::StoreMapAnchor::empty(), Ipc::StoreMapAnchor::lock, Ipc::StoreMapAnchor::rewind(), Ipc::StoreMapAnchor::splicingPoint, Ipc::StoreMapAnchor::start, and Ipc::ReadWriteLock::unlockExclusive().

◆ freeChainAt()

void Ipc::StoreMap::freeChainAt	(	SliceId	sliceId,
		const SliceId	splicingPoint
	)

private

Definition at line 391 of file StoreMap.cc.

References Ipc::StoreMapSlice::clear(), debugs, and Ipc::StoreMapSlice::next.

◆ freeEntry()

bool Ipc::StoreMap::freeEntry ( const sfileno fileno )

free the entry if possible or mark it as waiting to be freed if not

Returns: whether the entry was neither empty nor marked

Definition at line 313 of file StoreMap.cc.

References debugs, Ipc::StoreMapAnchor::empty(), Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::lockExclusive(), and Ipc::StoreMapAnchor::waitingToBeFreed.

Referenced by MemStore::evictCached(), Transients::evictCached(), Transients::evictIfFound(), and MemStore::get().

◆ freeEntryByKey()

void Ipc::StoreMap::freeEntryByKey ( const cache_key *const key )

free the entry if possible or mark it as waiting to be freed if not does nothing if we cannot check that the key matches the cached entry

Definition at line 331 of file StoreMap.cc.

References debugs, Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::lockExclusive(), Ipc::ReadWriteLock::lockShared(), Ipc::StoreMapAnchor::sameKey(), storeKeyText(), Ipc::ReadWriteLock::unlockExclusive(), Ipc::ReadWriteLock::unlockShared(), and Ipc::StoreMapAnchor::waitingToBeFreed.

Referenced by MemStore::evictIfFound().

◆ hasReadableEntry()

bool Ipc::StoreMap::hasReadableEntry ( const cache_key * const key )

Definition at line 363 of file StoreMap.cc.

◆ importSlice()

void Ipc::StoreMap::importSlice	(	const SliceId	sliceId,
		const Slice &	slice
	)

Definition at line 722 of file StoreMap.cc.

References assert.

◆ Init()

Ipc::StoreMap::Owner * Ipc::StoreMap::Init	(	const SBuf &	path,
		const int	slotLimit
	)

static

Definition at line 43 of file StoreMap.cc.

References Ipc::StoreMap::Owner::anchors, assert, SBuf::c_str(), debugs, Ipc::StoreMap::Owner::fileNos, min(), path, shm_new, sliceLimit(), Ipc::StoreMap::Owner::slices, StoreMapAnchorsId(), StoreMapFileNosId(), StoreMapSlicesId(), and SwapFilenMax.

Referenced by TransientsRr::create(), and MemStoreRr::create().

◆ markedForDeletion()

bool Ipc::StoreMap::markedForDeletion ( const cache_key * const key )

whether the entry with the given key exists and was marked as "waiting to be freed" some time ago

Definition at line 355 of file StoreMap.cc.

References Ipc::StoreMapAnchor::sameKey(), and Ipc::StoreMapAnchor::waitingToBeFreed.

Referenced by Transients::markedForDeletion().

◆ nameByKey()

sfileno Ipc::StoreMap::nameByKey ( const cache_key *const key ) const

private

Definition at line 884 of file StoreMap.cc.

References assert, and hash.

◆ openForReading() [1/2]

const Ipc::StoreMap::Anchor * Ipc::StoreMap::openForReading	(	const cache_key *const	key,
		sfileno &	fileno
	)

Definition at line 440 of file StoreMap.cc.

References debugs, and storeKeyText().

Referenced by MemStore::anchorToCache(), MemStore::get(), and Transients::get().

◆ openForReading() [2/2]

Anchor* Ipc::StoreMap::openForReading ( Slice & s )

private

◆ openForReadingAt()

const Ipc::StoreMap::Anchor * Ipc::StoreMap::openForReadingAt	(	const sfileno	fileno,
		const cache_key * const	key
	)

Definition at line 453 of file StoreMap.cc.

References Config, debugs, Ipc::StoreMapAnchor::empty(), Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::lockShared(), SquidConfig::paranoid_hit_validation, Ipc::StoreMapAnchor::sameKey(), Ipc::ReadWriteLock::unlockShared(), and Ipc::StoreMapAnchor::waitingToBeFreed.

◆ openForUpdating()

bool Ipc::StoreMap::openForUpdating	(	Update &	update,
		sfileno	fileNoHint
	)

Definition at line 523 of file StoreMap.cc.

References Ipc::StoreMapUpdate::Edition::anchor, debugs, Ipc::StoreMapUpdate::entry, Ipc::StoreMapUpdate::Edition::fileNo, Ipc::StoreMapUpdate::fresh, hash_link::key, Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::lockHeaders(), Must, Ipc::StoreMapUpdate::Edition::name, Ipc::StoreMapAnchor::set(), Ipc::StoreMapUpdate::stale, storeKeyText(), and Ipc::StoreMapAnchor::writing().

Referenced by MemStore::updateHeaders().

◆ openForWriting()

Ipc::StoreMap::Anchor * Ipc::StoreMap::openForWriting	(	const cache_key *const	key,
		sfileno &	fileno
	)

finds, locks, and returns an anchor for an empty key position, erasing the old entry (if any)

Definition at line 141 of file StoreMap.cc.

References debugs, and storeKeyText().

Referenced by Transients::addWriterEntry(), and MemStore::startCaching().

◆ openForWritingAt()

Ipc::StoreMap::Anchor * Ipc::StoreMap::openForWritingAt	(	sfileno	fileno,
		bool	overwriteExisting = `true`
	)

locks and returns an anchor for the empty fileno position; if overwriteExisting is false and the position is not empty, returns nil

Definition at line 156 of file StoreMap.cc.

References assert, debugs, Ipc::StoreMapAnchor::empty(), Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::lockExclusive(), Ipc::StoreMapAnchor::reading(), Ipc::StoreMapAnchor::splicingPoint, Ipc::StoreMapAnchor::start, Ipc::ReadWriteLock::unlockExclusive(), Ipc::StoreMapAnchor::waitingToBeFreed, and Ipc::StoreMapAnchor::writing().

◆ openKeyless()

bool Ipc::StoreMap::openKeyless ( Update::Edition & edition )

private

finds an anchor that is currently not associated with any entry key and locks it for writing so ensure exclusive access during updates

Definition at line 587 of file StoreMap.cc.

References Ipc::StoreMapUpdate::Edition::anchor, debugs, Ipc::StoreMapUpdate::Edition::fileNo, Must, and Ipc::StoreMapUpdate::Edition::name.

◆ openOrCreateForReading()

const Ipc::StoreMap::Anchor * Ipc::StoreMap::openOrCreateForReading	(	const cache_key *	key,
		sfileno &	fileno
	)

Definition at line 104 of file StoreMap.cc.

References assert, debugs, and storeKeyText().

Referenced by Transients::addReaderEntry().

◆ peekAtEntry()

const Ipc::StoreMap::Anchor & Ipc::StoreMap::peekAtEntry ( const sfileno fileno ) const

the caller must hold a lock on the entry

Returns: the corresponding Anchor

Definition at line 307 of file StoreMap.cc.

Referenced by Transients::readers().

◆ peekAtReader()

const Ipc::StoreMap::Anchor * Ipc::StoreMap::peekAtReader ( const sfileno fileno ) const

the caller must hold a lock on the entry

Returns: nullptr unless the slice is readable

Definition at line 287 of file StoreMap.cc.

References assert, Ipc::StoreMapAnchor::reading(), and Ipc::StoreMapAnchor::writing().

◆ peekAtWriter()

const Ipc::StoreMap::Anchor * Ipc::StoreMap::peekAtWriter ( const sfileno fileno ) const

the caller must hold a lock on the entry

Returns: nullptr unless the slice is writeable

Definition at line 297 of file StoreMap.cc.

References assert, Ipc::StoreMapAnchor::reading(), and Ipc::StoreMapAnchor::writing().

Referenced by Transients::hasWriter().

◆ prepFreeSlice()

void Ipc::StoreMap::prepFreeSlice ( const SliceId sliceId )

Definition at line 413 of file StoreMap.cc.

References assert.

Referenced by MemStore::reserveSapForWriting().

◆ purgeOne()

bool Ipc::StoreMap::purgeOne ( )

Definition at line 702 of file StoreMap.cc.

References debugs, Ipc::StoreMapAnchor::empty(), Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::lockExclusive(), Ipc::StoreMapAnchor::start, and Ipc::ReadWriteLock::unlockExclusive().

Referenced by MemStore::reserveSapForWriting().

◆ readableEntry()

const Ipc::StoreMap::Anchor & Ipc::StoreMap::readableEntry ( const AnchorId anchorId ) const

Definition at line 245 of file StoreMap.cc.

References assert.

Referenced by Transients::status(), and MemStore::updateAnchored().

◆ readableSlice()

const Ipc::StoreMap::Slice & Ipc::StoreMap::readableSlice	(	const AnchorId	anchorId,
		const SliceId	sliceId
	)		const

Definition at line 230 of file StoreMap.cc.

References assert.

Referenced by MemStore::copyFromShm(), and MemStore::updateHeadersOrThrow().

◆ relocate()

void Ipc::StoreMap::relocate	(	const sfileno	name,
		const sfileno	fileno
	)

private

Definition at line 905 of file StoreMap.cc.

◆ sliceAt() [1/2]

Ipc::StoreMap::Slice & Ipc::StoreMap::sliceAt ( const SliceId sliceId )

private

Definition at line 925 of file StoreMap.cc.

References assert.

Referenced by sliceAt().

◆ sliceAt() [2/2]

const Ipc::StoreMap::Slice & Ipc::StoreMap::sliceAt ( const SliceId sliceId ) const

private

Definition at line 932 of file StoreMap.cc.

References sliceAt().

◆ sliceContaining()

Ipc::StoreMap::SliceId Ipc::StoreMap::sliceContaining	(	const sfileno	fileno,
		const uint64_t	nth
	)		const

Returns the ID of the entry slice containing n-th byte or a negative ID if the entry does not store that many bytes (yet). Requires a read lock.

Definition at line 421 of file StoreMap.cc.

References debugs, Must, Ipc::StoreMapSlice::next, Ipc::StoreMapAnchor::reading(), Ipc::StoreMapSlice::size, and Ipc::StoreMapAnchor::start.

Referenced by MemStore::updateHeadersOrThrow().

◆ sliceLimit()

int Ipc::StoreMap::sliceLimit ( ) const

Definition at line 745 of file StoreMap.cc.

Referenced by Init(), MemStore::stat(), and StoreMap().

◆ startAppending()

void Ipc::StoreMap::startAppending ( const sfileno fileno )

Definition at line 192 of file StoreMap.cc.

References assert, debugs, Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::startAppending(), and Ipc::StoreMapAnchor::writing().

Referenced by Transients::addWriterEntry(), and MemStore::startCaching().

◆ switchWritingToReading()

void Ipc::StoreMap::switchWritingToReading ( const sfileno fileno )

Definition at line 212 of file StoreMap.cc.

References assert, Ipc::StoreMapAnchor::complete(), debugs, Ipc::StoreMapAnchor::lock, Ipc::ReadWriteLock::switchExclusiveToShared(), and Ipc::StoreMapAnchor::writing().

Referenced by Transients::completeWriting().

◆ updateStats()

void Ipc::StoreMap::updateStats ( ReadWriteLockStats & stats ) const

Definition at line 751 of file StoreMap.cc.

Referenced by MemStore::stat().

◆ validateHit()

bool Ipc::StoreMap::validateHit ( const sfileno fileno )

validates locked hit metadata and calls freeEntry() for invalid entries

Returns: whether hit metadata is correct

Definition at line 801 of file StoreMap.cc.

References asHex(), StatCounters::attempts, Config, DBG_IMPORTANT, debugs, ConservativeTimer::expired(), StatCounters::failures, StatCounters::hitValidation, SquidConfig::paranoid_hit_validation, StatCounters::refusalsDueToLocking, StatCounters::refusalsDueToTimeLimit, StatCounters::refusalsDueToZeroSize, statCounter, and storeKeyText().

◆ validEntry()

bool Ipc::StoreMap::validEntry ( const int n ) const

Definition at line 758 of file StoreMap.cc.

◆ validSlice()

bool Ipc::StoreMap::validSlice ( const int n ) const

Definition at line 764 of file StoreMap.cc.

◆ visitVictims()

bool Ipc::StoreMap::visitVictims ( const NameFilter visitor )

private

Visits entries until either

the visitor returns true (indicating its satisfaction with the offer);
we give up finding a suitable entry because it already took "too long"; or
we have offered all entries.

Definition at line 685 of file StoreMap.cc.

References debugs, and min().

◆ writeableEntry()

Ipc::StoreMap::Anchor & Ipc::StoreMap::writeableEntry ( const AnchorId anchorId )

Definition at line 238 of file StoreMap.cc.

References assert.

Referenced by MemStore::copyToShm(), MemStore::nextAppendableSlice(), and Transients::status().

◆ writeableSlice()

Ipc::StoreMap::Slice & Ipc::StoreMap::writeableSlice	(	const AnchorId	anchorId,
		const SliceId	sliceId
	)

Definition at line 222 of file StoreMap.cc.

References assert.

Referenced by MemStore::nextAppendableSlice().

Member Data Documentation

◆ anchors

Mem::Pointer<StoreMapAnchors> Ipc::StoreMap::anchors

protected

Definition at line 366 of file StoreMap.h.

Referenced by StoreMap(), and Ipc::StoreMap::Owner::~Owner().

◆ cleaner

StoreMapCleaner* Ipc::StoreMap::cleaner

Definition at line 361 of file StoreMap.h.

Referenced by MemStore::init(), and Transients::init().

◆ fileNos

Mem::Pointer<StoreMapFileNos> Ipc::StoreMap::fileNos

protected

Definition at line 365 of file StoreMap.h.

Referenced by StoreMap(), and Ipc::StoreMap::Owner::~Owner().

◆ hitValidation

bool Ipc::StoreMap::hitValidation

private

Definition at line 393 of file StoreMap.h.

Referenced by disableHitValidation().

◆ path

const SBuf Ipc::StoreMap::path

protected

Definition at line 364 of file StoreMap.h.

Referenced by Init(), and StoreMap().

◆ slices

Mem::Pointer<StoreMapSlices> Ipc::StoreMap::slices

protected

Definition at line 367 of file StoreMap.h.

Referenced by StoreMap(), and Ipc::StoreMap::Owner::~Owner().

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

src/ipc/StoreMap.h
src/ipc/StoreMap.cc

squid-cache.org

Optimising Web Delivery

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Anchor

◆ AnchorId

◆ Anchors

◆ FileNos

◆ NameFilter

◆ Slice

◆ SliceId

◆ Slices

◆ Update

Constructor & Destructor Documentation

◆ StoreMap()

Member Function Documentation

◆ abortUpdating()

◆ abortWriting()

◆ anchorAt() [1/2]

◆ anchorAt() [2/2]

◆ anchorByKey()

◆ closeForReading()

◆ closeForReadingAndFreeIdle()

◆ closeForUpdateFinal()

◆ closeForUpdating()

◆ closeForWriting()

◆ compareVersions()

◆ disableHitValidation()

◆ entryCount()

◆ entryLimit()

◆ fileNoByKey()

◆ fileNoByName()

◆ forgetWritingEntry()

◆ freeChain()

◆ freeChainAt()

◆ freeEntry()

◆ freeEntryByKey()

◆ hasReadableEntry()

◆ importSlice()

◆ Init()

◆ markedForDeletion()

◆ nameByKey()

◆ openForReading() [1/2]

◆ openForReading() [2/2]

◆ openForReadingAt()

◆ openForUpdating()

◆ openForWriting()

◆ openForWritingAt()

◆ openKeyless()

◆ openOrCreateForReading()

◆ peekAtEntry()

◆ peekAtReader()

◆ peekAtWriter()

◆ prepFreeSlice()

◆ purgeOne()

◆ readableEntry()

◆ readableSlice()

◆ relocate()

◆ sliceAt() [1/2]

◆ sliceAt() [2/2]

◆ sliceContaining()

◆ sliceLimit()

◆ startAppending()

◆ switchWritingToReading()

◆ updateStats()

◆ validateHit()

◆ validEntry()

◆ validSlice()

◆ visitVictims()

◆ writeableEntry()

◆ writeableSlice()