wikimedia /
mediawiki
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like LoadBalancer often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use LoadBalancer, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 30 | class LoadBalancer { |
||
| 31 | /** @var array[] Map of (server index => server config array) */ |
||
| 32 | private $mServers; |
||
| 33 | /** @var array[] Map of (local/foreignUsed/foreignFree => server index => DatabaseBase array) */ |
||
| 34 | private $mConns; |
||
| 35 | /** @var array Map of (server index => weight) */ |
||
| 36 | private $mLoads; |
||
| 37 | /** @var array[] Map of (group => server index => weight) */ |
||
| 38 | private $mGroupLoads; |
||
| 39 | /** @var bool Whether to disregard replica DB lag as a factor in replica DB selection */ |
||
| 40 | private $mAllowLagged; |
||
| 41 | /** @var integer Seconds to spend waiting on replica DB lag to resolve */ |
||
| 42 | private $mWaitTimeout; |
||
| 43 | /** @var array LBFactory information */ |
||
| 44 | private $mParentInfo; |
||
|
|
|||
| 45 | |||
| 46 | /** @var string The LoadMonitor subclass name */ |
||
| 47 | private $mLoadMonitorClass; |
||
| 48 | /** @var LoadMonitor */ |
||
| 49 | private $mLoadMonitor; |
||
| 50 | /** @var BagOStuff */ |
||
| 51 | private $srvCache; |
||
| 52 | /** @var WANObjectCache */ |
||
| 53 | private $wanCache; |
||
| 54 | /** @var TransactionProfiler */ |
||
| 55 | protected $trxProfiler; |
||
| 56 | |||
| 57 | /** @var bool|DatabaseBase Database connection that caused a problem */ |
||
| 58 | private $mErrorConnection; |
||
| 59 | /** @var integer The generic (not query grouped) replica DB index (of $mServers) */ |
||
| 60 | private $mReadIndex; |
||
| 61 | /** @var bool|DBMasterPos False if not set */ |
||
| 62 | private $mWaitForPos; |
||
| 63 | /** @var bool Whether the generic reader fell back to a lagged replica DB */ |
||
| 64 | private $laggedReplicaMode = false; |
||
| 65 | /** @var bool Whether the generic reader fell back to a lagged replica DB */ |
||
| 66 | private $allReplicasDownMode = false; |
||
| 67 | /** @var string The last DB selection or connection error */ |
||
| 68 | private $mLastError = 'Unknown error'; |
||
| 69 | /** @var string|bool Reason the LB is read-only or false if not */ |
||
| 70 | private $readOnlyReason = false; |
||
| 71 | /** @var integer Total connections opened */ |
||
| 72 | private $connsOpened = 0; |
||
| 73 | /** @var string|bool String if a requested DBO_TRX transaction round is active */ |
||
| 74 | private $trxRoundId = false; |
||
| 75 | /** @var array[] Map of (name => callable) */ |
||
| 76 | private $trxRecurringCallbacks = []; |
||
| 77 | |||
| 78 | /** @var integer Warn when this many connection are held */ |
||
| 79 | const CONN_HELD_WARN_THRESHOLD = 10; |
||
| 80 | /** @var integer Default 'max lag' when unspecified */ |
||
| 81 | const MAX_LAG_DEFAULT = 10; |
||
| 82 | /** @var integer Max time to wait for a replica DB to catch up (e.g. ChronologyProtector) */ |
||
| 83 | const POS_WAIT_TIMEOUT = 10; |
||
| 84 | /** @var integer Seconds to cache master server read-only status */ |
||
| 85 | const TTL_CACHE_READONLY = 5; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * @var boolean |
||
| 89 | */ |
||
| 90 | private $disabled = false; |
||
| 91 | |||
| 92 | /** |
||
| 93 | * @param array $params Array with keys: |
||
| 94 | * - servers : Required. Array of server info structures. |
||
| 95 | * - loadMonitor : Name of a class used to fetch server lag and load. |
||
| 96 | * - readOnlyReason : Reason the master DB is read-only if so [optional] |
||
| 97 | * - waitTimeout : Maximum time to wait for replicas for consistency [optional] |
||
| 98 | * - srvCache : BagOStuff object [optional] |
||
| 99 | * - wanCache : WANObjectCache object [optional] |
||
| 100 | * @throws MWException |
||
| 101 | */ |
||
| 102 | public function __construct( array $params ) { |
||
| 103 | if ( !isset( $params['servers'] ) ) { |
||
| 104 | throw new MWException( __CLASS__ . ': missing servers parameter' ); |
||
| 105 | } |
||
| 106 | $this->mServers = $params['servers']; |
||
| 107 | $this->mWaitTimeout = isset( $params['waitTimeout'] ) |
||
| 108 | ? $params['waitTimeout'] |
||
| 109 | : self::POS_WAIT_TIMEOUT; |
||
| 110 | |||
| 111 | $this->mReadIndex = -1; |
||
| 112 | $this->mWriteIndex = -1; |
||
| 113 | $this->mConns = [ |
||
| 114 | 'local' => [], |
||
| 115 | 'foreignUsed' => [], |
||
| 116 | 'foreignFree' => [] ]; |
||
| 117 | $this->mLoads = []; |
||
| 118 | $this->mWaitForPos = false; |
||
| 119 | $this->mErrorConnection = false; |
||
| 120 | $this->mAllowLagged = false; |
||
| 121 | |||
| 122 | View Code Duplication | if ( isset( $params['readOnlyReason'] ) && is_string( $params['readOnlyReason'] ) ) { |
|
| 123 | $this->readOnlyReason = $params['readOnlyReason']; |
||
| 124 | } |
||
| 125 | |||
| 126 | if ( isset( $params['loadMonitor'] ) ) { |
||
| 127 | $this->mLoadMonitorClass = $params['loadMonitor']; |
||
| 128 | } else { |
||
| 129 | $master = reset( $params['servers'] ); |
||
| 130 | if ( isset( $master['type'] ) && $master['type'] === 'mysql' ) { |
||
| 131 | $this->mLoadMonitorClass = 'LoadMonitorMySQL'; |
||
| 132 | } else { |
||
| 133 | $this->mLoadMonitorClass = 'LoadMonitorNull'; |
||
| 134 | } |
||
| 135 | } |
||
| 136 | |||
| 137 | foreach ( $params['servers'] as $i => $server ) { |
||
| 138 | $this->mLoads[$i] = $server['load']; |
||
| 139 | if ( isset( $server['groupLoads'] ) ) { |
||
| 140 | foreach ( $server['groupLoads'] as $group => $ratio ) { |
||
| 141 | if ( !isset( $this->mGroupLoads[$group] ) ) { |
||
| 142 | $this->mGroupLoads[$group] = []; |
||
| 143 | } |
||
| 144 | $this->mGroupLoads[$group][$i] = $ratio; |
||
| 145 | } |
||
| 146 | } |
||
| 147 | } |
||
| 148 | |||
| 149 | if ( isset( $params['srvCache'] ) ) { |
||
| 150 | $this->srvCache = $params['srvCache']; |
||
| 151 | } else { |
||
| 152 | $this->srvCache = new EmptyBagOStuff(); |
||
| 153 | } |
||
| 154 | if ( isset( $params['wanCache'] ) ) { |
||
| 155 | $this->wanCache = $params['wanCache']; |
||
| 156 | } else { |
||
| 157 | $this->wanCache = WANObjectCache::newEmpty(); |
||
| 158 | } |
||
| 159 | if ( isset( $params['trxProfiler'] ) ) { |
||
| 160 | $this->trxProfiler = $params['trxProfiler']; |
||
| 161 | } else { |
||
| 162 | $this->trxProfiler = new TransactionProfiler(); |
||
| 163 | } |
||
| 164 | } |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Get a LoadMonitor instance |
||
| 168 | * |
||
| 169 | * @return LoadMonitor |
||
| 170 | */ |
||
| 171 | private function getLoadMonitor() { |
||
| 172 | if ( !isset( $this->mLoadMonitor ) ) { |
||
| 173 | $class = $this->mLoadMonitorClass; |
||
| 174 | $this->mLoadMonitor = new $class( $this ); |
||
| 175 | } |
||
| 176 | |||
| 177 | return $this->mLoadMonitor; |
||
| 178 | } |
||
| 179 | |||
| 180 | /** |
||
| 181 | * @param array $loads |
||
| 182 | * @param bool|string $wiki Wiki to get non-lagged for |
||
| 183 | * @param int $maxLag Restrict the maximum allowed lag to this many seconds |
||
| 184 | * @return bool|int|string |
||
| 185 | */ |
||
| 186 | private function getRandomNonLagged( array $loads, $wiki = false, $maxLag = INF ) { |
||
| 187 | $lags = $this->getLagTimes( $wiki ); |
||
| 188 | |||
| 189 | # Unset excessively lagged servers |
||
| 190 | foreach ( $lags as $i => $lag ) { |
||
| 191 | if ( $i != 0 ) { |
||
| 192 | # How much lag this server nominally is allowed to have |
||
| 193 | $maxServerLag = isset( $this->mServers[$i]['max lag'] ) |
||
| 194 | ? $this->mServers[$i]['max lag'] |
||
| 195 | : self::MAX_LAG_DEFAULT; // default |
||
| 196 | # Constrain that futher by $maxLag argument |
||
| 197 | $maxServerLag = min( $maxServerLag, $maxLag ); |
||
| 198 | |||
| 199 | $host = $this->getServerName( $i ); |
||
| 200 | if ( $lag === false && !is_infinite( $maxServerLag ) ) { |
||
| 201 | wfDebugLog( 'replication', "Server $host (#$i) is not replicating?" ); |
||
| 202 | unset( $loads[$i] ); |
||
| 203 | } elseif ( $lag > $maxServerLag ) { |
||
| 204 | wfDebugLog( 'replication', "Server $host (#$i) has >= $lag seconds of lag" ); |
||
| 205 | unset( $loads[$i] ); |
||
| 206 | } |
||
| 207 | } |
||
| 208 | } |
||
| 209 | |||
| 210 | # Find out if all the replica DBs with non-zero load are lagged |
||
| 211 | $sum = 0; |
||
| 212 | foreach ( $loads as $load ) { |
||
| 213 | $sum += $load; |
||
| 214 | } |
||
| 215 | if ( $sum == 0 ) { |
||
| 216 | # No appropriate DB servers except maybe the master and some replica DBs with zero load |
||
| 217 | # Do NOT use the master |
||
| 218 | # Instead, this function will return false, triggering read-only mode, |
||
| 219 | # and a lagged replica DB will be used instead. |
||
| 220 | return false; |
||
| 221 | } |
||
| 222 | |||
| 223 | if ( count( $loads ) == 0 ) { |
||
| 224 | return false; |
||
| 225 | } |
||
| 226 | |||
| 227 | # Return a random representative of the remainder |
||
| 228 | return ArrayUtils::pickRandom( $loads ); |
||
| 229 | } |
||
| 230 | |||
| 231 | /** |
||
| 232 | * Get the index of the reader connection, which may be a replica DB |
||
| 233 | * This takes into account load ratios and lag times. It should |
||
| 234 | * always return a consistent index during a given invocation |
||
| 235 | * |
||
| 236 | * Side effect: opens connections to databases |
||
| 237 | * @param string|bool $group Query group, or false for the generic reader |
||
| 238 | * @param string|bool $wiki Wiki ID, or false for the current wiki |
||
| 239 | * @throws MWException |
||
| 240 | * @return bool|int|string |
||
| 241 | */ |
||
| 242 | public function getReaderIndex( $group = false, $wiki = false ) { |
||
| 243 | global $wgDBtype; |
||
| 244 | |||
| 245 | # @todo FIXME: For now, only go through all this for mysql databases |
||
| 246 | if ( $wgDBtype != 'mysql' ) { |
||
| 247 | return $this->getWriterIndex(); |
||
| 248 | } |
||
| 249 | |||
| 250 | if ( count( $this->mServers ) == 1 ) { |
||
| 251 | # Skip the load balancing if there's only one server |
||
| 252 | return 0; |
||
| 253 | } elseif ( $group === false && $this->mReadIndex >= 0 ) { |
||
| 254 | # Shortcut if generic reader exists already |
||
| 255 | return $this->mReadIndex; |
||
| 256 | } |
||
| 257 | |||
| 258 | # Find the relevant load array |
||
| 259 | if ( $group !== false ) { |
||
| 260 | if ( isset( $this->mGroupLoads[$group] ) ) { |
||
| 261 | $nonErrorLoads = $this->mGroupLoads[$group]; |
||
| 262 | } else { |
||
| 263 | # No loads for this group, return false and the caller can use some other group |
||
| 264 | wfDebugLog( 'connect', __METHOD__ . ": no loads for group $group\n" ); |
||
| 265 | |||
| 266 | return false; |
||
| 267 | } |
||
| 268 | } else { |
||
| 269 | $nonErrorLoads = $this->mLoads; |
||
| 270 | } |
||
| 271 | |||
| 272 | if ( !count( $nonErrorLoads ) ) { |
||
| 273 | throw new MWException( "Empty server array given to LoadBalancer" ); |
||
| 274 | } |
||
| 275 | |||
| 276 | # Scale the configured load ratios according to the dynamic load (if the load monitor supports it) |
||
| 277 | $this->getLoadMonitor()->scaleLoads( $nonErrorLoads, $group, $wiki ); |
||
| 278 | |||
| 279 | $laggedReplicaMode = false; |
||
| 280 | |||
| 281 | # No server found yet |
||
| 282 | $i = false; |
||
| 283 | # First try quickly looking through the available servers for a server that |
||
| 284 | # meets our criteria |
||
| 285 | $currentLoads = $nonErrorLoads; |
||
| 286 | while ( count( $currentLoads ) ) { |
||
| 287 | if ( $this->mAllowLagged || $laggedReplicaMode ) { |
||
| 288 | $i = ArrayUtils::pickRandom( $currentLoads ); |
||
| 289 | } else { |
||
| 290 | $i = false; |
||
| 291 | if ( $this->mWaitForPos && $this->mWaitForPos->asOfTime() ) { |
||
| 292 | # ChronologyProtecter causes mWaitForPos to be set via sessions. |
||
| 293 | # This triggers doWait() after connect, so it's especially good to |
||
| 294 | # avoid lagged servers so as to avoid just blocking in that method. |
||
| 295 | $ago = microtime( true ) - $this->mWaitForPos->asOfTime(); |
||
| 296 | # Aim for <= 1 second of waiting (being too picky can backfire) |
||
| 297 | $i = $this->getRandomNonLagged( $currentLoads, $wiki, $ago + 1 ); |
||
| 298 | } |
||
| 299 | if ( $i === false ) { |
||
| 300 | # Any server with less lag than it's 'max lag' param is preferable |
||
| 301 | $i = $this->getRandomNonLagged( $currentLoads, $wiki ); |
||
| 302 | } |
||
| 303 | if ( $i === false && count( $currentLoads ) != 0 ) { |
||
| 304 | # All replica DBs lagged. Switch to read-only mode |
||
| 305 | wfDebugLog( 'replication', "All replica DBs lagged. Switch to read-only mode" ); |
||
| 306 | $i = ArrayUtils::pickRandom( $currentLoads ); |
||
| 307 | $laggedReplicaMode = true; |
||
| 308 | } |
||
| 309 | } |
||
| 310 | |||
| 311 | if ( $i === false ) { |
||
| 312 | # pickRandom() returned false |
||
| 313 | # This is permanent and means the configuration or the load monitor |
||
| 314 | # wants us to return false. |
||
| 315 | wfDebugLog( 'connect', __METHOD__ . ": pickRandom() returned false" ); |
||
| 316 | |||
| 317 | return false; |
||
| 318 | } |
||
| 319 | |||
| 320 | $serverName = $this->getServerName( $i ); |
||
| 321 | wfDebugLog( 'connect', __METHOD__ . ": Using reader #$i: $serverName..." ); |
||
| 322 | |||
| 323 | $conn = $this->openConnection( $i, $wiki ); |
||
| 324 | if ( !$conn ) { |
||
| 325 | wfDebugLog( 'connect', __METHOD__ . ": Failed connecting to $i/$wiki" ); |
||
| 326 | unset( $nonErrorLoads[$i] ); |
||
| 327 | unset( $currentLoads[$i] ); |
||
| 328 | $i = false; |
||
| 329 | continue; |
||
| 330 | } |
||
| 331 | |||
| 332 | // Decrement reference counter, we are finished with this connection. |
||
| 333 | // It will be incremented for the caller later. |
||
| 334 | if ( $wiki !== false ) { |
||
| 335 | $this->reuseConnection( $conn ); |
||
| 336 | } |
||
| 337 | |||
| 338 | # Return this server |
||
| 339 | break; |
||
| 340 | } |
||
| 341 | |||
| 342 | # If all servers were down, quit now |
||
| 343 | if ( !count( $nonErrorLoads ) ) { |
||
| 344 | wfDebugLog( 'connect', "All servers down" ); |
||
| 345 | } |
||
| 346 | |||
| 347 | if ( $i !== false ) { |
||
| 348 | # Replica DB connection successful. |
||
| 349 | # Wait for the session master pos for a short time. |
||
| 350 | if ( $this->mWaitForPos && $i > 0 ) { |
||
| 351 | $this->doWait( $i ); |
||
| 352 | } |
||
| 353 | if ( $this->mReadIndex <= 0 && $this->mLoads[$i] > 0 && $group === false ) { |
||
| 354 | $this->mReadIndex = $i; |
||
| 355 | # Record if the generic reader index is in "lagged replica DB" mode |
||
| 356 | if ( $laggedReplicaMode ) { |
||
| 357 | $this->laggedReplicaMode = true; |
||
| 358 | } |
||
| 359 | } |
||
| 360 | $serverName = $this->getServerName( $i ); |
||
| 361 | wfDebugLog( 'connect', __METHOD__ . |
||
| 362 | ": using server $serverName for group '$group'\n" ); |
||
| 363 | } |
||
| 364 | |||
| 365 | return $i; |
||
| 366 | } |
||
| 367 | |||
| 368 | /** |
||
| 369 | * Set the master wait position |
||
| 370 | * If a DB_REPLICA connection has been opened already, waits |
||
| 371 | * Otherwise sets a variable telling it to wait if such a connection is opened |
||
| 372 | * @param DBMasterPos $pos |
||
| 373 | */ |
||
| 374 | public function waitFor( $pos ) { |
||
| 375 | $this->mWaitForPos = $pos; |
||
| 376 | $i = $this->mReadIndex; |
||
| 377 | |||
| 378 | if ( $i > 0 ) { |
||
| 379 | if ( !$this->doWait( $i ) ) { |
||
| 380 | $this->laggedReplicaMode = true; |
||
| 381 | } |
||
| 382 | } |
||
| 383 | } |
||
| 384 | |||
| 385 | /** |
||
| 386 | * Set the master wait position and wait for a "generic" replica DB to catch up to it |
||
| 387 | * |
||
| 388 | * This can be used a faster proxy for waitForAll() |
||
| 389 | * |
||
| 390 | * @param DBMasterPos $pos |
||
| 391 | * @param int $timeout Max seconds to wait; default is mWaitTimeout |
||
| 392 | * @return bool Success (able to connect and no timeouts reached) |
||
| 393 | * @since 1.26 |
||
| 394 | */ |
||
| 395 | public function waitForOne( $pos, $timeout = null ) { |
||
| 396 | $this->mWaitForPos = $pos; |
||
| 397 | |||
| 398 | $i = $this->mReadIndex; |
||
| 399 | if ( $i <= 0 ) { |
||
| 400 | // Pick a generic replica DB if there isn't one yet |
||
| 401 | $readLoads = $this->mLoads; |
||
| 402 | unset( $readLoads[$this->getWriterIndex()] ); // replica DBs only |
||
| 403 | $readLoads = array_filter( $readLoads ); // with non-zero load |
||
| 404 | $i = ArrayUtils::pickRandom( $readLoads ); |
||
| 405 | } |
||
| 406 | |||
| 407 | View Code Duplication | if ( $i > 0 ) { |
|
| 408 | $ok = $this->doWait( $i, true, $timeout ); |
||
| 409 | } else { |
||
| 410 | $ok = true; // no applicable loads |
||
| 411 | } |
||
| 412 | |||
| 413 | return $ok; |
||
| 414 | } |
||
| 415 | |||
| 416 | /** |
||
| 417 | * Set the master wait position and wait for ALL replica DBs to catch up to it |
||
| 418 | * @param DBMasterPos $pos |
||
| 419 | * @param int $timeout Max seconds to wait; default is mWaitTimeout |
||
| 420 | * @return bool Success (able to connect and no timeouts reached) |
||
| 421 | */ |
||
| 422 | public function waitForAll( $pos, $timeout = null ) { |
||
| 423 | $this->mWaitForPos = $pos; |
||
| 424 | $serverCount = count( $this->mServers ); |
||
| 425 | |||
| 426 | $ok = true; |
||
| 427 | for ( $i = 1; $i < $serverCount; $i++ ) { |
||
| 428 | View Code Duplication | if ( $this->mLoads[$i] > 0 ) { |
|
| 429 | $ok = $this->doWait( $i, true, $timeout ) && $ok; |
||
| 430 | } |
||
| 431 | } |
||
| 432 | |||
| 433 | return $ok; |
||
| 434 | } |
||
| 435 | |||
| 436 | /** |
||
| 437 | * Get any open connection to a given server index, local or foreign |
||
| 438 | * Returns false if there is no connection open |
||
| 439 | * |
||
| 440 | * @param int $i Server index |
||
| 441 | * @return DatabaseBase|bool False on failure |
||
| 442 | */ |
||
| 443 | public function getAnyOpenConnection( $i ) { |
||
| 444 | foreach ( $this->mConns as $connsByServer ) { |
||
| 445 | if ( !empty( $connsByServer[$i] ) ) { |
||
| 446 | return reset( $connsByServer[$i] ); |
||
| 447 | } |
||
| 448 | } |
||
| 449 | |||
| 450 | return false; |
||
| 451 | } |
||
| 452 | |||
| 453 | /** |
||
| 454 | * Wait for a given replica DB to catch up to the master pos stored in $this |
||
| 455 | * @param int $index Server index |
||
| 456 | * @param bool $open Check the server even if a new connection has to be made |
||
| 457 | * @param int $timeout Max seconds to wait; default is mWaitTimeout |
||
| 458 | * @return bool |
||
| 459 | */ |
||
| 460 | protected function doWait( $index, $open = false, $timeout = null ) { |
||
| 461 | $close = false; // close the connection afterwards |
||
| 462 | |||
| 463 | // Check if we already know that the DB has reached this point |
||
| 464 | $server = $this->getServerName( $index ); |
||
| 465 | $key = $this->srvCache->makeGlobalKey( __CLASS__, 'last-known-pos', $server ); |
||
| 466 | /** @var DBMasterPos $knownReachedPos */ |
||
| 467 | $knownReachedPos = $this->srvCache->get( $key ); |
||
| 468 | if ( $knownReachedPos && $knownReachedPos->hasReached( $this->mWaitForPos ) ) { |
||
| 469 | wfDebugLog( 'replication', __METHOD__ . |
||
| 470 | ": replica DB $server known to be caught up (pos >= $knownReachedPos).\n" ); |
||
| 471 | return true; |
||
| 472 | } |
||
| 473 | |||
| 474 | // Find a connection to wait on, creating one if needed and allowed |
||
| 475 | $conn = $this->getAnyOpenConnection( $index ); |
||
| 476 | if ( !$conn ) { |
||
| 477 | if ( !$open ) { |
||
| 478 | wfDebugLog( 'replication', __METHOD__ . ": no connection open for $server\n" ); |
||
| 479 | |||
| 480 | return false; |
||
| 481 | } else { |
||
| 482 | $conn = $this->openConnection( $index, '' ); |
||
| 483 | if ( !$conn ) { |
||
| 484 | wfDebugLog( 'replication', __METHOD__ . ": failed to connect to $server\n" ); |
||
| 485 | |||
| 486 | return false; |
||
| 487 | } |
||
| 488 | // Avoid connection spam in waitForAll() when connections |
||
| 489 | // are made just for the sake of doing this lag check. |
||
| 490 | $close = true; |
||
| 491 | } |
||
| 492 | } |
||
| 493 | |||
| 494 | wfDebugLog( 'replication', __METHOD__ . ": Waiting for replica DB $server to catch up...\n" ); |
||
| 495 | $timeout = $timeout ?: $this->mWaitTimeout; |
||
| 496 | $result = $conn->masterPosWait( $this->mWaitForPos, $timeout ); |
||
| 497 | |||
| 498 | if ( $result == -1 || is_null( $result ) ) { |
||
| 499 | // Timed out waiting for replica DB, use master instead |
||
| 500 | $msg = __METHOD__ . ": Timed out waiting on $server pos {$this->mWaitForPos}"; |
||
| 501 | wfDebugLog( 'replication', "$msg\n" ); |
||
| 502 | wfDebugLog( 'DBPerformance', "$msg:\n" . wfBacktrace( true ) ); |
||
| 503 | $ok = false; |
||
| 504 | } else { |
||
| 505 | wfDebugLog( 'replication', __METHOD__ . ": Done\n" ); |
||
| 506 | $ok = true; |
||
| 507 | // Remember that the DB reached this point |
||
| 508 | $this->srvCache->set( $key, $this->mWaitForPos, BagOStuff::TTL_DAY ); |
||
| 509 | } |
||
| 510 | |||
| 511 | if ( $close ) { |
||
| 512 | $this->closeConnection( $conn ); |
||
| 513 | } |
||
| 514 | |||
| 515 | return $ok; |
||
| 516 | } |
||
| 517 | |||
| 518 | /** |
||
| 519 | * Get a connection by index |
||
| 520 | * This is the main entry point for this class. |
||
| 521 | * |
||
| 522 | * @param int $i Server index |
||
| 523 | * @param array|string|bool $groups Query group(s), or false for the generic reader |
||
| 524 | * @param string|bool $wiki Wiki ID, or false for the current wiki |
||
| 525 | * |
||
| 526 | * @throws MWException |
||
| 527 | * @return DatabaseBase |
||
| 528 | */ |
||
| 529 | public function getConnection( $i, $groups = [], $wiki = false ) { |
||
| 530 | if ( $i === null || $i === false ) { |
||
| 531 | throw new MWException( 'Attempt to call ' . __METHOD__ . |
||
| 532 | ' with invalid server index' ); |
||
| 533 | } |
||
| 534 | |||
| 535 | if ( $wiki === wfWikiID() ) { |
||
| 536 | $wiki = false; |
||
| 537 | } |
||
| 538 | |||
| 539 | $groups = ( $groups === false || $groups === [] ) |
||
| 540 | ? [ false ] // check one "group": the generic pool |
||
| 541 | : (array)$groups; |
||
| 542 | |||
| 543 | $masterOnly = ( $i == DB_MASTER || $i == $this->getWriterIndex() ); |
||
| 544 | $oldConnsOpened = $this->connsOpened; // connections open now |
||
| 545 | |||
| 546 | if ( $i == DB_MASTER ) { |
||
| 547 | $i = $this->getWriterIndex(); |
||
| 548 | } else { |
||
| 549 | # Try to find an available server in any the query groups (in order) |
||
| 550 | foreach ( $groups as $group ) { |
||
| 551 | $groupIndex = $this->getReaderIndex( $group, $wiki ); |
||
| 552 | if ( $groupIndex !== false ) { |
||
| 553 | $i = $groupIndex; |
||
| 554 | break; |
||
| 555 | } |
||
| 556 | } |
||
| 557 | } |
||
| 558 | |||
| 559 | # Operation-based index |
||
| 560 | if ( $i == DB_REPLICA ) { |
||
| 561 | $this->mLastError = 'Unknown error'; // reset error string |
||
| 562 | # Try the general server pool if $groups are unavailable. |
||
| 563 | $i = in_array( false, $groups, true ) |
||
| 564 | ? false // don't bother with this if that is what was tried above |
||
| 565 | : $this->getReaderIndex( false, $wiki ); |
||
| 566 | # Couldn't find a working server in getReaderIndex()? |
||
| 567 | if ( $i === false ) { |
||
| 568 | $this->mLastError = 'No working replica DB server: ' . $this->mLastError; |
||
| 569 | |||
| 570 | return $this->reportConnectionError(); |
||
| 571 | } |
||
| 572 | } |
||
| 573 | |||
| 574 | # Now we have an explicit index into the servers array |
||
| 575 | $conn = $this->openConnection( $i, $wiki ); |
||
| 576 | if ( !$conn ) { |
||
| 577 | return $this->reportConnectionError(); |
||
| 578 | } |
||
| 579 | |||
| 580 | # Profile any new connections that happen |
||
| 581 | if ( $this->connsOpened > $oldConnsOpened ) { |
||
| 582 | $host = $conn->getServer(); |
||
| 583 | $dbname = $conn->getDBname(); |
||
| 584 | $trxProf = Profiler::instance()->getTransactionProfiler(); |
||
| 585 | $trxProf->recordConnection( $host, $dbname, $masterOnly ); |
||
| 586 | } |
||
| 587 | |||
| 588 | if ( $masterOnly ) { |
||
| 589 | # Make master-requested DB handles inherit any read-only mode setting |
||
| 590 | $conn->setLBInfo( 'readOnlyReason', $this->getReadOnlyReason( $wiki, $conn ) ); |
||
| 591 | } |
||
| 592 | |||
| 593 | return $conn; |
||
| 594 | } |
||
| 595 | |||
| 596 | /** |
||
| 597 | * Mark a foreign connection as being available for reuse under a different |
||
| 598 | * DB name or prefix. This mechanism is reference-counted, and must be called |
||
| 599 | * the same number of times as getConnection() to work. |
||
| 600 | * |
||
| 601 | * @param DatabaseBase $conn |
||
| 602 | * @throws MWException |
||
| 603 | */ |
||
| 604 | public function reuseConnection( $conn ) { |
||
| 605 | $serverIndex = $conn->getLBInfo( 'serverIndex' ); |
||
| 606 | $refCount = $conn->getLBInfo( 'foreignPoolRefCount' ); |
||
| 607 | if ( $serverIndex === null || $refCount === null ) { |
||
| 608 | /** |
||
| 609 | * This can happen in code like: |
||
| 610 | * foreach ( $dbs as $db ) { |
||
| 611 | * $conn = $lb->getConnection( DB_REPLICA, [], $db ); |
||
| 612 | * ... |
||
| 613 | * $lb->reuseConnection( $conn ); |
||
| 614 | * } |
||
| 615 | * When a connection to the local DB is opened in this way, reuseConnection() |
||
| 616 | * should be ignored |
||
| 617 | */ |
||
| 618 | return; |
||
| 619 | } |
||
| 620 | |||
| 621 | $dbName = $conn->getDBname(); |
||
| 622 | $prefix = $conn->tablePrefix(); |
||
| 623 | if ( strval( $prefix ) !== '' ) { |
||
| 624 | $wiki = "$dbName-$prefix"; |
||
| 625 | } else { |
||
| 626 | $wiki = $dbName; |
||
| 627 | } |
||
| 628 | if ( $this->mConns['foreignUsed'][$serverIndex][$wiki] !== $conn ) { |
||
| 629 | throw new MWException( __METHOD__ . ": connection not found, has " . |
||
| 630 | "the connection been freed already?" ); |
||
| 631 | } |
||
| 632 | $conn->setLBInfo( 'foreignPoolRefCount', --$refCount ); |
||
| 633 | if ( $refCount <= 0 ) { |
||
| 634 | $this->mConns['foreignFree'][$serverIndex][$wiki] = $conn; |
||
| 635 | unset( $this->mConns['foreignUsed'][$serverIndex][$wiki] ); |
||
| 636 | wfDebug( __METHOD__ . ": freed connection $serverIndex/$wiki\n" ); |
||
| 637 | } else { |
||
| 638 | wfDebug( __METHOD__ . ": reference count for $serverIndex/$wiki reduced to $refCount\n" ); |
||
| 639 | } |
||
| 640 | } |
||
| 641 | |||
| 642 | /** |
||
| 643 | * Get a database connection handle reference |
||
| 644 | * |
||
| 645 | * The handle's methods wrap simply wrap those of a DatabaseBase handle |
||
| 646 | * |
||
| 647 | * @see LoadBalancer::getConnection() for parameter information |
||
| 648 | * |
||
| 649 | * @param int $db |
||
| 650 | * @param array|string|bool $groups Query group(s), or false for the generic reader |
||
| 651 | * @param string|bool $wiki Wiki ID, or false for the current wiki |
||
| 652 | * @return DBConnRef |
||
| 653 | */ |
||
| 654 | public function getConnectionRef( $db, $groups = [], $wiki = false ) { |
||
| 655 | return new DBConnRef( $this, $this->getConnection( $db, $groups, $wiki ) ); |
||
| 656 | } |
||
| 657 | |||
| 658 | /** |
||
| 659 | * Get a database connection handle reference without connecting yet |
||
| 660 | * |
||
| 661 | * The handle's methods wrap simply wrap those of a DatabaseBase handle |
||
| 662 | * |
||
| 663 | * @see LoadBalancer::getConnection() for parameter information |
||
| 664 | * |
||
| 665 | * @param int $db |
||
| 666 | * @param array|string|bool $groups Query group(s), or false for the generic reader |
||
| 667 | * @param string|bool $wiki Wiki ID, or false for the current wiki |
||
| 668 | * @return DBConnRef |
||
| 669 | */ |
||
| 670 | public function getLazyConnectionRef( $db, $groups = [], $wiki = false ) { |
||
| 671 | return new DBConnRef( $this, [ $db, $groups, $wiki ] ); |
||
| 672 | } |
||
| 673 | |||
| 674 | /** |
||
| 675 | * Open a connection to the server given by the specified index |
||
| 676 | * Index must be an actual index into the array. |
||
| 677 | * If the server is already open, returns it. |
||
| 678 | * |
||
| 679 | * On error, returns false, and the connection which caused the |
||
| 680 | * error will be available via $this->mErrorConnection. |
||
| 681 | * |
||
| 682 | * @note If disable() was called on this LoadBalancer, this method will throw a DBAccessError. |
||
| 683 | * |
||
| 684 | * @param int $i Server index |
||
| 685 | * @param string|bool $wiki Wiki ID, or false for the current wiki |
||
| 686 | * @return DatabaseBase|bool Returns false on errors |
||
| 687 | */ |
||
| 688 | public function openConnection( $i, $wiki = false ) { |
||
| 689 | if ( $wiki !== false ) { |
||
| 690 | $conn = $this->openForeignConnection( $i, $wiki ); |
||
| 691 | } elseif ( isset( $this->mConns['local'][$i][0] ) ) { |
||
| 692 | $conn = $this->mConns['local'][$i][0]; |
||
| 693 | } else { |
||
| 694 | $server = $this->mServers[$i]; |
||
| 695 | $server['serverIndex'] = $i; |
||
| 696 | $conn = $this->reallyOpenConnection( $server, false ); |
||
| 697 | $serverName = $this->getServerName( $i ); |
||
| 698 | if ( $conn->isOpen() ) { |
||
| 699 | wfDebugLog( 'connect', "Connected to database $i at $serverName\n" ); |
||
| 700 | $this->mConns['local'][$i][0] = $conn; |
||
| 701 | } else { |
||
| 702 | wfDebugLog( 'connect', "Failed to connect to database $i at $serverName\n" ); |
||
| 703 | $this->mErrorConnection = $conn; |
||
| 704 | $conn = false; |
||
| 705 | } |
||
| 706 | } |
||
| 707 | |||
| 708 | if ( $conn && !$conn->isOpen() ) { |
||
| 709 | // Connection was made but later unrecoverably lost for some reason. |
||
| 710 | // Do not return a handle that will just throw exceptions on use, |
||
| 711 | // but let the calling code (e.g. getReaderIndex) try another server. |
||
| 712 | // See DatabaseMyslBase::ping() for how this can happen. |
||
| 713 | $this->mErrorConnection = $conn; |
||
| 714 | $conn = false; |
||
| 715 | } |
||
| 716 | |||
| 717 | return $conn; |
||
| 718 | } |
||
| 719 | |||
| 720 | /** |
||
| 721 | * Open a connection to a foreign DB, or return one if it is already open. |
||
| 722 | * |
||
| 723 | * Increments a reference count on the returned connection which locks the |
||
| 724 | * connection to the requested wiki. This reference count can be |
||
| 725 | * decremented by calling reuseConnection(). |
||
| 726 | * |
||
| 727 | * If a connection is open to the appropriate server already, but with the wrong |
||
| 728 | * database, it will be switched to the right database and returned, as long as |
||
| 729 | * it has been freed first with reuseConnection(). |
||
| 730 | * |
||
| 731 | * On error, returns false, and the connection which caused the |
||
| 732 | * error will be available via $this->mErrorConnection. |
||
| 733 | * |
||
| 734 | * @note If disable() was called on this LoadBalancer, this method will throw a DBAccessError. |
||
| 735 | * |
||
| 736 | * @param int $i Server index |
||
| 737 | * @param string $wiki Wiki ID to open |
||
| 738 | * @return DatabaseBase |
||
| 739 | */ |
||
| 740 | private function openForeignConnection( $i, $wiki ) { |
||
| 741 | list( $dbName, $prefix ) = wfSplitWikiID( $wiki ); |
||
| 742 | if ( isset( $this->mConns['foreignUsed'][$i][$wiki] ) ) { |
||
| 743 | // Reuse an already-used connection |
||
| 744 | $conn = $this->mConns['foreignUsed'][$i][$wiki]; |
||
| 745 | wfDebug( __METHOD__ . ": reusing connection $i/$wiki\n" ); |
||
| 746 | } elseif ( isset( $this->mConns['foreignFree'][$i][$wiki] ) ) { |
||
| 747 | // Reuse a free connection for the same wiki |
||
| 748 | $conn = $this->mConns['foreignFree'][$i][$wiki]; |
||
| 749 | unset( $this->mConns['foreignFree'][$i][$wiki] ); |
||
| 750 | $this->mConns['foreignUsed'][$i][$wiki] = $conn; |
||
| 751 | wfDebug( __METHOD__ . ": reusing free connection $i/$wiki\n" ); |
||
| 752 | } elseif ( !empty( $this->mConns['foreignFree'][$i] ) ) { |
||
| 753 | // Reuse a connection from another wiki |
||
| 754 | $conn = reset( $this->mConns['foreignFree'][$i] ); |
||
| 755 | $oldWiki = key( $this->mConns['foreignFree'][$i] ); |
||
| 756 | |||
| 757 | // The empty string as a DB name means "don't care". |
||
| 758 | // DatabaseMysqlBase::open() already handle this on connection. |
||
| 759 | if ( $dbName !== '' && !$conn->selectDB( $dbName ) ) { |
||
| 760 | $this->mLastError = "Error selecting database $dbName on server " . |
||
| 761 | $conn->getServer() . " from client host " . wfHostname() . "\n"; |
||
| 762 | $this->mErrorConnection = $conn; |
||
| 763 | $conn = false; |
||
| 764 | } else { |
||
| 765 | $conn->tablePrefix( $prefix ); |
||
| 766 | unset( $this->mConns['foreignFree'][$i][$oldWiki] ); |
||
| 767 | $this->mConns['foreignUsed'][$i][$wiki] = $conn; |
||
| 768 | wfDebug( __METHOD__ . ": reusing free connection from $oldWiki for $wiki\n" ); |
||
| 769 | } |
||
| 770 | } else { |
||
| 771 | // Open a new connection |
||
| 772 | $server = $this->mServers[$i]; |
||
| 773 | $server['serverIndex'] = $i; |
||
| 774 | $server['foreignPoolRefCount'] = 0; |
||
| 775 | $server['foreign'] = true; |
||
| 776 | $conn = $this->reallyOpenConnection( $server, $dbName ); |
||
| 777 | if ( !$conn->isOpen() ) { |
||
| 778 | wfDebug( __METHOD__ . ": error opening connection for $i/$wiki\n" ); |
||
| 779 | $this->mErrorConnection = $conn; |
||
| 780 | $conn = false; |
||
| 781 | } else { |
||
| 782 | $conn->tablePrefix( $prefix ); |
||
| 783 | $this->mConns['foreignUsed'][$i][$wiki] = $conn; |
||
| 784 | wfDebug( __METHOD__ . ": opened new connection for $i/$wiki\n" ); |
||
| 785 | } |
||
| 786 | } |
||
| 787 | |||
| 788 | // Increment reference count |
||
| 789 | if ( $conn ) { |
||
| 790 | $refCount = $conn->getLBInfo( 'foreignPoolRefCount' ); |
||
| 791 | $conn->setLBInfo( 'foreignPoolRefCount', $refCount + 1 ); |
||
| 792 | } |
||
| 793 | |||
| 794 | return $conn; |
||
| 795 | } |
||
| 796 | |||
| 797 | /** |
||
| 798 | * Test if the specified index represents an open connection |
||
| 799 | * |
||
| 800 | * @param int $index Server index |
||
| 801 | * @access private |
||
| 802 | * @return bool |
||
| 803 | */ |
||
| 804 | private function isOpen( $index ) { |
||
| 805 | if ( !is_integer( $index ) ) { |
||
| 806 | return false; |
||
| 807 | } |
||
| 808 | |||
| 809 | return (bool)$this->getAnyOpenConnection( $index ); |
||
| 810 | } |
||
| 811 | |||
| 812 | /** |
||
| 813 | * Really opens a connection. Uncached. |
||
| 814 | * Returns a Database object whether or not the connection was successful. |
||
| 815 | * @access private |
||
| 816 | * |
||
| 817 | * @param array $server |
||
| 818 | * @param bool $dbNameOverride |
||
| 819 | * @throws MWException |
||
| 820 | * @return DatabaseBase |
||
| 821 | */ |
||
| 822 | protected function reallyOpenConnection( $server, $dbNameOverride = false ) { |
||
| 823 | if ( $this->disabled ) { |
||
| 824 | throw new DBAccessError(); |
||
| 825 | } |
||
| 826 | |||
| 827 | if ( !is_array( $server ) ) { |
||
| 828 | throw new MWException( 'You must update your load-balancing configuration. ' . |
||
| 829 | 'See DefaultSettings.php entry for $wgDBservers.' ); |
||
| 830 | } |
||
| 831 | |||
| 832 | if ( $dbNameOverride !== false ) { |
||
| 833 | $server['dbname'] = $dbNameOverride; |
||
| 834 | } |
||
| 835 | |||
| 836 | // Let the handle know what the cluster master is (e.g. "db1052") |
||
| 837 | $masterName = $this->getServerName( $this->getWriterIndex() ); |
||
| 838 | $server['clusterMasterHost'] = $masterName; |
||
| 839 | |||
| 840 | // Log when many connection are made on requests |
||
| 841 | if ( ++$this->connsOpened >= self::CONN_HELD_WARN_THRESHOLD ) { |
||
| 842 | wfDebugLog( 'DBPerformance', __METHOD__ . ": " . |
||
| 843 | "{$this->connsOpened}+ connections made (master=$masterName)\n" . |
||
| 844 | wfBacktrace( true ) ); |
||
| 845 | } |
||
| 846 | |||
| 847 | # Create object |
||
| 848 | try { |
||
| 849 | $db = DatabaseBase::factory( $server['type'], $server ); |
||
| 850 | } catch ( DBConnectionError $e ) { |
||
| 851 | // FIXME: This is probably the ugliest thing I have ever done to |
||
| 852 | // PHP. I'm half-expecting it to segfault, just out of disgust. -- TS |
||
| 853 | $db = $e->db; |
||
| 854 | } |
||
| 855 | |||
| 856 | $db->setLBInfo( $server ); |
||
| 857 | $db->setLazyMasterHandle( |
||
| 858 | $this->getLazyConnectionRef( DB_MASTER, [], $db->getWikiID() ) |
||
| 859 | ); |
||
| 860 | $db->setTransactionProfiler( $this->trxProfiler ); |
||
| 861 | |||
| 862 | if ( $server['serverIndex'] === $this->getWriterIndex() ) { |
||
| 863 | if ( $this->trxRoundId !== false ) { |
||
| 864 | $this->applyTransactionRoundFlags( $db ); |
||
| 865 | } |
||
| 866 | foreach ( $this->trxRecurringCallbacks as $name => $callback ) { |
||
| 867 | $db->setTransactionListener( $name, $callback ); |
||
| 868 | } |
||
| 869 | } |
||
| 870 | |||
| 871 | return $db; |
||
| 872 | } |
||
| 873 | |||
| 874 | /** |
||
| 875 | * @throws DBConnectionError |
||
| 876 | * @return bool |
||
| 877 | */ |
||
| 878 | private function reportConnectionError() { |
||
| 907 | |||
| 908 | /** |
||
| 909 | * @return int |
||
| 910 | * @since 1.26 |
||
| 911 | */ |
||
| 912 | public function getWriterIndex() { |
||
| 915 | |||
| 916 | /** |
||
| 917 | * Returns true if the specified index is a valid server index |
||
| 918 | * |
||
| 919 | * @param string $i |
||
| 920 | * @return bool |
||
| 921 | */ |
||
| 922 | public function haveIndex( $i ) { |
||
| 925 | |||
| 926 | /** |
||
| 927 | * Returns true if the specified index is valid and has non-zero load |
||
| 928 | * |
||
| 929 | * @param string $i |
||
| 930 | * @return bool |
||
| 931 | */ |
||
| 932 | public function isNonZeroLoad( $i ) { |
||
| 935 | |||
| 936 | /** |
||
| 937 | * Get the number of defined servers (not the number of open connections) |
||
| 938 | * |
||
| 939 | * @return int |
||
| 940 | */ |
||
| 941 | public function getServerCount() { |
||
| 944 | |||
| 945 | /** |
||
| 946 | * Get the host name or IP address of the server with the specified index |
||
| 947 | * Prefer a readable name if available. |
||
| 948 | * @param string $i |
||
| 949 | * @return string |
||
| 950 | */ |
||
| 951 | public function getServerName( $i ) { |
||
| 952 | if ( isset( $this->mServers[$i]['hostName'] ) ) { |
||
| 953 | $name = $this->mServers[$i]['hostName']; |
||
| 954 | } elseif ( isset( $this->mServers[$i]['host'] ) ) { |
||
| 955 | $name = $this->mServers[$i]['host']; |
||
| 956 | } else { |
||
| 957 | $name = ''; |
||
| 958 | } |
||
| 959 | |||
| 960 | return ( $name != '' ) ? $name : 'localhost'; |
||
| 961 | } |
||
| 962 | |||
| 963 | /** |
||
| 964 | * Return the server info structure for a given index, or false if the index is invalid. |
||
| 965 | * @param int $i |
||
| 966 | * @return array|bool |
||
| 967 | */ |
||
| 968 | public function getServerInfo( $i ) { |
||
| 975 | |||
| 976 | /** |
||
| 977 | * Sets the server info structure for the given index. Entry at index $i |
||
| 978 | * is created if it doesn't exist |
||
| 979 | * @param int $i |
||
| 980 | * @param array $serverInfo |
||
| 981 | */ |
||
| 982 | public function setServerInfo( $i, array $serverInfo ) { |
||
| 985 | |||
| 986 | /** |
||
| 987 | * Get the current master position for chronology control purposes |
||
| 988 | * @return DBMasterPos|bool Returns false if not applicable |
||
| 989 | */ |
||
| 990 | public function getMasterPos() { |
||
| 1008 | |||
| 1009 | /** |
||
| 1010 | * Disable this load balancer. All connections are closed, and any attempt to |
||
| 1011 | * open a new connection will result in a DBAccessError. |
||
| 1012 | * |
||
| 1013 | * @since 1.27 |
||
| 1014 | */ |
||
| 1015 | public function disable() { |
||
| 1019 | |||
| 1020 | /** |
||
| 1021 | * Close all open connections |
||
| 1022 | */ |
||
| 1023 | public function closeAll() { |
||
| 1035 | |||
| 1036 | /** |
||
| 1037 | * Close a connection |
||
| 1038 | * |
||
| 1039 | * Using this function makes sure the LoadBalancer knows the connection is closed. |
||
| 1040 | * If you use $conn->close() directly, the load balancer won't update its state. |
||
| 1041 | * |
||
| 1042 | * @param DatabaseBase $conn |
||
| 1043 | */ |
||
| 1044 | public function closeConnection( DatabaseBase $conn ) { |
||
| 1045 | $serverIndex = $conn->getLBInfo( 'serverIndex' ); // second index level of mConns |
||
| 1046 | foreach ( $this->mConns as $type => $connsByServer ) { |
||
| 1047 | if ( !isset( $connsByServer[$serverIndex] ) ) { |
||
| 1048 | continue; |
||
| 1049 | } |
||
| 1050 | |||
| 1051 | foreach ( $connsByServer[$serverIndex] as $i => $trackedConn ) { |
||
| 1052 | if ( $conn === $trackedConn ) { |
||
| 1053 | unset( $this->mConns[$type][$serverIndex][$i] ); |
||
| 1062 | |||
| 1063 | /** |
||
| 1064 | * Commit transactions on all open connections |
||
| 1065 | * @param string $fname Caller name |
||
| 1066 | * @throws DBExpectedError |
||
| 1067 | */ |
||
| 1068 | public function commitAll( $fname = __METHOD__ ) { |
||
| 1094 | |||
| 1095 | /** |
||
| 1096 | * Perform all pre-commit callbacks that remain part of the atomic transactions |
||
| 1097 | * and disable any post-commit callbacks until runMasterPostTrxCallbacks() |
||
| 1098 | * @since 1.28 |
||
| 1099 | */ |
||
| 1100 | public function finalizeMasterChanges() { |
||
| 1109 | |||
| 1110 | /** |
||
| 1111 | * Perform all pre-commit checks for things like replication safety |
||
| 1112 | * @param array $options Includes: |
||
| 1113 | * - maxWriteDuration : max write query duration time in seconds |
||
| 1114 | * @throws DBTransactionError |
||
| 1115 | * @since 1.28 |
||
| 1116 | */ |
||
| 1117 | public function approveMasterChanges( array $options ) { |
||
| 1148 | |||
| 1149 | /** |
||
| 1150 | * Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set) |
||
| 1151 | * |
||
| 1152 | * The DBO_TRX setting will be reverted to the default in each of these methods: |
||
| 1153 | * - commitMasterChanges() |
||
| 1154 | * - rollbackMasterChanges() |
||
| 1155 | * - commitAll() |
||
| 1156 | * This allows for custom transaction rounds from any outer transaction scope. |
||
| 1157 | * |
||
| 1158 | * @param string $fname |
||
| 1159 | * @throws DBExpectedError |
||
| 1160 | * @since 1.28 |
||
| 1161 | */ |
||
| 1162 | public function beginMasterChanges( $fname = __METHOD__ ) { |
||
| 1193 | |||
| 1194 | /** |
||
| 1195 | * Issue COMMIT on all master connections where writes where done |
||
| 1196 | * @param string $fname Caller name |
||
| 1197 | * @throws DBExpectedError |
||
| 1198 | */ |
||
| 1199 | public function commitMasterChanges( $fname = __METHOD__ ) { |
||
| 1229 | |||
| 1230 | /** |
||
| 1231 | * Issue all pending post-COMMIT/ROLLBACK callbacks |
||
| 1232 | * @param integer $type IDatabase::TRIGGER_* constant |
||
| 1233 | * @return Exception|null The first exception or null if there were none |
||
| 1234 | * @since 1.28 |
||
| 1235 | */ |
||
| 1236 | public function runMasterPostTrxCallbacks( $type ) { |
||
| 1268 | |||
| 1269 | /** |
||
| 1270 | * Issue ROLLBACK only on master, only if queries were done on connection |
||
| 1271 | * @param string $fname Caller name |
||
| 1272 | * @throws DBExpectedError |
||
| 1273 | * @since 1.23 |
||
| 1274 | */ |
||
| 1275 | public function rollbackMasterChanges( $fname = __METHOD__ ) { |
||
| 1289 | |||
| 1290 | /** |
||
| 1291 | * Suppress all pending post-COMMIT/ROLLBACK callbacks |
||
| 1292 | * @return Exception|null The first exception or null if there were none |
||
| 1293 | * @since 1.28 |
||
| 1294 | */ |
||
| 1295 | public function suppressTransactionEndCallbacks() { |
||
| 1300 | |||
| 1301 | /** |
||
| 1302 | * @param DatabaseBase $conn |
||
| 1303 | */ |
||
| 1304 | private function applyTransactionRoundFlags( DatabaseBase $conn ) { |
||
| 1314 | |||
| 1315 | /** |
||
| 1316 | * @param DatabaseBase $conn |
||
| 1317 | */ |
||
| 1318 | private function undoTransactionRoundFlags( DatabaseBase $conn ) { |
||
| 1323 | |||
| 1324 | /** |
||
| 1325 | * Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot |
||
| 1326 | * |
||
| 1327 | * @param string $fname Caller name |
||
| 1328 | * @since 1.28 |
||
| 1329 | */ |
||
| 1330 | public function flushReplicaSnapshots( $fname = __METHOD__ ) { |
||
| 1335 | |||
| 1336 | /** |
||
| 1337 | * @return bool Whether a master connection is already open |
||
| 1338 | * @since 1.24 |
||
| 1339 | */ |
||
| 1340 | public function hasMasterConnection() { |
||
| 1343 | |||
| 1344 | /** |
||
| 1345 | * Determine if there are pending changes in a transaction by this thread |
||
| 1346 | * @since 1.23 |
||
| 1347 | * @return bool |
||
| 1348 | */ |
||
| 1349 | public function hasMasterChanges() { |
||
| 1357 | |||
| 1358 | /** |
||
| 1359 | * Get the timestamp of the latest write query done by this thread |
||
| 1360 | * @since 1.25 |
||
| 1361 | * @return float|bool UNIX timestamp or false |
||
| 1362 | */ |
||
| 1363 | public function lastMasterChangeTimestamp() { |
||
| 1371 | |||
| 1372 | /** |
||
| 1373 | * Check if this load balancer object had any recent or still |
||
| 1374 | * pending writes issued against it by this PHP thread |
||
| 1375 | * |
||
| 1376 | * @param float $age How many seconds ago is "recent" [defaults to mWaitTimeout] |
||
| 1377 | * @return bool |
||
| 1378 | * @since 1.25 |
||
| 1379 | */ |
||
| 1380 | public function hasOrMadeRecentMasterChanges( $age = null ) { |
||
| 1386 | |||
| 1387 | /** |
||
| 1388 | * Get the list of callers that have pending master changes |
||
| 1389 | * |
||
| 1390 | * @return string[] List of method names |
||
| 1391 | * @since 1.27 |
||
| 1392 | */ |
||
| 1393 | public function pendingMasterChangeCallers() { |
||
| 1401 | |||
| 1402 | /** |
||
| 1403 | * @note This method will trigger a DB connection if not yet done |
||
| 1404 | * @param string|bool $wiki Wiki ID, or false for the current wiki |
||
| 1405 | * @return bool Whether the generic connection for reads is highly "lagged" |
||
| 1406 | */ |
||
| 1407 | public function getLaggedReplicaMode( $wiki = false ) { |
||
| 1423 | |||
| 1424 | /** |
||
| 1425 | * @param bool $wiki |
||
| 1426 | * @return bool |
||
| 1427 | * @deprecated 1.28; use getLaggedReplicaMode() |
||
| 1428 | */ |
||
| 1429 | public function getLaggedSlaveMode( $wiki = false ) { |
||
| 1432 | |||
| 1433 | /** |
||
| 1434 | * @note This method will never cause a new DB connection |
||
| 1435 | * @return bool Whether any generic connection used for reads was highly "lagged" |
||
| 1436 | * @since 1.28 |
||
| 1437 | */ |
||
| 1438 | public function laggedReplicaUsed() { |
||
| 1441 | |||
| 1442 | /** |
||
| 1443 | * @return bool |
||
| 1444 | * @since 1.27 |
||
| 1445 | * @deprecated Since 1.28; use laggedReplicaUsed() |
||
| 1446 | */ |
||
| 1447 | public function laggedSlaveUsed() { |
||
| 1450 | |||
| 1451 | /** |
||
| 1452 | * @note This method may trigger a DB connection if not yet done |
||
| 1453 | * @param string|bool $wiki Wiki ID, or false for the current wiki |
||
| 1454 | * @param DatabaseBase|null DB master connection; used to avoid loops [optional] |
||
| 1455 | * @return string|bool Reason the master is read-only or false if it is not |
||
| 1456 | * @since 1.27 |
||
| 1457 | */ |
||
| 1458 | public function getReadOnlyReason( $wiki = false, DatabaseBase $conn = null ) { |
||
| 1475 | |||
| 1476 | /** |
||
| 1477 | * @param string $wiki Wiki ID, or false for the current wiki |
||
| 1478 | * @param DatabaseBase|null DB master connectionl used to avoid loops [optional] |
||
| 1479 | * @return bool |
||
| 1480 | */ |
||
| 1481 | private function masterRunningReadOnly( $wiki, DatabaseBase $conn = null ) { |
||
| 1502 | |||
| 1503 | /** |
||
| 1504 | * Disables/enables lag checks |
||
| 1505 | * @param null|bool $mode |
||
| 1506 | * @return bool |
||
| 1507 | */ |
||
| 1508 | public function allowLagged( $mode = null ) { |
||
| 1516 | |||
| 1517 | /** |
||
| 1518 | * @return bool |
||
| 1519 | */ |
||
| 1520 | public function pingAll() { |
||
| 1530 | |||
| 1531 | /** |
||
| 1532 | * Call a function with each open connection object |
||
| 1533 | * @param callable $callback |
||
| 1534 | * @param array $params |
||
| 1535 | */ |
||
| 1536 | View Code Duplication | public function forEachOpenConnection( $callback, array $params = [] ) { |
|
| 1546 | |||
| 1547 | /** |
||
| 1548 | * Call a function with each open connection object to a master |
||
| 1549 | * @param callable $callback |
||
| 1550 | * @param array $params |
||
| 1551 | * @since 1.28 |
||
| 1552 | */ |
||
| 1553 | public function forEachOpenMasterConnection( $callback, array $params = [] ) { |
||
| 1565 | |||
| 1566 | /** |
||
| 1567 | * Call a function with each open replica DB connection object |
||
| 1568 | * @param callable $callback |
||
| 1569 | * @param array $params |
||
| 1570 | * @since 1.28 |
||
| 1571 | */ |
||
| 1572 | View Code Duplication | public function forEachOpenReplicaConnection( $callback, array $params = [] ) { |
|
| 1585 | |||
| 1586 | /** |
||
| 1587 | * Get the hostname and lag time of the most-lagged replica DB |
||
| 1588 | * |
||
| 1589 | * This is useful for maintenance scripts that need to throttle their updates. |
||
| 1590 | * May attempt to open connections to replica DBs on the default DB. If there is |
||
| 1591 | * no lag, the maximum lag will be reported as -1. |
||
| 1592 | * |
||
| 1593 | * @param bool|string $wiki Wiki ID, or false for the default database |
||
| 1594 | * @return array ( host, max lag, index of max lagged host ) |
||
| 1595 | */ |
||
| 1596 | public function getMaxLag( $wiki = false ) { |
||
| 1616 | |||
| 1617 | /** |
||
| 1618 | * Get an estimate of replication lag (in seconds) for each server |
||
| 1619 | * |
||
| 1620 | * Results are cached for a short time in memcached/process cache |
||
| 1621 | * |
||
| 1622 | * Values may be "false" if replication is too broken to estimate |
||
| 1623 | * |
||
| 1624 | * @param string|bool $wiki |
||
| 1625 | * @return int[] Map of (server index => float|int|bool) |
||
| 1626 | */ |
||
| 1627 | public function getLagTimes( $wiki = false ) { |
||
| 1635 | |||
| 1636 | /** |
||
| 1637 | * Get the lag in seconds for a given connection, or zero if this load |
||
| 1638 | * balancer does not have replication enabled. |
||
| 1639 | * |
||
| 1640 | * This should be used in preference to Database::getLag() in cases where |
||
| 1641 | * replication may not be in use, since there is no way to determine if |
||
| 1642 | * replication is in use at the connection level without running |
||
| 1643 | * potentially restricted queries such as SHOW SLAVE STATUS. Using this |
||
| 1644 | * function instead of Database::getLag() avoids a fatal error in this |
||
| 1645 | * case on many installations. |
||
| 1646 | * |
||
| 1647 | * @param IDatabase $conn |
||
| 1648 | * @return int|bool Returns false on error |
||
| 1649 | */ |
||
| 1650 | public function safeGetLag( IDatabase $conn ) { |
||
| 1657 | |||
| 1658 | /** |
||
| 1659 | * Wait for a replica DB to reach a specified master position |
||
| 1660 | * |
||
| 1661 | * This will connect to the master to get an accurate position if $pos is not given |
||
| 1662 | * |
||
| 1663 | * @param IDatabase $conn Replica DB |
||
| 1664 | * @param DBMasterPos|bool $pos Master position; default: current position |
||
| 1665 | * @param integer $timeout Timeout in seconds |
||
| 1666 | * @return bool Success |
||
| 1667 | * @since 1.27 |
||
| 1668 | */ |
||
| 1669 | public function safeWaitForMasterPos( IDatabase $conn, $pos = false, $timeout = 10 ) { |
||
| 1692 | |||
| 1693 | /** |
||
| 1694 | * Clear the cache for slag lag delay times |
||
| 1695 | * |
||
| 1696 | * This is only used for testing |
||
| 1697 | */ |
||
| 1698 | public function clearLagTimeCache() { |
||
| 1701 | |||
| 1702 | /** |
||
| 1703 | * Set a callback via DatabaseBase::setTransactionListener() on |
||
| 1704 | * all current and future master connections of this load balancer |
||
| 1705 | * |
||
| 1706 | * @param string $name Callback name |
||
| 1707 | * @param callable|null $callback |
||
| 1708 | * @since 1.28 |
||
| 1709 | */ |
||
| 1710 | public function setTransactionListener( $name, callable $callback = null ) { |
||
| 1722 | } |
||
| 1723 |
Loading history...
This check marks private properties in classes that are never used. Those properties can be removed.