includes/libs/redis/RedisConnectionPool.php

   1 <?php
   2 /**
   3  * Redis client connection pooling manager.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @defgroup Redis Redis
  22  */
  23
  24 use Psr\Log\LoggerAwareInterface;
  25 use Psr\Log\LoggerInterface;
  26 use Psr\Log\NullLogger;
  27
  28 /**
  29  * Helper class to manage Redis connections.
  30  *
  31  * This can be used to get handle wrappers that free the handle when the wrapper
  32  * leaves scope. The maximum number of free handles (connections) is configurable.
  33  * This provides an easy way to cache connection handles that may also have state,
  34  * such as a handle does between multi() and exec(), and without hoarding connections.
  35  * The wrappers use PHP magic methods so that calling functions on them calls the
  36  * function of the actual Redis object handle.
  37  *
  38  * @ingroup Redis
  39  * @since 1.21
  40  */
  41 class RedisConnectionPool implements LoggerAwareInterface {
  42         /** @var string Connection timeout in seconds */
  43         protected $connectTimeout;
  44         /** @var string Read timeout in seconds */
  45         protected $readTimeout;
  46         /** @var string Plaintext auth password */
  47         protected $password;
  48         /** @var bool Whether connections persist */
  49         protected $persistent;
  50         /** @var int Serializer to use (Redis::SERIALIZER_*) */
  51         protected $serializer;
  52         /** @var string ID for persistent connections */
  53         protected $id;
  54
  55         /** @var int Current idle pool size */
  56         protected $idlePoolSize = 0;
  57
  58         /** @var array (server name => ((connection info array),...) */
  59         protected $connections = [];
  60         /** @var array (server name => UNIX timestamp) */
  61         protected $downServers = [];
  62
  63         /** @var array (pool ID => RedisConnectionPool) */
  64         protected static $instances = [];
  65
  66         /** integer; seconds to cache servers as "down". */
  67         const SERVER_DOWN_TTL = 30;
  68
  69         /**
  70          * @var LoggerInterface
  71          */
  72         protected $logger;
  73
  74         /**
  75          * @param array $options
  76          * @param string $id
  77          * @throws Exception
  78          */
  79         protected function __construct( array $options, $id ) {
  80                 if ( !class_exists( 'Redis' ) ) {
  81                         throw new RuntimeException(
  82                                 __CLASS__ . ' requires a Redis client library. ' .
  83                                 'See https://www.mediawiki.org/wiki/Redis#Setup' );
  84                 }
  85                 $this->logger = $options['logger'] ?? new NullLogger();
  86                 $this->connectTimeout = $options['connectTimeout'];
  87                 $this->readTimeout = $options['readTimeout'];
  88                 $this->persistent = $options['persistent'];
  89                 $this->password = $options['password'];
  90                 if ( !isset( $options['serializer'] ) || $options['serializer'] === 'php' ) {
  91                         $this->serializer = Redis::SERIALIZER_PHP;
  92                 } elseif ( $options['serializer'] === 'igbinary' ) {
  93                         $this->serializer = Redis::SERIALIZER_IGBINARY;
  94                 } elseif ( $options['serializer'] === 'none' ) {
  95                         $this->serializer = Redis::SERIALIZER_NONE;
  96                 } else {
  97                         throw new InvalidArgumentException( "Invalid serializer specified." );
  98                 }
  99                 $this->id = $id;
 100         }
 101
 102         public function setLogger( LoggerInterface $logger ) {
 103                 $this->logger = $logger;
 104         }
 105
 106         /**
 107          * @param array $options
 108          * @return array
 109          */
 110         protected static function applyDefaultConfig( array $options ) {
 111                 if ( !isset( $options['connectTimeout'] ) ) {
 112                         $options['connectTimeout'] = 1;
 113                 }
 114                 if ( !isset( $options['readTimeout'] ) ) {
 115                         $options['readTimeout'] = 1;
 116                 }
 117                 if ( !isset( $options['persistent'] ) ) {
 118                         $options['persistent'] = false;
 119                 }
 120                 if ( !isset( $options['password'] ) ) {
 121                         $options['password'] = null;
 122                 }
 123
 124                 return $options;
 125         }
 126
 127         /**
 128          * @param array $options
 129          * $options include:
 130          *   - connectTimeout : The timeout for new connections, in seconds.
 131          *                      Optional, default is 1 second.
 132          *   - readTimeout    : The timeout for operation reads, in seconds.
 133          *                      Commands like BLPOP can fail if told to wait longer than this.
 134          *                      Optional, default is 1 second.
 135          *   - persistent     : Set this to true to allow connections to persist across
 136          *                      multiple web requests. False by default.
 137          *   - password       : The authentication password, will be sent to Redis in clear text.
 138          *                      Optional, if it is unspecified, no AUTH command will be sent.
 139          *   - serializer     : Set to "php", "igbinary", or "none". Default is "php".
 140          * @return RedisConnectionPool
 141          */
 142         public static function singleton( array $options ) {
 143                 $options = self::applyDefaultConfig( $options );
 144                 // Map the options to a unique hash...
 145                 ksort( $options ); // normalize to avoid pool fragmentation
 146                 $id = sha1( serialize( $options ) );
 147                 // Initialize the object at the hash as needed...
 148                 if ( !isset( self::$instances[$id] ) ) {
 149                         self::$instances[$id] = new self( $options, $id );
 150                 }
 151
 152                 return self::$instances[$id];
 153         }
 154
 155         /**
 156          * Destroy all singleton() instances
 157          * @since 1.27
 158          */
 159         public static function destroySingletons() {
 160                 self::$instances = [];
 161         }
 162
 163         /**
 164          * Get a connection to a redis server. Based on code in RedisBagOStuff.php.
 165          *
 166          * @param string $server A hostname/port combination or the absolute path of a UNIX socket.
 167          *                       If a hostname is specified but no port, port 6379 will be used.
 168          * @param LoggerInterface|null $logger PSR-3 logger intance. [optional]
 169          * @return RedisConnRef|Redis|bool Returns false on failure
 170          * @throws MWException
 171          */
 172         public function getConnection( $server, LoggerInterface $logger = null ) {
 173                 // The above @return also documents 'Redis' for convenience with IDEs.
 174                 // RedisConnRef uses PHP magic methods, which wouldn't be recognised.
 175
 176                 $logger = $logger ?: $this->logger;
 177                 // Check the listing "dead" servers which have had a connection errors.
 178                 // Servers are marked dead for a limited period of time, to
 179                 // avoid excessive overhead from repeated connection timeouts.
 180                 if ( isset( $this->downServers[$server] ) ) {
 181                         $now = time();
 182                         if ( $now > $this->downServers[$server] ) {
 183                                 // Dead time expired
 184                                 unset( $this->downServers[$server] );
 185                         } else {
 186                                 // Server is dead
 187                                 $logger->debug(
 188                                         'Server "{redis_server}" is marked down for another ' .
 189                                         ( $this->downServers[$server] - $now ) . 'seconds',
 190                                         [ 'redis_server' => $server ]
 191                                 );
 192
 193                                 return false;
 194                         }
 195                 }
 196
 197                 // Check if a connection is already free for use
 198                 if ( isset( $this->connections[$server] ) ) {
 199                         foreach ( $this->connections[$server] as &$connection ) {
 200                                 if ( $connection['free'] ) {
 201                                         $connection['free'] = false;
 202                                         --$this->idlePoolSize;
 203
 204                                         return new RedisConnRef(
 205                                                 $this, $server, $connection['conn'], $logger
 206                                         );
 207                                 }
 208                         }
 209                 }
 210
 211                 if ( !$server ) {
 212                         throw new InvalidArgumentException(
 213                                 __CLASS__ . ": invalid configured server \"$server\"" );
 214                 } elseif ( substr( $server, 0, 1 ) === '/' ) {
 215                         // UNIX domain socket
 216                         // These are required by the redis extension to start with a slash, but
 217                         // we still need to set the port to a special value to make it work.
 218                         $host = $server;
 219                         $port = 0;
 220                 } else {
 221                         // TCP connection
 222                         if ( preg_match( '/^\[(.+)\]:(\d+)$/', $server, $m ) ) {
 223                                 list( $host, $port ) = [ $m[1], (int)$m[2] ]; // (ip, port)
 224                         } elseif ( preg_match( '/^([^:]+):(\d+)$/', $server, $m ) ) {
 225                                 list( $host, $port ) = [ $m[1], (int)$m[2] ]; // (ip or path, port)
 226                         } else {
 227                                 list( $host, $port ) = [ $server, 6379 ]; // (ip or path, port)
 228                         }
 229                 }
 230
 231                 $conn = new Redis();
 232                 try {
 233                         if ( $this->persistent ) {
 234                                 $result = $conn->pconnect( $host, $port, $this->connectTimeout, $this->id );
 235                         } else {
 236                                 $result = $conn->connect( $host, $port, $this->connectTimeout );
 237                         }
 238                         if ( !$result ) {
 239                                 $logger->error(
 240                                         'Could not connect to server "{redis_server}"',
 241                                         [ 'redis_server' => $server ]
 242                                 );
 243                                 // Mark server down for some time to avoid further timeouts
 244                                 $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
 245
 246                                 return false;
 247                         }
 248                         if ( ( $this->password !== null ) && !$conn->auth( $this->password ) ) {
 249                                 $logger->error(
 250                                         'Authentication error connecting to "{redis_server}"',
 251                                         [ 'redis_server' => $server ]
 252                                 );
 253                         }
 254                 } catch ( RedisException $e ) {
 255                         $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
 256                         $logger->error(
 257                                 'Redis exception connecting to "{redis_server}"',
 258                                 [
 259                                         'redis_server' => $server,
 260                                         'exception' => $e,
 261                                 ]
 262                         );
 263
 264                         return false;
 265                 }
 266
 267                 if ( $conn ) {
 268                         $conn->setOption( Redis::OPT_READ_TIMEOUT, $this->readTimeout );
 269                         $conn->setOption( Redis::OPT_SERIALIZER, $this->serializer );
 270                         $this->connections[$server][] = [ 'conn' => $conn, 'free' => false ];
 271
 272                         return new RedisConnRef( $this, $server, $conn, $logger );
 273                 } else {
 274                         return false;
 275                 }
 276         }
 277
 278         /**
 279          * Mark a connection to a server as free to return to the pool
 280          *
 281          * @param string $server
 282          * @param Redis $conn
 283          * @return bool
 284          */
 285         public function freeConnection( $server, Redis $conn ) {
 286                 $found = false;
 287
 288                 foreach ( $this->connections[$server] as &$connection ) {
 289                         if ( $connection['conn'] === $conn && !$connection['free'] ) {
 290                                 $connection['free'] = true;
 291                                 ++$this->idlePoolSize;
 292                                 break;
 293                         }
 294                 }
 295
 296                 $this->closeExcessIdleConections();
 297
 298                 return $found;
 299         }
 300
 301         /**
 302          * Close any extra idle connections if there are more than the limit
 303          */
 304         protected function closeExcessIdleConections() {
 305                 if ( $this->idlePoolSize <= count( $this->connections ) ) {
 306                         return; // nothing to do (no more connections than servers)
 307                 }
 308
 309                 foreach ( $this->connections as &$serverConnections ) {
 310                         foreach ( $serverConnections as $key => &$connection ) {
 311                                 if ( $connection['free'] ) {
 312                                         unset( $serverConnections[$key] );
 313                                         if ( --$this->idlePoolSize <= count( $this->connections ) ) {
 314                                                 return; // done (no more connections than servers)
 315                                         }
 316                                 }
 317                         }
 318                 }
 319         }
 320
 321         /**
 322          * The redis extension throws an exception in response to various read, write
 323          * and protocol errors. Sometimes it also closes the connection, sometimes
 324          * not. The safest response for us is to explicitly destroy the connection
 325          * object and let it be reopened during the next request.
 326          *
 327          * @param RedisConnRef $cref
 328          * @param RedisException $e
 329          */
 330         public function handleError( RedisConnRef $cref, RedisException $e ) {
 331                 $server = $cref->getServer();
 332                 $this->logger->error(
 333                         'Redis exception on server "{redis_server}"',
 334                         [
 335                                 'redis_server' => $server,
 336                                 'exception' => $e,
 337                         ]
 338                 );
 339                 foreach ( $this->connections[$server] as $key => $connection ) {
 340                         if ( $cref->isConnIdentical( $connection['conn'] ) ) {
 341                                 $this->idlePoolSize -= $connection['free'] ? 1 : 0;
 342                                 unset( $this->connections[$server][$key] );
 343                                 break;
 344                         }
 345                 }
 346         }
 347
 348         /**
 349          * Re-send an AUTH request to the redis server (useful after disconnects).
 350          *
 351          * This works around an upstream bug in phpredis. phpredis hides disconnects by transparently
 352          * reconnecting, but it neglects to re-authenticate the new connection. To the user of the
 353          * phpredis client API this manifests as a seemingly random tendency of connections to lose
 354          * their authentication status.
 355          *
 356          * This method is for internal use only.
 357          *
 358          * @see https://github.com/nicolasff/phpredis/issues/403
 359          *
 360          * @param string $server
 361          * @param Redis $conn
 362          * @return bool Success
 363          */
 364         public function reauthenticateConnection( $server, Redis $conn ) {
 365                 if ( $this->password !== null && !$conn->auth( $this->password ) ) {
 366                         $this->logger->error(
 367                                 'Authentication error connecting to "{redis_server}"',
 368                                 [ 'redis_server' => $server ]
 369                         );
 370
 371                         return false;
 372                 }
 373
 374                 return true;
 375         }
 376
 377         /**
 378          * Adjust or reset the connection handle read timeout value
 379          *
 380          * @param Redis $conn
 381          * @param int|null $timeout Optional
 382          */
 383         public function resetTimeout( Redis $conn, $timeout = null ) {
 384                 $conn->setOption( Redis::OPT_READ_TIMEOUT, $timeout ?: $this->readTimeout );
 385         }
 386
 387         /**
 388          * Make sure connections are closed for sanity
 389          */
 390         function __destruct() {
 391                 foreach ( $this->connections as $server => &$serverConnections ) {
 392                         foreach ( $serverConnections as $key => &$connection ) {
 393                                 try {
 394                                         /** @var Redis $conn */
 395                                         $conn = $connection['conn'];
 396                                         $conn->close();
 397                                 } catch ( RedisException $e ) {
 398                                         // The destructor can be called on shutdown when random parts of the system
 399                                         // have been destructed already, causing weird errors. Ignore them.
 400                                 }
 401                         }
 402                 }
 403         }
 404 }