3 * Database load balancing manager
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
22 namespace Wikimedia\Rdbms
;
24 use Psr\Log\LoggerInterface
;
25 use Psr\Log\NullLogger
;
26 use Wikimedia\ScopedCallback
;
31 use InvalidArgumentException
;
36 * Database connection, tracking, load balancing, and transaction manager for a cluster
40 class LoadBalancer
implements ILoadBalancer
{
41 /** @var ILoadMonitor */
43 /** @var callable|null Callback to run before the first connection attempt */
44 private $chronologyCallback;
47 /** @var WANObjectCache */
49 /** @var object|string Class name or object With profileIn/profileOut methods */
51 /** @var TransactionProfiler */
53 /** @var LoggerInterface */
55 /** @var LoggerInterface */
57 /** @var LoggerInterface */
59 /** @var LoggerInterface */
61 /** @var callable Exception logger */
63 /** @var callable Deprecation logger */
64 private $deprecationLogger;
66 /** @var DatabaseDomain Local Domain ID and default for selectDB() calls */
69 /** @var Database[][][] Map of (connection category => server index => IDatabase[]) */
72 /** @var array[] Map of (server index => server config array) */
74 /** @var float[] Map of (server index => weight) */
76 /** @var array[] Map of (group => server index => weight) */
78 /** @var bool Whether to disregard replica DB lag as a factor in replica DB selection */
80 /** @var int Seconds to spend waiting on replica DB lag to resolve */
82 /** @var array The LoadMonitor configuration */
83 private $loadMonitorConfig;
84 /** @var string Alternate ID string for the domain instead of DatabaseDomain::getId() */
85 private $localDomainIdAlias;
87 private $maxLag = self
::MAX_LAG_DEFAULT
;
89 /** @var string Current server name */
91 /** @var bool Whether this PHP instance is for a CLI script */
93 /** @var string Agent name for query profiling */
96 /** @var array[] $aliases Map of (table => (dbname, schema, prefix) map) */
97 private $tableAliases = [];
98 /** @var string[] Map of (index alias => index) */
99 private $indexAliases = [];
100 /** @var array[] Map of (name => callable) */
101 private $trxRecurringCallbacks = [];
103 /** @var Database DB connection object that caused a problem */
104 private $errorConnection;
105 /** @var int The generic (not query grouped) replica DB index (of $mServers) */
107 /** @var bool|DBMasterPos False if not set */
109 /** @var bool Whether the generic reader fell back to a lagged replica DB */
110 private $laggedReplicaMode = false;
111 /** @var bool Whether the generic reader fell back to a lagged replica DB */
112 private $allReplicasDownMode = false;
113 /** @var string The last DB selection or connection error */
114 private $lastError = 'Unknown error';
115 /** @var string|bool Reason the LB is read-only or false if not */
116 private $readOnlyReason = false;
117 /** @var int Total connections opened */
118 private $connsOpened = 0;
120 private $disabled = false;
121 /** @var bool Whether any connection has been attempted yet */
122 private $connectionAttempted = false;
124 /** @var string|bool String if a requested DBO_TRX transaction round is active */
125 private $trxRoundId = false;
126 /** @var string Stage of the current transaction round in the transaction round life-cycle */
127 private $trxRoundStage = self
::ROUND_CURSORY
;
129 /** @var string|null */
130 private $defaultGroup = null;
132 /** @var int Warn when this many connection are held */
133 const CONN_HELD_WARN_THRESHOLD
= 10;
135 /** @var int Default 'maxLag' when unspecified */
136 const MAX_LAG_DEFAULT
= 10;
137 /** @var int Default 'waitTimeout' when unspecified */
138 const MAX_WAIT_DEFAULT
= 10;
139 /** @var int Seconds to cache master server read-only status */
140 const TTL_CACHE_READONLY
= 5;
142 const KEY_LOCAL
= 'local';
143 const KEY_FOREIGN_FREE
= 'foreignFree';
144 const KEY_FOREIGN_INUSE
= 'foreignInUse';
146 const KEY_LOCAL_NOROUND
= 'localAutoCommit';
147 const KEY_FOREIGN_FREE_NOROUND
= 'foreignFreeAutoCommit';
148 const KEY_FOREIGN_INUSE_NOROUND
= 'foreignInUseAutoCommit';
150 /** @var string Transaction round, explicit or implicit, has not finished writing */
151 const ROUND_CURSORY
= 'cursory';
152 /** @var string Transaction round writes are complete and ready for pre-commit checks */
153 const ROUND_FINALIZED
= 'finalized';
154 /** @var string Transaction round passed final pre-commit checks */
155 const ROUND_APPROVED
= 'approved';
156 /** @var string Transaction round was committed and post-commit callbacks must be run */
157 const ROUND_COMMIT_CALLBACKS
= 'commit-callbacks';
158 /** @var string Transaction round was rolled back and post-rollback callbacks must be run */
159 const ROUND_ROLLBACK_CALLBACKS
= 'rollback-callbacks';
160 /** @var string Transaction round encountered an error */
161 const ROUND_ERROR
= 'error';
163 public function __construct( array $params ) {
164 if ( !isset( $params['servers'] ) ) {
165 throw new InvalidArgumentException( __CLASS__
. ': missing servers parameter' );
167 $this->servers
= $params['servers'];
168 foreach ( $this->servers
as $i => $server ) {
170 $this->servers
[$i]['master'] = true;
172 $this->servers
[$i]['replica'] = true;
176 $localDomain = isset( $params['localDomain'] )
177 ? DatabaseDomain
::newFromId( $params['localDomain'] )
178 : DatabaseDomain
::newUnspecified();
179 $this->setLocalDomain( $localDomain );
181 $this->waitTimeout
= $params['waitTimeout'] ?? self
::MAX_WAIT_DEFAULT
;
183 $this->readIndex
= -1;
185 // Connection were transaction rounds may be applied
186 self
::KEY_LOCAL
=> [],
187 self
::KEY_FOREIGN_INUSE
=> [],
188 self
::KEY_FOREIGN_FREE
=> [],
189 // Auto-committing counterpart connections that ignore transaction rounds
190 self
::KEY_LOCAL_NOROUND
=> [],
191 self
::KEY_FOREIGN_INUSE_NOROUND
=> [],
192 self
::KEY_FOREIGN_FREE_NOROUND
=> []
195 $this->waitForPos
= false;
196 $this->allowLagged
= false;
198 if ( isset( $params['readOnlyReason'] ) && is_string( $params['readOnlyReason'] ) ) {
199 $this->readOnlyReason
= $params['readOnlyReason'];
202 if ( isset( $params['maxLag'] ) ) {
203 $this->maxLag
= $params['maxLag'];
206 if ( isset( $params['loadMonitor'] ) ) {
207 $this->loadMonitorConfig
= $params['loadMonitor'];
209 $this->loadMonitorConfig
= [ 'class' => 'LoadMonitorNull' ];
211 $this->loadMonitorConfig +
= [ 'lagWarnThreshold' => $this->maxLag
];
213 foreach ( $params['servers'] as $i => $server ) {
214 $this->loads
[$i] = $server['load'];
215 if ( isset( $server['groupLoads'] ) ) {
216 foreach ( $server['groupLoads'] as $group => $ratio ) {
217 if ( !isset( $this->groupLoads
[$group] ) ) {
218 $this->groupLoads
[$group] = [];
220 $this->groupLoads
[$group][$i] = $ratio;
225 if ( isset( $params['srvCache'] ) ) {
226 $this->srvCache
= $params['srvCache'];
228 $this->srvCache
= new EmptyBagOStuff();
230 if ( isset( $params['wanCache'] ) ) {
231 $this->wanCache
= $params['wanCache'];
233 $this->wanCache
= WANObjectCache
::newEmpty();
235 $this->profiler
= $params['profiler'] ??
null;
236 if ( isset( $params['trxProfiler'] ) ) {
237 $this->trxProfiler
= $params['trxProfiler'];
239 $this->trxProfiler
= new TransactionProfiler();
242 $this->errorLogger
= $params['errorLogger'] ??
function ( Exception
$e ) {
243 trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING
);
245 $this->deprecationLogger
= $params['deprecationLogger'] ??
function ( $msg ) {
246 trigger_error( $msg, E_USER_DEPRECATED
);
249 foreach ( [ 'replLogger', 'connLogger', 'queryLogger', 'perfLogger' ] as $key ) {
250 $this->$key = $params[$key] ??
new NullLogger();
253 $this->hostname
= $params['hostname'] ??
( gethostname() ?
: 'unknown' );
254 $this->cliMode
= $params['cliMode'] ??
( PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg' );
255 $this->agent
= $params['agent'] ??
'';
257 if ( isset( $params['chronologyCallback'] ) ) {
258 $this->chronologyCallback
= $params['chronologyCallback'];
261 if ( isset( $params['roundStage'] ) ) {
262 if ( $params['roundStage'] === self
::STAGE_POSTCOMMIT_CALLBACKS
) {
263 $this->trxRoundStage
= self
::ROUND_COMMIT_CALLBACKS
;
264 } elseif ( $params['roundStage'] === self
::STAGE_POSTROLLBACK_CALLBACKS
) {
265 $this->trxRoundStage
= self
::ROUND_ROLLBACK_CALLBACKS
;
269 $this->defaultGroup
= $params['defaultGroup'] ??
null;
272 public function getLocalDomainID() {
273 return $this->localDomain
->getId();
276 public function resolveDomainID( $domain ) {
277 return ( $domain !== false ) ?
(string)$domain : $this->getLocalDomainID();
281 * Get a LoadMonitor instance
283 * @return ILoadMonitor
285 private function getLoadMonitor() {
286 if ( !isset( $this->loadMonitor
) ) {
288 'LoadMonitor' => LoadMonitor
::class,
289 'LoadMonitorNull' => LoadMonitorNull
::class,
290 'LoadMonitorMySQL' => LoadMonitorMySQL
::class,
293 $class = $this->loadMonitorConfig
['class'];
294 if ( isset( $compat[$class] ) ) {
295 $class = $compat[$class];
298 $this->loadMonitor
= new $class(
299 $this, $this->srvCache
, $this->wanCache
, $this->loadMonitorConfig
);
300 $this->loadMonitor
->setLogger( $this->replLogger
);
303 return $this->loadMonitor
;
307 * @param array $loads
308 * @param bool|string $domain Domain to get non-lagged for
309 * @param int $maxLag Restrict the maximum allowed lag to this many seconds
310 * @return bool|int|string
312 private function getRandomNonLagged( array $loads, $domain = false, $maxLag = INF
) {
313 $lags = $this->getLagTimes( $domain );
315 # Unset excessively lagged servers
316 foreach ( $lags as $i => $lag ) {
318 # How much lag this server nominally is allowed to have
319 $maxServerLag = $this->servers
[$i]['max lag'] ??
$this->maxLag
; // default
320 # Constrain that futher by $maxLag argument
321 $maxServerLag = min( $maxServerLag, $maxLag );
323 $host = $this->getServerName( $i );
324 if ( $lag === false && !is_infinite( $maxServerLag ) ) {
325 $this->replLogger
->error(
327 ": server {host} is not replicating?", [ 'host' => $host ] );
329 } elseif ( $lag > $maxServerLag ) {
330 $this->replLogger
->info(
332 ": server {host} has {lag} seconds of lag (>= {maxlag})",
333 [ 'host' => $host, 'lag' => $lag, 'maxlag' => $maxServerLag ]
340 # Find out if all the replica DBs with non-zero load are lagged
342 foreach ( $loads as $load ) {
346 # No appropriate DB servers except maybe the master and some replica DBs with zero load
347 # Do NOT use the master
348 # Instead, this function will return false, triggering read-only mode,
349 # and a lagged replica DB will be used instead.
353 if ( count( $loads ) == 0 ) {
357 # Return a random representative of the remainder
358 return ArrayUtils
::pickRandom( $loads );
361 public function getReaderIndex( $group = false, $domain = false ) {
362 if ( count( $this->servers
) == 1 ) {
363 // Skip the load balancing if there's only one server
364 return $this->getWriterIndex();
365 } elseif ( $group === false && $this->readIndex
>= 0 ) {
366 // Shortcut if the generic reader index was already cached
367 return $this->readIndex
;
370 if ( $group !== false ) {
371 // Use the server weight array for this load group
372 if ( isset( $this->groupLoads
[$group] ) ) {
373 $loads = $this->groupLoads
[$group];
375 // No loads for this group, return false and the caller can use some other group
376 $this->connLogger
->info( __METHOD__
. ": no loads for group $group" );
381 // Use the generic load group
382 $loads = $this->loads
;
385 // Scale the configured load ratios according to each server's load and state
386 $this->getLoadMonitor()->scaleLoads( $loads, $domain );
388 // Pick a server to use, accounting for weights, load, lag, and "waitForPos"
389 list( $i, $laggedReplicaMode ) = $this->pickReaderIndex( $loads, $domain );
390 if ( $i === false ) {
391 // Replica DB connection unsuccessful
395 if ( $this->waitForPos
&& $i != $this->getWriterIndex() ) {
396 // Before any data queries are run, wait for the server to catch up to the
397 // specified position. This is used to improve session consistency. Note that
398 // when LoadBalancer::waitFor() sets "waitForPos", the waiting triggers here,
399 // so update laggedReplicaMode as needed for consistency.
400 if ( !$this->doWait( $i ) ) {
401 $laggedReplicaMode = true;
405 if ( $this->readIndex
<= 0 && $this->loads
[$i] > 0 && $group === false ) {
406 // Cache the generic reader index for future ungrouped DB_REPLICA handles
407 $this->readIndex
= $i;
408 // Record if the generic reader index is in "lagged replica DB" mode
409 if ( $laggedReplicaMode ) {
410 $this->laggedReplicaMode
= true;
414 $serverName = $this->getServerName( $i );
415 $this->connLogger
->debug( __METHOD__
. ": using server $serverName for group '$group'" );
421 * @param array $loads List of server weights
422 * @param string|bool $domain
423 * @return array (reader index, lagged replica mode) or false on failure
425 private function pickReaderIndex( array $loads, $domain = false ) {
426 if ( !count( $loads ) ) {
427 throw new InvalidArgumentException( "Empty server array given to LoadBalancer" );
430 /** @var int|bool $i Index of selected server */
432 /** @var bool $laggedReplicaMode Whether server is considered lagged */
433 $laggedReplicaMode = false;
435 // Quickly look through the available servers for a server that meets criteria...
436 $currentLoads = $loads;
437 while ( count( $currentLoads ) ) {
438 if ( $this->allowLagged ||
$laggedReplicaMode ) {
439 $i = ArrayUtils
::pickRandom( $currentLoads );
442 if ( $this->waitForPos
&& $this->waitForPos
->asOfTime() ) {
443 // "chronologyCallback" sets "waitForPos" for session consistency.
444 // This triggers doWait() after connect, so it's especially good to
445 // avoid lagged servers so as to avoid excessive delay in that method.
446 $ago = microtime( true ) - $this->waitForPos
->asOfTime();
447 // Aim for <= 1 second of waiting (being too picky can backfire)
448 $i = $this->getRandomNonLagged( $currentLoads, $domain, $ago +
1 );
450 if ( $i === false ) {
451 // Any server with less lag than it's 'max lag' param is preferable
452 $i = $this->getRandomNonLagged( $currentLoads, $domain );
454 if ( $i === false && count( $currentLoads ) != 0 ) {
455 // All replica DBs lagged. Switch to read-only mode
456 $this->replLogger
->error(
457 __METHOD__
. ": all replica DBs lagged. Switch to read-only mode" );
458 $i = ArrayUtils
::pickRandom( $currentLoads );
459 $laggedReplicaMode = true;
463 if ( $i === false ) {
464 // pickRandom() returned false.
465 // This is permanent and means the configuration or the load monitor
466 // wants us to return false.
467 $this->connLogger
->debug( __METHOD__
. ": pickRandom() returned false" );
469 return [ false, false ];
472 $serverName = $this->getServerName( $i );
473 $this->connLogger
->debug( __METHOD__
. ": Using reader #$i: $serverName..." );
475 $conn = $this->openConnection( $i, $domain );
477 $this->connLogger
->warning( __METHOD__
. ": Failed connecting to $i/$domain" );
478 unset( $currentLoads[$i] ); // avoid this server next iteration
483 // Decrement reference counter, we are finished with this connection.
484 // It will be incremented for the caller later.
485 if ( $domain !== false ) {
486 $this->reuseConnection( $conn );
489 // Return this server
493 // If all servers were down, quit now
494 if ( !count( $currentLoads ) ) {
495 $this->connLogger
->error( __METHOD__
. ": all servers down" );
498 return [ $i, $laggedReplicaMode ];
501 public function waitFor( $pos ) {
502 $oldPos = $this->waitForPos
;
504 $this->waitForPos
= $pos;
505 // If a generic reader connection was already established, then wait now
506 $i = $this->readIndex
;
508 if ( !$this->doWait( $i ) ) {
509 $this->laggedReplicaMode
= true;
513 // Restore the older position if it was higher since this is used for lag-protection
514 $this->setWaitForPositionIfHigher( $oldPos );
518 public function waitForOne( $pos, $timeout = null ) {
519 $oldPos = $this->waitForPos
;
521 $this->waitForPos
= $pos;
523 $i = $this->readIndex
;
525 // Pick a generic replica DB if there isn't one yet
526 $readLoads = $this->loads
;
527 unset( $readLoads[$this->getWriterIndex()] ); // replica DBs only
528 $readLoads = array_filter( $readLoads ); // with non-zero load
529 $i = ArrayUtils
::pickRandom( $readLoads );
533 $ok = $this->doWait( $i, true, $timeout );
535 $ok = true; // no applicable loads
538 # Restore the old position, as this is not used for lag-protection but for throttling
539 $this->waitForPos
= $oldPos;
545 public function waitForAll( $pos, $timeout = null ) {
546 $timeout = $timeout ?
: $this->waitTimeout
;
548 $oldPos = $this->waitForPos
;
550 $this->waitForPos
= $pos;
551 $serverCount = count( $this->servers
);
554 for ( $i = 1; $i < $serverCount; $i++
) {
555 if ( $this->loads
[$i] > 0 ) {
556 $start = microtime( true );
557 $ok = $this->doWait( $i, true, $timeout ) && $ok;
558 $timeout -= intval( microtime( true ) - $start );
559 if ( $timeout <= 0 ) {
560 break; // timeout reached
565 # Restore the old position, as this is not used for lag-protection but for throttling
566 $this->waitForPos
= $oldPos;
573 * @param DBMasterPos|bool $pos
575 private function setWaitForPositionIfHigher( $pos ) {
580 if ( !$this->waitForPos ||
$pos->hasReached( $this->waitForPos
) ) {
581 $this->waitForPos
= $pos;
585 public function getAnyOpenConnection( $i, $flags = 0 ) {
586 $autocommit = ( ( $flags & self
::CONN_TRX_AUTOCOMMIT
) == self
::CONN_TRX_AUTOCOMMIT
);
587 foreach ( $this->conns
as $connsByServer ) {
588 if ( !isset( $connsByServer[$i] ) ) {
592 foreach ( $connsByServer[$i] as $conn ) {
593 if ( !$autocommit ||
$conn->getLBInfo( 'autoCommitOnly' ) ) {
603 * Wait for a given replica DB to catch up to the master pos stored in $this
604 * @param int $index Server index
605 * @param bool $open Check the server even if a new connection has to be made
606 * @param int|null $timeout Max seconds to wait; default is "waitTimeout" given to __construct()
609 protected function doWait( $index, $open = false, $timeout = null ) {
610 $timeout = max( 1, intval( $timeout ?
: $this->waitTimeout
) );
612 // Check if we already know that the DB has reached this point
613 $server = $this->getServerName( $index );
614 $key = $this->srvCache
->makeGlobalKey( __CLASS__
, 'last-known-pos', $server, 'v1' );
615 /** @var DBMasterPos $knownReachedPos */
616 $knownReachedPos = $this->srvCache
->get( $key );
618 $knownReachedPos instanceof DBMasterPos
&&
619 $knownReachedPos->hasReached( $this->waitForPos
)
621 $this->replLogger
->debug(
623 ': replica DB {dbserver} known to be caught up (pos >= $knownReachedPos).',
624 [ 'dbserver' => $server ]
629 // Find a connection to wait on, creating one if needed and allowed
630 $close = false; // close the connection afterwards
631 $conn = $this->getAnyOpenConnection( $index );
634 $this->replLogger
->debug(
635 __METHOD__
. ': no connection open for {dbserver}',
636 [ 'dbserver' => $server ]
641 $conn = $this->openConnection( $index, self
::DOMAIN_ANY
);
643 $this->replLogger
->warning(
644 __METHOD__
. ': failed to connect to {dbserver}',
645 [ 'dbserver' => $server ]
650 // Avoid connection spam in waitForAll() when connections
651 // are made just for the sake of doing this lag check.
656 $this->replLogger
->info(
658 ': waiting for replica DB {dbserver} to catch up...',
659 [ 'dbserver' => $server ]
662 $result = $conn->masterPosWait( $this->waitForPos
, $timeout );
664 if ( $result === null ) {
665 $this->replLogger
->warning(
666 __METHOD__
. ': Errored out waiting on {host} pos {pos}',
669 'pos' => $this->waitForPos
,
670 'trace' => ( new RuntimeException() )->getTraceAsString()
674 } elseif ( $result == -1 ) {
675 $this->replLogger
->warning(
676 __METHOD__
. ': Timed out waiting on {host} pos {pos}',
679 'pos' => $this->waitForPos
,
680 'trace' => ( new RuntimeException() )->getTraceAsString()
685 $this->replLogger
->debug( __METHOD__
. ": done waiting" );
687 // Remember that the DB reached this point
688 $this->srvCache
->set( $key, $this->waitForPos
, BagOStuff
::TTL_DAY
);
692 $this->closeConnection( $conn );
698 public function getConnection( $i, $groups = [], $domain = false, $flags = 0 ) {
699 if ( $i === null ||
$i === false ) {
700 throw new InvalidArgumentException( 'Attempt to call ' . __METHOD__
.
701 ' with invalid server index' );
704 if ( $this->localDomain
->equals( $domain ) ||
$domain === $this->localDomainIdAlias
) {
705 $domain = false; // local connection requested
708 if ( ( $flags & self
::CONN_TRX_AUTOCOMMIT
) === self
::CONN_TRX_AUTOCOMMIT
) {
709 // Assuming all servers are of the same type (or similar), which is overwhelmingly
710 // the case, use the master server information to get the attributes. The information
711 // for $i cannot be used since it might be DB_REPLICA, which might require connection
712 // attempts in order to be resolved into a real server index.
713 $attributes = $this->getServerAttributes( $this->getWriterIndex() );
714 if ( $attributes[Database
::ATTR_DB_LEVEL_LOCKING
] ) {
715 // Callers sometimes want to (a) escape REPEATABLE-READ stateness without locking
716 // rows (e.g. FOR UPDATE) or (b) make small commits during a larger transactions
717 // to reduce lock contention. None of these apply for sqlite and using separate
718 // connections just causes self-deadlocks.
719 $flags &= ~self
::CONN_TRX_AUTOCOMMIT
;
720 $this->connLogger
->info( __METHOD__
.
721 ': ignoring CONN_TRX_AUTOCOMMIT to avoid deadlocks.' );
725 // Check one "group" per default: the generic pool
726 $defaultGroups = $this->defaultGroup ?
[ $this->defaultGroup
] : [ false ];
728 $groups = ( $groups === false ||
$groups === [] )
732 $masterOnly = ( $i == self
::DB_MASTER ||
$i == $this->getWriterIndex() );
733 $oldConnsOpened = $this->connsOpened
; // connections open now
735 if ( $i == self
::DB_MASTER
) {
736 $i = $this->getWriterIndex();
737 } elseif ( $i == self
::DB_REPLICA
) {
738 # Try to find an available server in any the query groups (in order)
739 foreach ( $groups as $group ) {
740 $groupIndex = $this->getReaderIndex( $group, $domain );
741 if ( $groupIndex !== false ) {
748 # Operation-based index
749 if ( $i == self
::DB_REPLICA
) {
750 $this->lastError
= 'Unknown error'; // reset error string
751 # Try the general server pool if $groups are unavailable.
752 $i = ( $groups === [ false ] )
753 ?
false // don't bother with this if that is what was tried above
754 : $this->getReaderIndex( false, $domain );
755 # Couldn't find a working server in getReaderIndex()?
756 if ( $i === false ) {
757 $this->lastError
= 'No working replica DB server: ' . $this->lastError
;
758 // Throw an exception
759 $this->reportConnectionError();
760 return null; // not reached
764 # Now we have an explicit index into the servers array
765 $conn = $this->openConnection( $i, $domain, $flags );
767 // Throw an exception
768 $this->reportConnectionError();
769 return null; // not reached
772 # Profile any new connections that happen
773 if ( $this->connsOpened
> $oldConnsOpened ) {
774 $host = $conn->getServer();
775 $dbname = $conn->getDBname();
776 $this->trxProfiler
->recordConnection( $host, $dbname, $masterOnly );
780 # Make master-requested DB handles inherit any read-only mode setting
781 $conn->setLBInfo( 'readOnlyReason', $this->getReadOnlyReason( $domain, $conn ) );
787 public function reuseConnection( IDatabase
$conn ) {
788 $serverIndex = $conn->getLBInfo( 'serverIndex' );
789 $refCount = $conn->getLBInfo( 'foreignPoolRefCount' );
790 if ( $serverIndex === null ||
$refCount === null ) {
792 * This can happen in code like:
793 * foreach ( $dbs as $db ) {
794 * $conn = $lb->getConnection( $lb::DB_REPLICA, [], $db );
796 * $lb->reuseConnection( $conn );
798 * When a connection to the local DB is opened in this way, reuseConnection()
802 } elseif ( $conn instanceof DBConnRef
) {
803 // DBConnRef already handles calling reuseConnection() and only passes the live
804 // Database instance to this method. Any caller passing in a DBConnRef is broken.
805 $this->connLogger
->error(
806 __METHOD__
. ": got DBConnRef instance.\n" .
807 ( new RuntimeException() )->getTraceAsString() );
812 if ( $this->disabled
) {
813 return; // DBConnRef handle probably survived longer than the LoadBalancer
816 if ( $conn->getLBInfo( 'autoCommitOnly' ) ) {
817 $connFreeKey = self
::KEY_FOREIGN_FREE_NOROUND
;
818 $connInUseKey = self
::KEY_FOREIGN_INUSE_NOROUND
;
820 $connFreeKey = self
::KEY_FOREIGN_FREE
;
821 $connInUseKey = self
::KEY_FOREIGN_INUSE
;
824 $domain = $conn->getDomainID();
825 if ( !isset( $this->conns
[$connInUseKey][$serverIndex][$domain] ) ) {
826 throw new InvalidArgumentException( __METHOD__
.
827 ": connection $serverIndex/$domain not found; it may have already been freed." );
828 } elseif ( $this->conns
[$connInUseKey][$serverIndex][$domain] !== $conn ) {
829 throw new InvalidArgumentException( __METHOD__
.
830 ": connection $serverIndex/$domain mismatched; it may have already been freed." );
833 $conn->setLBInfo( 'foreignPoolRefCount', --$refCount );
834 if ( $refCount <= 0 ) {
835 $this->conns
[$connFreeKey][$serverIndex][$domain] = $conn;
836 unset( $this->conns
[$connInUseKey][$serverIndex][$domain] );
837 if ( !$this->conns
[$connInUseKey][$serverIndex] ) {
838 unset( $this->conns
[$connInUseKey][$serverIndex] ); // clean up
840 $this->connLogger
->debug( __METHOD__
. ": freed connection $serverIndex/$domain" );
842 $this->connLogger
->debug( __METHOD__
.
843 ": reference count for $serverIndex/$domain reduced to $refCount" );
847 public function getConnectionRef( $db, $groups = [], $domain = false, $flags = 0 ) {
848 $domain = $this->resolveDomainID( $domain );
850 return new DBConnRef( $this, $this->getConnection( $db, $groups, $domain, $flags ) );
853 public function getLazyConnectionRef( $db, $groups = [], $domain = false, $flags = 0 ) {
854 $domain = $this->resolveDomainID( $domain );
856 return new DBConnRef( $this, [ $db, $groups, $domain, $flags ] );
859 public function getMaintenanceConnectionRef( $db, $groups = [], $domain = false, $flags = 0 ) {
860 $domain = $this->resolveDomainID( $domain );
862 return new MaintainableDBConnRef(
863 $this, $this->getConnection( $db, $groups, $domain, $flags ) );
866 public function openConnection( $i, $domain = false, $flags = 0 ) {
867 if ( $this->localDomain
->equals( $domain ) ||
$domain === $this->localDomainIdAlias
) {
868 $domain = false; // local connection requested
871 if ( !$this->connectionAttempted
&& $this->chronologyCallback
) {
872 $this->connLogger
->debug( __METHOD__
. ': calling initLB() before first connection.' );
873 // Load any "waitFor" positions before connecting so that doWait() is triggered
874 $this->connectionAttempted
= true;
875 ( $this->chronologyCallback
)( $this );
878 // Check if an auto-commit connection is being requested. If so, it will not reuse the
879 // main set of DB connections but rather its own pool since:
880 // a) those are usually set to implicitly use transaction rounds via DBO_TRX
881 // b) those must support the use of explicit transaction rounds via beginMasterChanges()
882 $autoCommit = ( ( $flags & self
::CONN_TRX_AUTOCOMMIT
) == self
::CONN_TRX_AUTOCOMMIT
);
884 if ( $domain !== false ) {
885 // Connection is to a foreign domain
886 $conn = $this->openForeignConnection( $i, $domain, $flags );
888 // Connection is to the local domain
889 $conn = $this->openLocalConnection( $i, $flags );
892 if ( $conn instanceof IDatabase
&& !$conn->isOpen() ) {
893 // Connection was made but later unrecoverably lost for some reason.
894 // Do not return a handle that will just throw exceptions on use,
895 // but let the calling code (e.g. getReaderIndex) try another server.
896 // See DatabaseMyslBase::ping() for how this can happen.
897 $this->errorConnection
= $conn;
901 if ( $autoCommit && $conn instanceof IDatabase
) {
902 if ( $conn->trxLevel() ) { // sanity
903 throw new DBUnexpectedError(
905 __METHOD__
. ': CONN_TRX_AUTOCOMMIT handle has a transaction.'
909 $conn->clearFlag( $conn::DBO_TRX
); // auto-commit mode
916 * Open a connection to a local DB, or return one if it is already open.
918 * On error, returns false, and the connection which caused the
919 * error will be available via $this->errorConnection.
921 * @note If disable() was called on this LoadBalancer, this method will throw a DBAccessError.
923 * @param int $i Server index
924 * @param int $flags Class CONN_* constant bitfield
927 private function openLocalConnection( $i, $flags = 0 ) {
928 $autoCommit = ( ( $flags & self
::CONN_TRX_AUTOCOMMIT
) == self
::CONN_TRX_AUTOCOMMIT
);
930 $connKey = $autoCommit ? self
::KEY_LOCAL_NOROUND
: self
::KEY_LOCAL
;
931 if ( isset( $this->conns
[$connKey][$i][0] ) ) {
932 $conn = $this->conns
[$connKey][$i][0];
934 if ( !isset( $this->servers
[$i] ) ||
!is_array( $this->servers
[$i] ) ) {
935 throw new InvalidArgumentException( "No server with index '$i'." );
937 // Open a new connection
938 $server = $this->servers
[$i];
939 $server['serverIndex'] = $i;
940 $server['autoCommitOnly'] = $autoCommit;
941 $conn = $this->reallyOpenConnection( $server, $this->localDomain
);
942 $host = $this->getServerName( $i );
943 if ( $conn->isOpen() ) {
944 $this->connLogger
->debug(
945 __METHOD__
. ": connected to database $i at '$host'." );
946 $this->conns
[$connKey][$i][0] = $conn;
948 $this->connLogger
->warning(
949 __METHOD__
. ": failed to connect to database $i at '$host'." );
950 $this->errorConnection
= $conn;
959 * Open a connection to a foreign DB, or return one if it is already open.
961 * Increments a reference count on the returned connection which locks the
962 * connection to the requested domain. This reference count can be
963 * decremented by calling reuseConnection().
965 * If a connection is open to the appropriate server already, but with the wrong
966 * database, it will be switched to the right database and returned, as long as
967 * it has been freed first with reuseConnection().
969 * On error, returns false, and the connection which caused the
970 * error will be available via $this->errorConnection.
972 * @note If disable() was called on this LoadBalancer, this method will throw a DBAccessError.
974 * @param int $i Server index
975 * @param string $domain Domain ID to open
976 * @param int $flags Class CONN_* constant bitfield
977 * @return Database|bool Returns false on connection error
978 * @throws DBError When database selection fails
980 private function openForeignConnection( $i, $domain, $flags = 0 ) {
981 $domainInstance = DatabaseDomain
::newFromId( $domain );
982 $autoCommit = ( ( $flags & self
::CONN_TRX_AUTOCOMMIT
) == self
::CONN_TRX_AUTOCOMMIT
);
985 $connFreeKey = self
::KEY_FOREIGN_FREE_NOROUND
;
986 $connInUseKey = self
::KEY_FOREIGN_INUSE_NOROUND
;
988 $connFreeKey = self
::KEY_FOREIGN_FREE
;
989 $connInUseKey = self
::KEY_FOREIGN_INUSE
;
992 /** @var Database $conn */
993 if ( isset( $this->conns
[$connInUseKey][$i][$domain] ) ) {
994 // Reuse an in-use connection for the same domain
995 $conn = $this->conns
[$connInUseKey][$i][$domain];
996 $this->connLogger
->debug( __METHOD__
. ": reusing connection $i/$domain" );
997 } elseif ( isset( $this->conns
[$connFreeKey][$i][$domain] ) ) {
998 // Reuse a free connection for the same domain
999 $conn = $this->conns
[$connFreeKey][$i][$domain];
1000 unset( $this->conns
[$connFreeKey][$i][$domain] );
1001 $this->conns
[$connInUseKey][$i][$domain] = $conn;
1002 $this->connLogger
->debug( __METHOD__
. ": reusing free connection $i/$domain" );
1003 } elseif ( !empty( $this->conns
[$connFreeKey][$i] ) ) {
1004 // Reuse a free connection from another domain
1005 $conn = reset( $this->conns
[$connFreeKey][$i] );
1006 $oldDomain = key( $this->conns
[$connFreeKey][$i] );
1007 if ( $domainInstance->getDatabase() !== null ) {
1008 $conn->selectDomain( $domainInstance );
1010 // Stay on the current database, but update the schema/prefix
1011 $conn->dbSchema( $domainInstance->getSchema() );
1012 $conn->tablePrefix( $domainInstance->getTablePrefix() );
1014 unset( $this->conns
[$connFreeKey][$i][$oldDomain] );
1015 // Note that if $domain is an empty string, getDomainID() might not match it
1016 $this->conns
[$connInUseKey][$i][$conn->getDomainId()] = $conn;
1017 $this->connLogger
->debug( __METHOD__
.
1018 ": reusing free connection from $oldDomain for $domain" );
1020 if ( !isset( $this->servers
[$i] ) ||
!is_array( $this->servers
[$i] ) ) {
1021 throw new InvalidArgumentException( "No server with index '$i'." );
1023 // Open a new connection
1024 $server = $this->servers
[$i];
1025 $server['serverIndex'] = $i;
1026 $server['foreignPoolRefCount'] = 0;
1027 $server['foreign'] = true;
1028 $server['autoCommitOnly'] = $autoCommit;
1029 $conn = $this->reallyOpenConnection( $server, $domainInstance );
1030 if ( !$conn->isOpen() ) {
1031 $this->connLogger
->warning( __METHOD__
. ": connection error for $i/$domain" );
1032 $this->errorConnection
= $conn;
1035 // Note that if $domain is an empty string, getDomainID() might not match it
1036 $this->conns
[$connInUseKey][$i][$conn->getDomainID()] = $conn;
1037 $this->connLogger
->debug( __METHOD__
. ": opened new connection for $i/$domain" );
1041 // Increment reference count
1042 if ( $conn instanceof IDatabase
) {
1043 $refCount = $conn->getLBInfo( 'foreignPoolRefCount' );
1044 $conn->setLBInfo( 'foreignPoolRefCount', $refCount +
1 );
1050 public function getServerAttributes( $i ) {
1051 return Database
::attributesFromType(
1052 $this->getServerType( $i ),
1053 $this->servers
[$i]['driver'] ??
null
1058 * Test if the specified index represents an open connection
1060 * @param int $index Server index
1064 private function isOpen( $index ) {
1065 if ( !is_int( $index ) ) {
1069 return (bool)$this->getAnyOpenConnection( $index );
1073 * Open a new network connection to a server (uncached)
1075 * Returns a Database object whether or not the connection was successful.
1077 * @param array $server
1078 * @param DatabaseDomain $domain Domain the connection is for, possibly unspecified
1080 * @throws DBAccessError
1081 * @throws InvalidArgumentException
1083 protected function reallyOpenConnection( array $server, DatabaseDomain
$domain ) {
1084 if ( $this->disabled
) {
1085 throw new DBAccessError();
1088 if ( $domain->getDatabase() === null ) {
1089 // The database domain does not specify a DB name and some database systems require a
1090 // valid DB specified on connection. The $server configuration array contains a default
1091 // DB name to use for connections in such cases.
1092 if ( $server['type'] === 'mysql' ) {
1093 // For MySQL, DATABASE and SCHEMA are synonyms, connections need not specify a DB,
1094 // and the DB name in $server might not exist due to legacy reasons (the default
1095 // domain used to ignore the local LB domain, even when mismatched).
1096 $server['dbname'] = null;
1099 $server['dbname'] = $domain->getDatabase();
1102 if ( $domain->getSchema() !== null ) {
1103 $server['schema'] = $domain->getSchema();
1106 // It is always possible to connect with any prefix, even the empty string
1107 $server['tablePrefix'] = $domain->getTablePrefix();
1109 // Let the handle know what the cluster master is (e.g. "db1052")
1110 $masterName = $this->getServerName( $this->getWriterIndex() );
1111 $server['clusterMasterHost'] = $masterName;
1113 // Log when many connection are made on requests
1114 if ( ++
$this->connsOpened
>= self
::CONN_HELD_WARN_THRESHOLD
) {
1115 $this->perfLogger
->warning( __METHOD__
. ": " .
1116 "{$this->connsOpened}+ connections made (master=$masterName)" );
1119 $server['srvCache'] = $this->srvCache
;
1120 // Set loggers and profilers
1121 $server['connLogger'] = $this->connLogger
;
1122 $server['queryLogger'] = $this->queryLogger
;
1123 $server['errorLogger'] = $this->errorLogger
;
1124 $server['deprecationLogger'] = $this->deprecationLogger
;
1125 $server['profiler'] = $this->profiler
;
1126 $server['trxProfiler'] = $this->trxProfiler
;
1127 // Use the same agent and PHP mode for all DB handles
1128 $server['cliMode'] = $this->cliMode
;
1129 $server['agent'] = $this->agent
;
1130 // Use DBO_DEFAULT flags by default for LoadBalancer managed databases. Assume that the
1131 // application calls LoadBalancer::commitMasterChanges() before the PHP script completes.
1132 $server['flags'] = $server['flags'] ?? IDatabase
::DBO_DEFAULT
;
1134 // Create a live connection object
1136 $db = Database
::factory( $server['type'], $server );
1137 } catch ( DBConnectionError
$e ) {
1138 // FIXME: This is probably the ugliest thing I have ever done to
1139 // PHP. I'm half-expecting it to segfault, just out of disgust. -- TS
1143 $db->setLBInfo( $server );
1144 $db->setLazyMasterHandle(
1145 $this->getLazyConnectionRef( self
::DB_MASTER
, [], $db->getDomainID() )
1147 $db->setTableAliases( $this->tableAliases
);
1148 $db->setIndexAliases( $this->indexAliases
);
1150 if ( $server['serverIndex'] === $this->getWriterIndex() ) {
1151 if ( $this->trxRoundId
!== false ) {
1152 $this->applyTransactionRoundFlags( $db );
1154 foreach ( $this->trxRecurringCallbacks
as $name => $callback ) {
1155 $db->setTransactionListener( $name, $callback );
1163 * @throws DBConnectionError
1165 private function reportConnectionError() {
1166 $conn = $this->errorConnection
; // the connection which caused the error
1168 'method' => __METHOD__
,
1169 'last_error' => $this->lastError
,
1172 if ( $conn instanceof IDatabase
) {
1173 $context['db_server'] = $conn->getServer();
1174 $this->connLogger
->warning(
1175 __METHOD__
. ": connection error: {last_error} ({db_server})",
1179 throw new DBConnectionError( $conn, "{$this->lastError} ({$context['db_server']})" );
1181 // No last connection, probably due to all servers being too busy
1182 $this->connLogger
->error(
1184 ": LB failure with no last connection. Connection error: {last_error}",
1188 // If all servers were busy, "lastError" will contain something sensible
1189 throw new DBConnectionError( null, $this->lastError
);
1193 public function getWriterIndex() {
1197 public function haveIndex( $i ) {
1198 return array_key_exists( $i, $this->servers
);
1201 public function isNonZeroLoad( $i ) {
1202 return array_key_exists( $i, $this->servers
) && $this->loads
[$i] != 0;
1205 public function getServerCount() {
1206 return count( $this->servers
);
1209 public function getServerName( $i ) {
1210 if ( isset( $this->servers
[$i]['hostName'] ) ) {
1211 $name = $this->servers
[$i]['hostName'];
1212 } elseif ( isset( $this->servers
[$i]['host'] ) ) {
1213 $name = $this->servers
[$i]['host'];
1218 return ( $name != '' ) ?
$name : 'localhost';
1221 public function getServerInfo( $i ) {
1222 if ( isset( $this->servers
[$i] ) ) {
1223 return $this->servers
[$i];
1229 public function getServerType( $i ) {
1230 return $this->servers
[$i]['type'] ??
'unknown';
1233 public function getMasterPos() {
1234 # If this entire request was served from a replica DB without opening a connection to the
1235 # master (however unlikely that may be), then we can fetch the position from the replica DB.
1236 $masterConn = $this->getAnyOpenConnection( $this->getWriterIndex() );
1237 if ( !$masterConn ) {
1238 $serverCount = count( $this->servers
);
1239 for ( $i = 1; $i < $serverCount; $i++
) {
1240 $conn = $this->getAnyOpenConnection( $i );
1242 return $conn->getReplicaPos();
1246 return $masterConn->getMasterPos();
1252 public function disable() {
1254 $this->disabled
= true;
1257 public function closeAll() {
1258 $fname = __METHOD__
;
1259 $this->forEachOpenConnection( function ( IDatabase
$conn ) use ( $fname ) {
1260 $host = $conn->getServer();
1261 $this->connLogger
->debug(
1262 $fname . ": closing connection to database '$host'." );
1267 self
::KEY_LOCAL
=> [],
1268 self
::KEY_FOREIGN_INUSE
=> [],
1269 self
::KEY_FOREIGN_FREE
=> [],
1270 self
::KEY_LOCAL_NOROUND
=> [],
1271 self
::KEY_FOREIGN_INUSE_NOROUND
=> [],
1272 self
::KEY_FOREIGN_FREE_NOROUND
=> []
1274 $this->connsOpened
= 0;
1277 public function closeConnection( IDatabase
$conn ) {
1278 $serverIndex = $conn->getLBInfo( 'serverIndex' );
1279 foreach ( $this->conns
as $type => $connsByServer ) {
1280 if ( !isset( $connsByServer[$serverIndex] ) ) {
1284 foreach ( $connsByServer[$serverIndex] as $i => $trackedConn ) {
1285 if ( $conn === $trackedConn ) {
1286 $host = $this->getServerName( $i );
1287 $this->connLogger
->debug(
1288 __METHOD__
. ": closing connection to database $i at '$host'." );
1289 unset( $this->conns
[$type][$serverIndex][$i] );
1290 --$this->connsOpened
;
1299 public function commitAll( $fname = __METHOD__
) {
1300 $this->commitMasterChanges( $fname );
1301 $this->flushMasterSnapshots( $fname );
1302 $this->flushReplicaSnapshots( $fname );
1305 public function finalizeMasterChanges() {
1306 $this->assertTransactionRoundStage( [ self
::ROUND_CURSORY
, self
::ROUND_FINALIZED
] );
1308 $this->trxRoundStage
= self
::ROUND_ERROR
; // "failed" until proven otherwise
1309 // Loop until callbacks stop adding callbacks on other connections
1312 $count = 0; // callbacks execution attempts
1313 $this->forEachOpenMasterConnection( function ( Database
$conn ) use ( &$count ) {
1314 // Run any pre-commit callbacks while leaving the post-commit ones suppressed.
1315 // Any error should cause all (peer) transactions to be rolled back together.
1316 $count +
= $conn->runOnTransactionPreCommitCallbacks();
1319 } while ( $count > 0 );
1320 // Defer post-commit callbacks until after COMMIT/ROLLBACK happens on all handles
1321 $this->forEachOpenMasterConnection( function ( Database
$conn ) {
1322 $conn->setTrxEndCallbackSuppression( true );
1324 $this->trxRoundStage
= self
::ROUND_FINALIZED
;
1329 public function approveMasterChanges( array $options ) {
1330 $this->assertTransactionRoundStage( self
::ROUND_FINALIZED
);
1332 $limit = $options['maxWriteDuration'] ??
0;
1334 $this->trxRoundStage
= self
::ROUND_ERROR
; // "failed" until proven otherwise
1335 $this->forEachOpenMasterConnection( function ( IDatabase
$conn ) use ( $limit ) {
1336 // If atomic sections or explicit transactions are still open, some caller must have
1337 // caught an exception but failed to properly rollback any changes. Detect that and
1338 // throw and error (causing rollback).
1339 $conn->assertNoOpenTransactions();
1340 // Assert that the time to replicate the transaction will be sane.
1341 // If this fails, then all DB transactions will be rollback back together.
1342 $time = $conn->pendingWriteQueryDuration( $conn::ESTIMATE_DB_APPLY
);
1343 if ( $limit > 0 && $time > $limit ) {
1344 throw new DBTransactionSizeError(
1346 "Transaction spent $time second(s) in writes, exceeding the limit of $limit.",
1350 // If a connection sits idle while slow queries execute on another, that connection
1351 // may end up dropped before the commit round is reached. Ping servers to detect this.
1352 if ( $conn->writesOrCallbacksPending() && !$conn->ping() ) {
1353 throw new DBTransactionError(
1355 "A connection to the {$conn->getDBname()} database was lost before commit."
1359 $this->trxRoundStage
= self
::ROUND_APPROVED
;
1362 public function beginMasterChanges( $fname = __METHOD__
) {
1363 if ( $this->trxRoundId
!== false ) {
1364 throw new DBTransactionError(
1366 "$fname: Transaction round '{$this->trxRoundId}' already started."
1369 $this->assertTransactionRoundStage( self
::ROUND_CURSORY
);
1371 // Clear any empty transactions (no writes/callbacks) from the implicit round
1372 $this->flushMasterSnapshots( $fname );
1374 $this->trxRoundId
= $fname;
1375 $this->trxRoundStage
= self
::ROUND_ERROR
; // "failed" until proven otherwise
1376 // Mark applicable handles as participating in this explicit transaction round.
1377 // For each of these handles, any writes and callbacks will be tied to a single
1378 // transaction. The (peer) handles will reject begin()/commit() calls unless they
1379 // are part of an en masse commit or an en masse rollback.
1380 $this->forEachOpenMasterConnection( function ( Database
$conn ) {
1381 $this->applyTransactionRoundFlags( $conn );
1383 $this->trxRoundStage
= self
::ROUND_CURSORY
;
1386 public function commitMasterChanges( $fname = __METHOD__
) {
1387 $this->assertTransactionRoundStage( self
::ROUND_APPROVED
);
1391 /** @noinspection PhpUnusedLocalVariableInspection */
1392 $scope = $this->getScopedPHPBehaviorForCommit(); // try to ignore client aborts
1394 $restore = ( $this->trxRoundId
!== false );
1395 $this->trxRoundId
= false;
1396 $this->trxRoundStage
= self
::ROUND_ERROR
; // "failed" until proven otherwise
1397 // Commit any writes and clear any snapshots as well (callbacks require AUTOCOMMIT).
1398 // Note that callbacks should already be suppressed due to finalizeMasterChanges().
1399 $this->forEachOpenMasterConnection(
1400 function ( IDatabase
$conn ) use ( $fname, &$failures ) {
1402 $conn->commit( $fname, $conn::FLUSHING_ALL_PEERS
);
1403 } catch ( DBError
$e ) {
1404 ( $this->errorLogger
)( $e );
1405 $failures[] = "{$conn->getServer()}: {$e->getMessage()}";
1410 throw new DBTransactionError(
1412 "$fname: Commit failed on server(s) " . implode( "\n", array_unique( $failures ) )
1416 // Unmark handles as participating in this explicit transaction round
1417 $this->forEachOpenMasterConnection( function ( Database
$conn ) {
1418 $this->undoTransactionRoundFlags( $conn );
1421 $this->trxRoundStage
= self
::ROUND_COMMIT_CALLBACKS
;
1424 public function runMasterTransactionIdleCallbacks() {
1425 if ( $this->trxRoundStage
=== self
::ROUND_COMMIT_CALLBACKS
) {
1426 $type = IDatabase
::TRIGGER_COMMIT
;
1427 } elseif ( $this->trxRoundStage
=== self
::ROUND_ROLLBACK_CALLBACKS
) {
1428 $type = IDatabase
::TRIGGER_ROLLBACK
;
1430 throw new DBTransactionError(
1432 "Transaction should be in the callback stage (not '{$this->trxRoundStage}')"
1436 $oldStage = $this->trxRoundStage
;
1437 $this->trxRoundStage
= self
::ROUND_ERROR
; // "failed" until proven otherwise
1439 // Now that the COMMIT/ROLLBACK step is over, enable post-commit callback runs
1440 $this->forEachOpenMasterConnection( function ( Database
$conn ) {
1441 $conn->setTrxEndCallbackSuppression( false );
1444 $e = null; // first exception
1445 $fname = __METHOD__
;
1446 // Loop until callbacks stop adding callbacks on other connections
1448 // Run any pending callbacks for each connection...
1449 $count = 0; // callback execution attempts
1450 $this->forEachOpenMasterConnection(
1451 function ( Database
$conn ) use ( $type, &$e, &$count ) {
1452 if ( $conn->trxLevel() ) {
1453 return; // retry in the next iteration, after commit() is called
1456 $count +
= $conn->runOnTransactionIdleCallbacks( $type );
1457 } catch ( Exception
$ex ) {
1462 // Clear out any active transactions left over from callbacks...
1463 $this->forEachOpenMasterConnection( function ( Database
$conn ) use ( &$e, $fname ) {
1464 if ( $conn->writesPending() ) {
1465 // A callback from another handle wrote to this one and DBO_TRX is set
1466 $this->queryLogger
->warning( $fname . ": found writes pending." );
1467 $fnames = implode( ', ', $conn->pendingWriteAndCallbackCallers() );
1468 $this->queryLogger
->warning(
1469 $fname . ": found writes pending ($fnames).",
1471 'db_server' => $conn->getServer(),
1472 'db_name' => $conn->getDBname()
1475 } elseif ( $conn->trxLevel() ) {
1476 // A callback from another handle read from this one and DBO_TRX is set,
1477 // which can easily happen if there is only one DB (no replicas)
1478 $this->queryLogger
->debug( $fname . ": found empty transaction." );
1481 $conn->commit( $fname, $conn::FLUSHING_ALL_PEERS
);
1482 } catch ( Exception
$ex ) {
1486 } while ( $count > 0 );
1488 $this->trxRoundStage
= $oldStage;
1493 public function runMasterTransactionListenerCallbacks() {
1494 if ( $this->trxRoundStage
=== self
::ROUND_COMMIT_CALLBACKS
) {
1495 $type = IDatabase
::TRIGGER_COMMIT
;
1496 } elseif ( $this->trxRoundStage
=== self
::ROUND_ROLLBACK_CALLBACKS
) {
1497 $type = IDatabase
::TRIGGER_ROLLBACK
;
1499 throw new DBTransactionError(
1501 "Transaction should be in the callback stage (not '{$this->trxRoundStage}')"
1507 $this->trxRoundStage
= self
::ROUND_ERROR
; // "failed" until proven otherwise
1508 $this->forEachOpenMasterConnection( function ( Database
$conn ) use ( $type, &$e ) {
1510 $conn->runTransactionListenerCallbacks( $type );
1511 } catch ( Exception
$ex ) {
1515 $this->trxRoundStage
= self
::ROUND_CURSORY
;
1520 public function rollbackMasterChanges( $fname = __METHOD__
) {
1521 $restore = ( $this->trxRoundId
!== false );
1522 $this->trxRoundId
= false;
1523 $this->trxRoundStage
= self
::ROUND_ERROR
; // "failed" until proven otherwise
1524 $this->forEachOpenMasterConnection( function ( IDatabase
$conn ) use ( $fname ) {
1525 $conn->rollback( $fname, $conn::FLUSHING_ALL_PEERS
);
1528 // Unmark handles as participating in this explicit transaction round
1529 $this->forEachOpenMasterConnection( function ( Database
$conn ) {
1530 $this->undoTransactionRoundFlags( $conn );
1533 $this->trxRoundStage
= self
::ROUND_ROLLBACK_CALLBACKS
;
1537 * @param string|string[] $stage
1539 private function assertTransactionRoundStage( $stage ) {
1540 $stages = (array)$stage;
1542 if ( !in_array( $this->trxRoundStage
, $stages, true ) ) {
1543 $stageList = implode(
1545 array_map( function ( $v ) {
1549 throw new DBTransactionError(
1551 "Transaction round stage must be $stageList (not '{$this->trxRoundStage}')"
1557 * Make all DB servers with DBO_DEFAULT/DBO_TRX set join the transaction round
1559 * Some servers may have neither flag enabled, meaning that they opt out of such
1560 * transaction rounds and remain in auto-commit mode. Such behavior might be desired
1561 * when a DB server is used for something like simple key/value storage.
1563 * @param Database $conn
1565 private function applyTransactionRoundFlags( Database
$conn ) {
1566 if ( $conn->getLBInfo( 'autoCommitOnly' ) ) {
1567 return; // transaction rounds do not apply to these connections
1570 if ( $conn->getFlag( $conn::DBO_DEFAULT
) ) {
1571 // DBO_TRX is controlled entirely by CLI mode presence with DBO_DEFAULT.
1572 // Force DBO_TRX even in CLI mode since a commit round is expected soon.
1573 $conn->setFlag( $conn::DBO_TRX
, $conn::REMEMBER_PRIOR
);
1576 if ( $conn->getFlag( $conn::DBO_TRX
) ) {
1577 $conn->setLBInfo( 'trxRoundId', $this->trxRoundId
);
1582 * @param Database $conn
1584 private function undoTransactionRoundFlags( Database
$conn ) {
1585 if ( $conn->getLBInfo( 'autoCommitOnly' ) ) {
1586 return; // transaction rounds do not apply to these connections
1589 if ( $conn->getFlag( $conn::DBO_TRX
) ) {
1590 $conn->setLBInfo( 'trxRoundId', false );
1593 if ( $conn->getFlag( $conn::DBO_DEFAULT
) ) {
1594 $conn->restoreFlags( $conn::RESTORE_PRIOR
);
1598 public function flushReplicaSnapshots( $fname = __METHOD__
) {
1599 $this->forEachOpenReplicaConnection( function ( IDatabase
$conn ) use ( $fname ) {
1600 $conn->flushSnapshot( $fname );
1604 public function flushMasterSnapshots( $fname = __METHOD__
) {
1605 $this->forEachOpenMasterConnection( function ( IDatabase
$conn ) use ( $fname ) {
1606 $conn->flushSnapshot( $fname );
1614 public function getTransactionRoundStage() {
1615 return $this->trxRoundStage
;
1618 public function hasMasterConnection() {
1619 return $this->isOpen( $this->getWriterIndex() );
1622 public function hasMasterChanges() {
1624 $this->forEachOpenMasterConnection( function ( IDatabase
$conn ) use ( &$pending ) {
1625 $pending |
= $conn->writesOrCallbacksPending();
1628 return (bool)$pending;
1631 public function lastMasterChangeTimestamp() {
1633 $this->forEachOpenMasterConnection( function ( IDatabase
$conn ) use ( &$lastTime ) {
1634 $lastTime = max( $lastTime, $conn->lastDoneWrites() );
1640 public function hasOrMadeRecentMasterChanges( $age = null ) {
1641 $age = ( $age === null ) ?
$this->waitTimeout
: $age;
1643 return ( $this->hasMasterChanges()
1644 ||
$this->lastMasterChangeTimestamp() > microtime( true ) - $age );
1647 public function pendingMasterChangeCallers() {
1649 $this->forEachOpenMasterConnection( function ( IDatabase
$conn ) use ( &$fnames ) {
1650 $fnames = array_merge( $fnames, $conn->pendingWriteCallers() );
1656 public function getLaggedReplicaMode( $domain = false ) {
1657 // No-op if there is only one DB (also avoids recursion)
1658 if ( !$this->laggedReplicaMode
&& $this->getServerCount() > 1 ) {
1660 // See if laggedReplicaMode gets set
1661 $conn = $this->getConnection( self
::DB_REPLICA
, false, $domain );
1662 $this->reuseConnection( $conn );
1663 } catch ( DBConnectionError
$e ) {
1664 // Avoid expensive re-connect attempts and failures
1665 $this->allReplicasDownMode
= true;
1666 $this->laggedReplicaMode
= true;
1670 return $this->laggedReplicaMode
;
1673 public function laggedReplicaUsed() {
1674 return $this->laggedReplicaMode
;
1680 * @deprecated Since 1.28; use laggedReplicaUsed()
1682 public function laggedSlaveUsed() {
1683 return $this->laggedReplicaUsed();
1686 public function getReadOnlyReason( $domain = false, IDatabase
$conn = null ) {
1687 if ( $this->readOnlyReason
!== false ) {
1688 return $this->readOnlyReason
;
1689 } elseif ( $this->getLaggedReplicaMode( $domain ) ) {
1690 if ( $this->allReplicasDownMode
) {
1691 return 'The database has been automatically locked ' .
1692 'until the replica database servers become available';
1694 return 'The database has been automatically locked ' .
1695 'while the replica database servers catch up to the master.';
1697 } elseif ( $this->masterRunningReadOnly( $domain, $conn ) ) {
1698 return 'The database master is running in read-only mode.';
1705 * @param string $domain Domain ID, or false for the current domain
1706 * @param IDatabase|null $conn DB master connectionl used to avoid loops [optional]
1709 private function masterRunningReadOnly( $domain, IDatabase
$conn = null ) {
1710 $cache = $this->wanCache
;
1711 $masterServer = $this->getServerName( $this->getWriterIndex() );
1713 return (bool)$cache->getWithSetCallback(
1714 $cache->makeGlobalKey( __CLASS__
, 'server-read-only', $masterServer ),
1715 self
::TTL_CACHE_READONLY
,
1716 function () use ( $domain, $conn ) {
1717 $old = $this->trxProfiler
->setSilenced( true );
1719 $dbw = $conn ?
: $this->getConnection( self
::DB_MASTER
, [], $domain );
1720 $readOnly = (int)$dbw->serverIsReadOnly();
1722 $this->reuseConnection( $dbw );
1724 } catch ( DBError
$e ) {
1727 $this->trxProfiler
->setSilenced( $old );
1730 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'busyValue' => 0 ]
1734 public function allowLagged( $mode = null ) {
1735 if ( $mode === null ) {
1736 return $this->allowLagged
;
1738 $this->allowLagged
= $mode;
1740 return $this->allowLagged
;
1743 public function pingAll() {
1745 $this->forEachOpenConnection( function ( IDatabase
$conn ) use ( &$success ) {
1746 if ( !$conn->ping() ) {
1754 public function forEachOpenConnection( $callback, array $params = [] ) {
1755 foreach ( $this->conns
as $connsByServer ) {
1756 foreach ( $connsByServer as $serverConns ) {
1757 foreach ( $serverConns as $conn ) {
1758 $callback( $conn, ...$params );
1764 public function forEachOpenMasterConnection( $callback, array $params = [] ) {
1765 $masterIndex = $this->getWriterIndex();
1766 foreach ( $this->conns
as $connsByServer ) {
1767 if ( isset( $connsByServer[$masterIndex] ) ) {
1768 /** @var IDatabase $conn */
1769 foreach ( $connsByServer[$masterIndex] as $conn ) {
1770 $callback( $conn, ...$params );
1776 public function forEachOpenReplicaConnection( $callback, array $params = [] ) {
1777 foreach ( $this->conns
as $connsByServer ) {
1778 foreach ( $connsByServer as $i => $serverConns ) {
1779 if ( $i === $this->getWriterIndex() ) {
1780 continue; // skip master
1782 foreach ( $serverConns as $conn ) {
1783 $callback( $conn, ...$params );
1789 public function getMaxLag( $domain = false ) {
1794 if ( $this->getServerCount() <= 1 ) {
1795 return [ $host, $maxLag, $maxIndex ]; // no replication = no lag
1798 $lagTimes = $this->getLagTimes( $domain );
1799 foreach ( $lagTimes as $i => $lag ) {
1800 if ( $this->loads
[$i] > 0 && $lag > $maxLag ) {
1802 $host = $this->servers
[$i]['host'];
1807 return [ $host, $maxLag, $maxIndex ];
1810 public function getLagTimes( $domain = false ) {
1811 if ( $this->getServerCount() <= 1 ) {
1812 return [ $this->getWriterIndex() => 0 ]; // no replication = no lag
1815 $knownLagTimes = []; // map of (server index => 0 seconds)
1816 $indexesWithLag = [];
1817 foreach ( $this->servers
as $i => $server ) {
1818 if ( empty( $server['is static'] ) ) {
1819 $indexesWithLag[] = $i; // DB server might have replication lag
1821 $knownLagTimes[$i] = 0; // DB server is a non-replicating and read-only archive
1825 return $this->getLoadMonitor()->getLagTimes( $indexesWithLag, $domain ) +
$knownLagTimes;
1828 public function safeGetLag( IDatabase
$conn ) {
1829 if ( $this->getServerCount() <= 1 ) {
1832 return $conn->getLag();
1837 * @param IDatabase $conn
1838 * @param DBMasterPos|bool $pos
1839 * @param int|null $timeout
1842 public function safeWaitForMasterPos( IDatabase
$conn, $pos = false, $timeout = null ) {
1843 $timeout = max( 1, $timeout ?
: $this->waitTimeout
);
1845 if ( $this->getServerCount() <= 1 ||
!$conn->getLBInfo( 'replica' ) ) {
1846 return true; // server is not a replica DB
1850 // Get the current master position, opening a connection if needed
1851 $masterConn = $this->getAnyOpenConnection( $this->getWriterIndex() );
1852 if ( $masterConn ) {
1853 $pos = $masterConn->getMasterPos();
1855 $masterConn = $this->openConnection( $this->getWriterIndex(), self
::DOMAIN_ANY
);
1856 $pos = $masterConn->getMasterPos();
1857 $this->closeConnection( $masterConn );
1861 if ( $pos instanceof DBMasterPos
) {
1862 $result = $conn->masterPosWait( $pos, $timeout );
1863 if ( $result == -1 ||
is_null( $result ) ) {
1864 $msg = __METHOD__
. ': timed out waiting on {host} pos {pos}';
1865 $this->replLogger
->warning( $msg, [
1866 'host' => $conn->getServer(),
1868 'trace' => ( new RuntimeException() )->getTraceAsString()
1872 $this->replLogger
->debug( __METHOD__
. ': done waiting' );
1876 $ok = false; // something is misconfigured
1877 $this->replLogger
->error(
1878 __METHOD__
. ': could not get master pos for {host}',
1880 'host' => $conn->getServer(),
1881 'trace' => ( new RuntimeException() )->getTraceAsString()
1889 public function setTransactionListener( $name, callable
$callback = null ) {
1891 $this->trxRecurringCallbacks
[$name] = $callback;
1893 unset( $this->trxRecurringCallbacks
[$name] );
1895 $this->forEachOpenMasterConnection(
1896 function ( IDatabase
$conn ) use ( $name, $callback ) {
1897 $conn->setTransactionListener( $name, $callback );
1902 public function setTableAliases( array $aliases ) {
1903 $this->tableAliases
= $aliases;
1906 public function setIndexAliases( array $aliases ) {
1907 $this->indexAliases
= $aliases;
1910 public function setDomainPrefix( $prefix ) {
1911 // Find connections to explicit foreign domains still marked as in-use...
1913 $this->forEachOpenConnection( function ( IDatabase
$conn ) use ( &$domainsInUse ) {
1914 // Once reuseConnection() is called on a handle, its reference count goes from 1 to 0.
1915 // Until then, it is still in use by the caller (explicitly or via DBConnRef scope).
1916 if ( $conn->getLBInfo( 'foreignPoolRefCount' ) > 0 ) {
1917 $domainsInUse[] = $conn->getDomainID();
1921 // Do not switch connections to explicit foreign domains unless marked as safe
1922 if ( $domainsInUse ) {
1923 $domains = implode( ', ', $domainsInUse );
1924 throw new DBUnexpectedError( null,
1925 "Foreign domain connections are still in use ($domains)." );
1928 $this->setLocalDomain( new DatabaseDomain(
1929 $this->localDomain
->getDatabase(),
1930 $this->localDomain
->getSchema(),
1934 // Update the prefix for all local connections...
1935 $this->forEachOpenConnection( function ( IDatabase
$db ) use ( $prefix ) {
1936 if ( !$db->getLBInfo( 'foreign' ) ) {
1937 $db->tablePrefix( $prefix );
1943 * @param DatabaseDomain $domain
1945 private function setLocalDomain( DatabaseDomain
$domain ) {
1946 $this->localDomain
= $domain;
1947 // In case a caller assumes that the domain ID is simply <db>-<prefix>, which is almost
1948 // always true, gracefully handle the case when they fail to account for escaping.
1949 if ( $this->localDomain
->getTablePrefix() != '' ) {
1950 $this->localDomainIdAlias
=
1951 $this->localDomain
->getDatabase() . '-' . $this->localDomain
->getTablePrefix();
1953 $this->localDomainIdAlias
= $this->localDomain
->getDatabase();
1958 * Make PHP ignore user aborts/disconnects until the returned
1959 * value leaves scope. This returns null and does nothing in CLI mode.
1961 * @return ScopedCallback|null
1963 final protected function getScopedPHPBehaviorForCommit() {
1964 if ( PHP_SAPI
!= 'cli' ) { // https://bugs.php.net/bug.php?id=47540
1965 $old = ignore_user_abort( true ); // avoid half-finished operations
1966 return new ScopedCallback( function () use ( $old ) {
1967 ignore_user_abort( $old );
1974 function __destruct() {
1975 // Avoid connection leaks for sanity
1981 * @deprecated since 1.29
1983 class_alias( LoadBalancer
::class, 'LoadBalancer' );