summaryrefslogtreecommitdiff
path: root/includes/objectcache/RedisBagOStuff.php
blob: c5966cdb06101da29fd166bd6701042a1929ac91 (plain)
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
<?php
/**
 * Object caching using Redis (http://redis.io/).
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */


class RedisBagOStuff extends BagOStuff {
	protected $connectTimeout, $persistent, $password, $automaticFailover;

	/**
	 * A list of server names, from $params['servers']
	 */
	protected $servers;

	/**
	 * A cache of Redis objects, representing connections to Redis servers.
	 * The key is the server name.
	 */
	protected $conns = array();

	/**
	 * An array listing "dead" servers which have had a connection error in
	 * the past. Servers are marked dead for a limited period of time, to
	 * avoid excessive overhead from repeated connection timeouts. The key in
	 * the array is the server name, the value is the UNIX timestamp at which
	 * the server is resurrected.
	 */
	protected $deadServers = array();

	/**
	 * Construct a RedisBagOStuff object. Parameters are:
	 *
	 *   - servers: An array of server names. A server name may be a hostname,
	 *     a hostname/port combination or the absolute path of a UNIX socket.
	 *     If a hostname is specified but no port, the standard port number
	 *     6379 will be used. Required.
	 *
	 *   - connectTimeout: The timeout for new connections, in seconds. Optional,
	 *     default is 1 second.
	 *
	 *   - persistent: Set this to true to allow connections to persist across
	 *     multiple web requests. False by default.
	 *
	 *   - password: The authentication password, will be sent to Redis in
	 *     clear text. Optional, if it is unspecified, no AUTH command will be
	 *     sent.
	 *
	 *   - automaticFailover: If this is false, then each key will be mapped to
	 *     a single server, and if that server is down, any requests for that key
	 *     will fail. If this is true, a connection failure will cause the client
	 *     to immediately try the next server in the list (as determined by a
	 *     consistent hashing algorithm). True by default. This has the
	 *     potential to create consistency issues if a server is slow enough to
	 *     flap, for example if it is in swap death.
	 */
	function __construct( $params ) {
		if ( !extension_loaded( 'redis' ) ) {
			throw new MWException( __CLASS__. ' requires the phpredis extension: ' .
				'https://github.com/nicolasff/phpredis' );
		}

		$this->servers = $params['servers'];
		$this->connectTimeout = isset( $params['connectTimeout'] )
			? $params['connectTimeout'] : 1;
		$this->persistent = !empty( $params['persistent'] );
		if ( isset( $params['password'] ) ) {
			$this->password = $params['password'];
		}
		if ( isset( $params['automaticFailover'] ) ) {
			$this->automaticFailover = $params['automaticFailover'];
		} else {
			$this->automaticFailover = true;
		}
	}

	public function get( $key ) {
		wfProfileIn( __METHOD__ );
		list( $server, $conn ) = $this->getConnection( $key );
		if ( !$conn ) {
			wfProfileOut( __METHOD__ );
			return false;
		}
		try {
			$result = $conn->get( $key );
		} catch ( RedisException $e ) {
			$result = false;
			$this->handleException( $server, $e );
		}
		$this->logRequest( 'get', $key, $server, $result );
		wfProfileOut( __METHOD__ );
		return $result;
	}

	public function set( $key, $value, $expiry = 0 ) {
		wfProfileIn( __METHOD__ );
		list( $server, $conn ) = $this->getConnection( $key );
		if ( !$conn ) {
			wfProfileOut( __METHOD__ );
			return false;
		}
		$expiry = $this->convertToRelative( $expiry );
		try {
			if ( !$expiry ) {
				// No expiry, that is very different from zero expiry in Redis
				$result = $conn->set( $key, $value );
			} else {
				$result = $conn->setex( $key, $expiry, $value );
			}
		} catch ( RedisException $e ) {
			$result = false;
			$this->handleException( $server, $e );
		}

		$this->logRequest( 'set', $key, $server, $result );
		wfProfileOut( __METHOD__ );
		return $result;
	}

