MediaWiki master
|
Manage locks using memcached servers. More...
Inherits QuorumLockManager.
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 | |
acquireMutexes (MemcachedBagOStuff $memc, array $keys) | |
freeLocksOnServer ( $lockSrv, array $pathsByType) | |
Get a connection to a lock server and release locks on $paths. | |
getCache ( $lockSrv) | |
Get the MemcachedBagOStuff object for a $lockSrv. | |
getLocksOnServer ( $lockSrv, array $pathsByType) | |
Get a connection to a lock server and acquire locks. | |
isServerUp ( $lockSrv) | |
newLockArray () | |
recordKeyForPath ( $path) | |
releaseAllLocks () | |
releaseMutexes (MemcachedBagOStuff $memc, array $keys) | |
sanitizeLockArray ( $a) | |
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. | |
sha1Base36Absolute ( $path) | |
Get the base 36 SHA-1 of a string, padded to 31 digits. | |
Protected Attributes | |
MemcachedBagOStuff[] | $cacheServers = [] |
Map of (server name => MemcachedBagOStuff) | |
array | $lockTypeMap |
Mapping of lock types to the type actually used. | |
MapCacheLRU | $statusCache |
Server status cache. | |
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 | |
string | $domain |
domain (usually wiki ID) | |
array | $locksHeld = [] |
Map of (resource path => lock type => count) | |
int | $lockTTL |
maximum time locks can be held | |
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 memcached servers.
Version of LockManager based on using memcached 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 memcached. A majority of peers must agree for a lock to be acquired.
Definition at line 39 of file MemcLockManager.php.
MemcLockManager::__construct | ( | array | $config | ) |
Construct a new instance from configuration.
array | $config | Parameters include:
|
Exception |
Reimplemented from LockManager.
Definition at line 65 of file MemcLockManager.php.
References $params.
MemcLockManager::__destruct | ( | ) |
Make sure remaining locks get cleared.
Definition at line 350 of file MemcLockManager.php.
References $path, and LockManager\unlockByType().
|
protected |
MemcachedBagOStuff | $memc | |
array | $keys | List of keys to acquire |
Definition at line 303 of file MemcLockManager.php.
References Wikimedia\ObjectCache\MediumSpecificBagOStuff\add(), and releaseMutexes().
Referenced by freeLocksOnServer(), and getLocksOnServer().
|
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 164 of file MemcLockManager.php.
References LockManager\$locksHeld, $path, acquireMutexes(), getCache(), newLockArray(), recordKeyForPath(), releaseMutexes(), and sanitizeLockArray().
|
protected |
Get the MemcachedBagOStuff object for a $lockSrv.
string | $lockSrv | Server name |
Definition at line 252 of file MemcLockManager.php.
Referenced by freeLocksOnServer(), getLocksOnServer(), and isServerUp().
|
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 92 of file MemcLockManager.php.
References LockManager\$locksHeld, LockManager\$lockTTL, $path, LockManager\$session, acquireMutexes(), getCache(), newLockArray(), recordKeyForPath(), releaseMutexes(), and sanitizeLockArray().
|
protected |
string | $lockSrv |
Reimplemented from QuorumLockManager.
Definition at line 242 of file MemcLockManager.php.
References getCache().
|
protected |
Definition at line 280 of file MemcLockManager.php.
Referenced by freeLocksOnServer(), getLocksOnServer(), and sanitizeLockArray().
|
protected |
string | $path |
Definition at line 273 of file MemcLockManager.php.
References $path, and LockManager\sha1Base36Absolute().
Referenced by freeLocksOnServer(), and getLocksOnServer().
|
protected |
Reimplemented from QuorumLockManager.
Definition at line 233 of file MemcLockManager.php.
|
protected |
MemcachedBagOStuff | $memc | |
array | $keys | List of acquired keys |
Definition at line 341 of file MemcLockManager.php.
References Wikimedia\ObjectCache\MediumSpecificBagOStuff\delete().
Referenced by acquireMutexes(), freeLocksOnServer(), and getLocksOnServer().
|
protected |
array | $a |
Definition at line 288 of file MemcLockManager.php.
References newLockArray().
Referenced by freeLocksOnServer(), and getLocksOnServer().
|
protected |
Map of (server name => MemcachedBagOStuff)
Definition at line 48 of file MemcLockManager.php.
|
protected |
Mapping of lock types to the type actually used.
Definition at line 41 of file MemcLockManager.php.
|
protected |
Server status cache.
Definition at line 50 of file MemcLockManager.php.