includes/libs/lockmanager/DBLockManager.php

   1 <?php
   2 /**
   3  * Version of LockManager based on using DB table locks.
   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  * @ingroup LockManager
  22  */
  23
  24 use Wikimedia\Rdbms\Database;
  25 use Wikimedia\Rdbms\IDatabase;
  26 use Wikimedia\Rdbms\DBError;
  27
  28 /**
  29  * Version of LockManager based on using named/row DB locks.
  30  *
  31  * This is meant for multi-wiki systems that may share files.
  32  *
  33  * All lock requests for a resource, identified by a hash string, will map to one bucket.
  34  * Each bucket maps to one or several peer DBs, each on their own server.
  35  * A majority of peer DBs must agree for a lock to be acquired.
  36  *
  37  * Caching is used to avoid hitting servers that are down.
  38  *
  39  * @ingroup LockManager
  40  * @since 1.19
  41  */
  42 abstract class DBLockManager extends QuorumLockManager {
  43         /** @var array[]|IDatabase[] Map of (DB names => server config or IDatabase) */
  44         protected $dbServers; // (DB name => server config array)
  45         /** @var BagOStuff */
  46         protected $statusCache;
  47
  48         protected $lockExpiry; // integer number of seconds
  49         protected $safeDelay; // integer number of seconds
  50         /** @var IDatabase[] Map Database connections (DB name => Database) */
  51         protected $conns = [];
  52
  53         /**
  54          * Construct a new instance from configuration.
  55          *
  56          * @param array $config Parameters include:
  57          *   - dbServers   : Associative array of DB names to server configuration.
  58          *                   Configuration is an associative array that includes:
  59          *                     - host        : DB server name
  60          *                     - dbname      : DB name
  61          *                     - type        : DB type (mysql,postgres,...)
  62          *                     - user        : DB user
  63          *                     - password    : DB user password
  64          *                     - tablePrefix : DB table prefix
  65          *                     - flags       : DB flags; bitfield of IDatabase::DBO_* constants
  66          *   - dbsByBucket : Array of 1-16 consecutive integer keys, starting from 0,
  67          *                   each having an odd-numbered list of DB names (peers) as values.
  68          *   - lockExpiry  : Lock timeout (seconds) for dropped connections. [optional]
  69          *                   This tells the DB server how long to wait before assuming
  70          *                   connection failure and releasing all the locks for a session.
  71          *   - srvCache    : A BagOStuff instance using APC or the like.
  72          */
  73         public function __construct( array $config ) {
  74                 parent::__construct( $config );
  75
  76                 $this->dbServers = $config['dbServers'];
  77                 // Sanitize srvsByBucket config to prevent PHP errors
  78                 $this->srvsByBucket = array_filter( $config['dbsByBucket'], 'is_array' );
  79                 $this->srvsByBucket = array_values( $this->srvsByBucket ); // consecutive
  80
  81                 if ( isset( $config['lockExpiry'] ) ) {
  82                         $this->lockExpiry = $config['lockExpiry'];
  83                 } else {
  84                         $met = ini_get( 'max_execution_time' );
  85                         $this->lockExpiry = $met ?: 60; // use some sane amount if 0
  86                 }
  87                 $this->safeDelay = ( $this->lockExpiry <= 0 )
  88                         ? 60 // pick a safe-ish number to match DB timeout default
  89                         : $this->lockExpiry; // cover worst case
  90
  91                 // Tracks peers that couldn't be queried recently to avoid lengthy
  92                 // connection timeouts. This is useless if each bucket has one peer.
  93                 $this->statusCache = $config['srvCache'] ?? new HashBagOStuff();
  94         }
  95
  96         /**
  97          * @todo change this code to work in one batch
  98          * @param string $lockSrv
  99          * @param array $pathsByType
 100          * @return StatusValue
 101          */
 102         protected function getLocksOnServer( $lockSrv, array $pathsByType ) {
 103                 $status = StatusValue::newGood();
 104                 foreach ( $pathsByType as $type => $paths ) {
 105                         $status->merge( $this->doGetLocksOnServer( $lockSrv, $paths, $type ) );
 106                 }
 107
 108                 return $status;
 109         }
 110
 111         abstract protected function doGetLocksOnServer( $lockSrv, array $paths, $type );
 112
 113         protected function freeLocksOnServer( $lockSrv, array $pathsByType ) {
 114                 return StatusValue::newGood();
 115         }
 116
 117         /**
 118          * @see QuorumLockManager::isServerUp()
 119          * @param string $lockSrv
 120          * @return bool
 121          */
 122         protected function isServerUp( $lockSrv ) {
 123                 if ( !$this->cacheCheckFailures( $lockSrv ) ) {
 124                         return false; // recent failure to connect
 125                 }
 126                 try {
 127                         $this->getConnection( $lockSrv );
 128                 } catch ( DBError $e ) {
 129                         $this->cacheRecordFailure( $lockSrv );
 130
 131                         return false; // failed to connect
 132                 }
 133
 134                 return true;
 135         }
 136
 137         /**
 138          * Get (or reuse) a connection to a lock DB
 139          *
 140          * @param string $lockDb
 141          * @return IDatabase
 142          * @throws DBError
 143          * @throws UnexpectedValueException
 144          */
 145         protected function getConnection( $lockDb ) {
 146                 if ( !isset( $this->conns[$lockDb] ) ) {
 147                         if ( $this->dbServers[$lockDb] instanceof IDatabase ) {
 148                                 // Direct injected connection hande for $lockDB
 149                                 $db = $this->dbServers[$lockDb];
 150                         } elseif ( is_array( $this->dbServers[$lockDb] ) ) {
 151                                 // Parameters to construct a new database connection
 152                                 $config = $this->dbServers[$lockDb];
 153                                 $db = Database::factory( $config['type'], $config );
 154                         } else {
 155                                 throw new UnexpectedValueException( "No server called '$lockDb'." );
 156                         }
 157
 158                         $db->clearFlag( DBO_TRX );
 159                         # If the connection drops, try to avoid letting the DB rollback
 160                         # and release the locks before the file operations are finished.
 161                         # This won't handle the case of DB server restarts however.
 162                         $options = [];
 163                         if ( $this->lockExpiry > 0 ) {
 164                                 $options['connTimeout'] = $this->lockExpiry;
 165                         }
 166                         $db->setSessionOptions( $options );
 167                         $this->initConnection( $lockDb, $db );
 168
 169                         $this->conns[$lockDb] = $db;
 170                 }
 171
 172                 return $this->conns[$lockDb];
 173         }
 174
 175         /**
 176          * Do additional initialization for new lock DB connection
 177          *
 178          * @param string $lockDb
 179          * @param IDatabase $db
 180          * @throws DBError
 181          */
 182         protected function initConnection( $lockDb, IDatabase $db ) {
 183         }
 184
 185         /**
 186          * Checks if the DB has not recently had connection/query errors.
 187          * This just avoids wasting time on doomed connection attempts.
 188          *
 189          * @param string $lockDb
 190          * @return bool
 191          */
 192         protected function cacheCheckFailures( $lockDb ) {
 193                 return ( $this->safeDelay > 0 )
 194                         ? !$this->statusCache->get( $this->getMissKey( $lockDb ) )
 195                         : true;
 196         }
 197
 198         /**
 199          * Log a lock request failure to the cache
 200          *
 201          * @param string $lockDb
 202          * @return bool Success
 203          */
 204         protected function cacheRecordFailure( $lockDb ) {
 205                 return ( $this->safeDelay > 0 )
 206                         ? $this->statusCache->set( $this->getMissKey( $lockDb ), 1, $this->safeDelay )
 207                         : true;
 208         }
 209
 210         /**
 211          * Get a cache key for recent query misses for a DB
 212          *
 213          * @param string $lockDb
 214          * @return string
 215          */
 216         protected function getMissKey( $lockDb ) {
 217                 return 'dblockmanager:downservers:' . str_replace( ' ', '_', $lockDb );
 218         }
 219
 220         /**
 221          * Make sure remaining locks get cleared for sanity
 222          */
 223         function __destruct() {
 224                 $this->releaseAllLocks();
 225                 foreach ( $this->conns as $db ) {
 226                         $db->close();
 227                 }
 228         }
 229 }