includes/libs/objectcache/BagOStuff.php

   1 <?php
   2 /**
   3  * Copyright © 2003-2004 Brion Vibber <brion@pobox.com>
   4  * https://www.mediawiki.org/
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Cache
  23  */
  24
  25 /**
  26  * @defgroup Cache Cache
  27  */
  28
  29 use Psr\Log\LoggerAwareInterface;
  30 use Psr\Log\LoggerInterface;
  31 use Psr\Log\NullLogger;
  32 use Wikimedia\ScopedCallback;
  33 use Wikimedia\WaitConditionLoop;
  34
  35 /**
  36  * Class representing a cache/ephemeral data store
  37  *
  38  * This interface is intended to be more or less compatible with the PHP memcached client.
  39  *
  40  * Instances of this class should be created with an intended access scope, such as:
  41  *   - a) A single PHP thread on a server (e.g. stored in a PHP variable)
  42  *   - b) A single application server (e.g. stored in APC or sqlite)
  43  *   - c) All application servers in datacenter (e.g. stored in memcached or mysql)
  44  *   - d) All application servers in all datacenters (e.g. stored via mcrouter or dynomite)
  45  *
  46  * Callers should use the proper factory methods that yield BagOStuff instances. Site admins
  47  * should make sure the configuration for those factory methods matches their access scope.
  48  * BagOStuff subclasses have widely varying levels of support for replication features.
  49  *
  50  * For any given instance, methods like lock(), unlock(), merge(), and set() with WRITE_SYNC
  51  * should semantically operate over its entire access scope; any nodes/threads in that scope
  52  * should serialize appropriately when using them. Likewise, a call to get() with READ_LATEST
  53  * from one node in its access scope should reflect the prior changes of any other node its access
  54  * scope. Any get() should reflect the changes of any prior set() with WRITE_SYNC.
  55  *
  56  * @ingroup Cache
  57  */
  58 abstract class BagOStuff implements IExpiringStore, LoggerAwareInterface {
  59         /** @var array[] Lock tracking */
  60         protected $locks = [];
  61         /** @var int ERR_* class constant */
  62         protected $lastError = self::ERR_NONE;
  63         /** @var string */
  64         protected $keyspace = 'local';
  65         /** @var LoggerInterface */
  66         protected $logger;
  67         /** @var callback|null */
  68         protected $asyncHandler;
  69         /** @var int Seconds */
  70         protected $syncTimeout;
  71
  72         /** @var bool */
  73         private $debugMode = false;
  74         /** @var array */
  75         private $duplicateKeyLookups = [];
  76         /** @var bool */
  77         private $reportDupes = false;
  78         /** @var bool */
  79         private $dupeTrackScheduled = false;
  80
  81         /** @var callable[] */
  82         protected $busyCallbacks = [];
  83
  84         /** @var float|null */
  85         private $wallClockOverride;
  86
  87         /** @var int[] Map of (ATTR_* class constant => QOS_* class constant) */
  88         protected $attrMap = [];
  89
  90         /** Possible values for getLastError() */
  91         const ERR_NONE = 0; // no error
  92         const ERR_NO_RESPONSE = 1; // no response
  93         const ERR_UNREACHABLE = 2; // can't connect
  94         const ERR_UNEXPECTED = 3; // response gave some error
  95
  96         /** Bitfield constants for get()/getMulti() */
  97         const READ_LATEST = 1; // use latest data for replicated stores
  98         const READ_VERIFIED = 2; // promise that caller can tell when keys are stale
  99         /** Bitfield constants for set()/merge() */
 100         const WRITE_SYNC = 1; // synchronously write to all locations for replicated stores
 101         const WRITE_CACHE_ONLY = 2; // Only change state of the in-memory cache
 102
 103         /**
 104          * $params include:
 105          *   - logger: Psr\Log\LoggerInterface instance
 106          *   - keyspace: Default keyspace for $this->makeKey()
 107          *   - asyncHandler: Callable to use for scheduling tasks after the web request ends.
 108          *      In CLI mode, it should run the task immediately.
 109          *   - reportDupes: Whether to emit warning log messages for all keys that were
 110          *      requested more than once (requires an asyncHandler).
 111          *   - syncTimeout: How long to wait with WRITE_SYNC in seconds.
 112          * @param array $params
 113          */
 114         public function __construct( array $params = [] ) {
 115                 if ( isset( $params['logger'] ) ) {
 116                         $this->setLogger( $params['logger'] );
 117                 } else {
 118                         $this->setLogger( new NullLogger() );
 119                 }
 120
 121                 if ( isset( $params['keyspace'] ) ) {
 122                         $this->keyspace = $params['keyspace'];
 123                 }
 124
 125                 $this->asyncHandler = $params['asyncHandler'] ?? null;
 126
 127                 if ( !empty( $params['reportDupes'] ) && is_callable( $this->asyncHandler ) ) {
 128                         $this->reportDupes = true;
 129                 }
 130
 131                 $this->syncTimeout = $params['syncTimeout'] ?? 3;
 132         }
 133
 134         /**
 135          * @param LoggerInterface $logger
 136          * @return void
 137          */
 138         public function setLogger( LoggerInterface $logger ) {
 139                 $this->logger = $logger;
 140         }
 141
 142         /**
 143          * @param bool $bool
 144          */
 145         public function setDebug( $bool ) {
 146                 $this->debugMode = $bool;
 147         }
 148
 149         /**
 150          * Get an item with the given key, regenerating and setting it if not found
 151          *
 152          * If the callback returns false, then nothing is stored.
 153          *
 154          * @param string $key
 155          * @param int $ttl Time-to-live (seconds)
 156          * @param callable $callback Callback that derives the new value
 157          * @param int $flags Bitfield of BagOStuff::READ_* constants [optional]
 158          * @return mixed The cached value if found or the result of $callback otherwise
 159          * @since 1.27
 160          */
 161         final public function getWithSetCallback( $key, $ttl, $callback, $flags = 0 ) {
 162                 $value = $this->get( $key, $flags );
 163
 164                 if ( $value === false ) {
 165                         if ( !is_callable( $callback ) ) {
 166                                 throw new InvalidArgumentException( "Invalid cache miss callback provided." );
 167                         }
 168                         $value = call_user_func( $callback );
 169                         if ( $value !== false ) {
 170                                 $this->set( $key, $value, $ttl );
 171                         }
 172                 }
 173
 174                 return $value;
 175         }
 176
 177         /**
 178          * Get an item with the given key
 179          *
 180          * If the key includes a deterministic input hash (e.g. the key can only have
 181          * the correct value) or complete staleness checks are handled by the caller
 182          * (e.g. nothing relies on the TTL), then the READ_VERIFIED flag should be set.
 183          * This lets tiered backends know they can safely upgrade a cached value to
 184          * higher tiers using standard TTLs.
 185          *
 186          * @param string $key
 187          * @param int $flags Bitfield of BagOStuff::READ_* constants [optional]
 188          * @param int|null $oldFlags [unused]
 189          * @return mixed Returns false on failure and if the item does not exist
 190          */
 191         public function get( $key, $flags = 0, $oldFlags = null ) {
 192                 // B/C for ( $key, &$casToken = null, $flags = 0 )
 193                 $flags = is_int( $oldFlags ) ? $oldFlags : $flags;
 194
 195                 $this->trackDuplicateKeys( $key );
 196
 197                 return $this->doGet( $key, $flags );
 198         }
 199
 200         /**
 201          * Track the number of times that a given key has been used.
 202          * @param string $key
 203          */
 204         private function trackDuplicateKeys( $key ) {
 205                 if ( !$this->reportDupes ) {
 206                         return;
 207                 }
 208
 209                 if ( !isset( $this->duplicateKeyLookups[$key] ) ) {
 210                         // Track that we have seen this key. This N-1 counting style allows
 211                         // easy filtering with array_filter() later.
 212                         $this->duplicateKeyLookups[$key] = 0;
 213                 } else {
 214                         $this->duplicateKeyLookups[$key] += 1;
 215
 216                         if ( $this->dupeTrackScheduled === false ) {
 217                                 $this->dupeTrackScheduled = true;
 218                                 // Schedule a callback that logs keys processed more than once by get().
 219                                 call_user_func( $this->asyncHandler, function () {
 220                                         $dups = array_filter( $this->duplicateKeyLookups );
 221                                         foreach ( $dups as $key => $count ) {
 222                                                 $this->logger->warning(
 223                                                         'Duplicate get(): "{key}" fetched {count} times',
 224                                                         // Count is N-1 of the actual lookup count
 225                                                         [ 'key' => $key, 'count' => $count + 1, ]
 226                                                 );
 227                                         }
 228                                 } );
 229                         }
 230                 }
 231         }
 232
 233         /**
 234          * @param string $key
 235          * @param int $flags Bitfield of BagOStuff::READ_* constants [optional]
 236          * @return mixed Returns false on failure and if the item does not exist
 237          */
 238         abstract protected function doGet( $key, $flags = 0 );
 239
 240         /**
 241          * @note: This method is only needed if merge() uses mergeViaCas()
 242          *
 243          * @param string $key
 244          * @param mixed &$casToken
 245          * @param int $flags Bitfield of BagOStuff::READ_* constants [optional]
 246          * @return mixed Returns false on failure and if the item does not exist
 247          * @throws Exception
 248          */
 249         protected function getWithToken( $key, &$casToken, $flags = 0 ) {
 250                 throw new Exception( __METHOD__ . ' not implemented.' );
 251         }
 252
 253         /**
 254          * Set an item
 255          *
 256          * @param string $key
 257          * @param mixed $value
 258          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 259          * @param int $flags Bitfield of BagOStuff::WRITE_* constants
 260          * @return bool Success
 261          */
 262         abstract public function set( $key, $value, $exptime = 0, $flags = 0 );
 263
 264         /**
 265          * Delete an item
 266          *
 267          * @param string $key
 268          * @return bool True if the item was deleted or not found, false on failure
 269          */
 270         abstract public function delete( $key );
 271
 272         /**
 273          * Merge changes into the existing cache value (possibly creating a new one)
 274          *
 275          * The callback function returns the new value given the current value
 276          * (which will be false if not present), and takes the arguments:
 277          * (this BagOStuff, cache key, current value, TTL).
 278          * The TTL parameter is reference set to $exptime. It can be overriden in the callback.
 279          *
 280          * @param string $key
 281          * @param callable $callback Callback method to be executed
 282          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 283          * @param int $attempts The amount of times to attempt a merge in case of failure
 284          * @param int $flags Bitfield of BagOStuff::WRITE_* constants
 285          * @return bool Success
 286          * @throws InvalidArgumentException
 287          */
 288         public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
 289                 return $this->mergeViaLock( $key, $callback, $exptime, $attempts, $flags );
 290         }
 291
 292         /**
 293          * @see BagOStuff::merge()
 294          *
 295          * @param string $key
 296          * @param callable $callback Callback method to be executed
 297          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 298          * @param int $attempts The amount of times to attempt a merge in case of failure
 299          * @return bool Success
 300          */
 301         protected function mergeViaCas( $key, $callback, $exptime = 0, $attempts = 10 ) {
 302                 do {
 303                         $this->clearLastError();
 304                         $reportDupes = $this->reportDupes;
 305                         $this->reportDupes = false;
 306                         $casToken = null; // passed by reference
 307                         $currentValue = $this->getWithToken( $key, $casToken, self::READ_LATEST );
 308                         $this->reportDupes = $reportDupes;
 309
 310                         if ( $this->getLastError() ) {
 311                                 $this->logger->warning(
 312                                         __METHOD__ . ' failed due to I/O error on get() for {key}.',
 313                                         [ 'key' => $key ]
 314                                 );
 315
 316                                 return false; // don't spam retries (retry only on races)
 317                         }
 318
 319                         // Derive the new value from the old value
 320                         $value = call_user_func( $callback, $this, $key, $currentValue, $exptime );
 321
 322                         $this->clearLastError();
 323                         if ( $value === false ) {
 324                                 $success = true; // do nothing
 325                         } elseif ( $currentValue === false ) {
 326                                 // Try to create the key, failing if it gets created in the meantime
 327                                 $success = $this->add( $key, $value, $exptime );
 328                         } else {
 329                                 // Try to update the key, failing if it gets changed in the meantime
 330                                 $success = $this->cas( $casToken, $key, $value, $exptime );
 331                         }
 332                         if ( $this->getLastError() ) {
 333                                 $this->logger->warning(
 334                                         __METHOD__ . ' failed due to I/O error for {key}.',
 335                                         [ 'key' => $key ]
 336                                 );
 337
 338                                 return false; // IO error; don't spam retries
 339                         }
 340                 } while ( !$success && --$attempts );
 341
 342                 return $success;
 343         }
 344
 345         /**
 346          * Check and set an item
 347          *
 348          * @param mixed $casToken
 349          * @param string $key
 350          * @param mixed $value
 351          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 352          * @return bool Success
 353          * @throws Exception
 354          */
 355         protected function cas( $casToken, $key, $value, $exptime = 0 ) {
 356                 if ( !$this->lock( $key, 0 ) ) {
 357                         return false; // non-blocking
 358                 }
 359
 360                 $curCasToken = null; // passed by reference
 361                 $this->getWithToken( $key, $curCasToken, self::READ_LATEST );
 362                 if ( $casToken === $curCasToken ) {
 363                         $success = $this->set( $key, $value, $exptime );
 364                 } else {
 365                         $this->logger->info(
 366                                 __METHOD__ . ' failed due to race condition for {key}.',
 367                                 [ 'key' => $key ]
 368                         );
 369
 370                         $success = false; // mismatched or failed
 371                 }
 372
 373                 $this->unlock( $key );
 374
 375                 return $success;
 376         }
 377
 378         /**
 379          * @see BagOStuff::merge()
 380          *
 381          * @param string $key
 382          * @param callable $callback Callback method to be executed
 383          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 384          * @param int $attempts The amount of times to attempt a merge in case of failure
 385          * @param int $flags Bitfield of BagOStuff::WRITE_* constants
 386          * @return bool Success
 387          */
 388         protected function mergeViaLock( $key, $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
 389                 if ( $attempts <= 1 ) {
 390                         $timeout = 0; // clearly intended to be "non-blocking"
 391                 } else {
 392                         $timeout = 3;
 393                 }
 394
 395                 if ( !$this->lock( $key, $timeout ) ) {
 396                         return false;
 397                 }
 398
 399                 $this->clearLastError();
 400                 $reportDupes = $this->reportDupes;
 401                 $this->reportDupes = false;
 402                 $currentValue = $this->get( $key, self::READ_LATEST );
 403                 $this->reportDupes = $reportDupes;
 404
 405                 if ( $this->getLastError() ) {
 406                         $this->logger->warning(
 407                                 __METHOD__ . ' failed due to I/O error on get() for {key}.',
 408                                 [ 'key' => $key ]
 409                         );
 410
 411                         $success = false;
 412                 } else {
 413                         // Derive the new value from the old value
 414                         $value = call_user_func( $callback, $this, $key, $currentValue, $exptime );
 415                         if ( $value === false ) {
 416                                 $success = true; // do nothing
 417                         } else {
 418                                 $success = $this->set( $key, $value, $exptime, $flags ); // set the new value
 419                         }
 420                 }
 421
 422                 if ( !$this->unlock( $key ) ) {
 423                         // this should never happen
 424                         trigger_error( "Could not release lock for key '$key'." );
 425                 }
 426
 427                 return $success;
 428         }
 429
 430         /**
 431          * Reset the TTL on a key if it exists
 432          *
 433          * @param string $key
 434          * @param int $expiry
 435          * @return bool Success Returns false if there is no key
 436          * @since 1.28
 437          */
 438         public function changeTTL( $key, $expiry = 0 ) {
 439                 $value = $this->get( $key );
 440
 441                 return ( $value === false ) ? false : $this->set( $key, $value, $expiry );
 442         }
 443
 444         /**
 445          * Acquire an advisory lock on a key string
 446          *
 447          * Note that if reentry is enabled, duplicate calls ignore $expiry
 448          *
 449          * @param string $key
 450          * @param int $timeout Lock wait timeout; 0 for non-blocking [optional]
 451          * @param int $expiry Lock expiry [optional]; 1 day maximum
 452          * @param string $rclass Allow reentry if set and the current lock used this value
 453          * @return bool Success
 454          */
 455         public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
 456                 // Avoid deadlocks and allow lock reentry if specified
 457                 if ( isset( $this->locks[$key] ) ) {
 458                         if ( $rclass != '' && $this->locks[$key]['class'] === $rclass ) {
 459                                 ++$this->locks[$key]['depth'];
 460                                 return true;
 461                         } else {
 462                                 return false;
 463                         }
 464                 }
 465
 466                 $fname = __METHOD__;
 467                 $expiry = min( $expiry ?: INF, self::TTL_DAY );
 468                 $loop = new WaitConditionLoop(
 469                         function () use ( $key, $timeout, $expiry, $fname ) {
 470                                 $this->clearLastError();
 471                                 if ( $this->add( "{$key}:lock", 1, $expiry ) ) {
 472                                         return true; // locked!
 473                                 } elseif ( $this->getLastError() ) {
 474                                         $this->logger->warning(
 475                                                 $fname . ' failed due to I/O error for {key}.',
 476                                                 [ 'key' => $key ]
 477                                         );
 478
 479                                         return WaitConditionLoop::CONDITION_ABORTED; // network partition?
 480                                 }
 481
 482                                 return WaitConditionLoop::CONDITION_CONTINUE;
 483                         },
 484                         $timeout
 485                 );
 486
 487                 $code = $loop->invoke();
 488                 $locked = ( $code === $loop::CONDITION_REACHED );
 489                 if ( $locked ) {
 490                         $this->locks[$key] = [ 'class' => $rclass, 'depth' => 1 ];
 491                 } elseif ( $code === $loop::CONDITION_TIMED_OUT ) {
 492                         $this->logger->warning(
 493                                 "$fname failed due to timeout for {key}.",
 494                                 [ 'key' => $key, 'timeout' => $timeout ]
 495                         );
 496                 }
 497
 498                 return $locked;
 499         }
 500
 501         /**
 502          * Release an advisory lock on a key string
 503          *
 504          * @param string $key
 505          * @return bool Success
 506          */
 507         public function unlock( $key ) {
 508                 if ( isset( $this->locks[$key] ) && --$this->locks[$key]['depth'] <= 0 ) {
 509                         unset( $this->locks[$key] );
 510
 511                         $ok = $this->delete( "{$key}:lock" );
 512                         if ( !$ok ) {
 513                                 $this->logger->warning(
 514                                         __METHOD__ . ' failed to release lock for {key}.',
 515                                         [ 'key' => $key ]
 516                                 );
 517                         }
 518
 519                         return $ok;
 520                 }
 521
 522                 return true;
 523         }
 524
 525         /**
 526          * Get a lightweight exclusive self-unlocking lock
 527          *
 528          * Note that the same lock cannot be acquired twice.
 529          *
 530          * This is useful for task de-duplication or to avoid obtrusive
 531          * (though non-corrupting) DB errors like INSERT key conflicts
 532          * or deadlocks when using LOCK IN SHARE MODE.
 533          *
 534          * @param string $key
 535          * @param int $timeout Lock wait timeout; 0 for non-blocking [optional]
 536          * @param int $expiry Lock expiry [optional]; 1 day maximum
 537          * @param string $rclass Allow reentry if set and the current lock used this value
 538          * @return ScopedCallback|null Returns null on failure
 539          * @since 1.26
 540          */
 541         final public function getScopedLock( $key, $timeout = 6, $expiry = 30, $rclass = '' ) {
 542                 $expiry = min( $expiry ?: INF, self::TTL_DAY );
 543
 544                 if ( !$this->lock( $key, $timeout, $expiry, $rclass ) ) {
 545                         return null;
 546                 }
 547
 548                 $lSince = $this->getCurrentTime(); // lock timestamp
 549
 550                 return new ScopedCallback( function () use ( $key, $lSince, $expiry ) {
 551                         $latency = 0.050; // latency skew (err towards keeping lock present)
 552                         $age = ( $this->getCurrentTime() - $lSince + $latency );
 553                         if ( ( $age + $latency ) >= $expiry ) {
 554                                 $this->logger->warning(
 555                                         "Lock for {key} held too long ({age} sec).",
 556                                         [ 'key' => $key, 'age' => $age ]
 557                                 );
 558                                 return; // expired; it's not "safe" to delete the key
 559                         }
 560                         $this->unlock( $key );
 561                 } );
 562         }
 563
 564         /**
 565          * Delete all objects expiring before a certain date.
 566          * @param string $date The reference date in MW format
 567          * @param callable|bool $progressCallback Optional, a function which will be called
 568          *     regularly during long-running operations with the percentage progress
 569          *     as the first parameter.
 570          *
 571          * @return bool Success, false if unimplemented
 572          */
 573         public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
 574                 // stub
 575                 return false;
 576         }
 577
 578         /**
 579          * Get an associative array containing the item for each of the keys that have items.
 580          * @param array $keys List of strings
 581          * @param int $flags Bitfield; supports READ_LATEST [optional]
 582          * @return array
 583          */
 584         public function getMulti( array $keys, $flags = 0 ) {
 585                 $res = [];
 586                 foreach ( $keys as $key ) {
 587                         $val = $this->get( $key );
 588                         if ( $val !== false ) {
 589                                 $res[$key] = $val;
 590                         }
 591                 }
 592                 return $res;
 593         }
 594
 595         /**
 596          * Batch insertion
 597          * @param array $data $key => $value assoc array
 598          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 599          * @return bool Success
 600          * @since 1.24
 601          */
 602         public function setMulti( array $data, $exptime = 0 ) {
 603                 $res = true;
 604                 foreach ( $data as $key => $value ) {
 605                         if ( !$this->set( $key, $value, $exptime ) ) {
 606                                 $res = false;
 607                         }
 608                 }
 609                 return $res;
 610         }
 611
 612         /**
 613          * @param string $key
 614          * @param mixed $value
 615          * @param int $exptime
 616          * @return bool Success
 617          */
 618         public function add( $key, $value, $exptime = 0 ) {
 619                 // @note: avoid lock() here since that method uses *this* method by default
 620                 if ( $this->get( $key ) === false ) {
 621                         return $this->set( $key, $value, $exptime );
 622                 }
 623                 return false; // key already set
 624         }
 625
 626         /**
 627          * Increase stored value of $key by $value while preserving its TTL
 628          * @param string $key Key to increase
 629          * @param int $value Value to add to $key (Default 1)
 630          * @return int|bool New value or false on failure
 631          */
 632         public function incr( $key, $value = 1 ) {
 633                 if ( !$this->lock( $key, 1 ) ) {
 634                         return false;
 635                 }
 636                 $n = $this->get( $key );
 637                 if ( $this->isInteger( $n ) ) { // key exists?
 638                         $n += intval( $value );
 639                         $this->set( $key, max( 0, $n ) ); // exptime?
 640                 } else {
 641                         $n = false;
 642                 }
 643                 $this->unlock( $key );
 644
 645                 return $n;
 646         }
 647
 648         /**
 649          * Decrease stored value of $key by $value while preserving its TTL
 650          * @param string $key
 651          * @param int $value
 652          * @return int|bool New value or false on failure
 653          */
 654         public function decr( $key, $value = 1 ) {
 655                 return $this->incr( $key, - $value );
 656         }
 657
 658         /**
 659          * Increase stored value of $key by $value while preserving its TTL
 660          *
 661          * This will create the key with value $init and TTL $ttl instead if not present
 662          *
 663          * @param string $key
 664          * @param int $ttl
 665          * @param int $value
 666          * @param int $init
 667          * @return int|bool New value or false on failure
 668          * @since 1.24
 669          */
 670         public function incrWithInit( $key, $ttl, $value = 1, $init = 1 ) {
 671                 $this->clearLastError();
 672                 $newValue = $this->incr( $key, $value );
 673                 if ( $newValue === false && !$this->getLastError() ) {
 674                         // No key set; initialize
 675                         $newValue = $this->add( $key, (int)$init, $ttl ) ? $init : false;
 676                         if ( $newValue === false && !$this->getLastError() ) {
 677                                 // Raced out initializing; increment
 678                                 $newValue = $this->incr( $key, $value );
 679                         }
 680                 }
 681
 682                 return $newValue;
 683         }
 684
 685         /**
 686          * Get the "last error" registered; clearLastError() should be called manually
 687          * @return int ERR_* constant for the "last error" registry
 688          * @since 1.23
 689          */
 690         public function getLastError() {
 691                 return $this->lastError;
 692         }
 693
 694         /**
 695          * Clear the "last error" registry
 696          * @since 1.23
 697          */
 698         public function clearLastError() {
 699                 $this->lastError = self::ERR_NONE;
 700         }
 701
 702         /**
 703          * Set the "last error" registry
 704          * @param int $err ERR_* constant
 705          * @since 1.23
 706          */
 707         protected function setLastError( $err ) {
 708                 $this->lastError = $err;
 709         }
 710
 711         /**
 712          * Let a callback be run to avoid wasting time on special blocking calls
 713          *
 714          * The callbacks may or may not be called ever, in any particular order.
 715          * They are likely to be invoked when something WRITE_SYNC is used used.
 716          * They should follow a caching pattern as shown below, so that any code
 717          * using the word will get it's result no matter what happens.
 718          * @code
 719          *     $result = null;
 720          *     $workCallback = function () use ( &$result ) {
 721          *         if ( !$result ) {
 722          *             $result = ....
 723          *         }
 724          *         return $result;
 725          *     }
 726          * @endcode
 727          *
 728          * @param callable $workCallback
 729          * @since 1.28
 730          */
 731         public function addBusyCallback( callable $workCallback ) {
 732                 $this->busyCallbacks[] = $workCallback;
 733         }
 734
 735         /**
 736          * Modify a cache update operation array for EventRelayer::notify()
 737          *
 738          * This is used for relayed writes, e.g. for broadcasting a change
 739          * to multiple data-centers. If the array contains a 'val' field
 740          * then the command involves setting a key to that value. Note that
 741          * for simplicity, 'val' is always a simple scalar value. This method
 742          * is used to possibly serialize the value and add any cache-specific
 743          * key/values needed for the relayer daemon (e.g. memcached flags).
 744          *
 745          * @param array $event
 746          * @return array
 747          * @since 1.26
 748          */
 749         public function modifySimpleRelayEvent( array $event ) {
 750                 return $event;
 751         }
 752
 753         /**
 754          * @param string $text
 755          */
 756         protected function debug( $text ) {
 757                 if ( $this->debugMode ) {
 758                         $this->logger->debug( "{class} debug: $text", [
 759                                 'class' => static::class,
 760                         ] );
 761                 }
 762         }
 763
 764         /**
 765          * Convert an optionally relative time to an absolute time
 766          * @param int $exptime
 767          * @return int
 768          */
 769         protected function convertExpiry( $exptime ) {
 770                 if ( $exptime != 0 && $exptime < ( 10 * self::TTL_YEAR ) ) {
 771                         return (int)$this->getCurrentTime() + $exptime;
 772                 } else {
 773                         return $exptime;
 774                 }
 775         }
 776
 777         /**
 778          * Convert an optionally absolute expiry time to a relative time. If an
 779          * absolute time is specified which is in the past, use a short expiry time.
 780          *
 781          * @param int $exptime
 782          * @return int
 783          */
 784         protected function convertToRelative( $exptime ) {
 785                 if ( $exptime >= ( 10 * self::TTL_YEAR ) ) {
 786                         $exptime -= (int)$this->getCurrentTime();
 787                         if ( $exptime <= 0 ) {
 788                                 $exptime = 1;
 789                         }
 790                         return $exptime;
 791                 } else {
 792                         return $exptime;
 793                 }
 794         }
 795
 796         /**
 797          * Check if a value is an integer
 798          *
 799          * @param mixed $value
 800          * @return bool
 801          */
 802         protected function isInteger( $value ) {
 803                 return ( is_int( $value ) || ctype_digit( $value ) );
 804         }
 805
 806         /**
 807          * Construct a cache key.
 808          *
 809          * @since 1.27
 810          * @param string $keyspace
 811          * @param array $args
 812          * @return string Colon-delimited list of $keyspace followed by escaped components of $args
 813          */
 814         public function makeKeyInternal( $keyspace, $args ) {
 815                 $key = $keyspace;
 816                 foreach ( $args as $arg ) {
 817                         $arg = str_replace( ':', '%3A', $arg );
 818                         $key = $key . ':' . $arg;
 819                 }
 820                 return strtr( $key, ' ', '_' );
 821         }
 822
 823         /**
 824          * Make a global cache key.
 825          *
 826          * @since 1.27
 827          * @param string $class Key class
 828          * @param string|null $component [optional] Key component (starting with a key collection name)
 829          * @return string Colon-delimited list of $keyspace followed by escaped components of $args
 830          */
 831         public function makeGlobalKey( $class, $component = null ) {
 832                 return $this->makeKeyInternal( 'global', func_get_args() );
 833         }
 834
 835         /**
 836          * Make a cache key, scoped to this instance's keyspace.
 837          *
 838          * @since 1.27
 839          * @param string $class Key class
 840          * @param string|null $component [optional] Key component (starting with a key collection name)
 841          * @return string Colon-delimited list of $keyspace followed by escaped components of $args
 842          */
 843         public function makeKey( $class, $component = null ) {
 844                 return $this->makeKeyInternal( $this->keyspace, func_get_args() );
 845         }
 846
 847         /**
 848          * @param int $flag ATTR_* class constant
 849          * @return int QOS_* class constant
 850          * @since 1.28
 851          */
 852         public function getQoS( $flag ) {
 853                 return $this->attrMap[$flag] ?? self::QOS_UNKNOWN;
 854         }
 855
 856         /**
 857          * Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map
 858          *
 859          * @param BagOStuff[] $bags
 860          * @return int[] Resulting flag map (class ATTR_* constant => class QOS_* constant)
 861          */
 862         protected function mergeFlagMaps( array $bags ) {
 863                 $map = [];
 864                 foreach ( $bags as $bag ) {
 865                         foreach ( $bag->attrMap as $attr => $rank ) {
 866                                 if ( isset( $map[$attr] ) ) {
 867                                         $map[$attr] = min( $map[$attr], $rank );
 868                                 } else {
 869                                         $map[$attr] = $rank;
 870                                 }
 871                         }
 872                 }
 873
 874                 return $map;
 875         }
 876
 877         /**
 878          * @return float UNIX timestamp
 879          * @codeCoverageIgnore
 880          */
 881         protected function getCurrentTime() {
 882                 return $this->wallClockOverride ?: microtime( true );
 883         }
 884
 885         /**
 886          * @param float|null &$time Mock UNIX timestamp for testing
 887          * @codeCoverageIgnore
 888          */
 889         public function setMockTime( &$time ) {
 890                 $this->wallClockOverride =& $time;
 891         }
 892 }