Class for handling resource locking. More...

Inheritance diagram for LockManager:

[legend]

Public Member Functions
	__construct (array $config)
	Construct a new instance from configuration. More...

	lock (array $paths, $type=self::LOCK_EX, $timeout=0)
	Lock the resources at the given abstract paths. More...

	lockByType (array $pathsByType, $timeout=0)
	Lock the resources at the given abstract paths. More...

	unlock (array $paths, $type=self::LOCK_EX)
	Unlock the resources at the given abstract paths. More...

	unlockByType (array $pathsByType)
	Unlock the resources at the given abstract paths. More...

Public Attributes
const	LOCK_EX = 3

const	LOCK_SH = 1
	Lock types; stronger locks have higher values. More...

const	LOCK_UW = 2

Protected Member Functions
	doLock (array $paths, $type)
	Lock resources with the given keys and lock type. More...

	doLockByType (array $pathsByType)

	doUnlock (array $paths, $type)
	Unlock resources with the given keys and lock type. More...

	doUnlockByType (array $pathsByType)

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

	sha1Base16Absolute ( $path)
	Get the base 16 SHA-1 of a string, padded to 31 digits. More...

	sha1Base36Absolute ( $path)
	Get the base 36 SHA-1 of a string, padded to 31 digits. More...

Protected Attributes
	$domain

array	$locksHeld = array()
	Map of (resource path => lock type => count) *. More...

	$lockTTL

array	$lockTypeMap
	Mapping of lock types to the type actually used *. More...

Detailed Description

Class for handling resource locking.

Locks on resource keys can either be shared or exclusive.

Implementations must keep track of what is locked by this proccess in-memory and support nested locking calls (using reference counting). At least LOCK_UW and LOCK_EX must be implemented. LOCK_SH can be a no-op. Locks should either be non-blocking or have low wait timeouts.

Subclasses should avoid throwing exceptions at all costs.

Since: 1.19

Definition at line 45 of file LockManager.php.

Constructor & Destructor Documentation

◆ __construct()

LockManager::__construct ( array $config )

Construct a new instance from configuration.

Parameters

array

$config

Paramaters include:

domain : Domain (usually wiki ID) that all resources are relative to [optional]
lockTTL : Age (in seconds) at which resource locks should expire. This only applies if locks are not tied to a connection/process.

Reimplemented in DBLockManager, RedisLockManager, MemcLockManager, and FSLockManager.

Definition at line 70 of file LockManager.php.

References wfWikiID().

Member Function Documentation

◆ doLock()

LockManager::doLock	(	array	$paths,
			$type
	)

abstractprotected

Lock resources with the given keys and lock type.

Parameters

array	$paths	List of paths
int	$type	LockManager::LOCK_* constant

Returns: Status

Reimplemented in NullLockManager, FSLockManager, and QuorumLockManager.

Referenced by doLockByType().

◆ doLockByType()

LockManager::doLockByType ( array $pathsByType )

protected

See also: LockManager::lockByType()

Parameters

array $pathsByType Map of LockManager::LOCK_* constants to lists of paths

Returns: Status

Since: 1.22

Reimplemented in QuorumLockManager.

Definition at line 196 of file LockManager.php.

References $type, array(), as, doLock(), doUnlock(), and Status\newGood().

Referenced by lockByType().

◆ doUnlock()

LockManager::doUnlock	(	array	$paths,
			$type
	)

abstractprotected

Unlock resources with the given keys and lock type.

Parameters

array	$paths	List of paths
int	$type	LockManager::LOCK_* constant

Returns: Status

Reimplemented in NullLockManager, FSLockManager, and QuorumLockManager.

Referenced by doLockByType(), and doUnlockByType().

◆ doUnlockByType()

LockManager::doUnlockByType ( array $pathsByType )

protected

See also: LockManager::unlockByType()

Parameters

array $pathsByType Map of LockManager::LOCK_* constants to lists of paths

Returns: Status

Since: 1.22

Reimplemented in QuorumLockManager.

Definition at line 230 of file LockManager.php.

References $type, as, doUnlock(), and Status\newGood().

Referenced by unlockByType().

◆ lock()

LockManager::lock	(	array	$paths,
			$type = `self::LOCK_EX`,
			$timeout = `0`
	)

final

Lock the resources at the given abstract paths.

Parameters

array	$paths	List of resource names
int	$type	LockManager::LOCK_* constant
int	$timeout	Timeout in seconds (0 means non-blocking) (since 1.21)

Returns: Status

Definition at line 90 of file LockManager.php.

References $type, array(), and lockByType().

Referenced by RedisLockManager\getLocksOnServer().

◆ lockByType()

LockManager::lockByType	(	array	$pathsByType,
			$timeout = `0`
	)

final

Lock the resources at the given abstract paths.

Parameters

array	$pathsByType	Map of LockManager::LOCK_* constants to lists of paths
int	$timeout	Timeout in seconds (0 means non-blocking) (since 1.21)

Returns: Status

Since: 1.22

Definition at line 102 of file LockManager.php.

