includes/libs/rdbms/loadbalancer/LoadBalancer.php

   1 <?php
   2 /**
   3  * Database load balancing manager
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22 namespace Wikimedia\Rdbms;
  23
  24 use Psr\Log\LoggerInterface;
  25 use Psr\Log\NullLogger;
  26 use Wikimedia\ScopedCallback;
  27 use BagOStuff;
  28 use EmptyBagOStuff;
  29 use WANObjectCache;
  30 use ArrayUtils;
  31 use InvalidArgumentException;
  32 use RuntimeException;
  33 use Exception;
  34
  35 /**
  36  * Database connection, tracking, load balancing, and transaction manager for a cluster
  37  *
  38  * @ingroup Database
  39  */
  40 class LoadBalancer implements ILoadBalancer {
  41         /** @var ILoadMonitor */
  42         private $loadMonitor;
  43         /** @var callable|null Callback to run before the first connection attempt */
  44         private $chronologyCallback;
  45         /** @var BagOStuff */
  46         private $srvCache;
  47         /** @var WANObjectCache */
  48         private $wanCache;
  49         /** @var object|string Class name or object With profileIn/profileOut methods */
  50         private $profiler;
  51         /** @var TransactionProfiler */
  52         private $trxProfiler;
  53         /** @var LoggerInterface */
  54         private $replLogger;
  55         /** @var LoggerInterface */
  56         private $connLogger;
  57         /** @var LoggerInterface */
  58         private $queryLogger;
  59         /** @var LoggerInterface */
  60         private $perfLogger;
  61         /** @var callable Exception logger */
  62         private $errorLogger;
  63         /** @var callable Deprecation logger */
  64         private $deprecationLogger;
  65
  66         /** @var DatabaseDomain Local Domain ID and default for selectDB() calls */
  67         private $localDomain;
  68
  69         /** @var Database[][][] Map of (connection category => server index => IDatabase[]) */
  70         private $conns;
  71
  72         /** @var array[] Map of (server index => server config array) */
  73         private $servers;
  74         /** @var float[] Map of (server index => weight) */
  75         private $loads;
  76         /** @var array[] Map of (group => server index => weight) */
  77         private $groupLoads;
  78         /** @var bool Whether to disregard replica DB lag as a factor in replica DB selection */
  79         private $allowLagged;
  80         /** @var int Seconds to spend waiting on replica DB lag to resolve */
  81         private $waitTimeout;
  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;
  86         /** @var int */
  87         private $maxLag = self::MAX_LAG_DEFAULT;
  88
  89         /** @var string Current server name */
  90         private $hostname;
  91         /** @var bool Whether this PHP instance is for a CLI script */
  92         private $cliMode;
  93         /** @var string Agent name for query profiling */
  94         private $agent;
  95
  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 = [];
 102
 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) */
 106         private $readIndex;
 107         /** @var bool|DBMasterPos False if not set */
 108         private $waitForPos;
 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;
 119         /** @var bool */
 120         private $disabled = false;
 121         /** @var bool Whether any connection has been attempted yet */
 122         private $connectionAttempted = false;
 123
 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;
 128
 129         /** @var string|null */
 130         private $defaultGroup = null;
 131
 132         /** @var int Warn when this many connection are held */
 133         const CONN_HELD_WARN_THRESHOLD = 10;
 134
 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;
 141
 142         const KEY_LOCAL = 'local';
 143         const KEY_FOREIGN_FREE = 'foreignFree';
 144         const KEY_FOREIGN_INUSE = 'foreignInUse';
 145
 146         const KEY_LOCAL_NOROUND = 'localAutoCommit';
 147         const KEY_FOREIGN_FREE_NOROUND = 'foreignFreeAutoCommit';
 148         const KEY_FOREIGN_INUSE_NOROUND = 'foreignInUseAutoCommit';
 149
 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';
 162
 163         public function __construct( array $params ) {
 164                 if ( !isset( $params['servers'] ) ) {
 165                         throw new InvalidArgumentException( __CLASS__ . ': missing servers parameter' );
 166                 }
 167                 $this->servers = $params['servers'];
 168                 foreach ( $this->servers as $i => $server ) {
 169                         if ( $i == 0 ) {
 170                                 $this->servers[$i]['master'] = true;
 171                         } else {
 172                                 $this->servers[$i]['replica'] = true;
 173                         }
 174                 }
 175
 176                 $localDomain = isset( $params['localDomain'] )
 177                         ? DatabaseDomain::newFromId( $params['localDomain'] )
 178                         : DatabaseDomain::newUnspecified();
 179                 $this->setLocalDomain( $localDomain );
 180
 181                 $this->waitTimeout = $params['waitTimeout'] ?? self::MAX_WAIT_DEFAULT;
 182
 183                 $this->readIndex = -1;
 184                 $this->conns = [
 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 => []
 193                 ];
 194                 $this->loads = [];
 195                 $this->waitForPos = false;
 196                 $this->allowLagged = false;
 197
 198                 if ( isset( $params['readOnlyReason'] ) && is_string( $params['readOnlyReason'] ) ) {
 199                         $this->readOnlyReason = $params['readOnlyReason'];
 200                 }
 201
 202                 if ( isset( $params['maxLag'] ) ) {
 203                         $this->maxLag = $params['maxLag'];
 204                 }
 205
 206                 if ( isset( $params['loadMonitor'] ) ) {
 207                         $this->loadMonitorConfig = $params['loadMonitor'];
 208                 } else {
 209                         $this->loadMonitorConfig = [ 'class' => 'LoadMonitorNull' ];
 210                 }
 211                 $this->loadMonitorConfig += [ 'lagWarnThreshold' => $this->maxLag ];
 212
 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] = [];
 219                                         }
 220                                         $this->groupLoads[$group][$i] = $ratio;
 221                                 }
 222                         }
 223                 }
 224
 225                 if ( isset( $params['srvCache'] ) ) {
 226                         $this->srvCache = $params['srvCache'];
 227                 } else {
 228                         $this->srvCache = new EmptyBagOStuff();
 229                 }
 230                 if ( isset( $params['wanCache'] ) ) {
 231                         $this->wanCache = $params['wanCache'];
 232                 } else {
 233                         $this->wanCache = WANObjectCache::newEmpty();
 234                 }
 235                 $this->profiler = $params['profiler'] ?? null;
 236                 if ( isset( $params['trxProfiler'] ) ) {
 237                         $this->trxProfiler = $params['trxProfiler'];
 238                 } else {
 239                         $this->trxProfiler = new TransactionProfiler();
 240                 }
 241
 242                 $this->errorLogger = $params['errorLogger'] ?? function ( Exception $e ) {
 243                         trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING );
 244                 };
 245                 $this->deprecationLogger = $params['deprecationLogger'] ?? function ( $msg ) {
 246                         trigger_error( $msg, E_USER_DEPRECATED );
 247                 };
 248
 249                 foreach ( [ 'replLogger', 'connLogger', 'queryLogger', 'perfLogger' ] as $key ) {
 250                         $this->$key = $params[$key] ?? new NullLogger();
 251                 }
 252
 253                 $this->hostname = $params['hostname'] ?? ( gethostname() ?: 'unknown' );
 254                 $this->cliMode = $params['cliMode'] ?? ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' );
 255                 $this->agent = $params['agent'] ?? '';
 256
 257                 if ( isset( $params['chronologyCallback'] ) ) {
 258                         $this->chronologyCallback = $params['chronologyCallback'];
 259                 }
 260
 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;
 266                         }
 267                 }
 268
 269                 $this->defaultGroup = $params['defaultGroup'] ?? null;
 270         }
 271
 272         public function getLocalDomainID() {
 273                 return $this->localDomain->getId();
 274         }
 275
 276         public function resolveDomainID( $domain ) {
 277                 return ( $domain !== false ) ? (string)$domain : $this->getLocalDomainID();
 278         }
 279
 280         /**
 281          * Get a LoadMonitor instance
 282          *
 283          * @return ILoadMonitor
 284          */
 285         private function getLoadMonitor() {
 286                 if ( !isset( $this->loadMonitor ) ) {
 287                         $compat = [
 288                                 'LoadMonitor' => LoadMonitor::class,
 289                                 'LoadMonitorNull' => LoadMonitorNull::class,
 290                                 'LoadMonitorMySQL' => LoadMonitorMySQL::class,
 291                         ];
 292
 293                         $class = $this->loadMonitorConfig['class'];
 294                         if ( isset( $compat[$class] ) ) {
 295                                 $class = $compat[$class];
 296                         }
 297
 298                         $this->loadMonitor = new $class(
 299                                 $this, $this->srvCache, $this->wanCache, $this->loadMonitorConfig );
 300                         $this->loadMonitor->setLogger( $this->replLogger );
 301                 }
 302
 303                 return $this->loadMonitor;
 304         }
 305
 306         /**
 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
 311          */
 312         private function getRandomNonLagged( array $loads, $domain = false, $maxLag = INF ) {
 313                 $lags = $this->getLagTimes( $domain );
 314
 315                 # Unset excessively lagged servers
 316                 foreach ( $lags as $i => $lag ) {
 317                         if ( $i != 0 ) {
 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 );
 322
 323                                 $host = $this->getServerName( $i );
 324                                 if ( $lag === false && !is_infinite( $maxServerLag ) ) {
 325                                         $this->replLogger->error(
 326                                                 __METHOD__ .
 327                                                 ": server {host} is not replicating?", [ 'host' => $host ] );
 328                                         unset( $loads[$i] );
 329                                 } elseif ( $lag > $maxServerLag ) {
 330                                         $this->replLogger->info(
 331                                                 __METHOD__ .
 332                                                 ": server {host} has {lag} seconds of lag (>= {maxlag})",
 333                                                 [ 'host' => $host, 'lag' => $lag, 'maxlag' => $maxServerLag ]
 334                                         );
 335                                         unset( $loads[$i] );
 336                                 }
 337                         }
 338                 }
 339
 340                 # Find out if all the replica DBs with non-zero load are lagged
 341                 $sum = 0;
 342                 foreach ( $loads as $load ) {
 343                         $sum += $load;
 344                 }
 345                 if ( $sum == 0 ) {
 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.
 350                         return false;
 351                 }
 352
 353                 if ( count( $loads ) == 0 ) {
 354                         return false;
 355                 }
 356
 357                 # Return a random representative of the remainder
 358                 return ArrayUtils::pickRandom( $loads );
 359         }
 360
 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;
 368                 }
 369
 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];
 374                         } else {
 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" );
 377
 378                                 return false;
 379                         }
 380                 } else {
 381                         // Use the generic load group
 382                         $loads = $this->loads;
 383                 }
 384
 385                 // Scale the configured load ratios according to each server's load and state
 386                 $this->getLoadMonitor()->scaleLoads( $loads, $domain );
 387
 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
 392                         return false;
 393                 }
 394
 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;
 402                         }
 403                 }
 404
 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;
 411                         }
 412                 }
 413
 414                 $serverName = $this->getServerName( $i );
 415                 $this->connLogger->debug( __METHOD__ . ": using server $serverName for group '$group'" );
 416
 417                 return $i;
 418         }
 419
 420         /**
 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
 424          */
 425         private function pickReaderIndex( array $loads, $domain = false ) {
 426                 if ( !count( $loads ) ) {
 427                         throw new InvalidArgumentException( "Empty server array given to LoadBalancer" );
 428                 }
 429
 430                 /** @var int|bool $i Index of selected server */
 431                 $i = false;
 432                 /** @var bool $laggedReplicaMode Whether server is considered lagged */
 433                 $laggedReplicaMode = false;
 434
 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 );
 440                         } else {
 441                                 $i = false;
 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 );
 449                                 }
 450                                 if ( $i === false ) {
 451                                         // Any server with less lag than it's 'max lag' param is preferable
 452                                         $i = $this->getRandomNonLagged( $currentLoads, $domain );
 453                                 }
 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;
 460                                 }
 461                         }
 462
 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" );
 468
 469                                 return [ false, false ];
 470                         }
 471
 472                         $serverName = $this->getServerName( $i );
 473                         $this->connLogger->debug( __METHOD__ . ": Using reader #$i: $serverName..." );
 474
 475                         $conn = $this->openConnection( $i, $domain );
 476                         if ( !$conn ) {
 477                                 $this->connLogger->warning( __METHOD__ . ": Failed connecting to $i/$domain" );
 478                                 unset( $currentLoads[$i] ); // avoid this server next iteration
 479                                 $i = false;
 480                                 continue;
 481                         }
 482
 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 );
 487                         }
 488
 489                         // Return this server
 490                         break;
 491                 }
 492
 493                 // If all servers were down, quit now
 494                 if ( !count( $currentLoads ) ) {
 495                         $this->connLogger->error( __METHOD__ . ": all servers down" );
 496                 }
 497
 498                 return [ $i, $laggedReplicaMode ];
 499         }
 500
 501         public function waitFor( $pos ) {
 502                 $oldPos = $this->waitForPos;
 503                 try {
 504                         $this->waitForPos = $pos;
 505                         // If a generic reader connection was already established, then wait now
 506                         $i = $this->readIndex;
 507                         if ( $i > 0 ) {
 508                                 if ( !$this->doWait( $i ) ) {
 509                                         $this->laggedReplicaMode = true;
 510                                 }
 511                         }
 512                 } finally {
 513                         // Restore the older position if it was higher since this is used for lag-protection
 514                         $this->setWaitForPositionIfHigher( $oldPos );
 515                 }
 516         }
 517
 518         public function waitForOne( $pos, $timeout = null ) {
 519                 $oldPos = $this->waitForPos;
 520                 try {
 521                         $this->waitForPos = $pos;
 522
 523                         $i = $this->readIndex;
 524                         if ( $i <= 0 ) {
 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 );
 530                         }
 531
 532                         if ( $i > 0 ) {
 533                                 $ok = $this->doWait( $i, true, $timeout );
 534                         } else {
 535                                 $ok = true; // no applicable loads
 536                         }
 537                 } finally {
 538                         # Restore the old position, as this is not used for lag-protection but for throttling
 539                         $this->waitForPos = $oldPos;
 540                 }
 541
 542                 return $ok;
 543         }
 544
 545         public function waitForAll( $pos, $timeout = null ) {
 546                 $timeout = $timeout ?: $this->waitTimeout;
 547
 548                 $oldPos = $this->waitForPos;
 549                 try {
 550                         $this->waitForPos = $pos;
 551                         $serverCount = count( $this->servers );
 552
 553                         $ok = true;
 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
 561                                         }
 562                                 }
 563                         }
 564                 } finally {
 565                         # Restore the old position, as this is not used for lag-protection but for throttling
 566                         $this->waitForPos = $oldPos;
 567                 }
 568
 569                 return $ok;
 570         }
 571
 572         /**
 573          * @param DBMasterPos|bool $pos
 574          */
 575         private function setWaitForPositionIfHigher( $pos ) {
 576                 if ( !$pos ) {
 577                         return;
 578                 }
 579
 580                 if ( !$this->waitForPos || $pos->hasReached( $this->waitForPos ) ) {
 581                         $this->waitForPos = $pos;
 582                 }
 583         }
 584
 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] ) ) {
 589                                 continue;
 590                         }
 591
 592                         foreach ( $connsByServer[$i] as $conn ) {
 593                                 if ( !$autocommit || $conn->getLBInfo( 'autoCommitOnly' ) ) {
 594                                         return $conn;
 595                                 }
 596                         }
 597                 }
 598
 599                 return false;
 600         }
 601
 602         /**
 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()
 607          * @return bool
 608          */
 609         protected function doWait( $index, $open = false, $timeout = null ) {
 610                 $timeout = max( 1, intval( $timeout ?: $this->waitTimeout ) );
 611
 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 );
 617                 if (
 618                         $knownReachedPos instanceof DBMasterPos &&
 619                         $knownReachedPos->hasReached( $this->waitForPos )
 620                 ) {
 621                         $this->replLogger->debug(
 622                                 __METHOD__ .
 623                                 ': replica DB {dbserver} known to be caught up (pos >= $knownReachedPos).',
 624                                 [ 'dbserver' => $server ]
 625                         );
 626                         return true;
 627                 }
 628
 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 );
 632                 if ( !$conn ) {
 633                         if ( !$open ) {
 634                                 $this->replLogger->debug(
 635                                         __METHOD__ . ': no connection open for {dbserver}',
 636                                         [ 'dbserver' => $server ]
 637                                 );
 638
 639                                 return false;
 640                         } else {
 641                                 $conn = $this->openConnection( $index, self::DOMAIN_ANY );
 642                                 if ( !$conn ) {
 643                                         $this->replLogger->warning(
 644                                                 __METHOD__ . ': failed to connect to {dbserver}',
 645                                                 [ 'dbserver' => $server ]
 646                                         );
 647
 648                                         return false;
 649                                 }
 650                                 // Avoid connection spam in waitForAll() when connections
 651                                 // are made just for the sake of doing this lag check.
 652                                 $close = true;
 653                         }
 654                 }
 655
 656                 $this->replLogger->info(
 657                         __METHOD__ .
 658                         ': waiting for replica DB {dbserver} to catch up...',
 659                         [ 'dbserver' => $server ]
 660                 );
 661
 662                 $result = $conn->masterPosWait( $this->waitForPos, $timeout );
 663
 664                 if ( $result === null ) {
 665                         $this->replLogger->warning(
 666                                 __METHOD__ . ': Errored out waiting on {host} pos {pos}',
 667                                 [
 668                                         'host' => $server,
 669                                         'pos' => $this->waitForPos,
 670                                         'trace' => ( new RuntimeException() )->getTraceAsString()
 671                                 ]
 672                         );
 673                         $ok = false;
 674                 } elseif ( $result == -1 ) {
 675                         $this->replLogger->warning(
 676                                 __METHOD__ . ': Timed out waiting on {host} pos {pos}',
 677                                 [
 678                                         'host' => $server,
 679                                         'pos' => $this->waitForPos,
 680                                         'trace' => ( new RuntimeException() )->getTraceAsString()
 681                                 ]
 682                         );
 683                         $ok = false;
 684                 } else {
 685                         $this->replLogger->debug( __METHOD__ . ": done waiting" );
 686                         $ok = true;
 687                         // Remember that the DB reached this point
 688                         $this->srvCache->set( $key, $this->waitForPos, BagOStuff::TTL_DAY );
 689                 }
 690
 691                 if ( $close ) {
 692                         $this->closeConnection( $conn );
 693                 }
 694
 695                 return $ok;
 696         }
 697
 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' );
 702                 }
 703
 704                 if ( $this->localDomain->equals( $domain ) || $domain === $this->localDomainIdAlias ) {
 705                         $domain = false; // local connection requested
 706                 }
 707
 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.' );
 722                         }
 723                 }
 724
 725                 // Check one "group" per default: the generic pool
 726                 $defaultGroups = $this->defaultGroup ? [ $this->defaultGroup ] : [ false ];
 727
 728                 $groups = ( $groups === false || $groups === [] )
 729                         ? $defaultGroups
 730                         : (array)$groups;
 731
 732                 $masterOnly = ( $i == self::DB_MASTER || $i == $this->getWriterIndex() );
 733                 $oldConnsOpened = $this->connsOpened; // connections open now
 734
 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 ) {
 742                                         $i = $groupIndex;
 743                                         break;
 744                                 }
 745                         }
 746                 }
 747
 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
 761                         }
 762                 }
 763
 764                 # Now we have an explicit index into the servers array
 765                 $conn = $this->openConnection( $i, $domain, $flags );
 766                 if ( !$conn ) {
 767                         // Throw an exception
 768                         $this->reportConnectionError();
 769                         return null; // not reached
 770                 }
 771
 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 );
 777                 }
 778
 779                 if ( $masterOnly ) {
 780                         # Make master-requested DB handles inherit any read-only mode setting
 781                         $conn->setLBInfo( 'readOnlyReason', $this->getReadOnlyReason( $domain, $conn ) );
 782                 }
 783
 784                 return $conn;
 785         }
 786
 787         public function reuseConnection( IDatabase $conn ) {
 788                 $serverIndex = $conn->getLBInfo( 'serverIndex' );
 789                 $refCount = $conn->getLBInfo( 'foreignPoolRefCount' );
 790                 if ( $serverIndex === null || $refCount === null ) {
 791                         /**
 792                          * This can happen in code like:
 793                          *   foreach ( $dbs as $db ) {
 794                          *     $conn = $lb->getConnection( $lb::DB_REPLICA, [], $db );
 795                          *     ...
 796                          *     $lb->reuseConnection( $conn );
 797                          *   }
 798                          * When a connection to the local DB is opened in this way, reuseConnection()
 799                          * should be ignored
 800                          */
 801                         return;
 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() );
 808
 809                         return;
 810                 }
 811
 812                 if ( $this->disabled ) {
 813                         return; // DBConnRef handle probably survived longer than the LoadBalancer
 814                 }
 815
 816                 if ( $conn->getLBInfo( 'autoCommitOnly' ) ) {
 817                         $connFreeKey = self::KEY_FOREIGN_FREE_NOROUND;
 818                         $connInUseKey = self::KEY_FOREIGN_INUSE_NOROUND;
 819                 } else {
 820                         $connFreeKey = self::KEY_FOREIGN_FREE;
 821                         $connInUseKey = self::KEY_FOREIGN_INUSE;
 822                 }
 823
 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." );
 831                 }
 832
 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
 839                         }
 840                         $this->connLogger->debug( __METHOD__ . ": freed connection $serverIndex/$domain" );
 841                 } else {
 842                         $this->connLogger->debug( __METHOD__ .
 843                                 ": reference count for $serverIndex/$domain reduced to $refCount" );
 844                 }
 845         }
 846
 847         public function getConnectionRef( $db, $groups = [], $domain = false, $flags = 0 ) {
 848                 $domain = $this->resolveDomainID( $domain );
 849
 850                 return new DBConnRef( $this, $this->getConnection( $db, $groups, $domain, $flags ) );
 851         }
 852
 853         public function getLazyConnectionRef( $db, $groups = [], $domain = false, $flags = 0 ) {
 854                 $domain = $this->resolveDomainID( $domain );
 855
 856                 return new DBConnRef( $this, [ $db, $groups, $domain, $flags ] );
 857         }
 858
 859         public function getMaintenanceConnectionRef( $db, $groups = [], $domain = false, $flags = 0 ) {
 860                 $domain = $this->resolveDomainID( $domain );
 861
 862                 return new MaintainableDBConnRef(
 863                         $this, $this->getConnection( $db, $groups, $domain, $flags ) );
 864         }
 865
 866         public function openConnection( $i, $domain = false, $flags = 0 ) {
 867                 if ( $this->localDomain->equals( $domain ) || $domain === $this->localDomainIdAlias ) {
 868                         $domain = false; // local connection requested
 869                 }
 870
 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 );
 876                 }
 877
 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 );
 883
 884                 if ( $domain !== false ) {
 885                         // Connection is to a foreign domain
 886                         $conn = $this->openForeignConnection( $i, $domain, $flags );
 887                 } else {
 888                         // Connection is to the local domain
 889                         $conn = $this->openLocalConnection( $i, $flags );
 890                 }
 891
 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;
 898                         $conn = false;
 899                 }
 900
 901                 if ( $autoCommit && $conn instanceof IDatabase ) {
 902                         if ( $conn->trxLevel() ) { // sanity
 903                                 throw new DBUnexpectedError(
 904                                         $conn,
 905                                         __METHOD__ . ': CONN_TRX_AUTOCOMMIT handle has a transaction.'
 906                                 );
 907                         }
 908
 909                         $conn->clearFlag( $conn::DBO_TRX ); // auto-commit mode
 910                 }
 911
 912                 return $conn;
 913         }
 914
 915         /**
 916          * Open a connection to a local DB, or return one if it is already open.
 917          *
 918          * On error, returns false, and the connection which caused the
 919          * error will be available via $this->errorConnection.
 920          *
 921          * @note If disable() was called on this LoadBalancer, this method will throw a DBAccessError.
 922          *
 923          * @param int $i Server index
 924          * @param int $flags Class CONN_* constant bitfield
 925          * @return Database
 926          */
 927         private function openLocalConnection( $i, $flags = 0 ) {
 928                 $autoCommit = ( ( $flags & self::CONN_TRX_AUTOCOMMIT ) == self::CONN_TRX_AUTOCOMMIT );
 929
 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];
 933                 } else {
 934                         if ( !isset( $this->servers[$i] ) || !is_array( $this->servers[$i] ) ) {
 935                                 throw new InvalidArgumentException( "No server with index '$i'." );
 936                         }
 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;
 947                         } else {
 948                                 $this->connLogger->warning(
 949                                         __METHOD__ . ": failed to connect to database $i at '$host'." );
 950                                 $this->errorConnection = $conn;
 951                                 $conn = false;
 952                         }
 953                 }
 954
 955                 return $conn;
 956         }
 957
 958         /**
 959          * Open a connection to a foreign DB, or return one if it is already open.
 960          *
 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().
 964          *
 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().
 968          *
 969          * On error, returns false, and the connection which caused the
 970          * error will be available via $this->errorConnection.
 971          *
 972          * @note If disable() was called on this LoadBalancer, this method will throw a DBAccessError.
 973          *
 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
 979          */
 980         private function openForeignConnection( $i, $domain, $flags = 0 ) {
 981                 $domainInstance = DatabaseDomain::newFromId( $domain );
 982                 $autoCommit = ( ( $flags & self::CONN_TRX_AUTOCOMMIT ) == self::CONN_TRX_AUTOCOMMIT );
 983
 984                 if ( $autoCommit ) {
 985                         $connFreeKey = self::KEY_FOREIGN_FREE_NOROUND;
 986                         $connInUseKey = self::KEY_FOREIGN_INUSE_NOROUND;
 987                 } else {
 988                         $connFreeKey = self::KEY_FOREIGN_FREE;
 989                         $connInUseKey = self::KEY_FOREIGN_INUSE;
 990                 }
 991
 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 );
