includes/db/LoadBalancer.php

   1 <?php
   2 /**
   3  * Database load balancing.
   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 Database
  22  */
  23
  24 /**
  25  * Database load balancing object
  26  *
  27  * @todo document
  28  * @ingroup Database
  29  */
  30 class LoadBalancer {
  31         private $mServers, $mConns, $mLoads, $mGroupLoads;
  32         private $mErrorConnection;
  33         private $mReadIndex, $mAllowLagged;
  34         private $mWaitForPos, $mWaitTimeout;
  35         private $mLaggedSlaveMode, $mLastError = 'Unknown error';
  36         private $mParentInfo, $mLagTimes;
  37         private $mLoadMonitorClass, $mLoadMonitor;
  38
  39         /**
  40          * @param array $params with keys:
  41          *    servers           Required. Array of server info structures.
  42          *    masterWaitTimeout Replication lag wait timeout
  43          *    loadMonitor       Name of a class used to fetch server lag and load.
  44          * @throws MWException
  45          */
  46         function __construct( $params ) {
  47                 if ( !isset( $params['servers'] ) ) {
  48                         throw new MWException( __CLASS__ . ': missing servers parameter' );
  49                 }
  50                 $this->mServers = $params['servers'];
  51
  52                 if ( isset( $params['waitTimeout'] ) ) {
  53                         $this->mWaitTimeout = $params['waitTimeout'];
  54                 } else {
  55                         $this->mWaitTimeout = 10;
  56                 }
  57
  58                 $this->mReadIndex = -1;
  59                 $this->mWriteIndex = -1;
  60                 $this->mConns = array(
  61                         'local' => array(),
  62                         'foreignUsed' => array(),
  63                         'foreignFree' => array() );
  64                 $this->mLoads = array();
  65                 $this->mWaitForPos = false;
  66                 $this->mLaggedSlaveMode = false;
  67                 $this->mErrorConnection = false;
  68                 $this->mAllowLagged = false;
  69
  70                 if ( isset( $params['loadMonitor'] ) ) {
  71                         $this->mLoadMonitorClass = $params['loadMonitor'];
  72                 } else {
  73                         $master = reset( $params['servers'] );
  74                         if ( isset( $master['type'] ) && $master['type'] === 'mysql' ) {
  75                                 $this->mLoadMonitorClass = 'LoadMonitor_MySQL';
  76                         } else {
  77                                 $this->mLoadMonitorClass = 'LoadMonitor_Null';
  78                         }
  79                 }
  80
  81                 foreach ( $params['servers'] as $i => $server ) {
  82                         $this->mLoads[$i] = $server['load'];
  83                         if ( isset( $server['groupLoads'] ) ) {
  84                                 foreach ( $server['groupLoads'] as $group => $ratio ) {
  85                                         if ( !isset( $this->mGroupLoads[$group] ) ) {
  86                                                 $this->mGroupLoads[$group] = array();
  87                                         }
  88                                         $this->mGroupLoads[$group][$i] = $ratio;
  89                                 }
  90                         }
  91                 }
  92         }
  93
  94         /**
  95          * Get a LoadMonitor instance
  96          *
  97          * @return LoadMonitor
  98          */
  99         function getLoadMonitor() {
 100                 if ( !isset( $this->mLoadMonitor ) ) {
 101                         $class = $this->mLoadMonitorClass;
 102                         $this->mLoadMonitor = new $class( $this );
 103                 }
 104                 return $this->mLoadMonitor;
 105         }
 106
 107         /**
 108          * Get or set arbitrary data used by the parent object, usually an LBFactory
 109          * @param $x
 110          * @return Mixed
 111          */
 112         function parentInfo( $x = null ) {
 113                 return wfSetVar( $this->mParentInfo, $x );
 114         }
 115
 116         /**
 117          * Given an array of non-normalised probabilities, this function will select
 118          * an element and return the appropriate key
 119          *
 120          * @deprecated since 1.21, use ArrayUtils::pickRandom()
 121          *
 122          * @param $weights array
 123          *
 124          * @return bool|int|string
 125          */
 126         function pickRandom( $weights ) {
 127                 return ArrayUtils::pickRandom( $weights );
 128         }
 129
 130         /**
 131          * @param $loads array
 132          * @param $wiki bool
 133          * @return bool|int|string
 134          */
 135         function getRandomNonLagged( $loads, $wiki = false ) {
 136                 # Unset excessively lagged servers
 137                 $lags = $this->getLagTimes( $wiki );
 138                 foreach ( $lags as $i => $lag ) {
 139                         if ( $i != 0 ) {
 140                                 if ( $lag === false ) {
 141                                         wfDebugLog( 'replication', "Server #$i is not replicating\n" );
 142                                         unset( $loads[$i] );
 143                                 } elseif ( isset( $this->mServers[$i]['max lag'] ) && $lag > $this->mServers[$i]['max lag'] ) {
 144                                         wfDebugLog( 'replication', "Server #$i is excessively lagged ($lag seconds)\n" );
 145                                         unset( $loads[$i] );
 146                                 }
 147                         }
 148                 }
 149
 150                 # Find out if all the slaves with non-zero load are lagged
 151                 $sum = 0;
 152                 foreach ( $loads as $load ) {
 153                         $sum += $load;
 154                 }
 155                 if ( $sum == 0 ) {
 156                         # No appropriate DB servers except maybe the master and some slaves with zero load
 157                         # Do NOT use the master
 158                         # Instead, this function will return false, triggering read-only mode,
 159                         # and a lagged slave will be used instead.
 160                         return false;
 161                 }
 162
 163                 if ( count( $loads ) == 0 ) {
 164                         return false;
 165                 }
 166
 167                 #wfDebugLog( 'connect', var_export( $loads, true ) );
 168
 169                 # Return a random representative of the remainder
 170                 return $this->pickRandom( $loads );
 171         }
 172
 173         /**
 174          * Get the index of the reader connection, which may be a slave
 175          * This takes into account load ratios and lag times. It should
 176          * always return a consistent index during a given invocation
 177          *
 178          * Side effect: opens connections to databases
 179          * @param $group bool
 180          * @param $wiki bool
 181          * @throws MWException
 182          * @return bool|int|string
 183          */
 184         function getReaderIndex( $group = false, $wiki = false ) {
 185                 global $wgReadOnly, $wgDBClusterTimeout, $wgDBAvgStatusPoll, $wgDBtype;
 186
 187                 # @todo FIXME: For now, only go through all this for mysql databases
 188                 if ( $wgDBtype != 'mysql' ) {
 189                         return $this->getWriterIndex();
 190                 }
 191
 192                 if ( count( $this->mServers ) == 1 ) {
 193                         # Skip the load balancing if there's only one server
 194                         return 0;
 195                 } elseif ( $group === false and $this->mReadIndex >= 0 ) {
 196                         # Shortcut if generic reader exists already
 197                         return $this->mReadIndex;
 198                 }
 199
 200                 wfProfileIn( __METHOD__ );
 201
 202                 $totalElapsed = 0;
 203
 204                 # convert from seconds to microseconds
 205                 $timeout = $wgDBClusterTimeout * 1e6;
 206
 207                 # Find the relevant load array
 208                 if ( $group !== false ) {
 209                         if ( isset( $this->mGroupLoads[$group] ) ) {
 210                                 $nonErrorLoads = $this->mGroupLoads[$group];
 211                         } else {
 212                                 # No loads for this group, return false and the caller can use some other group
 213                                 wfDebug( __METHOD__ . ": no loads for group $group\n" );
 214                                 wfProfileOut( __METHOD__ );
 215                                 return false;
 216                         }
 217                 } else {
 218                         $nonErrorLoads = $this->mLoads;
 219                 }
 220
 221                 if ( !$nonErrorLoads ) {
 222                         wfProfileOut( __METHOD__ );
 223                         throw new MWException( "Empty server array given to LoadBalancer" );
 224                 }
 225
 226                 # Scale the configured load ratios according to the dynamic load (if the load monitor supports it)
 227                 $this->getLoadMonitor()->scaleLoads( $nonErrorLoads, $group, $wiki );
 228
 229                 $laggedSlaveMode = false;
 230
 231                 # First try quickly looking through the available servers for a server that
 232                 # meets our criteria
 233                 do {
 234                         $totalThreadsConnected = 0;
 235                         $overloadedServers = 0;
 236                         $currentLoads = $nonErrorLoads;
 237                         while ( count( $currentLoads ) ) {
 238                                 if ( $wgReadOnly || $this->mAllowLagged || $laggedSlaveMode ) {
 239                                         $i = $this->pickRandom( $currentLoads );
 240                                 } else {
 241                                         $i = $this->getRandomNonLagged( $currentLoads, $wiki );
 242                                         if ( $i === false && count( $currentLoads ) != 0 ) {
 243                                                 # All slaves lagged. Switch to read-only mode
 244                                                 wfDebugLog( 'replication', "All slaves lagged. Switch to read-only mode\n" );
 245                                                 $wgReadOnly = 'The database has been automatically locked ' .
 246                                                         'while the slave database servers catch up to the master';
 247                                                 $i = $this->pickRandom( $currentLoads );
 248                                                 $laggedSlaveMode = true;
 249                                         }
 250                                 }
 251
 252                                 if ( $i === false ) {
 253                                         # pickRandom() returned false
 254                                         # This is permanent and means the configuration or the load monitor
 255                                         # wants us to return false.
 256                                         wfDebugLog( 'connect', __METHOD__ . ": pickRandom() returned false\n" );
 257                                         wfProfileOut( __METHOD__ );
 258                                         return false;
 259                                 }
 260
 261                                 wfDebugLog( 'connect', __METHOD__ . ": Using reader #$i: {$this->mServers[$i]['host']}...\n" );
 262                                 $conn = $this->openConnection( $i, $wiki );
 263
 264                                 if ( !$conn ) {
 265                                         wfDebugLog( 'connect', __METHOD__ . ": Failed connecting to $i/$wiki\n" );
 266                                         unset( $nonErrorLoads[$i] );
 267                                         unset( $currentLoads[$i] );
 268                                         continue;
 269                                 }
 270
 271                                 // Perform post-connection backoff
 272                                 $threshold = isset( $this->mServers[$i]['max threads'] )
 273                                         ? $this->mServers[$i]['max threads'] : false;
 274                                 $backoff = $this->getLoadMonitor()->postConnectionBackoff( $conn, $threshold );
 275
 276                                 // Decrement reference counter, we are finished with this connection.
 277                                 // It will be incremented for the caller later.
 278                                 if ( $wiki !== false ) {
 279                                         $this->reuseConnection( $conn );
 280                                 }
 281
 282                                 if ( $backoff ) {
 283                                         # Post-connection overload, don't use this server for now
 284                                         $totalThreadsConnected += $backoff;
 285                                         $overloadedServers++;
 286                                         unset( $currentLoads[$i] );
 287                                 } else {
 288                                         # Return this server
 289                                         break 2;
 290                                 }
 291                         }
 292
 293                         # No server found yet
 294                         $i = false;
 295
 296                         # If all servers were down, quit now
 297                         if ( !count( $nonErrorLoads ) ) {
 298                                 wfDebugLog( 'connect', "All servers down\n" );
 299                                 break;
 300                         }
 301
 302                         # Some servers must have been overloaded
 303                         if ( $overloadedServers == 0 ) {
 304                                 throw new MWException( __METHOD__ . ": unexpectedly found no overloaded servers" );
 305                         }
 306                         # Back off for a while
 307                         # Scale the sleep time by the number of connected threads, to produce a
 308                         # roughly constant global poll rate
 309                         $avgThreads = $totalThreadsConnected / $overloadedServers;
 310                         $totalElapsed += $this->sleep( $wgDBAvgStatusPoll * $avgThreads );
 311                 } while ( $totalElapsed < $timeout );
 312
 313                 if ( $totalElapsed >= $timeout ) {
 314                         wfDebugLog( 'connect', "All servers busy\n" );
 315                         $this->mErrorConnection = false;
 316                         $this->mLastError = 'All servers busy';
 317                 }
 318
 319                 if ( $i !== false ) {
 320                         # Slave connection successful
 321                         # Wait for the session master pos for a short time
 322                         if ( $this->mWaitForPos && $i > 0 ) {
 323                                 if ( !$this->doWait( $i ) ) {
 324                                         $this->mServers[$i]['slave pos'] = $conn->getSlavePos();
 325                                 }
 326                         }
 327                         if ( $this->mReadIndex <= 0 && $this->mLoads[$i] > 0 && $i !== false ) {
 328                                 $this->mReadIndex = $i;
 329                         }
 330                 }
 331                 wfProfileOut( __METHOD__ );
 332                 return $i;
 333         }
 334
 335         /**
 336          * Wait for a specified number of microseconds, and return the period waited
 337          * @param $t int
 338          * @return int
 339          */
 340         function sleep( $t ) {
 341                 wfProfileIn( __METHOD__ );
 342                 wfDebug( __METHOD__ . ": waiting $t us\n" );
 343                 usleep( $t );
 344                 wfProfileOut( __METHOD__ );
 345                 return $t;
 346         }
 347
 348         /**
 349          * Set the master wait position
 350          * If a DB_SLAVE connection has been opened already, waits
 351          * Otherwise sets a variable telling it to wait if such a connection is opened
 352          * @param $pos DBMasterPos
 353          */
 354         public function waitFor( $pos ) {
 355                 wfProfileIn( __METHOD__ );
 356                 $this->mWaitForPos = $pos;
 357                 $i = $this->mReadIndex;
 358
 359                 if ( $i > 0 ) {
 360                         if ( !$this->doWait( $i ) ) {
 361                                 $this->mServers[$i]['slave pos'] = $this->getAnyOpenConnection( $i )->getSlavePos();
 362                                 $this->mLaggedSlaveMode = true;
 363                         }
 364                 }
 365                 wfProfileOut( __METHOD__ );
 366         }
 367
 368         /**
 369          * Set the master wait position and wait for ALL slaves to catch up to it
 370          * @param $pos DBMasterPos
 371          */
 372         public function waitForAll( $pos ) {
 373                 wfProfileIn( __METHOD__ );
 374                 $this->mWaitForPos = $pos;
 375                 for ( $i = 1; $i < count( $this->mServers ); $i++ ) {
 376                         $this->doWait( $i, true );
 377                 }
 378                 wfProfileOut( __METHOD__ );
 379         }
 380
 381         /**
 382          * Get any open connection to a given server index, local or foreign
 383          * Returns false if there is no connection open
 384          *
 385          * @param $i int
 386          * @return DatabaseBase|bool False on failure
 387          */
 388         function getAnyOpenConnection( $i ) {
 389                 foreach ( $this->mConns as $conns ) {
 390                         if ( !empty( $conns[$i] ) ) {
 391                                 return reset( $conns[$i] );
 392                         }
 393                 }
 394                 return false;
 395         }
 396
 397         /**
 398          * Wait for a given slave to catch up to the master pos stored in $this
 399          * @param $index
 400          * @param $open bool
 401          * @return bool
 402          */
 403         protected function doWait( $index, $open = false ) {
 404                 # Find a connection to wait on
 405                 $conn = $this->getAnyOpenConnection( $index );
 406                 if ( !$conn ) {
 407                         if ( !$open ) {
 408                                 wfDebug( __METHOD__ . ": no connection open\n" );
 409                                 return false;
 410                         } else {
 411                                 $conn = $this->openConnection( $index, '' );
 412                                 if ( !$conn ) {
 413                                         wfDebug( __METHOD__ . ": failed to open connection\n" );
 414                                         return false;
 415                                 }
 416                         }
 417                 }
 418
 419                 wfDebug( __METHOD__ . ": Waiting for slave #$index to catch up...\n" );
 420                 $result = $conn->masterPosWait( $this->mWaitForPos, $this->mWaitTimeout );
 421
 422                 if ( $result == -1 || is_null( $result ) ) {
 423                         # Timed out waiting for slave, use master instead
 424                         wfDebug( __METHOD__ . ": Timed out waiting for slave #$index pos {$this->mWaitForPos}\n" );
 425                         return false;
 426                 } else {
 427                         wfDebug( __METHOD__ . ": Done\n" );
 428                         return true;
 429                 }
 430         }
 431
 432         /**
 433          * Get a connection by index
 434          * This is the main entry point for this class.
 435          *
 436          * @param $i Integer: server index
 437          * @param array $groups query groups
 438          * @param bool|string $wiki Wiki ID
 439          *
 440          * @throws MWException
 441          * @return DatabaseBase
 442          */
 443         public function &getConnection( $i, $groups = array(), $wiki = false ) {
 444                 wfProfileIn( __METHOD__ );
 445
 446                 if ( $i == DB_LAST ) {
 447                         wfProfileOut( __METHOD__ );
 448                         throw new MWException( 'Attempt to call ' . __METHOD__ . ' with deprecated server index DB_LAST' );
 449                 } elseif ( $i === null || $i === false ) {
 450                         wfProfileOut( __METHOD__ );
 451                         throw new MWException( 'Attempt to call ' . __METHOD__ . ' with invalid server index' );
 452                 }
 453
 454                 if ( $wiki === wfWikiID() ) {
 455                         $wiki = false;
 456                 }
 457
 458                 # Query groups
 459                 if ( $i == DB_MASTER ) {
 460                         $i = $this->getWriterIndex();
 461                 } elseif ( !is_array( $groups ) ) {
 462                         $groupIndex = $this->getReaderIndex( $groups, $wiki );
 463                         if ( $groupIndex !== false ) {
 464                                 $serverName = $this->getServerName( $groupIndex );
 465                                 wfDebug( __METHOD__ . ": using server $serverName for group $groups\n" );
 466                                 $i = $groupIndex;
 467                         }
 468                 } else {
 469                         foreach ( $groups as $group ) {
 470                                 $groupIndex = $this->getReaderIndex( $group, $wiki );
 471                                 if ( $groupIndex !== false ) {
 472                                         $serverName = $this->getServerName( $groupIndex );
 473                                         wfDebug( __METHOD__ . ": using server $serverName for group $group\n" );
 474                                         $i = $groupIndex;
 475                                         break;
 476                                 }
 477                         }
 478                 }
 479
 480                 # Operation-based index
 481                 if ( $i == DB_SLAVE ) {
 482                         $this->mLastError = 'Unknown error'; // reset error string
 483                         $i = $this->getReaderIndex( false, $wiki );
 484                         # Couldn't find a working server in getReaderIndex()?
 485                         if ( $i === false ) {
 486                                 $this->mLastError = 'No working slave server: ' . $this->mLastError;
 487                                 wfProfileOut( __METHOD__ );
 488                                 return $this->reportConnectionError();
 489                         }
 490                 }
 491
 492                 # Now we have an explicit index into the servers array
 493                 $conn = $this->openConnection( $i, $wiki );
 494                 if ( !$conn ) {
 495                         wfProfileOut( __METHOD__ );
 496                         return $this->reportConnectionError();
 497                 }
 498
 499                 wfProfileOut( __METHOD__ );
 500                 return $conn;
 501         }
 502
 503         /**
 504          * Mark a foreign connection as being available for reuse under a different
 505          * DB name or prefix. This mechanism is reference-counted, and must be called
 506          * the same number of times as getConnection() to work.
 507          *
 508          * @param DatabaseBase $conn
 509          * @throws MWException
 510          */
 511         public function reuseConnection( $conn ) {
 512                 $serverIndex = $conn->getLBInfo( 'serverIndex' );
 513                 $refCount = $conn->getLBInfo( 'foreignPoolRefCount' );
 514                 $dbName = $conn->getDBname();
 515                 $prefix = $conn->tablePrefix();
 516                 if ( strval( $prefix ) !== '' ) {
 517                         $wiki = "$dbName-$prefix";
 518                 } else {
 519                         $wiki = $dbName;
 520                 }
 521                 if ( $serverIndex === null || $refCount === null ) {
 522                         wfDebug( __METHOD__ . ": this connection was not opened as a foreign connection\n" );
 523                         /**
 524                          * This can happen in code like:
 525                          *   foreach ( $dbs as $db ) {
 526                          *     $conn = $lb->getConnection( DB_SLAVE, array(), $db );
 527                          *     ...
 528                          *     $lb->reuseConnection( $conn );
 529                          *   }
 530                          * When a connection to the local DB is opened in this way, reuseConnection()
 531                          * should be ignored
 532                          */
 533                         return;
 534                 }
 535                 if ( $this->mConns['foreignUsed'][$serverIndex][$wiki] !== $conn ) {
 536                         throw new MWException( __METHOD__ . ": connection not found, has the connection been freed already?" );
 537                 }
 538                 $conn->setLBInfo( 'foreignPoolRefCount', --$refCount );
 539                 if ( $refCount <= 0 ) {
 540                         $this->mConns['foreignFree'][$serverIndex][$wiki] = $conn;
 541                         unset( $this->mConns['foreignUsed'][$serverIndex][$wiki] );
 542                         wfDebug( __METHOD__ . ": freed connection $serverIndex/$wiki\n" );
 543                 } else {
 544                         wfDebug( __METHOD__ . ": reference count for $serverIndex/$wiki reduced to $refCount\n" );
 545                 }
 546         }
 547
 548         /**
 549          * Open a connection to the server given by the specified index
 550          * Index must be an actual index into the array.
 551          * If the server is already open, returns it.
 552          *
 553          * On error, returns false, and the connection which caused the
 554          * error will be available via $this->mErrorConnection.
 555          *
 556          * @param $i Integer server index
 557          * @param string $wiki wiki ID to open
 558          * @return DatabaseBase
 559          *
 560          * @access private
 561          */
 562         function openConnection( $i, $wiki = false ) {
 563                 wfProfileIn( __METHOD__ );
 564                 if ( $wiki !== false ) {
 565                         $conn = $this->openForeignConnection( $i, $wiki );
 566                         wfProfileOut( __METHOD__ );
 567                         return $conn;
 568                 }
 569                 if ( isset( $this->mConns['local'][$i][0] ) ) {
 570                         $conn = $this->mConns['local'][$i][0];
 571                 } else {
 572                         $server = $this->mServers[$i];
 573                         $server['serverIndex'] = $i;
 574                         $conn = $this->reallyOpenConnection( $server, false );
 575                         if ( $conn->isOpen() ) {
 576                                 wfDebug( "Connected to database $i at {$this->mServers[$i]['host']}\n" );
 577                                 $this->mConns['local'][$i][0] = $conn;
 578                         } else {
 579                                 wfDebug( "Failed to connect to database $i at {$this->mServers[$i]['host']}\n" );
 580                                 $this->mErrorConnection = $conn;
 581                                 $conn = false;
 582                         }
 583                 }
 584                 wfProfileOut( __METHOD__ );
 585                 return $conn;
 586         }
 587
 588         /**
 589          * Open a connection to a foreign DB, or return one if it is already open.
 590          *
 591          * Increments a reference count on the returned connection which locks the
 592          * connection to the requested wiki. This reference count can be
 593          * decremented by calling reuseConnection().
 594          *
 595          * If a connection is open to the appropriate server already, but with the wrong
 596          * database, it will be switched to the right database and returned, as long as
 597          * it has been freed first with reuseConnection().
 598          *
 599          * On error, returns false, and the connection which caused the
 600          * error will be available via $this->mErrorConnection.
 601          *
 602          * @param $i Integer: server index
 603          * @param string $wiki wiki ID to open
 604          * @return DatabaseBase
 605          */
 606         function openForeignConnection( $i, $wiki ) {
 607                 wfProfileIn( __METHOD__ );
 608                 list( $dbName, $prefix ) = wfSplitWikiID( $wiki );
 609                 if ( isset( $this->mConns['foreignUsed'][$i][$wiki] ) ) {
 610                         // Reuse an already-used connection
 611                         $conn = $this->mConns['foreignUsed'][$i][$wiki];
 612                         wfDebug( __METHOD__ . ": reusing connection $i/$wiki\n" );
 613                 } elseif ( isset( $this->mConns['foreignFree'][$i][$wiki] ) ) {
 614                         // Reuse a free connection for the same wiki
 615                         $conn = $this->mConns['foreignFree'][$i][$wiki];
 616                         unset( $this->mConns['foreignFree'][$i][$wiki] );
 617                         $this->mConns['foreignUsed'][$i][$wiki] = $conn;
 618                         wfDebug( __METHOD__ . ": reusing free connection $i/$wiki\n" );
 619                 } elseif ( !empty( $this->mConns['foreignFree'][$i] ) ) {
 620                         // Reuse a connection from another wiki
 621                         $conn = reset( $this->mConns['foreignFree'][$i] );
 622                         $oldWiki = key( $this->mConns['foreignFree'][$i] );
 623
 624                         if ( !$conn->selectDB( $dbName ) ) {
 625                                 $this->mLastError = "Error selecting database $dbName on server " .
 626                                         $conn->getServer() . " from client host " . wfHostname() . "\n";
 627                                 $this->mErrorConnection = $conn;
 628                                 $conn = false;
 629                         } else {
 630                                 $conn->tablePrefix( $prefix );
 631                                 unset( $this->mConns['foreignFree'][$i][$oldWiki] );
 632                                 $this->mConns['foreignUsed'][$i][$wiki] = $conn;
 633                                 wfDebug( __METHOD__ . ": reusing free connection from $oldWiki for $wiki\n" );
 634                         }
 635                 } else {
 636                         // Open a new connection
 637                         $server = $this->mServers[$i];
 638                         $server['serverIndex'] = $i;
 639                         $server['foreignPoolRefCount'] = 0;
 640                         $conn = $this->reallyOpenConnection( $server, $dbName );
 641                         if ( !$conn->isOpen() ) {
 642                                 wfDebug( __METHOD__ . ": error opening connection for $i/$wiki\n" );
 643                                 $this->mErrorConnection = $conn;
 644                                 $conn = false;
 645                         } else {
 646                                 $conn->tablePrefix( $prefix );
 647                                 $this->mConns['foreignUsed'][$i][$wiki] = $conn;
 648                                 wfDebug( __METHOD__ . ": opened new connection for $i/$wiki\n" );
 649                         }
 650                 }
 651
 652                 // Increment reference count
 653                 if ( $conn ) {
 654                         $refCount = $conn->getLBInfo( 'foreignPoolRefCount' );
 655                         $conn->setLBInfo( 'foreignPoolRefCount', $refCount + 1 );
 656                 }
 657                 wfProfileOut( __METHOD__ );
 658                 return $conn;
 659         }
 660
 661         /**
 662          * Test if the specified index represents an open connection
 663          *
 664          * @param $index Integer: server index
 665          * @access private
 666          * @return bool
 667          */
 668         function isOpen( $index ) {
 669                 if ( !is_integer( $index ) ) {
 670                         return false;
 671                 }
 672                 return (bool)$this->getAnyOpenConnection( $index );
 673         }
 674
 675         /**
 676          * Really opens a connection. Uncached.
 677          * Returns a Database object whether or not the connection was successful.
 678          * @access private
 679          *
 680          * @param $server
 681          * @param $dbNameOverride bool
 682          * @throws MWException
 683          * @return DatabaseBase
 684          */
 685         function reallyOpenConnection( $server, $dbNameOverride = false ) {
 686                 if ( !is_array( $server ) ) {
 687                         throw new MWException( 'You must update your load-balancing configuration. ' .
 688                                 'See DefaultSettings.php entry for $wgDBservers.' );
 689                 }
 690
 691                 if ( $dbNameOverride !== false ) {
 692                         $server['dbname'] = $dbNameOverride;
 693                 }
 694
 695                 # Create object
 696                 try {
 697                         $db = DatabaseBase::factory( $server['type'], $server );
 698                 } catch ( DBConnectionError $e ) {
 699                         // FIXME: This is probably the ugliest thing I have ever done to
 700                         // PHP. I'm half-expecting it to segfault, just out of disgust. -- TS
 701                         $db = $e->db;
 702                 }
 703
 704                 $db->setLBInfo( $server );
 705                 if ( isset( $server['fakeSlaveLag'] ) ) {
 706                         $db->setFakeSlaveLag( $server['fakeSlaveLag'] );
 707                 }
 708                 if ( isset( $server['fakeMaster'] ) ) {
 709                         $db->setFakeMaster( true );
 710                 }
 711                 return $db;
 712         }
 713
 714         /**
 715          * @throws DBConnectionError
 716          * @return bool
 717          */
 718         private function reportConnectionError() {
 719                 $conn = $this->mErrorConnection; // The connection which caused the error
 720
 721                 if ( !is_object( $conn ) ) {
 722                         // No last connection, probably due to all servers being too busy
 723                         wfLogDBError( "LB failure with no last connection. Connection error: {$this->mLastError}\n" );
 724
 725                         // If all servers were busy, mLastError will contain something sensible
 726                         throw new DBConnectionError( null, $this->mLastError );
 727                 } else {
 728                         $server = $conn->getProperty( 'mServer' );
 729                         wfLogDBError( "Connection error: {$this->mLastError} ({$server})\n" );
 730                         $conn->reportConnectionError( "{$this->mLastError} ({$server})" ); // throws DBConnectionError
 731                 }
 732                 return false; /* not reached */
 733         }
 734
 735         /**
 736          * @return int
 737          */
 738         function getWriterIndex() {
 739                 return 0;
 740         }
 741
 742         /**
 743          * Returns true if the specified index is a valid server index
 744          *
 745          * @param $i
 746          * @return bool
 747          */
 748         function haveIndex( $i ) {
 749                 return array_key_exists( $i, $this->mServers );
 750         }
 751
 752         /**
 753          * Returns true if the specified index is valid and has non-zero load
 754          *
 755          * @param $i
 756          * @return bool
 757          */
 758         function isNonZeroLoad( $i ) {
 759                 return array_key_exists( $i, $this->mServers ) && $this->mLoads[$i] != 0;
 760         }
 761
 762         /**
 763          * Get the number of defined servers (not the number of open connections)
 764          *
 765          * @return int
 766          */
 767         function getServerCount() {
 768                 return count( $this->mServers );
 769         }
 770
 771         /**
 772          * Get the host name or IP address of the server with the specified index
 773          * Prefer a readable name if available.
 774          * @param $i
 775          * @return string
 776          */
 777         function getServerName( $i ) {
 778                 if ( isset( $this->mServers[$i]['hostName'] ) ) {
 779                         return $this->mServers[$i]['hostName'];
 780                 } elseif ( isset( $this->mServers[$i]['host'] ) ) {
 781                         return $this->mServers[$i]['host'];
 782                 } else {
 783                         return '';
 784                 }
 785         }
 786
 787         /**
 788          * Return the server info structure for a given index, or false if the index is invalid.
 789          * @param $i
 790          * @return bool
 791          */
 792         function getServerInfo( $i ) {
 793                 if ( isset( $this->mServers[$i] ) ) {
 794                         return $this->mServers[$i];
 795                 } else {
 796                         return false;
 797                 }
 798         }
 799
 800         /**
 801          * Sets the server info structure for the given index. Entry at index $i is created if it doesn't exist
 802          * @param $i
 803          * @param $serverInfo
 804          */
 805         function setServerInfo( $i, $serverInfo ) {
 806                 $this->mServers[$i] = $serverInfo;
 807         }
 808
 809         /**
 810          * Get the current master position for chronology control purposes
 811          * @return mixed
 812          */
 813         function getMasterPos() {
 814                 # If this entire request was served from a slave without opening a connection to the
 815                 # master (however unlikely that may be), then we can fetch the position from the slave.
 816                 $masterConn = $this->getAnyOpenConnection( 0 );
 817                 if ( !$masterConn ) {
 818                         for ( $i = 1; $i < count( $this->mServers ); $i++ ) {
 819                                 $conn = $this->getAnyOpenConnection( $i );
 820                                 if ( $conn ) {
 821                                         wfDebug( "Master pos fetched from slave\n" );
 822                                         return $conn->getSlavePos();
 823                                 }
 824                         }
 825                 } else {
 826                         wfDebug( "Master pos fetched from master\n" );
 827                         return $masterConn->getMasterPos();
 828                 }
 829                 return false;
 830         }
 831
 832         /**
 833          * Close all open connections
 834          */
 835         function closeAll() {
 836                 foreach ( $this->mConns as $conns2 ) {
 837                         foreach ( $conns2 as $conns3 ) {
 838                                 foreach ( $conns3 as $conn ) {
 839                                         $conn->close();
 840                                 }
 841                         }
 842                 }
 843                 $this->mConns = array(
 844                         'local' => array(),
 845                         'foreignFree' => array(),
 846                         'foreignUsed' => array(),
 847                 );
 848         }
 849
 850         /**
 851          * Deprecated function, typo in function name
 852          *
 853          * @deprecated in 1.18
 854          * @param $conn
 855          */
 856         function closeConnecton( $conn ) {
 857                 wfDeprecated( __METHOD__, '1.18' );
 858                 $this->closeConnection( $conn );
 859         }
 860
 861         /**
 862          * Close a connection
 863          * Using this function makes sure the LoadBalancer knows the connection is closed.
 864          * If you use $conn->close() directly, the load balancer won't update its state.
 865          * @param $conn DatabaseBase
 866          */
 867         function closeConnection( $conn ) {
 868                 $done = false;
 869                 foreach ( $this->mConns as $i1 => $conns2 ) {
 870                         foreach ( $conns2 as $i2 => $conns3 ) {
 871                                 foreach ( $conns3 as $i3 => $candidateConn ) {
 872                                         if ( $conn === $candidateConn ) {
 873                                                 $conn->close();
 874                                                 unset( $this->mConns[$i1][$i2][$i3] );
 875                                                 $done = true;
 876                                                 break;
 877                                         }
 878                                 }
 879                         }
 880                 }
 881                 if ( !$done ) {
 882                         $conn->close();
 883                 }
 884         }
 885
 886         /**
 887          * Commit transactions on all open connections
 888          */
 889         function commitAll() {
 890                 foreach ( $this->mConns as $conns2 ) {
 891                         foreach ( $conns2 as $conns3 ) {
 892                                 foreach ( $conns3 as $conn ) {
 893                                         if ( $conn->trxLevel() ) {
 894                                                 $conn->commit( __METHOD__, 'flush' );
 895                                         }
 896                                 }
 897                         }
 898                 }
 899         }
 900
 901         /**
 902          *  Issue COMMIT only on master, only if queries were done on connection
 903          */
 904         function commitMasterChanges() {
 905                 // Always 0, but who knows.. :)
 906                 $masterIndex = $this->getWriterIndex();
 907                 foreach ( $this->mConns as $conns2 ) {
 908                         if ( empty( $conns2[$masterIndex] ) ) {
 909                                 continue;
 910                         }
 911                         foreach ( $conns2[$masterIndex] as $conn ) {
 912                                 if ( $conn->trxLevel() && $conn->writesOrCallbacksPending() ) {
 913                                         $conn->commit( __METHOD__, 'flush' );
 914                                 }
 915                         }
 916                 }
 917         }
 918
 919         /**
 920          * @param $value null
 921          * @return Mixed
 922          */
 923         function waitTimeout( $value = null ) {
 924                 return wfSetVar( $this->mWaitTimeout, $value );
 925         }
 926
 927         /**
 928          * @return bool
 929          */
 930         function getLaggedSlaveMode() {
 931                 return $this->mLaggedSlaveMode;
 932         }
 933
 934         /**
 935          * Disables/enables lag checks
 936          * @param $mode null
 937          * @return bool
 938          */
 939         function allowLagged( $mode = null ) {
 940                 if ( $mode === null ) {
 941                         return $this->mAllowLagged;
 942                 }
 943                 $this->mAllowLagged = $mode;
 944                 return $this->mAllowLagged;
 945         }
 946
 947         /**
 948          * @return bool
 949          */
 950         function pingAll() {
 951                 $success = true;
 952                 foreach ( $this->mConns as $conns2 ) {
 953                         foreach ( $conns2 as $conns3 ) {
 954                                 foreach ( $conns3 as $conn ) {
 955                                         if ( !$conn->ping() ) {
 956                                                 $success = false;
 957                                         }
 958                                 }
 959                         }
 960                 }
 961                 return $success;
 962         }
 963
 964         /**
 965          * Call a function with each open connection object
 966          * @param $callback
 967          * @param array $params
 968          */
 969         function forEachOpenConnection( $callback, $params = array() ) {
 970                 foreach ( $this->mConns as $conns2 ) {
 971                         foreach ( $conns2 as $conns3 ) {
 972                                 foreach ( $conns3 as $conn ) {
 973                                         $mergedParams = array_merge( array( $conn ), $params );
 974                                         call_user_func_array( $callback, $mergedParams );
 975                                 }
 976                         }
 977                 }
 978         }
 979
 980         /**
 981          * Get the hostname and lag time of the most-lagged slave.
 982          * This is useful for maintenance scripts that need to throttle their updates.
 983          * May attempt to open connections to slaves on the default DB. If there is
 984          * no lag, the maximum lag will be reported as -1.
 985          *
 986          * @param string $wiki Wiki ID, or false for the default database
 987          *
 988          * @return array ( host, max lag, index of max lagged host )
 989          */
 990         function getMaxLag( $wiki = false ) {
 991                 $maxLag = -1;
 992                 $host = '';
 993                 $maxIndex = 0;
 994                 if ( $this->getServerCount() > 1 ) { // no replication = no lag
 995                         foreach ( $this->mServers as $i => $conn ) {
 996                                 $conn = false;
 997                                 if ( $wiki === false ) {
 998                                         $conn = $this->getAnyOpenConnection( $i );
 999                                 }
1000                                 if ( !$conn ) {
1001                                         $conn = $this->openConnection( $i, $wiki );
1002                                 }
1003                                 if ( !$conn ) {
1004                                         continue;
1005                                 }
1006                                 $lag = $conn->getLag();
1007                                 if ( $lag > $maxLag ) {
1008                                         $maxLag = $lag;
1009                                         $host = $this->mServers[$i]['host'];
1010                                         $maxIndex = $i;
1011                                 }
1012                         }
1013                 }
1014                 return array( $host, $maxLag, $maxIndex );
1015         }
1016
1017         /**
1018          * Get lag time for each server
1019          * Results are cached for a short time in memcached, and indefinitely in the process cache
1020          *
1021          * @param $wiki
1022          *
1023          * @return array
1024          */
1025         function getLagTimes( $wiki = false ) {
1026                 # Try process cache
1027                 if ( isset( $this->mLagTimes ) ) {
1028                         return $this->mLagTimes;
1029                 }
1030                 if ( $this->getServerCount() == 1 ) {
1031                         # No replication
1032                         $this->mLagTimes = array( 0 => 0 );
1033                 } else {
1034                         # Send the request to the load monitor
1035                         $this->mLagTimes = $this->getLoadMonitor()->getLagTimes(
1036                                 array_keys( $this->mServers ), $wiki );
1037                 }
1038                 return $this->mLagTimes;
1039         }
1040
1041         /**
1042          * Get the lag in seconds for a given connection, or zero if this load
1043          * balancer does not have replication enabled.
1044          *
1045          * This should be used in preference to Database::getLag() in cases where
1046          * replication may not be in use, since there is no way to determine if
1047          * replication is in use at the connection level without running
1048          * potentially restricted queries such as SHOW SLAVE STATUS. Using this
1049          * function instead of Database::getLag() avoids a fatal error in this
1050          * case on many installations.
1051          *
1052          * @param $conn DatabaseBase
1053          *
1054          * @return int
1055          */
1056         function safeGetLag( $conn ) {
1057                 if ( $this->getServerCount() == 1 ) {
1058                         return 0;
1059                 } else {
1060                         return $conn->getLag();
1061                 }
1062         }
1063
1064         /**
1065          * Clear the cache for getLagTimes
1066          */
1067         function clearLagTimeCache() {
1068                 $this->mLagTimes = null;
1069         }
1070 }