3 * Object caching using a SQL database.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use MediaWiki\MediaWikiServices
;
25 use Wikimedia\Rdbms\Database
;
26 use Wikimedia\Rdbms\IDatabase
;
27 use Wikimedia\Rdbms\DBError
;
28 use Wikimedia\Rdbms\DBQueryError
;
29 use Wikimedia\Rdbms\DBConnectionError
;
30 use Wikimedia\Rdbms\IMaintainableDatabase
;
31 use Wikimedia\Rdbms\LoadBalancer
;
32 use Wikimedia\ScopedCallback
;
33 use Wikimedia\WaitConditionLoop
;
36 * Class to store objects in the database
40 class SqlBagOStuff
extends MediumSpecificBagOStuff
{
41 /** @var array[] (server index => server config) */
42 protected $serverInfos;
43 /** @var string[] (server index => tag/host name) */
44 protected $serverTags;
46 protected $numServers;
47 /** @var int UNIX timestamp */
48 protected $lastGarbageCollect = 0;
50 protected $purgePeriod = 10;
52 protected $purgeLimit = 100;
54 protected $shards = 1;
56 protected $tableName = 'objectcache';
58 protected $replicaOnly = false;
60 /** @var LoadBalancer|null */
61 protected $separateMainLB;
64 /** @var array UNIX timestamps */
65 protected $connFailureTimes = [];
66 /** @var array Exceptions */
67 protected $connFailureErrors = [];
70 private static $GC_DELAY_SEC = 1;
73 private static $OP_SET = 'set';
75 private static $OP_ADD = 'add';
77 private static $OP_TOUCH = 'touch';
79 private static $OP_DELETE = 'delete';
82 * Constructor. Parameters are:
83 * - server: A server info structure in the format required by each
84 * element in $wgDBServers.
86 * - servers: An array of server info structures describing a set of database servers
87 * to distribute keys to. If this is specified, the "server" option will be
88 * ignored. If string keys are used, then they will be used for consistent
89 * hashing *instead* of the host name (from the server config). This is useful
90 * when a cluster is replicated to another site (with different host names)
91 * but each server has a corresponding replica in the other cluster.
93 * - purgePeriod: The average number of object cache writes in between
94 * garbage collection operations, where expired entries
95 * are removed from the database. Or in other words, the
96 * reciprocal of the probability of purging on any given
97 * write. If this is set to zero, purging will never be done.
99 * - purgeLimit: Maximum number of rows to purge at once.
101 * - tableName: The table name to use, default is "objectcache".
103 * - shards: The number of tables to use for data storage on each server.
104 * If this is more than 1, table names will be formed in the style
105 * objectcacheNNN where NNN is the shard index, between 0 and
106 * shards-1. The number of digits will be the minimum number
107 * required to hold the largest shard index. Data will be
108 * distributed across all tables by key hash. This is for
109 * MySQL bugs 61735 <https://bugs.mysql.com/bug.php?id=61735>
110 * and 61736 <https://bugs.mysql.com/bug.php?id=61736>.
112 * - replicaOnly: Whether to only use replica DBs and avoid triggering
113 * garbage collection logic of expired items. This only
114 * makes sense if the primary DB is used and only if get()
115 * calls will be used. This is used by ReplicatedBagOStuff.
116 * - syncTimeout: Max seconds to wait for replica DBs to catch up for WRITE_SYNC.
118 * @param array $params
120 public function __construct( $params ) {
121 parent
::__construct( $params );
123 $this->attrMap
[self
::ATTR_EMULATION
] = self
::QOS_EMULATION_SQL
;
124 $this->attrMap
[self
::ATTR_SYNCWRITES
] = self
::QOS_SYNCWRITES_NONE
;
126 if ( isset( $params['servers'] ) ) {
127 $this->serverInfos
= [];
128 $this->serverTags
= [];
129 $this->numServers
= count( $params['servers'] );
131 foreach ( $params['servers'] as $tag => $info ) {
132 $this->serverInfos
[$index] = $info;
133 if ( is_string( $tag ) ) {
134 $this->serverTags
[$index] = $tag;
136 $this->serverTags
[$index] = $info['host'] ??
"#$index";
140 } elseif ( isset( $params['server'] ) ) {
141 $this->serverInfos
= [ $params['server'] ];
142 $this->numServers
= count( $this->serverInfos
);
144 // Default to using the main wiki's database servers
145 $this->serverInfos
= false;
146 $this->numServers
= 1;
147 $this->attrMap
[self
::ATTR_SYNCWRITES
] = self
::QOS_SYNCWRITES_BE
;
149 if ( isset( $params['purgePeriod'] ) ) {
150 $this->purgePeriod
= intval( $params['purgePeriod'] );
152 if ( isset( $params['purgeLimit'] ) ) {
153 $this->purgeLimit
= intval( $params['purgeLimit'] );
155 if ( isset( $params['tableName'] ) ) {
156 $this->tableName
= $params['tableName'];
158 if ( isset( $params['shards'] ) ) {
159 $this->shards
= intval( $params['shards'] );
161 // Backwards-compatibility for < 1.34
162 $this->replicaOnly
= $params['replicaOnly'] ??
( $params['slaveOnly'] ??
false );
166 * Get a connection to the specified database
168 * @param int $serverIndex
169 * @return IMaintainableDatabase
170 * @throws MWException
172 protected function getDB( $serverIndex ) {
173 if ( $serverIndex >= $this->numServers
) {
174 throw new MWException( __METHOD__
. ": Invalid server index \"$serverIndex\"" );
177 # Don't keep timing out trying to connect for each call if the DB is down
179 isset( $this->connFailureErrors
[$serverIndex] ) &&
180 ( $this->getCurrentTime() - $this->connFailureTimes
[$serverIndex] ) < 60
182 throw $this->connFailureErrors
[$serverIndex];
185 if ( $this->serverInfos
) {
186 if ( !isset( $this->conns
[$serverIndex] ) ) {
187 // Use custom database defined by server connection info
188 $info = $this->serverInfos
[$serverIndex];
189 $type = $info['type'] ??
'mysql';
190 $host = $info['host'] ??
'[unknown]';
191 $this->logger
->debug( __CLASS__
. ": connecting to $host" );
192 $db = Database
::factory( $type, $info );
193 $db->clearFlag( DBO_TRX
); // auto-commit mode
194 $this->conns
[$serverIndex] = $db;
196 $db = $this->conns
[$serverIndex];
198 // Use the main LB database
199 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
200 $index = $this->replicaOnly ? DB_REPLICA
: DB_MASTER
;
201 if ( $lb->getServerType( $lb->getWriterIndex() ) !== 'sqlite' ) {
202 // Keep a separate connection to avoid contention and deadlocks
203 $db = $lb->getConnectionRef( $index, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
205 // However, SQLite has the opposite behavior due to DB-level locking.
206 // Stock sqlite MediaWiki installs use a separate sqlite cache DB instead.
207 $db = $lb->getConnectionRef( $index );
211 $this->logger
->debug( sprintf( "Connection %s will be used for SqlBagOStuff", $db ) );
217 * Get the server index and table name for a given key
219 * @return array Server index and table name
221 protected function getTableByKey( $key ) {
222 if ( $this->shards
> 1 ) {
223 $hash = hexdec( substr( md5( $key ), 0, 8 ) ) & 0x7fffffff;
224 $tableIndex = $hash %
$this->shards
;
228 if ( $this->numServers
> 1 ) {
229 $sortedServers = $this->serverTags
;
230 ArrayUtils
::consistentHashSort( $sortedServers, $key );
231 reset( $sortedServers );
232 $serverIndex = key( $sortedServers );
236 return [ $serverIndex, $this->getTableNameByShard( $tableIndex ) ];
240 * Get the table name for a given shard index
244 protected function getTableNameByShard( $index ) {
245 if ( $this->shards
> 1 ) {
246 $decimals = strlen( $this->shards
- 1 );
247 return $this->tableName
.
248 sprintf( "%0{$decimals}d", $index );
250 return $this->tableName
;
254 protected function doGet( $key, $flags = 0, &$casToken = null ) {
257 $blobs = $this->fetchBlobMulti( [ $key ] );
258 if ( array_key_exists( $key, $blobs ) ) {
259 $blob = $blobs[$key];
260 $value = $this->unserialize( $blob );
262 $casToken = ( $value !== false ) ?
$blob : null;
270 protected function doGetMulti( array $keys, $flags = 0 ) {
273 $blobs = $this->fetchBlobMulti( $keys );
274 foreach ( $blobs as $key => $blob ) {
275 $values[$key] = $this->unserialize( $blob );
281 protected function fetchBlobMulti( array $keys, $flags = 0 ) {
282 $values = []; // array of (key => value)
285 foreach ( $keys as $key ) {
286 list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
287 $keysByTable[$serverIndex][$tableName][] = $key;
291 foreach ( $keysByTable as $serverIndex => $serverKeys ) {
293 $db = $this->getDB( $serverIndex );
294 foreach ( $serverKeys as $tableName => $tableKeys ) {
295 $res = $db->select( $tableName,
296 [ 'keyname', 'value', 'exptime' ],
297 [ 'keyname' => $tableKeys ],
299 // Approximate write-on-the-fly BagOStuff API via blocking.
300 // This approximation fails if a ROLLBACK happens (which is rare).
301 // We do not want to flush the TRX as that can break callers.
302 $db->trxLevel() ?
[ 'LOCK IN SHARE MODE' ] : []
304 if ( $res === false ) {
307 foreach ( $res as $row ) {
308 $row->serverIndex
= $serverIndex;
309 $row->tableName
= $tableName;
310 $dataRows[$row->keyname
] = $row;
313 } catch ( DBError
$e ) {
314 $this->handleReadError( $e, $serverIndex );
318 foreach ( $keys as $key ) {
319 if ( isset( $dataRows[$key] ) ) { // HIT?
320 $row = $dataRows[$key];
321 $this->debug( "get: retrieved data; expiry time is " . $row->exptime
);
322 $db = null; // in case of connection failure
324 $db = $this->getDB( $row->serverIndex
);
325 if ( $this->isExpired( $db, $row->exptime
) ) { // MISS
326 $this->debug( "get: key has expired" );
328 $values[$key] = $db->decodeBlob( $row->value
);
330 } catch ( DBQueryError
$e ) {
331 $this->handleWriteError( $e, $db, $row->serverIndex
);
334 $this->debug( 'get: no matching rows' );
341 protected function doSetMulti( array $data, $exptime = 0, $flags = 0 ) {
342 return $this->modifyMulti( $data, $exptime, $flags, self
::$OP_SET );
346 * @param mixed[]|null[] $data Map of (key => new value or null)
347 * @param int $exptime UNIX timestamp, TTL in seconds, or 0 (no expiration)
348 * @param int $flags Bitfield of BagOStuff::WRITE_* constants
349 * @param string $op Cache operation
352 private function modifyMulti( array $data, $exptime, $flags, $op ) {
354 foreach ( $data as $key => $value ) {
355 list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
356 $keysByTable[$serverIndex][$tableName][] = $key;
359 $exptime = $this->getExpirationAsTimestamp( $exptime );
362 /** @noinspection PhpUnusedLocalVariableInspection */
363 $silenceScope = $this->silenceTransactionProfiler();
364 foreach ( $keysByTable as $serverIndex => $serverKeys ) {
365 $db = null; // in case of connection failure
367 $db = $this->getDB( $serverIndex );
368 $this->occasionallyGarbageCollect( $db ); // expire old entries if any
369 $dbExpiry = $exptime ?
$db->timestamp( $exptime ) : $this->getMaxDateTime( $db );
370 } catch ( DBError
$e ) {
371 $this->handleWriteError( $e, $db, $serverIndex );
376 foreach ( $serverKeys as $tableName => $tableKeys ) {
378 $result = $this->updateTableKeys(
386 } catch ( DBError
$e ) {
387 $this->handleWriteError( $e, $db, $serverIndex );
394 if ( ( $flags & self
::WRITE_SYNC
) == self
::WRITE_SYNC
) {
395 $result = $this->waitForReplication() && $result;
403 * @param IDatabase $db
404 * @param string $table
405 * @param string[] $tableKeys Keys in $data to update
406 * @param mixed[]|null[] $data Map of (key => new value or null)
407 * @param string $dbExpiry DB-encoded expiry
410 * @throws InvalidArgumentException
412 private function updateTableKeys( $op, $db, $table, $tableKeys, $data, $dbExpiry ) {
415 if ( $op === self
::$OP_ADD ) {
417 foreach ( $tableKeys as $key ) {
420 'value' => $db->encodeBlob( $this->serialize( $data[$key] ) ),
421 'exptime' => $dbExpiry
427 'keyname' => $tableKeys,
428 'exptime <= ' . $db->addQuotes( $db->timestamp() )
432 $db->insert( $table, $rows, __METHOD__
, [ 'IGNORE' ] );
434 $success = ( $db->affectedRows() == count( $rows ) );
435 } elseif ( $op === self
::$OP_SET ) {
437 foreach ( $tableKeys as $key ) {
440 'value' => $db->encodeBlob( $this->serialize( $data[$key] ) ),
441 'exptime' => $dbExpiry
444 $db->replace( $table, [ 'keyname' ], $rows, __METHOD__
);
445 } elseif ( $op === self
::$OP_DELETE ) {
446 $db->delete( $table, [ 'keyname' => $tableKeys ], __METHOD__
);
447 } elseif ( $op === self
::$OP_TOUCH ) {
450 [ 'exptime' => $dbExpiry ],
452 'keyname' => $tableKeys,
453 'exptime > ' . $db->addQuotes( $db->timestamp() )
458 $success = ( $db->affectedRows() == count( $tableKeys ) );
460 throw new InvalidArgumentException( "Invalid operation '$op'" );
466 protected function doSet( $key, $value, $exptime = 0, $flags = 0 ) {
467 return $this->modifyMulti( [ $key => $value ], $exptime, $flags, self
::$OP_SET );
470 public function add( $key, $value, $exptime = 0, $flags = 0 ) {
471 return $this->modifyMulti( [ $key => $value ], $exptime, $flags, self
::$OP_ADD );
474 protected function cas( $casToken, $key, $value, $exptime = 0, $flags = 0 ) {
475 list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
476 $exptime = $this->getExpirationAsTimestamp( $exptime );
478 /** @noinspection PhpUnusedLocalVariableInspection */
479 $silenceScope = $this->silenceTransactionProfiler();
480 $db = null; // in case of connection failure
482 $db = $this->getDB( $serverIndex );
483 // (T26425) use a replace if the db supports it instead of
484 // delete/insert to avoid clashes with conflicting keynames
489 'value' => $db->encodeBlob( $this->serialize( $value ) ),
490 'exptime' => $exptime
491 ?
$db->timestamp( $exptime )
492 : $this->getMaxDateTime( $db )
496 'value' => $db->encodeBlob( $casToken ),
497 'exptime > ' . $db->addQuotes( $db->timestamp() )
501 } catch ( DBQueryError
$e ) {
502 $this->handleWriteError( $e, $db, $serverIndex );
507 return (bool)$db->affectedRows();
510 protected function doDeleteMulti( array $keys, $flags = 0 ) {
511 return $this->modifyMulti(
512 array_fill_keys( $keys, null ),
519 protected function doDelete( $key, $flags = 0 ) {
520 return $this->modifyMulti( [ $key => null ], 0, $flags, self
::$OP_DELETE );
523 public function incr( $key, $step = 1 ) {
524 list( $serverIndex, $tableName ) = $this->getTableByKey( $key );
527 /** @noinspection PhpUnusedLocalVariableInspection */
528 $silenceScope = $this->silenceTransactionProfiler();
529 $db = null; // in case of connection failure
531 $db = $this->getDB( $serverIndex );
532 $encTimestamp = $db->addQuotes( $db->timestamp() );
535 [ 'value = value + ' . (int)$step ],
536 [ 'keyname' => $key, "exptime > $encTimestamp" ],
539 if ( $db->affectedRows() > 0 ) {
540 $newValue = $db->selectField(
543 [ 'keyname' => $key, "exptime > $encTimestamp" ],
546 if ( $this->isInteger( $newValue ) ) {
547 $newCount = (int)$newValue;
550 } catch ( DBError
$e ) {
551 $this->handleWriteError( $e, $db, $serverIndex );
557 public function merge( $key, callable
$callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
558 $ok = $this->mergeViaCas( $key, $callback, $exptime, $attempts, $flags );
559 if ( ( $flags & self
::WRITE_SYNC
) == self
::WRITE_SYNC
) {
560 $ok = $this->waitForReplication() && $ok;
566 public function changeTTLMulti( array $keys, $exptime, $flags = 0 ) {
567 return $this->modifyMulti(
568 array_fill_keys( $keys, null ),
575 protected function doChangeTTL( $key, $exptime, $flags ) {
576 return $this->modifyMulti( [ $key => null ], $exptime, $flags, self
::$OP_TOUCH );
580 * @param IDatabase $db
581 * @param string $exptime
584 protected function isExpired( $db, $exptime ) {
586 $exptime != $this->getMaxDateTime( $db ) &&
587 wfTimestamp( TS_UNIX
, $exptime ) < $this->getCurrentTime()
592 * @param IDatabase $db
595 protected function getMaxDateTime( $db ) {
596 if ( (int)$this->getCurrentTime() > 0x7fffffff ) {
597 return $db->timestamp( 1 << 62 );
599 return $db->timestamp( 0x7fffffff );
604 * @param IDatabase $db
607 protected function occasionallyGarbageCollect( IDatabase
$db ) {
609 // Random purging is enabled
610 $this->purgePeriod
&&
611 // Only purge on one in every $this->purgePeriod writes
612 mt_rand( 0, $this->purgePeriod
- 1 ) == 0 &&
613 // Avoid repeating the delete within a few seconds
614 ( $this->getCurrentTime() - $this->lastGarbageCollect
) > self
::$GC_DELAY_SEC
616 $garbageCollector = function () use ( $db ) {
617 $this->deleteServerObjectsExpiringBefore(
618 $db, $this->getCurrentTime(),
622 $this->lastGarbageCollect
= time();
624 if ( $this->asyncHandler
) {
625 $this->lastGarbageCollect
= $this->getCurrentTime(); // avoid duplicate enqueues
626 ( $this->asyncHandler
)( $garbageCollector );
633 public function expireAll() {
634 $this->deleteObjectsExpiringBefore( $this->getCurrentTime() );
637 public function deleteObjectsExpiringBefore(
639 callable
$progress = null,
642 /** @noinspection PhpUnusedLocalVariableInspection */
643 $silenceScope = $this->silenceTransactionProfiler();
645 $serverIndexes = range( 0, $this->numServers
- 1 );
646 shuffle( $serverIndexes );
650 $keysDeletedCount = 0;
651 foreach ( $serverIndexes as $numServersDone => $serverIndex ) {
652 $db = null; // in case of connection failure
654 $db = $this->getDB( $serverIndex );
655 $this->deleteServerObjectsExpiringBefore(
663 } catch ( DBError
$e ) {
664 $this->handleWriteError( $e, $db, $serverIndex );
673 * @param IDatabase $db
674 * @param string|int $timestamp
675 * @param callable|null $progressCallback
677 * @param int $serversDoneCount
678 * @param int &$keysDeletedCount
681 private function deleteServerObjectsExpiringBefore(
686 $serversDoneCount = 0,
687 &$keysDeletedCount = 0
689 $cutoffUnix = wfTimestamp( TS_UNIX
, $timestamp );
690 $shardIndexes = range( 0, $this->shards
- 1 );
691 shuffle( $shardIndexes );
693 foreach ( $shardIndexes as $numShardsDone => $shardIndex ) {
694 $continue = null; // last exptime
695 $lag = null; // purge lag
698 $this->getTableNameByShard( $shardIndex ),
699 [ 'keyname', 'exptime' ],
701 [ 'exptime < ' . $db->addQuotes( $db->timestamp( $cutoffUnix ) ) ],
702 $continue ?
[ 'exptime >= ' . $db->addQuotes( $continue ) ] : []
705 [ 'LIMIT' => min( $limit, 100 ), 'ORDER BY' => 'exptime' ]
708 if ( $res->numRows() ) {
709 $row = $res->current();
710 if ( $lag === null ) {
711 $lag = max( $cutoffUnix - wfTimestamp( TS_UNIX
, $row->exptime
), 1 );
715 foreach ( $res as $row ) {
716 $keys[] = $row->keyname
;
717 $continue = $row->exptime
;
721 $this->getTableNameByShard( $shardIndex ),
723 'exptime < ' . $db->addQuotes( $db->timestamp( $cutoffUnix ) ),
728 $keysDeletedCount +
= $db->affectedRows();
731 if ( is_callable( $progressCallback ) ) {
733 $remainingLag = $cutoffUnix - wfTimestamp( TS_UNIX
, $continue );
734 $processedLag = max( $lag - $remainingLag, 0 );
735 $doneRatio = ( $numShardsDone +
$processedLag / $lag ) / $this->shards
;
740 $overallRatio = ( $doneRatio / $this->numServers
)
741 +
( $serversDoneCount / $this->numServers
);
742 call_user_func( $progressCallback, $overallRatio * 100 );
744 } while ( $res->numRows() && $keysDeletedCount < $limit );
749 * Delete content of shard tables in every server.
750 * Return true if the operation is successful, false otherwise.
753 public function deleteAll() {
754 /** @noinspection PhpUnusedLocalVariableInspection */
755 $silenceScope = $this->silenceTransactionProfiler();
756 for ( $serverIndex = 0; $serverIndex < $this->numServers
; $serverIndex++
) {
757 $db = null; // in case of connection failure
759 $db = $this->getDB( $serverIndex );
760 for ( $i = 0; $i < $this->shards
; $i++
) {
761 $db->delete( $this->getTableNameByShard( $i ), '*', __METHOD__
);
763 } catch ( DBError
$e ) {
764 $this->handleWriteError( $e, $db, $serverIndex );
771 public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
772 // Avoid deadlocks and allow lock reentry if specified
773 if ( isset( $this->locks
[$key] ) ) {
774 if ( $rclass != '' && $this->locks
[$key]['class'] === $rclass ) {
775 ++
$this->locks
[$key]['depth'];
782 list( $serverIndex ) = $this->getTableByKey( $key );
784 $db = null; // in case of connection failure
786 $db = $this->getDB( $serverIndex );
787 $ok = $db->lock( $key, __METHOD__
, $timeout );
789 $this->locks
[$key] = [ 'class' => $rclass, 'depth' => 1 ];
792 $this->logger
->warning(
793 __METHOD__
. " failed due to timeout for {key}.",
794 [ 'key' => $key, 'timeout' => $timeout ]
798 } catch ( DBError
$e ) {
799 $this->handleWriteError( $e, $db, $serverIndex );
806 public function unlock( $key ) {
807 if ( !isset( $this->locks
[$key] ) ) {
811 if ( --$this->locks
[$key]['depth'] <= 0 ) {
812 unset( $this->locks
[$key] );
814 list( $serverIndex ) = $this->getTableByKey( $key );
816 $db = null; // in case of connection failure
818 $db = $this->getDB( $serverIndex );
819 $ok = $db->unlock( $key, __METHOD__
);
821 $this->logger
->warning(
822 __METHOD__
. ' failed to release lock for {key}.',
826 } catch ( DBError
$e ) {
827 $this->handleWriteError( $e, $db, $serverIndex );
838 * Serialize an object and, if possible, compress the representation.
839 * On typical message and page data, this can provide a 3X decrease
840 * in storage requirements.
845 protected function serialize( $data ) {
846 if ( is_int( $data ) ) {
850 $serial = serialize( $data );
851 if ( function_exists( 'gzdeflate' ) ) {
852 $serial = gzdeflate( $serial );
859 * Unserialize and, if necessary, decompress an object.
860 * @param string $serial
863 protected function unserialize( $serial ) {
864 if ( $this->isInteger( $serial ) ) {
868 if ( function_exists( 'gzinflate' ) ) {
869 Wikimedia\
suppressWarnings();
870 $decomp = gzinflate( $serial );
871 Wikimedia\restoreWarnings
();
873 if ( $decomp !== false ) {
878 return unserialize( $serial );
882 * Handle a DBError which occurred during a read operation.
884 * @param DBError $exception
885 * @param int $serverIndex
887 protected function handleReadError( DBError
$exception, $serverIndex ) {
888 if ( $exception instanceof DBConnectionError
) {
889 $this->markServerDown( $exception, $serverIndex );
892 $this->setAndLogDBError( $exception );
896 * Handle a DBQueryError which occurred during a write operation.
898 * @param DBError $exception
899 * @param IDatabase|null $db DB handle or null if connection failed
900 * @param int $serverIndex
903 protected function handleWriteError( DBError
$exception, $db, $serverIndex ) {
904 if ( !( $db instanceof IDatabase
) ) {
905 $this->markServerDown( $exception, $serverIndex );
908 $this->setAndLogDBError( $exception );
912 * @param DBError $exception
914 private function setAndLogDBError( DBError
$exception ) {
915 $this->logger
->error( "DBError: {$exception->getMessage()}" );
916 if ( $exception instanceof DBConnectionError
) {
917 $this->setLastError( BagOStuff
::ERR_UNREACHABLE
);
918 $this->logger
->debug( __METHOD__
. ": ignoring connection error" );
920 $this->setLastError( BagOStuff
::ERR_UNEXPECTED
);
921 $this->logger
->debug( __METHOD__
. ": ignoring query error" );
926 * Mark a server down due to a DBConnectionError exception
928 * @param DBError $exception
929 * @param int $serverIndex
931 protected function markServerDown( DBError
$exception, $serverIndex ) {
932 unset( $this->conns
[$serverIndex] ); // bug T103435
934 $now = $this->getCurrentTime();
935 if ( isset( $this->connFailureTimes
[$serverIndex] ) ) {
936 if ( $now - $this->connFailureTimes
[$serverIndex] >= 60 ) {
937 unset( $this->connFailureTimes
[$serverIndex] );
938 unset( $this->connFailureErrors
[$serverIndex] );
940 $this->logger
->debug( __METHOD__
. ": Server #$serverIndex already down" );
944 $this->logger
->info( __METHOD__
. ": Server #$serverIndex down until " . ( $now +
60 ) );
945 $this->connFailureTimes
[$serverIndex] = $now;
946 $this->connFailureErrors
[$serverIndex] = $exception;
950 * Create shard tables. For use from eval.php.
952 public function createTables() {
953 for ( $serverIndex = 0; $serverIndex < $this->numServers
; $serverIndex++
) {
954 $db = $this->getDB( $serverIndex );
955 if ( $db->getType() !== 'mysql' ) {
956 throw new MWException( __METHOD__
. ' is not supported on this DB server' );
959 for ( $i = 0; $i < $this->shards
; $i++
) {
961 'CREATE TABLE ' . $db->tableName( $this->getTableNameByShard( $i ) ) .
962 ' LIKE ' . $db->tableName( 'objectcache' ),
969 * @return bool Whether the main DB is used, e.g. wfGetDB( DB_MASTER )
971 protected function usesMainDB() {
972 return !$this->serverInfos
;
975 protected function waitForReplication() {
976 if ( !$this->usesMainDB() ) {
977 // Custom DB server list; probably doesn't use replication
981 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
982 if ( $lb->getServerCount() <= 1 ) {
983 return true; // no replica DBs
986 // Main LB is used; wait for any replica DBs to catch up
988 $masterPos = $lb->getMasterPos();
990 return true; // not applicable
993 $loop = new WaitConditionLoop(
994 function () use ( $lb, $masterPos ) {
995 return $lb->waitForAll( $masterPos, 1 );
1001 return ( $loop->invoke() === $loop::CONDITION_REACHED
);
1002 } catch ( DBError
$e ) {
1003 $this->setAndLogDBError( $e );
1010 * Returns a ScopedCallback which resets the silence flag in the transaction profiler when it is
1011 * destroyed on the end of a scope, for example on return or throw
1012 * @return ScopedCallback
1015 protected function silenceTransactionProfiler() {
1016 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
1017 $oldSilenced = $trxProfiler->setSilenced( true );
1018 return new ScopedCallback( function () use ( $trxProfiler, $oldSilenced ) {
1019 $trxProfiler->setSilenced( $oldSilenced );