MediaWiki REL1_39
|
Manage locks using redis servers. More...
Public Member Functions | |
__construct (array $config) | |
Construct a new instance from configuration. | |
__destruct () | |
Make sure remaining locks get cleared. | |
Public Member Functions inherited from LockManager | |
lock (array $paths, $type=self::LOCK_EX, $timeout=0) | |
Lock the resources at the given abstract paths. | |
lockByType (array $pathsByType, $timeout=0) | |
Lock the resources at the given abstract paths. | |
unlock (array $paths, $type=self::LOCK_EX) | |
Unlock the resources at the given abstract paths. | |
unlockByType (array $pathsByType) | |
Unlock the resources at the given abstract paths. | |
Protected Member Functions | |
freeLocksOnServer ( $lockSrv, array $pathsByType) | |
Get a connection to a lock server and release locks on $paths. | |
getLocksOnServer ( $lockSrv, array $pathsByType) | |
Get a connection to a lock server and acquire locks. | |
isServerUp ( $lockSrv) | |
Check if a lock server is up. | |
recordKeyForPath ( $path, $type) | |
releaseAllLocks () | |
Release all locks that this session is holding. | |
Protected Member Functions inherited from QuorumLockManager | |
collectPledgeQuorum ( $bucket, callable $callback) | |
Attempt to acquire pledges with the peers for a bucket. | |
doLock (array $paths, $type) | |
Lock resources with the given keys and lock type. | |
doLockByType (array $pathsByType) | |
doLockingRequestBucket ( $bucket, array $pathsByType) | |
Attempt to acquire locks with the peers for a bucket. | |
doUnlock (array $paths, $type) | |
Unlock resources with the given keys and lock type. | |
doUnlockByType (array $pathsByType) | |
doUnlockingRequestBucket ( $bucket, array $pathsByType) | |
Attempt to release locks with the peers for a bucket. | |
getBucketFromPath ( $path) | |
Get the bucket for resource path. | |
releasePledges ( $bucket, callable $callback) | |
Attempt to release pledges with the peers for a bucket. | |
Protected Member Functions inherited from LockManager | |
normalizePathsByType (array $pathsByType) | |
Normalize the $paths array by converting LOCK_UW locks into the appropriate type and removing any duplicated paths for each lock type. | |
sha1Base16Absolute ( $path) | |
Get the base 16 SHA-1 of a string, padded to 31 digits. | |
sha1Base36Absolute ( $path) | |
Get the base 36 SHA-1 of a string, padded to 31 digits. | |
Protected Attributes | |
array | $lockServers = [] |
Map server names to hostname/IP and port numbers. | |
array | $lockTypeMap |
Mapping of lock types to the type actually used. | |
RedisConnectionPool | $redisPool |
Protected Attributes inherited from QuorumLockManager | |
array | $degradedBuckets = [] |
Map of degraded buckets. | |
array | $srvsByBucket = [] |
Map of bucket indexes to peer server lists. | |
Protected Attributes inherited from LockManager | |
$domain | |
array | $locksHeld = [] |
Map of (resource path => lock type => count) | |
$lockTTL | |
array | $lockTypeMap |
Mapping of lock types to the type actually used. | |
LoggerInterface | $logger |
string | $session |
Random 32-char hex number. | |
const | CLI_LOCK_TTL = 3600 |
Default lock TTL in CLI mode. | |
const | MAX_LOCK_TTL = 2 * 3600 |
Max expected lock expiry in any context. | |
const | MIN_GUESSED_LOCK_TTL = 5 * 60 |
The minimum lock TTL if it is guessed from max_execution_time rather than configured. | |
const | MIN_LOCK_TTL = 5 |
Minimum lock TTL. | |
Additional Inherited Members | |
Public Attributes inherited from LockManager | |
const | LOCK_EX = 3 |
const | LOCK_SH = 1 |
Lock types; stronger locks have higher values. | |
const | LOCK_UW = 2 |
Manage locks using redis servers.
Version of LockManager based on using redis servers. This is meant for multi-wiki systems that may share files. All locks are non-blocking, which avoids deadlocks.
All lock requests for a resource, identified by a hash string, will map to one bucket. Each bucket maps to one or several peer servers, each running redis. A majority of peers must agree for a lock to be acquired.
This class requires Redis 2.6 as it makes use of Lua scripts for fast atomic operations.
Definition at line 40 of file RedisLockManager.php.
RedisLockManager::__construct | ( | array | $config | ) |
Construct a new instance from configuration.
array | $config | Parameters include:
|
Exception |
Reimplemented from LockManager.
Definition at line 65 of file RedisLockManager.php.
References RedisConnectionPool\singleton().
RedisLockManager::__destruct | ( | ) |
Make sure remaining locks get cleared.
Definition at line 268 of file RedisLockManager.php.
References $path, $type, and LockManager\unlockByType().
|
protected |
Get a connection to a lock server and release locks on $paths.
Subclasses must effectively implement this or releaseAllLocks().
string | $lockSrv | |
array | $pathsByType | Map of LockManager::LOCK_* constants to lists of paths |
Reimplemented from QuorumLockManager.
Definition at line 174 of file RedisLockManager.php.
References $path, $res, $type, LockManager\LOCK_SH, and recordKeyForPath().
|
protected |
Get a connection to a lock server and acquire locks.
string | $lockSrv | |
array | $pathsByType | Map of LockManager::LOCK_* constants to lists of paths |
Reimplemented from QuorumLockManager.
Definition at line 81 of file RedisLockManager.php.
References $path, $res, $type, LockManager\lock(), LockManager\LOCK_SH, and recordKeyForPath().
|
protected |
Check if a lock server is up.
This should process cache results to reduce RTT.
string | $lockSrv |
Reimplemented from QuorumLockManager.
Definition at line 249 of file RedisLockManager.php.
|
protected |
string | $path | |
string | $type | One of (EX,SH) |
Definition at line 260 of file RedisLockManager.php.
References $path, and LockManager\sha1Base36Absolute().
Referenced by freeLocksOnServer(), and getLocksOnServer().
|
protected |
Release all locks that this session is holding.
Subclasses must effectively implement this or freeLocksOnServer().
Reimplemented from QuorumLockManager.
Definition at line 245 of file RedisLockManager.php.
|
protected |
Map server names to hostname/IP and port numbers.
Definition at line 52 of file RedisLockManager.php.
|
protected |
Mapping of lock types to the type actually used.
Definition at line 42 of file RedisLockManager.php.
|
protected |
Definition at line 49 of file RedisLockManager.php.