	public function delete( $key, $time = 0 ) {
		wfProfileIn( __METHOD__ );
		list( $server, $conn ) = $this->getConnection( $key );
		if ( !$conn ) {
			wfProfileOut( __METHOD__ );
			return false;
		}
		try {
			$conn->delete( $key );
			// Return true even if the key didn't exist
			$result = true;
		} catch ( RedisException $e ) {
			$result = false;
			$this->handleException( $server, $e );
		}
		$this->logRequest( 'delete', $key, $server, $result );
		wfProfileOut( __METHOD__ );
		return $result;
	}

	public function getMulti( array $keys ) {
		wfProfileIn( __METHOD__ );
		$batches = array();
		$conns = array();
		foreach ( $keys as $key ) {
			list( $server, $conn ) = $this->getConnection( $key );
			if ( !$conn ) {
				continue;
			}
			$conns[$server] = $conn;
			$batches[$server][] = $key;
		}
		$result = array();
		foreach ( $batches as $server => $batchKeys ) {
			$conn = $conns[$server];
			try {
				$conn->multi( Redis::PIPELINE );
				foreach ( $batchKeys as $key ) {
					$conn->get( $key );
				}
				$batchResult = $conn->exec();
				if ( $batchResult === false ) {
					$this->debug( "multi request to $server failed" );
					continue;
				}
				foreach ( $batchResult as $i => $value ) {
					if ( $value !== false ) {
						$result[$batchKeys[$i]] = $value;
					}
				}
			} catch ( RedisException $e ) {
				$this->handleException( $server, $e );
			}
		}

		$this->debug( "getMulti for " . count( $keys ) . " keys " .
			"returned " . count( $result ) . " results" );
		wfProfileOut( __METHOD__ );
		return $result;
	}

	public function add( $key, $value, $expiry = 0 ) {
		wfProfileIn( __METHOD__ );
		list( $server, $conn ) = $this->getConnection( $key );
		if ( !$conn ) {
			wfProfileOut( __METHOD__ );
			return false;
		}
		$expiry = $this->convertToRelative( $expiry );
		try {
			$result = $conn->setnx( $key, $value );
			if ( $result && $expiry ) {
				$conn->expire( $key, $expiry );
			}
		} catch ( RedisException $e ) {
			$result = false;
			$this->handleException( $server, $e );
		}
		$this->logRequest( 'add', $key, $server, $result );
		wfProfileOut( __METHOD__ );
		return $result;
	}

	/**
	 * Non-atomic implementation of replace(). Could perhaps be done atomically
	 * with WATCH or scripting, but this function is rarely used.
	 */
	public function replace( $key, $value, $expiry = 0 ) {
		wfProfileIn( __METHOD__ );
		list( $server, $conn ) = $this->getConnection( $key );
		if ( !$conn ) {
			wfProfileOut( __METHOD__ );
			return false;
		}
		if ( !$conn->exists( $key ) ) {
			wfProfileOut( __METHOD__ );
			return false;
		}

		$expiry = $this->convertToRelative( $expiry );
		try {
			if ( !$expiry ) {
				$result = $conn->set( $key, $value );
			} else {
				$result = $conn->setex( $key, $expiry, $value );
			}
		} catch ( RedisException $e ) {
			$result = false;
			$this->handleException( $server, $e );
		}

		$this->logRequest( 'replace', $key, $server, $result );
		wfProfileOut( __METHOD__ );
		return $result;
	}

	/**
	 * Non-atomic implementation of incr().
	 *
	 * Probably all callers actually want incr() to atomically initialise
	 * values to zero if they don't exist, as provided by the Redis INCR
	 * command. But we are constrained by the memcached-like interface to
	 * return null in that case. Once the key exists, further increments are
	 * atomic.
	 */
	public function incr( $key, $value = 1 ) {
		wfProfileIn( __METHOD__ );
		list( $server, $conn ) = $this->getConnection( $key );
		if ( !$conn ) {
			wfProfileOut( __METHOD__ );
			return false;
		}
		if ( !$conn->exists( $key ) ) {
			wfProfileOut( __METHOD__ );
			return null;
		}
		try {
			$result = $conn->incrBy( $key, $value );
		} catch ( RedisException $e ) {
			$result = false;
			$this->handleException( $server, $e );
		}

		$this->logRequest( 'incr', $key, $server, $result );
		wfProfileOut( __METHOD__ );
		return $result;
	}

