MediaWiki  master
RedisBagOStuff Class Reference

Redis-based caching module for redis server >= 2.6.12 and phpredis >= 2.2.4. More...

Inheritance diagram for RedisBagOStuff:
Collaboration diagram for RedisBagOStuff:

Public Member Functions

 __construct ( $params)
 Construct a RedisBagOStuff object. More...
 
 decr ( $key, $value=1, $flags=0)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 doChangeTTLMulti (array $keys, $exptime, $flags=0)
 
 incr ( $key, $value=1, $flags=0)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 logRequest ( $op, $keys, $server, $e=null)
 Send information about a single request to the debug log. More...
 
 makeKeyInternal ( $keyspace, $components)
 Make a cache key for the given keyspace and components. More...
 
- Public Member Functions inherited from MediumSpecificBagOStuff
 __construct (array $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 a key if it exists. More...
 
 changeTTLMulti (array $keys, $exptime, $flags=0)
 Change the expiration of multiple keys that exist. More...
 
 delete ( $key, $flags=0)
 Delete an item. More...
 
 deleteMulti (array $keys, $flags=0)
 Batch deletion. 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 with the given key. More...
 
 getMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items. More...
 
 getQoS ( $flag)
 
 getSegmentationSize ()
 
 getSegmentedValueMaxSize ()
 
 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='')
 
 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...
 
 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...
 
 setMulti (array $valueByKey, $exptime=0, $flags=0)
 Batch insertion/replace. More...
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 
- Public Member Functions inherited from BagOStuff
 clearLastError ()
 Clear the "last error" registry. More...
 
 getCurrentTime ()
 
 getLastError ( $watchPoint=0)
 Get the "last error" registry. More...
 
 getLogger ()
 
 getScopedLock ( $key, $timeout=6, $exptime=30, $rclass='')
 Get a lightweight exclusive self-unlocking lock. More...
 
 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)
 
 setMockTime (&$time)
 
 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...
 
 doAdd ( $key, $value, $exptime=0, $flags=0)
 Insert an item if it does not already exist. More...
 
 doChangeTTL ( $key, $exptime, $flags)
 
 doDelete ( $key, $flags=0)
 Delete an item. More...
 
 doDeleteMulti (array $keys, $flags=0)
 
 doGet ( $key, $flags=0, &$casToken=null)
 Get an item. More...
 
 doGetMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items. More...
 
 doIncrWithInit ( $key, $exptime, $step, $init, $flags)
 
 doSet ( $key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 doSetMulti (array $data, $exptime=0, $flags=0)
 
 getConnection ( $key)
 
 handleException (RedisConnRef $conn, RedisException $e)
 The redis extension throws an exception in response to various read, write and protocol errors. More...
 
 logError ( $msg)
 Log a fatal error. More...
 
- Protected Member Functions inherited from MediumSpecificBagOStuff
 cas ( $casToken, $key, $value, $exptime=0, $flags=0)
 Set an item if the current CAS token matches the provided CAS token. More...
 
 debug ( $text)
 
 doCas ( $casToken, $key, $value, $exptime=0, $flags=0)
 Set an item if the current CAS token matches the provided CAS token. More...
 
 doLock ( $key, $timeout, $exptime)
 
 doUnlock ( $key)
 
 getExpirationAsTimestamp ( $exptime)
 Convert an optionally relative timestamp to an absolute time. More...
 
 getExpirationAsTTL ( $exptime)
 Convert an optionally absolute expiry time to a relative time. More...
 
 getSerialized ( $value, $key)
 Get the serialized form a value, logging a warning if it involves custom classes. More...
 
 isInteger ( $value)
 Check if a value is an integer. More...
 
 isRelativeExpiration ( $exptime)
 
 makeLockKey ( $key)
 
 makeValueOrSegmentList ( $key, $value, $exptime, $flags, &$ok)
 Make the entry to store at a key (inline or segment list), storing any segments. More...
 
 mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags)
 
 resolveSegments ( $key, $mainValue)
 Get and reassemble the chunks of blob at the given key. More...
 
 serialize ( $value)
 
 tokensMatch ( $value, $otherValue)
 
 unserialize ( $value)
 
 updateOpStats (string $op, array $keyInfo)
 
- 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

bool $automaticFailover
 
RedisConnectionPool $redisPool
 
array $servers
 List of server names. More...
 
array $serverTagMap
 Map of (tag => server name) More...
 