References array(), doLockByType(), Status\newGood(), normalizePathsByType(), wfProfileIn(), and wfProfileOut().

Referenced by ScopedLock\factory(), and lock().

◆ normalizePathsByType()

LockManager::normalizePathsByType ( array $pathsByType )

finalprotected

Normalize the $paths array by converting LOCK_UW locks into the appropriate type and removing any duplicated paths for each lock type.

Parameters

array $pathsByType Map of LockManager::LOCK_* constants to lists of paths

Returns: array

Since: 1.22

Definition at line 181 of file LockManager.php.

References $res, $type, array(), and as.

Referenced by lockByType(), and unlockByType().

◆ sha1Base16Absolute()

LockManager::sha1Base16Absolute ( $path )

finalprotected

Get the base 16 SHA-1 of a string, padded to 31 digits.

Before hashing, the path will be prefixed with the domain ID. This should be used interally for lock key or file names.

Parameters

string $path

Returns: string

Definition at line 169 of file LockManager.php.

◆ sha1Base36Absolute()

LockManager::sha1Base36Absolute ( $path )

finalprotected

Get the base 36 SHA-1 of a string, padded to 31 digits.

Before hashing, the path will be prefixed with the domain ID. This should be used interally for lock key or file names.

Parameters

string $path

Returns: string

Definition at line 157 of file LockManager.php.

References wfBaseConvert().

Referenced by MySqlLockManager\doGetLocksOnServer(), RedisLockManager\recordKeyForPath(), and MemcLockManager\recordKeyForPath().

◆ unlock()

LockManager::unlock	(	array	$paths,
			$type = `self::LOCK_EX`
	)

final

Unlock the resources at the given abstract paths.

Parameters

array	$paths	List of paths
int	$type	LockManager::LOCK_* constant

Returns: Status

Definition at line 129 of file LockManager.php.

References $type, array(), and unlockByType().

◆ unlockByType()

LockManager::unlockByType ( array $pathsByType )

final

Unlock the resources at the given abstract paths.

Parameters

array $pathsByType Map of LockManager::LOCK_* constants to lists of paths

Returns: Status

Since: 1.22

Definition at line 140 of file LockManager.php.

References doUnlockByType(), normalizePathsByType(), wfProfileIn(), and wfProfileOut().

Referenced by RedisLockManager\__destruct(), and unlock().

Member Data Documentation

◆ $domain

LockManager::$domain

protected

Definition at line 54 of file LockManager.php.

◆ $locksHeld

array LockManager::$locksHeld = array()

protected

Map of (resource path => lock type => count) *.

Definition at line 52 of file LockManager.php.

Referenced by MemcLockManager\doFreeLocksOnServer(), and MemcLockManager\doGetLocksOnServer().

◆ $lockTTL

LockManager::$lockTTL

protected

Definition at line 55 of file LockManager.php.

Referenced by MemcLockManager\doGetLocksOnServer().

◆ $lockTypeMap

array LockManager::$lockTypeMap

protected

Initial value:

= array(
        self::LOCK_SH => self::LOCK_SH,
        self::LOCK_UW => self::LOCK_EX, 
        self::LOCK_EX => self::LOCK_EX
    )

Mapping of lock types to the type actually used *.

Definition at line 46 of file LockManager.php.

◆ LOCK_EX

const LockManager::LOCK_EX = 3

Definition at line 60 of file LockManager.php.

Referenced by FileBackendStore\doClean(), FSLockManager\doSingleLock(), FileBackendTest\doTestLockCalls(), FileBackendStore\getPathsToLockForOpsInternal(), FileBackendMultiWrite\getScopedLocksForOps(), DatabaseSqlite\lock(), SyncFileBackend\syncFileBatch(), and DatabaseSqlite\unlock().

◆ LOCK_SH

const LockManager::LOCK_SH = 1

Lock types; stronger locks have higher values.

Definition at line 58 of file LockManager.php.

Referenced by PostgreSqlLockManager\doGetLocksOnServer(), FSLockManager\doSingleLock(), FileBackendTest\doTestLockCalls(), RedisLockManager\freeLocksOnServer(), and RedisLockManager\getLocksOnServer().

◆ LOCK_UW

const LockManager::LOCK_UW = 2

Definition at line 59 of file LockManager.php.

Referenced by SwiftFileBackend\addMissingMetadata(), FileBackendStore\concatenate(), FileBackendStore\getPathsToLockForOpsInternal(), FileBackendMultiWrite\getScopedLocksForOps(), and SyncFileBackend\syncFileBatch().

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

includes/filebackend/lockmanager/LockManager.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doLock()

◆ doLockByType()

◆ doUnlock()

◆ doUnlockByType()

◆ lock()

◆ lockByType()

◆ normalizePathsByType()

◆ sha1Base16Absolute()

◆ sha1Base36Absolute()

◆ unlock()

◆ unlockByType()

Member Data Documentation

◆ $domain

◆ $locksHeld

◆ $lockTTL

◆ $lockTypeMap

◆ LOCK_EX

◆ LOCK_SH

◆ LOCK_UW