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
23 class RedisBagOStuff
extends BagOStuff
{
24 /** @var RedisConnectionPool */
26 /** @var Array List of server names */
29 protected $automaticFailover;
32 * Construct a RedisBagOStuff object. Parameters are:
34 * - servers: An array of server names. A server name may be a hostname,
35 * a hostname/port combination or the absolute path of a UNIX socket.
36 * If a hostname is specified but no port, the standard port number
37 * 6379 will be used. Required.
39 * - connectTimeout: The timeout for new connections, in seconds. Optional,
40 * default is 1 second.
42 * - persistent: Set this to true to allow connections to persist across
43 * multiple web requests. False by default.
45 * - password: The authentication password, will be sent to Redis in
46 * clear text. Optional, if it is unspecified, no AUTH command will be
49 * - automaticFailover: If this is false, then each key will be mapped to
50 * a single server, and if that server is down, any requests for that key
51 * will fail. If this is true, a connection failure will cause the client
52 * to immediately try the next server in the list (as determined by a
53 * consistent hashing algorithm). True by default. This has the
54 * potential to create consistency issues if a server is slow enough to
55 * flap, for example if it is in swap death.
57 function __construct( $params ) {
58 $redisConf = array( 'serializer' => 'none' ); // manage that in this class
59 foreach ( array( 'connectTimeout', 'persistent', 'password' ) as $opt ) {
60 if ( isset( $params[$opt] ) ) {
61 $redisConf[$opt] = $params[$opt];
64 $this->redisPool
= RedisConnectionPool
::singleton( $redisConf );
66 $this->servers
= $params['servers'];
67 if ( isset( $params['automaticFailover'] ) ) {
68 $this->automaticFailover
= $params['automaticFailover'];
70 $this->automaticFailover
= true;
74 public function get( $key, &$casToken = null ) {
75 $section = new ProfileSection( __METHOD__
);
77 list( $server, $conn ) = $this->getConnection( $key );
82 $value = $conn->get( $key );
84 $result = $this->unserialize( $value );
85 } catch ( RedisException
$e ) {
87 $this->handleException( $server, $conn, $e );
90 $this->logRequest( 'get', $key, $server, $result );
94 public function set( $key, $value, $expiry = 0 ) {
95 $section = new ProfileSection( __METHOD__
);
97 list( $server, $conn ) = $this->getConnection( $key );
101 $expiry = $this->convertToRelative( $expiry );
104 $result = $conn->setex( $key, $expiry, $this->serialize( $value ) );
106 // No expiry, that is very different from zero expiry in Redis
107 $result = $conn->set( $key, $this->serialize( $value ) );
109 } catch ( RedisException
$e ) {
111 $this->handleException( $server, $conn, $e );
114 $this->logRequest( 'set', $key, $server, $result );
118 public function cas( $casToken, $key, $value, $expiry = 0 ) {
119 $section = new ProfileSection( __METHOD__
);
121 list( $server, $conn ) = $this->getConnection( $key );
125 $expiry = $this->convertToRelative( $expiry );
127 $conn->watch( $key );
129 if ( $this->serialize( $this->get( $key ) ) !== $casToken ) {
134 // multi()/exec() will fail atomically if the key changed since watch()
137 $conn->setex( $key, $expiry, $this->serialize( $value ) );
139 // No expiry, that is very different from zero expiry in Redis
140 $conn->set( $key, $this->serialize( $value ) );
142 $result = ( $conn->exec() == array( true ) );
143 } catch ( RedisException
$e ) {
145 $this->handleException( $server, $conn, $e );
148 $this->logRequest( 'cas', $key, $server, $result );
152 public function delete( $key, $time = 0 ) {
153 $section = new ProfileSection( __METHOD__
);
155 list( $server, $conn ) = $this->getConnection( $key );
160 $conn->delete( $key );
161 // Return true even if the key didn't exist
163 } catch ( RedisException
$e ) {
165 $this->handleException( $server, $conn, $e );
168 $this->logRequest( 'delete', $key, $server, $result );
172 public function getMulti( array $keys ) {
173 $section = new ProfileSection( __METHOD__
);
177 foreach ( $keys as $key ) {
178 list( $server, $conn ) = $this->getConnection( $key );
182 $conns[$server] = $conn;
183 $batches[$server][] = $key;
186 foreach ( $batches as $server => $batchKeys ) {
187 $conn = $conns[$server];
189 $conn->multi( Redis
::PIPELINE
);
190 foreach ( $batchKeys as $key ) {
193 $batchResult = $conn->exec();
194 if ( $batchResult === false ) {
195 $this->debug( "multi request to $server failed" );
198 foreach ( $batchResult as $i => $value ) {
199 if ( $value !== false ) {
200 $result[$batchKeys[$i]] = $this->unserialize( $value );
203 } catch ( RedisException
$e ) {
204 $this->handleException( $server, $conn, $e );
208 $this->debug( "getMulti for " . count( $keys ) . " keys " .
209 "returned " . count( $result ) . " results" );
213 public function add( $key, $value, $expiry = 0 ) {
214 $section = new ProfileSection( __METHOD__
);
216 list( $server, $conn ) = $this->getConnection( $key );
220 $expiry = $this->convertToRelative( $expiry );
224 $conn->setnx( $key, $this->serialize( $value ) );
225 $conn->expire( $key, $expiry );
226 $result = ( $conn->exec() == array( true, true ) );
228 $result = $conn->setnx( $key, $this->serialize( $value ) );
230 } catch ( RedisException
$e ) {
232 $this->handleException( $server, $conn, $e );
235 $this->logRequest( 'add', $key, $server, $result );
240 * Non-atomic implementation of replace(). Could perhaps be done atomically
241 * with WATCH or scripting, but this function is rarely used.
243 public function replace( $key, $value, $expiry = 0 ) {
244 $section = new ProfileSection( __METHOD__
);
246 list( $server, $conn ) = $this->getConnection( $key );
250 if ( !$conn->exists( $key ) ) {
254 $expiry = $this->convertToRelative( $expiry );
257 $result = $conn->set( $key, $this->serialize( $value ) );
259 $result = $conn->setex( $key, $expiry, $this->serialize( $value ) );
261 } catch ( RedisException
$e ) {
263 $this->handleException( $server, $conn, $e );
266 $this->logRequest( 'replace', $key, $server, $result );
271 * Non-atomic implementation of incr().
273 * Probably all callers actually want incr() to atomically initialise
274 * values to zero if they don't exist, as provided by the Redis INCR
275 * command. But we are constrained by the memcached-like interface to
276 * return null in that case. Once the key exists, further increments are
279 public function incr( $key, $value = 1 ) {
280 $section = new ProfileSection( __METHOD__
);
282 list( $server, $conn ) = $this->getConnection( $key );
286 if ( !$conn->exists( $key ) ) {
290 $result = $this->unserialize( $conn->incrBy( $key, $value ) );
291 } catch ( RedisException
$e ) {
293 $this->handleException( $server, $conn, $e );
296 $this->logRequest( 'incr', $key, $server, $result );
304 protected function serialize( $data ) {
305 // Ignore digit strings and ints so INCR/DECR work
306 return ( is_int( $data ) ||
ctype_digit( $data ) ) ?
$data : serialize( $data );
310 * @param string $data
313 protected function unserialize( $data ) {
314 // Ignore digit strings and ints so INCR/DECR work
315 return ( is_int( $data ) ||
ctype_digit( $data ) ) ?
$data : unserialize( $data );
319 * Get a Redis object with a connection suitable for fetching the specified key
320 * @return Array (server, RedisConnRef) or (false, false)
322 protected function getConnection( $key ) {
323 if ( count( $this->servers
) === 1 ) {
324 $candidates = $this->servers
;
326 $candidates = $this->servers
;
327 ArrayUtils
::consistentHashSort( $candidates, $key, '/' );
328 if ( !$this->automaticFailover
) {
329 $candidates = array_slice( $candidates, 0, 1 );
333 foreach ( $candidates as $server ) {
334 $conn = $this->redisPool
->getConnection( $server );
336 return array( $server, $conn );
339 return array( false, false );
345 protected function logError( $msg ) {
346 wfDebugLog( 'redis', "Redis error: $msg\n" );
350 * The redis extension throws an exception in response to various read, write
351 * and protocol errors. Sometimes it also closes the connection, sometimes
352 * not. The safest response for us is to explicitly destroy the connection
353 * object and let it be reopened during the next request.
355 protected function handleException( $server, RedisConnRef
$conn, $e ) {
356 $this->redisPool
->handleException( $server, $conn, $e );
360 * Send information about a single request to the debug log
362 public function logRequest( $method, $key, $server, $result ) {
363 $this->debug( "$method $key on $server: " .
364 ( $result === false ?
"failure" : "success" ) );