- Protected Attributes inherited from MediumSpecificBagOStuff
array< string, array > $locks = []
 Map of (key => (class LOCK_* constant => value) More...
 
float $maxLockSendDelay = 0.05
 Seconds; maximum expected seconds for a lock ping to reach the backend. More...
 
int $segmentationSize
 Bytes; chunk size of segmented cache values. More...
 
int $segmentedValueMaxSize
 Bytes; maximum total size of a segmented cache value. More...
 
const LOCK_DEPTH = 1
 
const LOCK_EXPIRY = 3
 
const LOCK_RCLASS = 0
 
const LOCK_TIME = 2
 
const METRIC_OP_ADD = 'add'
 
const METRIC_OP_CAS = 'cas'
 
const METRIC_OP_CHANGE_TTL = 'change_ttl'
 
const METRIC_OP_DECR = 'decr'
 
const METRIC_OP_DELETE = 'delete'
 
const METRIC_OP_GET = 'get'
 
const METRIC_OP_INCR = 'incr'
 
const METRIC_OP_SET = 'set'
 
const PASS_BY_REF = -1
 Idiom for doGet() to return extra information by reference. More...
 
- 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

Redis-based caching module for redis server >= 2.6.12 and phpredis >= 2.2.4.

See also
https://github.com/phpredis/phpredis/blob/d310ed7c8/Changelog.md
Note
Avoid use of Redis::MULTI transactions for twemproxy support

Definition at line 33 of file RedisBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

RedisBagOStuff::__construct (   $params)

Construct a RedisBagOStuff object.

Parameters are:

  • servers: An array of server names. A server name may be a hostname, a hostname/port combination or the absolute path of a UNIX socket. If a hostname is specified but no port, the standard port number 6379 will be used. Arrays keys can be used to specify the tag to hash on in place of the host/port. Required.
  • connectTimeout: The timeout for new connections, in seconds. Optional, default is 1 second.
  • persistent: Set this to true to allow connections to persist across multiple web requests. False by default.
  • password: The authentication password, will be sent to Redis in clear text. Optional, if it is unspecified, no AUTH command will be sent.
  • automaticFailover: If this is false, then each key will be mapped to a single server, and if that server is down, any requests for that key will fail. If this is true, a connection failure will cause the client to immediately try the next server in the list (as determined by a consistent hashing algorithm). True by default. This has the potential to create consistency issues if a server is slow enough to flap, for example if it is in swap death.
    Parameters
    array$params

Definition at line 71 of file RedisBagOStuff.php.

References Wikimedia\LightweightObjectStore\StorageAwareness\ATTR_DURABILITY, Wikimedia\LightweightObjectStore\StorageAwareness\QOS_DURABILITY_DISK, and RedisConnectionPool\singleton().

Member Function Documentation

◆ convertGenericKey()

RedisBagOStuff::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 MediumSpecificBagOStuff.

Definition at line 628 of file RedisBagOStuff.php.

◆ decr()

RedisBagOStuff::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 457 of file RedisBagOStuff.php.

References getConnection(), handleException(), logRequest(), and MediumSpecificBagOStuff\updateOpStats().

◆ doAdd()

RedisBagOStuff::doAdd (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
protected

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 405 of file RedisBagOStuff.php.

References $serialized, getConnection(), MediumSpecificBagOStuff\getExpirationAsTTL(), MediumSpecificBagOStuff\getSerialized(), handleException(), logRequest(), and MediumSpecificBagOStuff\updateOpStats().

◆ doChangeTTL()

RedisBagOStuff::doChangeTTL (   $key,
  $exptime,
  $flags 
)
protected

◆ doChangeTTLMulti()

RedisBagOStuff::doChangeTTLMulti ( array  $keys,
  $exptime,
  $flags = 0 
)
Parameters
string[]$keysList of keys
int$exptimeTTL or UNIX timestamp
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 348 of file RedisBagOStuff.php.

References $keys, getConnection(), MediumSpecificBagOStuff\getExpirationAsTimestamp(), MediumSpecificBagOStuff\getExpirationAsTTL(), handleException(), MediumSpecificBagOStuff\isRelativeExpiration(), logRequest(), and MediumSpecificBagOStuff\updateOpStats().

◆ doDelete()

RedisBagOStuff::doDelete (   $key,
  $flags = 0 
)
protected

Delete an item.

Parameters
string$key
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool True if the item was deleted or not found, false on failure

Reimplemented from MediumSpecificBagOStuff.

Definition at line 156 of file RedisBagOStuff.php.

References getConnection(), handleException(), logRequest(), and MediumSpecificBagOStuff\updateOpStats().

◆ doDeleteMulti()

RedisBagOStuff::doDeleteMulti ( array  $keys,
  $flags = 0 
)
protected
Parameters
string[]$keysList of keys
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 300 of file RedisBagOStuff.php.

References $keys, getConnection(), handleException(), logRequest(), and MediumSpecificBagOStuff\updateOpStats().

◆ doGet()

RedisBagOStuff::doGet (   $key,
  $flags = 0,
$casToken = null 
)
protected

Get an item.

The CAS token should be null if the key does not exist or the value is corrupt

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 92 of file RedisBagOStuff.php.

References $blob, getConnection(), handleException(), logRequest(), MediumSpecificBagOStuff\PASS_BY_REF, MediumSpecificBagOStuff\unserialize(), and MediumSpecificBagOStuff\updateOpStats().

◆ doGetMulti()

RedisBagOStuff::doGetMulti ( array  $keys,
  $flags = 0 
)
protected

Get an associative array containing the item for each of the keys that have items.

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 178 of file RedisBagOStuff.php.

References $blob, $keys, getConnection(), handleException(), logRequest(), MediumSpecificBagOStuff\unserialize(), and MediumSpecificBagOStuff\updateOpStats().

◆ doIncrWithInit()

RedisBagOStuff::doIncrWithInit (   $key,
  $exptime,
  $step,
  $init,
  $flags 
)
protected
Parameters
string$key
int$exptime
int$step
int$init
int$flags
Returns
int|bool New value or false on failure

Reimplemented from MediumSpecificBagOStuff.

Definition at line 481 of file RedisBagOStuff.php.

References getConnection(), MediumSpecificBagOStuff\getExpirationAsTTL(), handleException(), and logRequest().

◆ doSet()

RedisBagOStuff::doSet (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
protected

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 MediumSpecificBagOStuff.

Definition at line 127 of file RedisBagOStuff.php.

References $serialized, getConnection(), MediumSpecificBagOStuff\getExpirationAsTTL(), MediumSpecificBagOStuff\getSerialized(), handleException(), logRequest(), and MediumSpecificBagOStuff\updateOpStats().

◆ doSetMulti()

RedisBagOStuff::doSetMulti ( array  $data,
  $exptime = 0,
  $flags = 0 
)
protected
Parameters
mixed[]$dataMap of (key => value)
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 242 of file RedisBagOStuff.php.

References $serialized, getConnection(), MediumSpecificBagOStuff\getExpirationAsTTL(), MediumSpecificBagOStuff\getSerialized(), handleException(), logRequest(), and MediumSpecificBagOStuff\updateOpStats().

◆ getConnection()

RedisBagOStuff::getConnection (   $key)
protected
Parameters
string$key
Returns
RedisConnRef|Redis|null Redis handle wrapper for the key or null on failure

Definition at line 544 of file RedisBagOStuff.php.

References ArrayUtils\consistentHashSort(), Wikimedia\LightweightObjectStore\StorageAwareness\ERR_UNREACHABLE, and BagOStuff\setLastError().

Referenced by decr(), doAdd(), doChangeTTL(), doChangeTTLMulti(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doIncrWithInit(), doSet(), doSetMulti(), and incr().

◆ handleException()

RedisBagOStuff::handleException ( RedisConnRef  $conn,
RedisException  $e 
)
protected

The redis extension throws an exception in response to various read, write and protocol errors.

Sometimes it also closes the connection, sometimes not. The safest response for us is to explicitly destroy the connection object and let it be reopened during the next request.

Parameters
RedisConnRef$conn
RedisException$e

Definition at line 608 of file RedisBagOStuff.php.

References Wikimedia\LightweightObjectStore\StorageAwareness\ERR_UNEXPECTED, and BagOStuff\setLastError().

Referenced by decr(), doAdd(), doChangeTTL(), doChangeTTLMulti(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doIncrWithInit(), doSet(), doSetMulti(), and incr().

◆ incr()

RedisBagOStuff::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 433 of file RedisBagOStuff.php.

References getConnection(), handleException(), logRequest(), and MediumSpecificBagOStuff\updateOpStats().

◆ logError()

RedisBagOStuff::logError (   $msg)
protected

Log a fatal error.

Parameters
string$msg

Definition at line 596 of file RedisBagOStuff.php.

◆ logRequest()

RedisBagOStuff::logRequest (   $op,
  $keys,
  $server,
  $e = null 
)

Send information about a single request to the debug log.

Parameters
string$op
string$keys
string$server
Exception | bool | null$e

Definition at line 620 of file RedisBagOStuff.php.

References MediumSpecificBagOStuff\debug().

Referenced by decr(), doAdd(), doChangeTTL(), doChangeTTLMulti(), doDelete(), doDeleteMulti(), doGet(), doGetMulti(), doIncrWithInit(), doSet(), doSetMulti(), and incr().

◆ makeKeyInternal()

RedisBagOStuff::makeKeyInternal (   $keyspace,
  $components 
)

Make a cache key for the given keyspace and components.

Long components might be converted to respective hashes due to size constraints. In extreme cases, all of them might be combined into a single hash component.

Parameters
string$keyspaceKeyspace component
string[] | int[]$componentsKey components (key collection name first)
Returns
string Keyspace-prepended list of encoded components as a colon-separated value
Since
1.27

Reimplemented from MediumSpecificBagOStuff.

Definition at line 624 of file RedisBagOStuff.php.

References BagOStuff\$keyspace, and BagOStuff\genericKeyFromComponents().

Member Data Documentation

◆ $automaticFailover

bool RedisBagOStuff::$automaticFailover
protected

Definition at line 41 of file RedisBagOStuff.php.

◆ $redisPool

RedisConnectionPool RedisBagOStuff::$redisPool
protected

Definition at line 35 of file RedisBagOStuff.php.

◆ $servers

array RedisBagOStuff::$servers
protected

List of server names.

Definition at line 37 of file RedisBagOStuff.php.

◆ $serverTagMap

array RedisBagOStuff::$serverTagMap
protected

Map of (tag => server name)

Definition at line 39 of file RedisBagOStuff.php.


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