MediaWiki  master
CachedBagOStuff Class Reference

Wrapper around a BagOStuff that caches data in memory. More...

Inheritance diagram for CachedBagOStuff:
Collaboration diagram for CachedBagOStuff:

Public Member Functions

 __construct (BagOStuff $backend, $params=[])
 
 add ( $key, $value, $exptime=0, $flags=0)
 Insert an item if it does not already exist. More...
 
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls. More...
 
 changeTTL ( $key, $exptime=0, $flags=0)
 Change the expiration on an item. More...
 
 changeTTLMulti (array $keys, $exptime, $flags=0)
 Change the expiration of multiple items. More...
 
 decr ( $key, $value=1, $flags=0)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 delete ( $key, $flags=0)
 Delete an item if it exists. More...
 
 deleteMulti (array $keys, $flags=0)
 Delete a batch of items. More...
 
 deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF, string $tag=null)
 Delete all objects expiring before a certain date. More...
 
 get ( $key, $flags=0)
 Get an item. More...
 
 getMulti (array $keys, $flags=0)
 Get a batch of items. More...
 
 incr ( $key, $value=1, $flags=0)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 incrWithInit ( $key, $exptime, $step=1, $init=null, $flags=0)
 Increase the value of the given key (no TTL change) if it exists or create it otherwise. More...
 
 lock ( $key, $timeout=6, $exptime=6, $rclass='')
 Acquire an advisory lock on a key string, exclusive to the caller. More...
 
 makeGlobalKey ( $collection,... $components)
 Make a cache key for the default keyspace and given components. More...
 
 makeKey ( $collection,... $components)
 Make a cache key for the global keyspace and given components. More...
 
 makeKeyInternal ( $keyspace, $components)
 
 merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
 Merge changes into the existing cache value (possibly creating a new one) More...
 
 set ( $key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 setMockTime (&$time)
 
 setMulti (array $valueByKey, $exptime=0, $flags=0)
 Set a batch of items. More...
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 
- Public Member Functions inherited from BagOStuff
 __construct (array $params=[])
 
 clearLastError ()
 Clear the "last error" registry. More...
 
 getCurrentTime ()
 
 getLastError ( $watchPoint=0)
 Get the "last error" registry. More...
 
 getLogger ()
 
 getQoS ( $flag)
 
 getScopedLock ( $key, $timeout=6, $exptime=30, $rclass='')
 Get a lightweight exclusive self-unlocking lock. More...
 
 getSegmentationSize ()
 
 getSegmentedValueMaxSize ()
 
 getWithSetCallback ( $key, $exptime, $callback, $flags=0)
 Get an item, regenerating and setting it if not found. More...
 
 isKeyGlobal ( $key)
 Check whether a cache key is in the global keyspace. More...
 
 registerWrapperInfoForStats (string $prefixComponent, string $statsGroup, callable $collectionCallback)
 Register info about a caching layer class that uses BagOStuff as a backing store. More...
 
 setLogger (LoggerInterface $logger)
 
 setNewPreparedValues (array $valueByKey)
 Stage a set of new key values for storage and estimate the amount of bytes needed. More...
 
 watchErrors ()
 Get a "watch point" token that can be used to get the "last error" to occur after now. More...
 

Protected Member Functions

 convertGenericKey ( $key)
 Convert a "generic" reversible cache key into one for this cache. More...
 
- Protected Member Functions inherited from BagOStuff
 componentsFromGenericKey ( $key)
 Extract the components from a "generic" reversible cache key. More...
 
 determineKeyPrefixForStats ( $key)
 
 fieldHasFlags ( $field, $flags)
 
 genericKeyFromComponents (... $components)
 At a minimum, there must be a keyspace and collection name component. More...
 
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More...
 
 proxyCall (string $method, int $arg0Sig, int $resSig, array $genericArgs, BagOStuff $wrapper)
 Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys. More...
 
 setLastError ( $error)
 Set the "last error" registry due to a problem encountered during an attempted operation. More...
 

Protected Attributes

HashBagOStuff $procCache
 
BagOStuff $store
 
- Protected Attributes inherited from BagOStuff
callable null $asyncHandler
 
int[] $attrMap = []
 Map of (BagOStuff:ATTR_* constant => BagOStuff:QOS_* constant) More...
 
string $keyspace
 Default keyspace; used by makeKey() More...
 
int $lastError = self::ERR_NONE
 BagOStuff:ERR_* constant of the last error that occurred. More...
 
int $lastErrorId = 0
 Error event sequence number of the last error that occurred. More...
 
LoggerInterface $logger
 
StatsdDataFactoryInterface $stats
 
array< string, array > $wrapperInfoByPrefix = []
 Cache key processing callbacks and info for metrics. More...
 

Additional Inherited Members

- Public Attributes inherited from BagOStuff
const MAX_CONFLICTS_ONE = 1
 Abort after the first merge conflict. More...
 
const READ_LATEST = 1
 Bitfield constants for get()/getMulti(); these are only advisory. More...
 
const READ_VERIFIED = 2
 Promise that the caller handles detection of staleness. More...
 
const WRITE_ALLOW_SEGMENTS = 16
 Allow partitioning of the value if it is a large string. More...
 
const WRITE_BACKGROUND = 64
 If supported, do not block on write operation completion; instead, treat writes as succesful based on whether they could be buffered. More...
 
const WRITE_CACHE_ONLY = 8
 Bitfield constants for set()/merge(); these are only advisory. More...
 
const WRITE_PRUNE_SEGMENTS = 32
 Delete all the segments if the value is partitioned. More...
 
- Public Attributes inherited from Wikimedia\LightweightObjectStore\StorageAwareness
const ATTR_DURABILITY = 2
 Durability of writes; see QOS_DURABILITY_* (higher means stronger) More...
 
const ATTR_EMULATION = 1
 Emulation/fallback mode; see QOS_EMULATION_*; higher is better. More...
 
const ERR_NO_RESPONSE = 1
 Storage medium failed to yield a complete response to an operation. More...
 
const ERR_NONE = 0
 No storage medium error. More...
 
const ERR_UNEXPECTED = 3
 Storage medium operation failed due to usage limitations or an I/O error. More...
 
const ERR_UNREACHABLE = 2
 Storage medium could not be reached to establish a connection. More...
 
const QOS_DURABILITY_DISK = 4
 Data is saved to disk and writes do not usually block on fsync() More...
 
const QOS_DURABILITY_NONE = 1
 Data is never saved to begin with (blackhole store) More...
 
const QOS_DURABILITY_RDBMS = 5
 Data is saved to disk and writes usually block on fsync(), like a standard RDBMS. More...
 
const QOS_DURABILITY_SCRIPT = 2
 Data is lost at the end of the current web request or CLI script. More...
 
const QOS_DURABILITY_SERVICE = 3
 Data is lost once the service storing the data restarts. More...
 
const QOS_EMULATION_SQL = 1
 Fallback disk-based SQL store. More...
 
const QOS_UNKNOWN = INF
 Generic "unknown" value; useful for comparisons (always "good enough") More...
 
- Static Protected Attributes inherited from BagOStuff
static int $nextErrorMonitorId = 1
 Next sequence number to use for watch/error events. More...
 

Detailed Description

Wrapper around a BagOStuff that caches data in memory.

The differences between CachedBagOStuff and MultiWriteBagOStuff are:

  • CachedBagOStuff supports only one "backend".
  • There's a flag for writes to only go to the in-memory cache.
  • The in-memory cache is always updated.
  • Locks go to the backend cache (with MultiWriteBagOStuff, it would wind up going to the HashBagOStuff used for the in-memory cache).
Stability: newable

Definition at line 37 of file CachedBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

CachedBagOStuff::__construct ( BagOStuff  $backend,
  $params = [] 
)
Stability: stable
to call
Parameters
BagOStuff$backendPermanent backend to use
array$paramsParameters for HashBagOStuff

Definition at line 48 of file CachedBagOStuff.php.

Member Function Documentation

◆ add()

CachedBagOStuff::add (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)

Insert an item if it does not already exist.

Parameters
string$key
mixed$value
int$exptime
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success (item created)

Reimplemented from BagOStuff.

Definition at line 133 of file CachedBagOStuff.php.

◆ addBusyCallback()

CachedBagOStuff::addBusyCallback ( callable  $workCallback)

Let a callback be run to avoid wasting time on special blocking calls.

This is hard-deprecated and non-functional since 1.39. The callback will not be called.

Parameters
callable$workCallback
Since
1.28
Deprecated:
since 1.39

Reimplemented from BagOStuff.

Definition at line 307 of file CachedBagOStuff.php.

◆ changeTTL()

CachedBagOStuff::changeTTL (   $key,
  $exptime = 0,
  $flags = 0 
)

Change the expiration on an item.

If an expiry in the past is given then the key will immediately be expired

For large values written using WRITE_ALLOW_SEGMENTS, this only changes the TTL of the main segment list key. While lowering the TTL of the segment list key has the effect of functionally lowering the TTL of the key, it might leave unused blobs in cache for longer. Raising the TTL of such keys is not effective, since the expiration of a single segment key effectively expires the entire value.

Parameters
string$key
int$exptimeTTL or UNIX timestamp
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success (item found and updated)
Since
1.28

Reimplemented from BagOStuff.

Definition at line 157 of file CachedBagOStuff.php.

◆ changeTTLMulti()

CachedBagOStuff::changeTTLMulti ( array  $keys,
  $exptime,
  $flags = 0 
)

Change the expiration of multiple items.

See also
BagOStuff::changeTTL()
Parameters
string[]$keysList of keys
int$exptimeTTL or UNIX timestamp
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success (all items found and updated)
Since
1.34

Reimplemented from BagOStuff.

Definition at line 255 of file CachedBagOStuff.php.

References $keys, and BagOStuff\fieldHasFlags().

◆ convertGenericKey()

CachedBagOStuff::convertGenericKey (   $key)
protected

Convert a "generic" reversible cache key into one for this cache.

See also
BagOStuff::genericKeyFromComponents()
Parameters
string$keyKeyspace-prepended list of encoded components as a colon-separated value
Returns
string Keyspace-prepended list of encoded components as a colon-separated value

Reimplemented from BagOStuff.

Definition at line 218 of file CachedBagOStuff.php.

◆ decr()

CachedBagOStuff::decr (   $key,
  $value = 1,
  $flags = 0 
)

Decrease stored value of $key by $value while preserving its TTL.

Parameters
string$key
int$valueValue to subtract from $key (default: 1) [optional]
int$flagsBit field of class WRITE_* constants [optional]
Returns
int|bool New value or false on failure
Deprecated:
Since 1.38

Reimplemented from BagOStuff.

Definition at line 283 of file CachedBagOStuff.php.

◆ delete()

CachedBagOStuff::delete (   $key,
  $flags = 0 
)

Delete an item if it exists.

For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment list key has the effect of functionally deleting the key, it leaves unused blobs in cache.

Parameters
string$key
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success (item deleted or not found)

Reimplemented from BagOStuff.

Definition at line 117 of file CachedBagOStuff.php.

References BagOStuff\fieldHasFlags().

◆ deleteMulti()

CachedBagOStuff::deleteMulti ( array  $keys,
  $flags = 0 
)

Delete a batch of items.

This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O

WRITE_BACKGROUND can be used for bulk deletion where the response is not vital

Parameters
string[]$keysList of keys
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success (items deleted and/or not found)
Since
1.33

Reimplemented from BagOStuff.

Definition at line 239 of file CachedBagOStuff.php.

References $keys, and BagOStuff\fieldHasFlags().

◆ deleteObjectsExpiringBefore()

CachedBagOStuff::deleteObjectsExpiringBefore (   $timestamp,
callable  $progress = null,
  $limit = INF,
string  $tag = null 
)

Delete all objects expiring before a certain date.

Parameters
string | int$timestampThe reference date in MW or TS_UNIX format
callable | null$progressOptional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter. [optional]
int | float$limitMaximum number of keys to delete [default: INF]
string | null$tagTag to purge a single shard only. This is only supported when server tags are used in configuration.
Returns
bool Success; false if unimplemented

Reimplemented from BagOStuff.

Definition at line 189 of file CachedBagOStuff.php.

◆ get()

CachedBagOStuff::get (   $key,
  $flags = 0 
)

Get an item.

If the key includes a deterministic input hash (e.g. the key can only have the correct value) or complete staleness checks are handled by the caller (e.g. nothing relies on the TTL), then the READ_VERIFIED flag should be set. This lets tiered backends know they can safely upgrade a cached value to higher tiers using standard TTLs.

Parameters
string$key
int$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure or if the item does not exist

Reimplemented from BagOStuff.

Definition at line 58 of file CachedBagOStuff.php.

References BagOStuff\get(), and BagOStuff\WRITE_CACHE_ONLY.

Referenced by MediaWiki\Session\SessionBackend\__construct().

◆ getMulti()

CachedBagOStuff::getMulti ( array  $keys,
  $flags = 0 
)

Get a batch of items.

Parameters
string[]$keysList of keys
int$flagsBitfield; supports READ_LATEST [optional]
Returns
mixed[] Map of (key => value) for existing keys

Reimplemented from BagOStuff.

Definition at line 76 of file CachedBagOStuff.php.

References $keys, and setMulti().

◆ incr()

CachedBagOStuff::incr (   $key,
  $value = 1,
  $flags = 0 
)

Increase stored value of $key by $value while preserving its TTL.

Parameters
string$keyKey to increase
int$valueValue to add to $key (default: 1) [optional]
int$flagsBit field of class WRITE_* constants [optional]
Returns
int|bool New value or false on failure
Deprecated:
Since 1.38

Reimplemented from BagOStuff.

Definition at line 271 of file CachedBagOStuff.php.

◆ incrWithInit()

CachedBagOStuff::incrWithInit (   $key,
  $exptime,
  $step = 1,
  $init = null,
  $flags = 0 
)

Increase the value of the given key (no TTL change) if it exists or create it otherwise.

This will create the key with the value $init and TTL $exptime instead if not present. Callers should make sure that both ($init - $step) and $exptime are invariants for all operations to any given key. The value of $init should be at least that of $step.

The new value is returned, except if the WRITE_BACKGROUND flag is given, in which case the handler may choose to return true to indicate that the operation has been dispatched.

Parameters
string$keyKey built via makeKey() or makeGlobalKey()
int$exptimeTime-to-live (in seconds) or a UNIX timestamp expiration
int$stepAmount to increase the key value by [default: 1]
int | null$initValue to initialize the key to if it does not exist [default: $step]
int$flagsBit field of class WRITE_* constants [optional]
Returns
int|bool New value (or true if asynchronous) on success; false on failure
Since
1.24

Reimplemented from BagOStuff.

Definition at line 295 of file CachedBagOStuff.php.

◆ lock()

CachedBagOStuff::lock (   $key,
  $timeout = 6,
  $exptime = 6,
  $rclass = '' 
)

Acquire an advisory lock on a key string, exclusive to the caller.

Parameters
string$key
int$timeoutLock wait timeout; 0 for non-blocking [optional]
int$exptimeLock time-to-live in seconds; 1 day maximum [optional]
string$rclassIf this thread already holds the lock, and the lock was acquired using the same value for this parameter, then return true and use reference counting so that only the unlock() call from the outermost lock() caller actually releases the lock (note that only the outermost time-to-live is used) [optional]
Returns
bool Success

Reimplemented from BagOStuff.

Definition at line 169 of file CachedBagOStuff.php.

◆ makeGlobalKey()

CachedBagOStuff::makeGlobalKey (   $collection,
  $components 
)

Make a cache key for the default keyspace and given components.

See also
IStoreKeyEncoder::makeGlobalKey()
Parameters
string$collectionKey collection name component
string|int...$components Additional, ordered, key components for entity IDs
Returns
string Colon-separated, keyspace-prepended, ordered list of encoded components
Since
1.27

Reimplemented from BagOStuff.

Definition at line 214 of file CachedBagOStuff.php.

References BagOStuff\genericKeyFromComponents().

◆ makeKey()

CachedBagOStuff::makeKey (   $collection,
  $components 
)

Make a cache key for the global keyspace and given components.

See also
IStoreKeyEncoder::makeKey()
Parameters
string$collectionKey collection name component
string|int...$components Additional, ordered, key components for entity IDs
Returns
string Colon-separated, keyspace-prepended, ordered list of encoded components
Since
1.27

Reimplemented from BagOStuff.

Definition at line 210 of file CachedBagOStuff.php.

References BagOStuff\genericKeyFromComponents().

Referenced by MediaWiki\Session\SessionBackend\__construct().

◆ makeKeyInternal()

CachedBagOStuff::makeKeyInternal (   $keyspace,
  $components 
)

◆ merge()

CachedBagOStuff::merge (   $key,
callable  $callback,
  $exptime = 0,
  $attempts = 10,
  $flags = 0 
)

Merge changes into the existing cache value (possibly creating a new one)

The callback function returns the new value given the current value (which will be false if not present), and takes the arguments: (this BagOStuff, cache key, current value, TTL). The TTL parameter is reference set to $exptime. It can be overridden in the callback. Nothing is stored nor deleted if the callback returns false.

Parameters
string$key
callable$callbackCallback method to be executed
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$attemptsThe amount of times to attempt a merge in case of failure
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success
Exceptions
InvalidArgumentException

Reimplemented from BagOStuff.

Definition at line 145 of file CachedBagOStuff.php.

◆ set()

CachedBagOStuff::set (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)

Set an item.

Parameters
string$key
mixed$value
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Reimplemented from BagOStuff.

Definition at line 101 of file CachedBagOStuff.php.

References BagOStuff\fieldHasFlags().

◆ setMockTime()

CachedBagOStuff::setMockTime ( $time)
Access: internal
For testing only
Parameters
float | null&$timeMock UNIX timestamp

Reimplemented from BagOStuff.

Definition at line 311 of file CachedBagOStuff.php.

◆ setMulti()

CachedBagOStuff::setMulti ( array  $valueByKey,
  $exptime = 0,
  $flags = 0 
)

Set a batch of items.

This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O

WRITE_BACKGROUND can be used for bulk insertion where the response is not vital

Parameters
mixed[]$valueByKeyMap of (key => value)
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success
Since
1.24

Reimplemented from BagOStuff.

Definition at line 223 of file CachedBagOStuff.php.

References BagOStuff\fieldHasFlags().

Referenced by getMulti().

◆ unlock()

CachedBagOStuff::unlock (   $key)

Release an advisory lock on a key string.

Parameters
string$key
Returns
bool Success

Reimplemented from BagOStuff.

Definition at line 179 of file CachedBagOStuff.php.

Member Data Documentation

◆ $procCache

HashBagOStuff CachedBagOStuff::$procCache
protected

Definition at line 41 of file CachedBagOStuff.php.

◆ $store

BagOStuff CachedBagOStuff::$store
protected

Definition at line 39 of file CachedBagOStuff.php.


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