MediaWiki REL1_40
|
Version of PoolCounter that uses Redis. More...
Inherits PoolCounter.
Public Member Functions | |
__construct ( $conf, $type, $key) | |
acquireForAnyone ( $timeout=null) | |
I want to do this task, but if anyone else does it instead, it's also fine for me. | |
acquireForMe ( $timeout=null) | |
I want to do this task and I need to do it myself. | |
release () | |
I have successfully finished my task. | |
Public Member Functions inherited from PoolCounter | |
__construct (array $conf, string $type, string $key) | |
getKey () | |
isFastStaleEnabled () | |
Is fast stale mode (T250248) enabled? This may be overridden by the PoolCounterWork subclass. | |
Static Public Member Functions | |
static | releaseAll () |
Try to make sure that locks get released (even with exceptions and fatals) | |
Protected Member Functions | |
getConnection () | |
getSlotListKey () | |
getSlotRTimeSetKey () | |
getWaitSetKey () | |
getWakeupListKey () | |
initAndPopPoolSlotList (RedisConnRef $conn, $now) | |
registerAcquisitionTime (RedisConnRef $conn, $slot, $now) | |
waitForSlotOrNotif ( $doWakeup, $timeout=null) | |
Protected Member Functions inherited from PoolCounter | |
hashKeyIntoSlots ( $type, $key, $slots) | |
Given a key (any string) and the number of lots, returns a slot key (a prefix with a suffix integer from the [0..($slots-1)] range). | |
onAcquire () | |
Update any lock tracking information when the lock is acquired. | |
onRelease () | |
Update any lock tracking information when the lock is released. | |
precheckAcquire () | |
Checks that the lock request is sensible. | |
Protected Attributes | |
RedisConnRef | $conn |
string | $keySha1 |
SHA-1 of the key. | |
int | $lockTTL |
TTL for locks to expire (work should finish in this time) | |
LoggerInterface | $logger |
int null | $onRelease |
AWAKE_* constant. | |
RedisConnectionPool | $pool |
HashRing | $ring |
array | $serversByLabel |
(server label => host) map | |
string | $session |
Unique string to identify this process. | |
string null | $slot |
Pool slot value. | |
float null | $slotTime |
UNIX timestamp. | |
Protected Attributes inherited from PoolCounter | |
string | $key |
All workers with the same key share the lock. | |
int | $maxqueue |
If this number of workers are already working/waiting, fail instead of wait. | |
int | $slots = 0 |
Maximum number of workers working on this task type, regardless of key. | |
int | $timeout |
Maximum time in seconds to wait for the lock. | |
int | $workers |
Maximum number of workers working on tasks with the same key simultaneously. | |
Static Protected Attributes | |
static PoolCounterRedis[] | $active = null |
List of active PoolCounterRedis objects in this script. | |
Additional Inherited Members | |
Public Attributes inherited from PoolCounter | |
const | DONE = 3 |
const | ERROR = -1 |
const | LOCK_HELD = -5 |
const | LOCKED = 1 |
const | NOT_LOCKED = -2 |
const | QUEUE_FULL = -3 |
const | RELEASED = 2 |
const | TIMEOUT = -4 |
Version of PoolCounter that uses Redis.
There are four main redis keys used to track each pool counter key:
For a given pool key, all the redis keys start off non-existing and are deleted if not used for a while to prevent garbage from building up on the server. They are atomically re-initialized as needed. The "z-renewtime" key is used for detecting sessions which got slots but then disappeared. Stale entries from there have their timestamp updated and the corresponding slots freed up. The "z-wait" key is used for detecting processes registered as waiting but that disappeared. Stale entries from there are deleted and the corresponding slots are freed up. The worker count is included in all the redis key names as it does not vary within each $wgPoolCounterConf type and doing so handles configuration changes.
This class requires Redis 2.6 as it makes use Lua scripts for fast atomic operations. Also this should be on a server plenty of RAM for the working set to avoid evictions. Evictions could temporarily allow wait queues to double in size or temporarily cause pools to appear as full when they are not. Using volatile-ttl and bumping memory-samples in redis.conf can be helpful otherwise.
Definition at line 53 of file PoolCounterRedis.php.
PoolCounterRedis::__construct | ( | $conf, | |
$type, | |||
$key ) |
Definition at line 83 of file PoolCounterRedis.php.
References PoolCounter\$key, and $type.
PoolCounterRedis::acquireForAnyone | ( | $timeout = null | ) |
I want to do this task, but if anyone else does it instead, it's also fine for me.
I will read its cached data.
int | null | $timeout | Wait timeout, or null to use value passed to the constructor |
Reimplemented from PoolCounter.
Definition at line 136 of file PoolCounterRedis.php.
References PoolCounter\$timeout, PoolCounter\precheckAcquire(), and waitForSlotOrNotif().
PoolCounterRedis::acquireForMe | ( | $timeout = null | ) |
I want to do this task and I need to do it myself.
int | null | $timeout | Wait timeout, or null to use value passed to the constructor |
Reimplemented from PoolCounter.
Definition at line 127 of file PoolCounterRedis.php.
References PoolCounter\$timeout, PoolCounter\precheckAcquire(), and waitForSlotOrNotif().
|
protected |
Definition at line 108 of file PoolCounterRedis.php.
References $conn.
Referenced by release(), and waitForSlotOrNotif().
|
protected |
Definition at line 403 of file PoolCounterRedis.php.
Referenced by initAndPopPoolSlotList(), registerAcquisitionTime(), release(), and waitForSlotOrNotif().
|
protected |
Definition at line 410 of file PoolCounterRedis.php.
Referenced by initAndPopPoolSlotList(), registerAcquisitionTime(), and release().
|
protected |
Definition at line 417 of file PoolCounterRedis.php.
Referenced by initAndPopPoolSlotList(), registerAcquisitionTime(), release(), and waitForSlotOrNotif().
|
protected |
Definition at line 424 of file PoolCounterRedis.php.
Referenced by release(), and waitForSlotOrNotif().
|
protected |
RedisConnRef | $conn | |
float | $now | UNIX timestamp |
Definition at line 299 of file PoolCounterRedis.php.
References $conn, getSlotListKey(), getSlotRTimeSetKey(), getWaitSetKey(), and RedisConnRef\luaEval().
Referenced by waitForSlotOrNotif().
|
protected |
RedisConnRef | $conn | |
string | $slot | |
float | $now |
Definition at line 368 of file PoolCounterRedis.php.
References $conn, $slot, getSlotListKey(), getSlotRTimeSetKey(), getWaitSetKey(), and RedisConnRef\luaEval().
Referenced by waitForSlotOrNotif().
PoolCounterRedis::release | ( | ) |
I have successfully finished my task.
Lets another one grab the lock, and returns the workers waiting on acquireForAnyone()
Reimplemented from PoolCounter.
Definition at line 145 of file PoolCounterRedis.php.
References $conn, getConnection(), getSlotListKey(), getSlotRTimeSetKey(), getWaitSetKey(), getWakeupListKey(), RedisConnRef\luaEval(), PoolCounter\NOT_LOCKED, PoolCounter\onRelease(), and PoolCounter\RELEASED.
|
static |
Try to make sure that locks get released (even with exceptions and fatals)
Definition at line 431 of file PoolCounterRedis.php.
|
protected |
int | $doWakeup | AWAKE_* constant |
int | float | null | $timeout |
Definition at line 234 of file PoolCounterRedis.php.
References $conn, $keys, $res, $session, $slot, $slotTime, PoolCounter\$timeout, PoolCounter\DONE, getConnection(), getSlotListKey(), getWaitSetKey(), getWakeupListKey(), initAndPopPoolSlotList(), PoolCounter\LOCK_HELD, PoolCounter\LOCKED, PoolCounter\onAcquire(), PoolCounter\onRelease(), PoolCounter\QUEUE_FULL, registerAcquisitionTime(), and PoolCounter\TIMEOUT.
Referenced by acquireForAnyone(), and acquireForMe().
|
staticprotected |
List of active PoolCounterRedis objects in this script.
Definition at line 81 of file PoolCounterRedis.php.
|
protected |
Definition at line 67 of file PoolCounterRedis.php.
Referenced by getConnection(), initAndPopPoolSlotList(), registerAcquisitionTime(), release(), and waitForSlotOrNotif().
|
protected |
SHA-1 of the key.
Definition at line 63 of file PoolCounterRedis.php.
|
protected |
TTL for locks to expire (work should finish in this time)
Definition at line 65 of file PoolCounterRedis.php.
|
protected |
Definition at line 59 of file PoolCounterRedis.php.
|
protected |
AWAKE_* constant.
Definition at line 71 of file PoolCounterRedis.php.
|
protected |
Definition at line 57 of file PoolCounterRedis.php.
|
protected |
Definition at line 55 of file PoolCounterRedis.php.
|
protected |
(server label => host) map
Definition at line 61 of file PoolCounterRedis.php.
|
protected |
Unique string to identify this process.
Definition at line 73 of file PoolCounterRedis.php.
Referenced by waitForSlotOrNotif().
|
protected |
Pool slot value.
Definition at line 69 of file PoolCounterRedis.php.
Referenced by registerAcquisitionTime(), and waitForSlotOrNotif().
|
protected |
UNIX timestamp.
Definition at line 75 of file PoolCounterRedis.php.
Referenced by waitForSlotOrNotif().