1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
<?php
declare(strict_types=1);
namespace malkusch\lock\mutex;
use malkusch\lock\exception\LockAcquireException;
use malkusch\lock\exception\LockReleaseException;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;
/**
* Mutex based on the Redlock algorithm.
*
* @author Markus Malkusch <markus@malkusch.de>
* @license WTFPL
*
* @link http://redis.io/topics/distlock
* @link bitcoin:1P5FAZ4QhXCuwYPnLZdk3PJsqePbu1UDDA Donations
*/
abstract class RedisMutex extends SpinlockMutex implements LoggerAwareInterface
{
use LoggerAwareTrait;
/**
* @var string The random value token for key identification.
*/
private $token;
/**
* @var array The Redis APIs.
*/
private $redisAPIs;
/**
* Sets the Redis APIs.
*
* @param array $redisAPIs The Redis APIs.
* @param string $name The lock name.
* @param int $timeout The time in seconds a lock expires, default is 3.
*
* @throws \LengthException The timeout must be greater than 0.
*/
public function __construct(array $redisAPIs, string $name, int $timeout = 3)
{
parent::__construct($name, $timeout);
$this->redisAPIs = $redisAPIs;
$this->logger = new NullLogger();
}
protected function acquire(string $key, int $expire): bool
{
// 1. This differs from the specification to avoid an overflow on 32-Bit systems.
$time = microtime(true);
// 2.
$acquired = 0;
$errored = 0;
$this->token = bin2hex(random_bytes(16));
$exception = null;
foreach ($this->redisAPIs as $index => $redisAPI) {
try {
if ($this->add($redisAPI, $key, $this->token, $expire)) {
$acquired++;
}
} catch (LockAcquireException $exception) {
// todo if there is only one redis server, throw immediately.
$context = [
'key' => $key,
'index' => $index,
'token' => $this->token,
'exception' => $exception
];
$this->logger->warning('Could not set {key} = {token} at server #{index}.', $context);
$errored++;
}
}
// 3.
$elapsedTime = microtime(true) - $time;
$isAcquired = $this->isMajority($acquired) && $elapsedTime <= $expire;
if ($isAcquired) {
// 4.
return true;
}
// 5.
$this->release($key);
// In addition to RedLock it's an exception if too many servers fail.
if (!$this->isMajority(count($this->redisAPIs) - $errored)) {
assert(!is_null($exception)); // The last exception for some context.
throw new LockAcquireException(
"It's not possible to acquire a lock because at least half of the Redis server are not available.",
LockAcquireException::REDIS_NOT_ENOUGH_SERVERS,
$exception
);
}
return false;
}
protected function release(string $key): bool
{
/*
* All Redis commands must be analyzed before execution to determine which keys the command will operate on. In
* order for this to be true for EVAL, keys must be passed explicitly.
*
* @link https://redis.io/commands/set
*/
$script = 'if redis.call("get",KEYS[1]) == ARGV[1] then
return redis.call("del",KEYS[1])
else
return 0
end
';
$released = 0;
foreach ($this->redisAPIs as $index => $redisAPI) {
try {
if ($this->evalScript($redisAPI, $script, 1, [$key, $this->token])) {
$released++;
}
} catch (LockReleaseException $e) {
// todo throw if there is only one redis server
$context = [
'key' => $key,
'index' => $index,
'token' => $this->token,
'exception' => $e
];
$this->logger->warning('Could not unset {key} = {token} at server #{index}.', $context);
}
}
return $this->isMajority($released);
}
/**
* Returns if a count is the majority of all servers.
*
* @param int $count The count.
* @return bool True if the count is the majority.
*/
private function isMajority(int $count): bool
{
return $count > count($this->redisAPIs) / 2;
}
/**
* Sets the key only if such key doesn't exist at the server yet.
*
* @param mixed $redisAPI The connected Redis API.
* @param string $key The key.
* @param string $value The value.
* @param int $expire The TTL seconds.
*
* @return bool True, if the key was set.
*/
abstract protected function add($redisAPI, string $key, string $value, int $expire): bool;
/**
* @param mixed $redisAPI The connected Redis API.
* @param string $script The Lua script.
* @param int $numkeys The number of values in $arguments that represent Redis key names.
* @param array $arguments Keys and values.
*
* @throws LockReleaseException An unexpected error happened.
* @return mixed The script result, or false if executing failed.
*/
abstract protected function evalScript($redisAPI, string $script, int $numkeys, array $arguments);
}
|