	/**
	 * Get a Redis object with a connection suitable for fetching the specified key
	 */
	protected function getConnection( $key ) {
		if ( count( $this->servers ) === 1 ) {
			$candidates = $this->servers;
		} else {
			// Use consistent hashing
			$hashes = array();
			foreach ( $this->servers as $server ) {
				$hashes[$server] = md5( $server . '/' . $key );
			}
			asort( $hashes );
			if ( !$this->automaticFailover ) {
				reset( $hashes );
				$candidates = array( key( $hashes ) );
			} else {
				$candidates = array_keys( $hashes );
			}
		}

		foreach ( $candidates as $server ) {
			$conn = $this->getConnectionToServer( $server );
			if ( $conn ) {
				return array( $server, $conn );
			}
		}
		return array( false, false );
	}

	/**
	 * Get a connection to the server with the specified name. Connections
	 * are cached, and failures are persistent to avoid multiple timeouts.
	 *
	 * @return Redis object, or false on failure
	 */
	protected function getConnectionToServer( $server ) {
		if ( isset( $this->deadServers[$server] ) ) {
			$now = time();
			if ( $now > $this->deadServers[$server] ) {
				// Dead time expired
				unset( $this->deadServers[$server] );
			} else {
				// Server is dead
				$this->debug( "server $server is marked down for another " .
					($this->deadServers[$server] - $now ) .
					" seconds, can't get connection" );
				return false;
			}
		}

		if ( isset( $this->conns[$server] ) ) {
			return $this->conns[$server];
		}

		if ( substr( $server, 0, 1 ) === '/' ) {
			// UNIX domain socket
			// These are required by the redis extension to start with a slash, but
			// we still need to set the port to a special value to make it work.
			$host = $server;
			$port = 0;
		} else {
			// TCP connection
			$hostPort = IP::splitHostAndPort( $server );
			if ( !$hostPort ) {
				throw new MWException( __CLASS__.": invalid configured server \"$server\"" );
			}
			list( $host, $port ) = $hostPort;
			if ( $port === false ) {
				$port = 6379;
			}
		}
		$conn = new Redis;
		try {
			if ( $this->persistent ) {
				$this->debug( "opening persistent connection to $host:$port" );
				$result = $conn->pconnect( $host, $port, $this->connectTimeout );
			} else {
				$this->debug( "opening non-persistent connection to $host:$port" );
				$result = $conn->connect( $host, $port, $this->connectTimeout );
			}
			if ( !$result ) {
				$this->logError( "could not connect to server $server" );
				// Mark server down for 30s to avoid further timeouts
				$this->deadServers[$server] = time() + 30;
				return false;
			}
			if ( $this->password !== null ) {
				if ( !$conn->auth( $this->password ) ) {
					$this->logError( "authentication error connecting to $server" );
				}
			}
		} catch ( RedisException $e ) {
			$this->deadServers[$server] = time() + 30;
			wfDebugLog( 'redis', "Redis exception: " . $e->getMessage() . "\n" );
			return false;
		}

		$conn->setOption( Redis::OPT_SERIALIZER, Redis::SERIALIZER_PHP );
		$this->conns[$server] = $conn;
		return $conn;
	}

	/**
	 * Log a fatal error
	 */
	protected function logError( $msg ) {
		wfDebugLog( 'redis', "Redis error: $msg\n" );
	}

	/**
	 * The redis extension throws an exception in response to various read, write
	 * and protocol errors. Sometimes it also closes the connection, sometimes
	 * not. The safest response for us is to explicitly destroy the connection
	 * object and let it be reopened during the next request.
	 */
	protected function handleException( $server, $e ) {
		wfDebugLog( 'redis', "Redis exception on server $server: " . $e->getMessage() . "\n" );
		unset( $this->conns[$server] );
	}

	/**
	 * Send information about a single request to the debug log
	 */
	public function logRequest( $method, $key, $server, $result ) {
		$this->debug( "$method $key on $server: " .
			( $result === false ? "failure" : "success" ) );
	}
}