1009                         } else {
1010                                 // Stay on the current database, but update the schema/prefix
1011                                 $conn->dbSchema( $domainInstance->getSchema() );
1012                                 $conn->tablePrefix( $domainInstance->getTablePrefix() );
1013                         }
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" );
1019                 } else {
1020                         if ( !isset( $this->servers[$i] ) || !is_array( $this->servers[$i] ) ) {
1021                                 throw new InvalidArgumentException( "No server with index '$i'." );
1022                         }
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;
1033                                 $conn = false;
1034                         } else {
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" );
1038                         }
1039                 }
1040
1041                 // Increment reference count
1042                 if ( $conn instanceof IDatabase ) {
1043                         $refCount = $conn->getLBInfo( 'foreignPoolRefCount' );
1044                         $conn->setLBInfo( 'foreignPoolRefCount', $refCount + 1 );
1045                 }
1046
1047                 return $conn;
1048         }
1049
1050         public function getServerAttributes( $i ) {
1051                 return Database::attributesFromType(
1052                         $this->getServerType( $i ),
1053                         $this->servers[$i]['driver'] ?? null
1054                 );
1055         }
1056
1057         /**
1058          * Test if the specified index represents an open connection
1059          *
1060          * @param int $index Server index
1061          * @access private
1062          * @return bool
1063          */
1064         private function isOpen( $index ) {
1065                 if ( !is_int( $index ) ) {
1066                         return false;
1067                 }
1068
1069                 return (bool)$this->getAnyOpenConnection( $index );
1070         }
1071
1072         /**
1073          * Open a new network connection to a server (uncached)
1074          *
1075          * Returns a Database object whether or not the connection was successful.
1076          *
1077          * @param array $server
1078          * @param DatabaseDomain $domain Domain the connection is for, possibly unspecified
1079          * @return Database
1080          * @throws DBAccessError
1081          * @throws InvalidArgumentException
1082          */
1083         protected function reallyOpenConnection( array $server, DatabaseDomain $domain ) {
1084                 if ( $this->disabled ) {
1085                         throw new DBAccessError();
1086                 }
1087
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;
1097                         }
1098                 } else {
1099                         $server['dbname'] = $domain->getDatabase();
1100                 }
1101
1102                 if ( $domain->getSchema() !== null ) {
1103                         $server['schema'] = $domain->getSchema();
1104                 }
1105
1106                 // It is always possible to connect with any prefix, even the empty string
1107                 $server['tablePrefix'] = $domain->getTablePrefix();
1108
1109                 // Let the handle know what the cluster master is (e.g. "db1052")
1110                 $masterName = $this->getServerName( $this->getWriterIndex() );
1111                 $server['clusterMasterHost'] = $masterName;
1112
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)" );
1117                 }
1118
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;
1133
1134                 // Create a live connection object
1135                 try {
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
1140                         $db = $e->db;
1141                 }
1142
1143                 $db->setLBInfo( $server );
1144                 $db->setLazyMasterHandle(
1145                         $this->getLazyConnectionRef( self::DB_MASTER, [], $db->getDomainID() )
1146                 );
1147                 $db->setTableAliases( $this->tableAliases );
1148                 $db->setIndexAliases( $this->indexAliases );
1149
1150                 if ( $server['serverIndex'] === $this->getWriterIndex() ) {
1151                         if ( $this->trxRoundId !== false ) {
1152                                 $this->applyTransactionRoundFlags( $db );
1153                         }
1154                         foreach ( $this->trxRecurringCallbacks as $name => $callback ) {
1155                                 $db->setTransactionListener( $name, $callback );
1156                         }
1157                 }
1158
1159                 return $db;
1160         }
1161
1162         /**
1163          * @throws DBConnectionError
1164          */
1165         private function reportConnectionError() {
1166                 $conn = $this->errorConnection; // the connection which caused the error
1167                 $context = [
1168                         'method' => __METHOD__,
1169                         'last_error' => $this->lastError,
1170                 ];
1171
1172                 if ( $conn instanceof IDatabase ) {
1173                         $context['db_server'] = $conn->getServer();
1174                         $this->connLogger->warning(
1175                                 __METHOD__ . ": connection error: {last_error} ({db_server})",
1176                                 $context
1177                         );
1178
1179                         throw new DBConnectionError( $conn, "{$this->lastError} ({$context['db_server']})" );
1180                 } else {
1181                         // No last connection, probably due to all servers being too busy
1182                         $this->connLogger->error(
1183                                 __METHOD__ .
1184                                 ": LB failure with no last connection. Connection error: {last_error}",
1185                                 $context
1186                         );
1187
1188                         // If all servers were busy, "lastError" will contain something sensible
1189                         throw new DBConnectionError( null, $this->lastError );
1190                 }
1191         }
1192
1193         public function getWriterIndex() {
1194                 return 0;
1195         }
1196
1197         public function haveIndex( $i ) {
1198                 return array_key_exists( $i, $this->servers );
1199         }
1200
1201         public function isNonZeroLoad( $i ) {
1202                 return array_key_exists( $i, $this->servers ) && $this->loads[$i] != 0;
1203         }
1204
1205         public function getServerCount() {
1206                 return count( $this->servers );
1207         }
1208
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'];
1214                 } else {
1215                         $name = '';
1216                 }
1217
1218                 return ( $name != '' ) ? $name : 'localhost';
1219         }
1220
1221         public function getServerInfo( $i ) {
1222                 if ( isset( $this->servers[$i] ) ) {
1223                         return $this->servers[$i];
1224                 } else {
1225                         return false;
1226                 }
1227         }
1228
1229         public function getServerType( $i ) {
1230                 return $this->servers[$i]['type'] ?? 'unknown';
1231         }
1232
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 );
1241                                 if ( $conn ) {
1242                                         return $conn->getReplicaPos();
1243                                 }
1244                         }
1245                 } else {
1246                         return $masterConn->getMasterPos();
1247                 }
1248
1249                 return false;
1250         }
1251
1252         public function disable() {
1253                 $this->closeAll();
1254                 $this->disabled = true;
1255         }
1256
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'." );
1263                         $conn->close();
1264                 } );
1265
1266                 $this->conns = [
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 => []
1273                 ];
1274                 $this->connsOpened = 0;
1275         }
1276
1277         public function closeConnection( IDatabase $conn ) {
1278                 $serverIndex = $conn->getLBInfo( 'serverIndex' );
1279                 foreach ( $this->conns as $type => $connsByServer ) {
1280                         if ( !isset( $connsByServer[$serverIndex] ) ) {
1281                                 continue;
1282                         }
1283
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;
1291                                         break 2;
1292                                 }
1293                         }
1294                 }
1295
1296                 $conn->close();
1297         }
1298
1299         public function commitAll( $fname = __METHOD__ ) {
1300                 $this->commitMasterChanges( $fname );
1301                 $this->flushMasterSnapshots( $fname );
1302                 $this->flushReplicaSnapshots( $fname );
1303         }
1304
1305         public function finalizeMasterChanges() {
1306                 $this->assertTransactionRoundStage( [ self::ROUND_CURSORY, self::ROUND_FINALIZED ] );
1307
1308                 $this->trxRoundStage = self::ROUND_ERROR; // "failed" until proven otherwise
1309                 // Loop until callbacks stop adding callbacks on other connections
1310                 $total = 0;
1311                 do {
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();
1317                         } );
1318                         $total += $count;
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 );
1323                 } );
1324                 $this->trxRoundStage = self::ROUND_FINALIZED;
1325
1326                 return $total;
1327         }
1328
1329         public function approveMasterChanges( array $options ) {
1330                 $this->assertTransactionRoundStage( self::ROUND_FINALIZED );
1331
1332                 $limit = $options['maxWriteDuration'] ?? 0;
1333
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(
1345                                         $conn,
1346                                         "Transaction spent $time second(s) in writes, exceeding the limit of $limit.",
1347                                         [ $time, $limit ]
1348                                 );
1349                         }
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(
1354                                         $conn,
1355                                         "A connection to the {$conn->getDBname()} database was lost before commit."
1356                                 );
1357                         }
1358                 } );
1359                 $this->trxRoundStage = self::ROUND_APPROVED;
1360         }
1361
1362         public function beginMasterChanges( $fname = __METHOD__ ) {
1363                 if ( $this->trxRoundId !== false ) {
1364                         throw new DBTransactionError(
1365                                 null,
1366                                 "$fname: Transaction round '{$this->trxRoundId}' already started."
1367                         );
1368                 }
1369                 $this->assertTransactionRoundStage( self::ROUND_CURSORY );
1370
1371                 // Clear any empty transactions (no writes/callbacks) from the implicit round
1372                 $this->flushMasterSnapshots( $fname );
1373
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 );
1382                 } );
1383                 $this->trxRoundStage = self::ROUND_CURSORY;
1384         }
1385
1386         public function commitMasterChanges( $fname = __METHOD__ ) {
1387                 $this->assertTransactionRoundStage( self::ROUND_APPROVED );
1388
1389                 $failures = [];
1390
1391                 /** @noinspection PhpUnusedLocalVariableInspection */
1392                 $scope = $this->getScopedPHPBehaviorForCommit(); // try to ignore client aborts
1393
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 ) {
1401                                 try {
1402                                         $conn->commit( $fname, $conn::FLUSHING_ALL_PEERS );
1403                                 } catch ( DBError $e ) {
1404                                         ( $this->errorLogger )( $e );
1405                                         $failures[] = "{$conn->getServer()}: {$e->getMessage()}";
1406                                 }
1407                         }
1408                 );
1409                 if ( $failures ) {
1410                         throw new DBTransactionError(
1411                                 null,
1412                                 "$fname: Commit failed on server(s) " . implode( "\n", array_unique( $failures ) )
1413                         );
1414                 }
1415                 if ( $restore ) {
1416                         // Unmark handles as participating in this explicit transaction round
1417                         $this->forEachOpenMasterConnection( function ( Database $conn ) {
1418                                 $this->undoTransactionRoundFlags( $conn );
1419                         } );
1420                 }
1421                 $this->trxRoundStage = self::ROUND_COMMIT_CALLBACKS;
1422         }
1423
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;
1429                 } else {
1430                         throw new DBTransactionError(
1431                                 null,
1432                                 "Transaction should be in the callback stage (not '{$this->trxRoundStage}')"
1433                         );
1434                 }
1435
1436                 $oldStage = $this->trxRoundStage;
1437                 $this->trxRoundStage = self::ROUND_ERROR; // "failed" until proven otherwise
1438
1439                 // Now that the COMMIT/ROLLBACK step is over, enable post-commit callback runs
1440                 $this->forEachOpenMasterConnection( function ( Database $conn ) {
1441                         $conn->setTrxEndCallbackSuppression( false );
1442                 } );
1443
1444                 $e = null; // first exception
1445                 $fname = __METHOD__;
1446                 // Loop until callbacks stop adding callbacks on other connections
1447                 do {
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
1454                                         }
1455                                         try {
1456                                                 $count += $conn->runOnTransactionIdleCallbacks( $type );
1457                                         } catch ( Exception $ex ) {
1458                                                 $e = $e ?: $ex;
1459                                         }
1460                                 }
1461                         );
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).",
1470                                                 [
1471                                                         'db_server' => $conn->getServer(),
1472                                                         'db_name' => $conn->getDBname()
1473                                                 ]
1474                                         );
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." );
1479                                 }
1480                                 try {
1481                                         $conn->commit( $fname, $conn::FLUSHING_ALL_PEERS );
1482                                 } catch ( Exception $ex ) {
1483                                         $e = $e ?: $ex;
1484                                 }
1485                         } );
1486                 } while ( $count > 0 );
1487
1488                 $this->trxRoundStage = $oldStage;
1489
1490                 return $e;
1491         }
1492
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;
1498                 } else {
1499                         throw new DBTransactionError(
1500                                 null,
1501                                 "Transaction should be in the callback stage (not '{$this->trxRoundStage}')"
1502                         );
1503                 }
1504
1505                 $e = null;
1506
1507                 $this->trxRoundStage = self::ROUND_ERROR; // "failed" until proven otherwise
1508                 $this->forEachOpenMasterConnection( function ( Database $conn ) use ( $type, &$e ) {
1509                         try {
1510                                 $conn->runTransactionListenerCallbacks( $type );
1511                         } catch ( Exception $ex ) {
1512                                 $e = $e ?: $ex;
1513                         }
1514                 } );
1515                 $this->trxRoundStage = self::ROUND_CURSORY;
1516
1517                 return $e;
1518         }
1519
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 );
1526                 } );
1527                 if ( $restore ) {
1528                         // Unmark handles as participating in this explicit transaction round
1529                         $this->forEachOpenMasterConnection( function ( Database $conn ) {
1530                                 $this->undoTransactionRoundFlags( $conn );
1531                         } );
1532                 }
1533                 $this->trxRoundStage = self::ROUND_ROLLBACK_CALLBACKS;
1534         }
1535
1536         /**
1537          * @param string|string[] $stage
1538          */
1539         private function assertTransactionRoundStage( $stage ) {
1540                 $stages = (array)$stage;
1541
1542                 if ( !in_array( $this->trxRoundStage, $stages, true ) ) {
1543                         $stageList = implode(
1544                                 '/',
1545                                 array_map( function ( $v ) {
1546                                         return "'$v'";
1547                                 }, $stages )
1548                         );
1549                         throw new DBTransactionError(
1550                                 null,
1551                                 "Transaction round stage must be $stageList (not '{$this->trxRoundStage}')"
1552                         );
1553                 }
1554         }
1555
1556         /**
1557          * Make all DB servers with DBO_DEFAULT/DBO_TRX set join the transaction round
1558          *
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.
1562          *
1563          * @param Database $conn
1564          */
1565         private function applyTransactionRoundFlags( Database $conn ) {
1566                 if ( $conn->getLBInfo( 'autoCommitOnly' ) ) {
1567                         return; // transaction rounds do not apply to these connections
1568                 }
1569
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 );
1574                 }
1575
1576                 if ( $conn->getFlag( $conn::DBO_TRX ) ) {
1577                         $conn->setLBInfo( 'trxRoundId', $this->trxRoundId );
1578                 }
1579         }
1580
1581         /**
1582          * @param Database $conn
1583          */
1584         private function undoTransactionRoundFlags( Database $conn ) {
1585                 if ( $conn->getLBInfo( 'autoCommitOnly' ) ) {
1586                         return; // transaction rounds do not apply to these connections
1587                 }
1588
1589                 if ( $conn->getFlag( $conn::DBO_TRX ) ) {
1590                         $conn->setLBInfo( 'trxRoundId', false );
1591                 }
1592
1593                 if ( $conn->getFlag( $conn::DBO_DEFAULT ) ) {
1594                         $conn->restoreFlags( $conn::RESTORE_PRIOR );
1595                 }
1596         }
1597
1598         public function flushReplicaSnapshots( $fname = __METHOD__ ) {
1599                 $this->forEachOpenReplicaConnection( function ( IDatabase $conn ) use ( $fname ) {
1600                         $conn->flushSnapshot( $fname );
1601                 } );
1602         }
1603
1604         public function flushMasterSnapshots( $fname = __METHOD__ ) {
1605                 $this->forEachOpenMasterConnection( function ( IDatabase $conn ) use ( $fname ) {
1606                         $conn->flushSnapshot( $fname );
1607                 } );
1608         }
1609
1610         /**
1611          * @return string
1612          * @since 1.32
1613          */
1614         public function getTransactionRoundStage() {
1615                 return $this->trxRoundStage;
1616         }
1617
1618         public function hasMasterConnection() {
1619                 return $this->isOpen( $this->getWriterIndex() );
1620         }
1621
1622         public function hasMasterChanges() {
1623                 $pending = 0;
1624                 $this->forEachOpenMasterConnection( function ( IDatabase $conn ) use ( &$pending ) {
1625                         $pending |= $conn->writesOrCallbacksPending();
1626                 } );
1627
1628                 return (bool)$pending;
1629         }
1630
1631         public function lastMasterChangeTimestamp() {
1632                 $lastTime = false;
1633                 $this->forEachOpenMasterConnection( function ( IDatabase $conn ) use ( &$lastTime ) {
1634                         $lastTime = max( $lastTime, $conn->lastDoneWrites() );
1635                 } );
1636
1637                 return $lastTime;
1638         }
1639
1640         public function hasOrMadeRecentMasterChanges( $age = null ) {
1641                 $age = ( $age === null ) ? $this->waitTimeout : $age;
1642
1643                 return ( $this->hasMasterChanges()
1644                         || $this->lastMasterChangeTimestamp() > microtime( true ) - $age );
1645         }
1646
1647         public function pendingMasterChangeCallers() {
1648                 $fnames = [];
1649                 $this->forEachOpenMasterConnection( function ( IDatabase $conn ) use ( &$fnames ) {
1650                         $fnames = array_merge( $fnames, $conn->pendingWriteCallers() );
1651                 } );
1652
1653                 return $fnames;
1654         }
1655
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 ) {
1659                         try {
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;
1667                         }
1668                 }
1669
1670                 return $this->laggedReplicaMode;
1671         }
1672
1673         public function laggedReplicaUsed() {
1674                 return $this->laggedReplicaMode;
1675         }
1676
1677         /**
1678          * @return bool
1679          * @since 1.27
1680          * @deprecated Since 1.28; use laggedReplicaUsed()
1681          */
1682         public function laggedSlaveUsed() {
1683                 return $this->laggedReplicaUsed();
1684         }
1685
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';
1693                         } else {
1694                                 return 'The database has been automatically locked ' .
1695                                         'while the replica database servers catch up to the master.';
1696                         }
1697                 } elseif ( $this->masterRunningReadOnly( $domain, $conn ) ) {
1698                         return 'The database master is running in read-only mode.';
1699                 }
1700
1701                 return false;
1702         }
1703
1704         /**
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]
1707          * @return bool
1708          */
1709         private function masterRunningReadOnly( $domain, IDatabase $conn = null ) {
1710                 $cache = $this->wanCache;
1711                 $masterServer = $this->getServerName( $this->getWriterIndex() );
1712
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 );
1718                                 try {
1719                                         $dbw = $conn ?: $this->getConnection( self::DB_MASTER, [], $domain );
1720                                         $readOnly = (int)$dbw->serverIsReadOnly();
1721                                         if ( !$conn ) {
1722                                                 $this->reuseConnection( $dbw );
1723                                         }
1724                                 } catch ( DBError $e ) {
1725                                         $readOnly = 0;
1726                                 }
1727                                 $this->trxProfiler->setSilenced( $old );
1728                                 return $readOnly;
1729                         },
1730                         [ 'pcTTL' => $cache::TTL_PROC_LONG, 'busyValue' => 0 ]
1731                 );
1732         }
1733
1734         public function allowLagged( $mode = null ) {
1735                 if ( $mode === null ) {
1736                         return $this->allowLagged;
1737                 }
1738                 $this->allowLagged = $mode;
1739
1740                 return $this->allowLagged;
1741         }
1742
1743         public function pingAll() {
1744                 $success = true;
1745                 $this->forEachOpenConnection( function ( IDatabase $conn ) use ( &$success ) {
1746                         if ( !$conn->ping() ) {
1747                                 $success = false;
1748                         }
1749                 } );
1750
1751                 return $success;
1752         }
1753
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 );
1759                                 }
1760                         }
1761                 }
1762         }
1763
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 );
1771                                 }
1772                         }
1773                 }
1774         }
1775
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
1781                                 }
1782                                 foreach ( $serverConns as $conn ) {
1783                                         $callback( $conn, ...$params );
1784                                 }
1785                         }
1786                 }
1787         }
1788
1789         public function getMaxLag( $domain = false ) {
1790                 $maxLag = -1;
1791                 $host = '';
1792                 $maxIndex = 0;
1793
1794                 if ( $this->getServerCount() <= 1 ) {
1795                         return [ $host, $maxLag, $maxIndex ]; // no replication = no lag
1796                 }
1797
1798                 $lagTimes = $this->getLagTimes( $domain );
1799                 foreach ( $lagTimes as $i => $lag ) {
1800                         if ( $this->loads[$i] > 0 && $lag > $maxLag ) {
1801                                 $maxLag = $lag;
1802                                 $host = $this->servers[$i]['host'];
1803                                 $maxIndex = $i;
1804                         }
1805                 }
1806
1807                 return [ $host, $maxLag, $maxIndex ];
1808         }
1809
1810         public function getLagTimes( $domain = false ) {
1811                 if ( $this->getServerCount() <= 1 ) {
1812                         return [ $this->getWriterIndex() => 0 ]; // no replication = no lag
1813                 }
1814
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
1820                         } else {
1821                                 $knownLagTimes[$i] = 0; // DB server is a non-replicating and read-only archive
1822                         }
1823                 }
1824
1825                 return $this->getLoadMonitor()->getLagTimes( $indexesWithLag, $domain ) + $knownLagTimes;
1826         }
1827
1828         public function safeGetLag( IDatabase $conn ) {
1829                 if ( $this->getServerCount() <= 1 ) {
1830                         return 0;
1831                 } else {
1832                         return $conn->getLag();
1833                 }
1834         }
1835
1836         /**
1837          * @param IDatabase $conn
1838          * @param DBMasterPos|bool $pos
1839          * @param int|null $timeout
1840          * @return bool
1841          */
1842         public function safeWaitForMasterPos( IDatabase $conn, $pos = false, $timeout = null ) {
1843                 $timeout = max( 1, $timeout ?: $this->waitTimeout );
1844
1845                 if ( $this->getServerCount() <= 1 || !$conn->getLBInfo( 'replica' ) ) {
1846                         return true; // server is not a replica DB
1847                 }
1848
1849                 if ( !$pos ) {
1850                         // Get the current master position, opening a connection if needed
1851                         $masterConn = $this->getAnyOpenConnection( $this->getWriterIndex() );
1852                         if ( $masterConn ) {
1853                                 $pos = $masterConn->getMasterPos();
1854                         } else {
1855                                 $masterConn = $this->openConnection( $this->getWriterIndex(), self::DOMAIN_ANY );
1856                                 $pos = $masterConn->getMasterPos();
1857                                 $this->closeConnection( $masterConn );
1858                         }
1859                 }
1860
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(),
1867                                         'pos' => $pos,
1868                                         'trace' => ( new RuntimeException() )->getTraceAsString()
1869                                 ] );
1870                                 $ok = false;
1871                         } else {
1872                                 $this->replLogger->debug( __METHOD__ . ': done waiting' );
1873                                 $ok = true;
1874                         }
1875                 } else {
1876                         $ok = false; // something is misconfigured
1877                         $this->replLogger->error(
1878                                 __METHOD__ . ': could not get master pos for {host}',
1879                                 [
1880                                         'host' => $conn->getServer(),
1881                                         'trace' => ( new RuntimeException() )->getTraceAsString()
1882                                 ]
1883                         );
1884                 }
1885
1886                 return $ok;
1887         }
1888
1889         public function setTransactionListener( $name, callable $callback = null ) {
1890                 if ( $callback ) {
1891                         $this->trxRecurringCallbacks[$name] = $callback;
1892                 } else {
1893                         unset( $this->trxRecurringCallbacks[$name] );
1894                 }
1895                 $this->forEachOpenMasterConnection(
1896                         function ( IDatabase $conn ) use ( $name, $callback ) {
1897                                 $conn->setTransactionListener( $name, $callback );
1898                         }
1899                 );
1900         }
1901
1902         public function setTableAliases( array $aliases ) {
1903                 $this->tableAliases = $aliases;
1904         }
1905
1906         public function setIndexAliases( array $aliases ) {
1907                 $this->indexAliases = $aliases;
1908         }
1909
1910         public function setDomainPrefix( $prefix ) {
1911                 // Find connections to explicit foreign domains still marked as in-use...
1912                 $domainsInUse = [];
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();
1918                         }
1919                 } );
1920
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)." );
1926                 }
1927
1928                 $this->setLocalDomain( new DatabaseDomain(
1929                         $this->localDomain->getDatabase(),
1930                         $this->localDomain->getSchema(),
1931                         $prefix
1932                 ) );
1933
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 );
1938                         }
1939                 } );
1940         }
1941
1942         /**
1943          * @param DatabaseDomain $domain
1944          */
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();
1952                 } else {
1953                         $this->localDomainIdAlias = $this->localDomain->getDatabase();
1954                 }
1955         }
1956
1957         /**
1958          * Make PHP ignore user aborts/disconnects until the returned
1959          * value leaves scope. This returns null and does nothing in CLI mode.
1960          *
1961          * @return ScopedCallback|null
1962          */
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 );
1968                         } );
1969                 }
1970
1971                 return null;
1972         }
1973
1974         function __destruct() {
1975                 // Avoid connection leaks for sanity
1976                 $this->disable();
1977         }
1978 }
1979
1980 /**
1981  * @deprecated since 1.29
1982  */
1983 class_alias( LoadBalancer::class, 'LoadBalancer' );