3 * Object caching using Redis (http://redis.io/).
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Redis-based caching module for redis server >= 2.6.12
26 * @note Avoid use of Redis::MULTI transactions for twemproxy support
31 class RedisBagOStuff
extends BagOStuff
{
32 /** @var RedisConnectionPool */
34 /** @var array List of server names */
36 /** @var array Map of (tag => server name) */
37 protected $serverTagMap;
39 protected $automaticFailover;
42 * Construct a RedisBagOStuff object. Parameters are:
44 * - servers: An array of server names. A server name may be a hostname,
45 * a hostname/port combination or the absolute path of a UNIX socket.
46 * If a hostname is specified but no port, the standard port number
47 * 6379 will be used. Arrays keys can be used to specify the tag to
48 * hash on in place of the host/port. Required.
50 * - connectTimeout: The timeout for new connections, in seconds. Optional,
51 * default is 1 second.
53 * - persistent: Set this to true to allow connections to persist across
54 * multiple web requests. False by default.
56 * - password: The authentication password, will be sent to Redis in
57 * clear text. Optional, if it is unspecified, no AUTH command will be
60 * - automaticFailover: If this is false, then each key will be mapped to
61 * a single server, and if that server is down, any requests for that key
62 * will fail. If this is true, a connection failure will cause the client
63 * to immediately try the next server in the list (as determined by a
64 * consistent hashing algorithm). True by default. This has the
65 * potential to create consistency issues if a server is slow enough to
66 * flap, for example if it is in swap death.
67 * @param array $params
69 function __construct( $params ) {
70 parent
::__construct( $params );
71 $redisConf = [ 'serializer' => 'none' ]; // manage that in this class
72 foreach ( [ 'connectTimeout', 'persistent', 'password' ] as $opt ) {
73 if ( isset( $params[$opt] ) ) {
74 $redisConf[$opt] = $params[$opt];
77 $this->redisPool
= RedisConnectionPool
::singleton( $redisConf );
79 $this->servers
= $params['servers'];
80 foreach ( $this->servers
as $key => $server ) {
81 $this->serverTagMap
[is_int( $key ) ?
$server : $key] = $server;
84 if ( isset( $params['automaticFailover'] ) ) {
85 $this->automaticFailover
= $params['automaticFailover'];
87 $this->automaticFailover
= true;
90 $this->attrMap
[self
::ATTR_SYNCWRITES
] = self
::QOS_SYNCWRITES_NONE
;
93 protected function doGet( $key, $flags = 0 ) {
96 return $this->getWithToken( $key, $casToken, $flags );
99 protected function getWithToken( $key, &$casToken, $flags = 0 ) {
100 list( $server, $conn ) = $this->getConnection( $key );
105 $value = $conn->get( $key );
107 $result = $this->unserialize( $value );
108 } catch ( RedisException
$e ) {
110 $this->handleException( $conn, $e );
113 $this->logRequest( 'get', $key, $server, $result );
117 public function set( $key, $value, $expiry = 0, $flags = 0 ) {
118 list( $server, $conn ) = $this->getConnection( $key );
122 $expiry = $this->convertToRelative( $expiry );
125 $result = $conn->setex( $key, $expiry, $this->serialize( $value ) );
127 // No expiry, that is very different from zero expiry in Redis
128 $result = $conn->set( $key, $this->serialize( $value ) );
130 } catch ( RedisException
$e ) {
132 $this->handleException( $conn, $e );
135 $this->logRequest( 'set', $key, $server, $result );
139 public function delete( $key ) {
140 list( $server, $conn ) = $this->getConnection( $key );
145 $conn->delete( $key );
146 // Return true even if the key didn't exist
148 } catch ( RedisException
$e ) {
150 $this->handleException( $conn, $e );
153 $this->logRequest( 'delete', $key, $server, $result );
157 public function getMulti( array $keys, $flags = 0 ) {
160 foreach ( $keys as $key ) {
161 list( $server, $conn ) = $this->getConnection( $key );
165 $conns[$server] = $conn;
166 $batches[$server][] = $key;
169 foreach ( $batches as $server => $batchKeys ) {
170 $conn = $conns[$server];
172 $conn->multi( Redis
::PIPELINE
);
173 foreach ( $batchKeys as $key ) {
176 $batchResult = $conn->exec();
177 if ( $batchResult === false ) {
178 $this->debug( "multi request to $server failed" );
181 foreach ( $batchResult as $i => $value ) {
182 if ( $value !== false ) {
183 $result[$batchKeys[$i]] = $this->unserialize( $value );
186 } catch ( RedisException
$e ) {
187 $this->handleException( $conn, $e );
191 $this->debug( "getMulti for " . count( $keys ) . " keys " .
192 "returned " . count( $result ) . " results" );
201 public function setMulti( array $data, $expiry = 0 ) {
204 foreach ( $data as $key => $value ) {
205 list( $server, $conn ) = $this->getConnection( $key );
209 $conns[$server] = $conn;
210 $batches[$server][] = $key;
213 $expiry = $this->convertToRelative( $expiry );
215 foreach ( $batches as $server => $batchKeys ) {
216 $conn = $conns[$server];
218 $conn->multi( Redis
::PIPELINE
);
219 foreach ( $batchKeys as $key ) {
221 $conn->setex( $key, $expiry, $this->serialize( $data[$key] ) );
223 $conn->set( $key, $this->serialize( $data[$key] ) );
226 $batchResult = $conn->exec();
227 if ( $batchResult === false ) {
228 $this->debug( "setMulti request to $server failed" );
231 foreach ( $batchResult as $value ) {
232 if ( $value === false ) {
236 } catch ( RedisException
$e ) {
237 $this->handleException( $server, $conn, $e );
245 public function add( $key, $value, $expiry = 0 ) {
246 list( $server, $conn ) = $this->getConnection( $key );
250 $expiry = $this->convertToRelative( $expiry );
253 $result = $conn->set(
255 $this->serialize( $value ),
256 [ 'nx', 'ex' => $expiry ]
259 $result = $conn->setnx( $key, $this->serialize( $value ) );
261 } catch ( RedisException
$e ) {
263 $this->handleException( $conn, $e );
266 $this->logRequest( 'add', $key, $server, $result );
270 public function merge( $key, callable
$callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
271 return $this->mergeViaCas( $key, $callback, $exptime, $attempts );
275 * Non-atomic implementation of incr().
277 * Probably all callers actually want incr() to atomically initialise
278 * values to zero if they don't exist, as provided by the Redis INCR
279 * command. But we are constrained by the memcached-like interface to
280 * return null in that case. Once the key exists, further increments are
282 * @param string $key Key to increase
283 * @param int $value Value to add to $key (Default 1)
284 * @return int|bool New value or false on failure
286 public function incr( $key, $value = 1 ) {
287 list( $server, $conn ) = $this->getConnection( $key );
292 if ( !$conn->exists( $key ) ) {
295 // @FIXME: on races, the key may have a 0 TTL
296 $result = $conn->incrBy( $key, $value );
297 } catch ( RedisException
$e ) {
299 $this->handleException( $conn, $e );
302 $this->logRequest( 'incr', $key, $server, $result );
306 public function changeTTL( $key, $expiry = 0 ) {
307 list( $server, $conn ) = $this->getConnection( $key );
312 $expiry = $this->convertToRelative( $expiry );
314 $result = $conn->expire( $key, $expiry );
315 } catch ( RedisException
$e ) {
317 $this->handleException( $conn, $e );
320 $this->logRequest( 'expire', $key, $server, $result );
324 public function modifySimpleRelayEvent( array $event ) {
325 if ( array_key_exists( 'val', $event ) ) {
326 $event['val'] = serialize( $event['val'] ); // this class uses PHP serialization
336 protected function serialize( $data ) {
337 // Serialize anything but integers so INCR/DECR work
338 // Do not store integer-like strings as integers to avoid type confusion (T62563)
339 return is_int( $data ) ?
$data : serialize( $data );
343 * @param string $data
346 protected function unserialize( $data ) {
347 $int = intval( $data );
348 return $data === (string)$int ?
$int : unserialize( $data );
352 * Get a Redis object with a connection suitable for fetching the specified key
354 * @return array (server, RedisConnRef) or (false, false)
356 protected function getConnection( $key ) {
357 $candidates = array_keys( $this->serverTagMap
);
359 if ( count( $this->servers
) > 1 ) {
360 ArrayUtils
::consistentHashSort( $candidates, $key, '/' );
361 if ( !$this->automaticFailover
) {
362 $candidates = array_slice( $candidates, 0, 1 );
366 while ( ( $tag = array_shift( $candidates ) ) !== null ) {
367 $server = $this->serverTagMap
[$tag];
368 $conn = $this->redisPool
->getConnection( $server, $this->logger
);
373 // If automatic failover is enabled, check that the server's link
374 // to its master (if any) is up -- but only if there are other
375 // viable candidates left to consider. Also, getMasterLinkStatus()
376 // does not work with twemproxy, though $candidates will be empty
377 // by now in such cases.
378 if ( $this->automaticFailover
&& $candidates ) {
380 if ( $this->getMasterLinkStatus( $conn ) === 'down' ) {
381 // If the master cannot be reached, fail-over to the next server.
382 // If masters are in data-center A, and replica DBs in data-center B,
383 // this helps avoid the case were fail-over happens in A but not
384 // to the corresponding server in B (e.g. read/write mismatch).
387 } catch ( RedisException
$e ) {
388 // Server is not accepting commands
389 $this->handleException( $conn, $e );
394 return [ $server, $conn ];
397 $this->setLastError( BagOStuff
::ERR_UNREACHABLE
);
399 return [ false, false ];
403 * Check the master link status of a Redis server that is configured as a replica DB.
404 * @param RedisConnRef $conn
405 * @return string|null Master link status (either 'up' or 'down'), or null
406 * if the server is not a replica DB.
408 protected function getMasterLinkStatus( RedisConnRef
$conn ) {
409 $info = $conn->info();
410 return $info['master_link_status'] ??
null;
417 protected function logError( $msg ) {
418 $this->logger
->error( "Redis error: $msg" );
422 * The redis extension throws an exception in response to various read, write
423 * and protocol errors. Sometimes it also closes the connection, sometimes
424 * not. The safest response for us is to explicitly destroy the connection
425 * object and let it be reopened during the next request.
426 * @param RedisConnRef $conn
427 * @param Exception $e
429 protected function handleException( RedisConnRef
$conn, $e ) {
430 $this->setLastError( BagOStuff
::ERR_UNEXPECTED
);
431 $this->redisPool
->handleError( $conn, $e );
435 * Send information about a single request to the debug log
436 * @param string $method
438 * @param string $server
439 * @param bool $result
441 public function logRequest( $method, $key, $server, $result ) {
442 $this->debug( "$method $key on $server: " .
443 ( $result === false ?
"failure" : "success" ) );