includes/libs/objectcache/MultiWriteBagOStuff.php

   1 <?php
   2 /**
   3  * Wrapper for object caching in different caches.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Cache
  22  */
  23 use Wikimedia\ObjectFactory;
  24
  25 /**
  26  * A cache class that replicates all writes to multiple child caches. Reads
  27  * are implemented by reading from the caches in the order they are given in
  28  * the configuration until a cache gives a positive result.
  29  *
  30  * Note that cache key construction will use the first cache backend in the list,
  31  * so make sure that the other backends can handle such keys (e.g. via encoding).
  32  *
  33  * @ingroup Cache
  34  */
  35 class MultiWriteBagOStuff extends BagOStuff {
  36         /** @var BagOStuff[] */
  37         protected $caches;
  38         /** @var bool Use async secondary writes */
  39         protected $asyncWrites = false;
  40         /** @var int[] List of all backing cache indexes */
  41         protected $cacheIndexes = [];
  42
  43         /** @var int TTL when a key is copied to a higher cache tier */
  44         private static $UPGRADE_TTL = 3600;
  45
  46         /**
  47          * $params include:
  48          *   - caches: A numbered array of either ObjectFactory::getObjectFromSpec
  49          *      arrays yeilding BagOStuff objects or direct BagOStuff objects.
  50          *      If using the former, the 'args' field *must* be set.
  51          *      The first cache is the primary one, being the first to
  52          *      be read in the fallback chain. Writes happen to all stores
  53          *      in the order they are defined. However, lock()/unlock() calls
  54          *      only use the primary store.
  55          *   - replication: Either 'sync' or 'async'. This controls whether writes
  56          *      to secondary stores are deferred when possible. Async writes
  57          *      require setting 'asyncHandler'. HHVM register_postsend_function() function.
  58          *      Async writes can increase the chance of some race conditions
  59          *      or cause keys to expire seconds later than expected. It is
  60          *      safe to use for modules when cached values: are immutable,
  61          *      invalidation uses logical TTLs, invalidation uses etag/timestamp
  62          *      validation against the DB, or merge() is used to handle races.
  63          * @param array $params
  64          * @throws InvalidArgumentException
  65          */
  66         public function __construct( $params ) {
  67                 parent::__construct( $params );
  68
  69                 if ( empty( $params['caches'] ) || !is_array( $params['caches'] ) ) {
  70                         throw new InvalidArgumentException(
  71                                 __METHOD__ . ': "caches" parameter must be an array of caches'
  72                         );
  73                 }
  74
  75                 $this->caches = [];
  76                 foreach ( $params['caches'] as $cacheInfo ) {
  77                         if ( $cacheInfo instanceof BagOStuff ) {
  78                                 $this->caches[] = $cacheInfo;
  79                         } else {
  80                                 if ( !isset( $cacheInfo['args'] ) ) {
  81                                         // B/C for when $cacheInfo was for ObjectCache::newFromParams().
  82                                         // Callers intenting this to be for ObjectFactory::getObjectFromSpec
  83                                         // should have set "args" per the docs above. Doings so avoids extra
  84                                         // (likely harmless) params (factory/class/calls) ending up in "args".
  85                                         $cacheInfo['args'] = [ $cacheInfo ];
  86                                 }
  87                                 $this->caches[] = ObjectFactory::getObjectFromSpec( $cacheInfo );
  88                         }
  89                 }
  90                 $this->mergeFlagMaps( $this->caches );
  91
  92                 $this->asyncWrites = (
  93                         isset( $params['replication'] ) &&
  94                         $params['replication'] === 'async' &&
  95                         is_callable( $this->asyncHandler )
  96                 );
  97
  98                 $this->cacheIndexes = array_keys( $this->caches );
  99         }
 100
 101         public function setDebug( $enabled ) {
 102                 parent::setDebug( $enabled );
 103                 foreach ( $this->caches as $cache ) {
 104                         $cache->setDebug( $enabled );
 105                 }
 106         }
 107
 108         public function get( $key, $flags = 0 ) {
 109                 if ( ( $flags & self::READ_LATEST ) == self::READ_LATEST ) {
 110                         // If the latest write was a delete(), we do NOT want to fallback
 111                         // to the other tiers and possibly see the old value. Also, this
 112                         // is used by merge(), which only needs to hit the primary.
 113                         return $this->caches[0]->get( $key, $flags );
 114                 }
 115
 116                 $value = false;
 117                 $missIndexes = []; // backends checked
 118                 foreach ( $this->caches as $i => $cache ) {
 119                         $value = $cache->get( $key, $flags );
 120                         if ( $value !== false ) {
 121                                 break;
 122                         }
 123                         $missIndexes[] = $i;
 124                 }
 125
 126                 if ( $value !== false
 127                         && $missIndexes
 128                         && ( $flags & self::READ_VERIFIED ) == self::READ_VERIFIED
 129                 ) {
 130                         // Backfill the value to the higher (and often faster/smaller) cache tiers
 131                         $this->doWrite(
 132                                 $missIndexes,
 133                                 $this->asyncWrites,
 134                                 'set',
 135                                 // @TODO: consider using self::WRITE_ALLOW_SEGMENTS here?
 136                                 [ $key, $value, self::$UPGRADE_TTL ]
 137                         );
 138                 }
 139
 140                 return $value;
 141         }
 142
 143         public function set( $key, $value, $exptime = 0, $flags = 0 ) {
 144                 return $this->doWrite(
 145                         $this->cacheIndexes,
 146                         $this->usesAsyncWritesGivenFlags( $flags ),
 147                         __FUNCTION__,
 148                         func_get_args()
 149                 );
 150         }
 151
 152         public function delete( $key, $flags = 0 ) {
 153                 return $this->doWrite(
 154                         $this->cacheIndexes,
 155                         $this->usesAsyncWritesGivenFlags( $flags ),
 156                         __FUNCTION__,
 157                         func_get_args()
 158                 );
 159         }
 160
 161         public function add( $key, $value, $exptime = 0, $flags = 0 ) {
 162                 // Try the write to the top-tier cache
 163                 $ok = $this->doWrite(
 164                         [ 0 ],
 165                         $this->usesAsyncWritesGivenFlags( $flags ),
 166                         __FUNCTION__,
 167                         func_get_args()
 168                 );
 169
 170                 if ( $ok ) {
 171                         // Relay the add() using set() if it succeeded. This is meant to handle certain
 172                         // migration scenarios where the same store might get written to twice for certain
 173                         // keys. In that case, it does not make sense to return false due to "self-conflicts".
 174                         return $this->doWrite(
 175                                 array_slice( $this->cacheIndexes, 1 ),
 176                                 $this->usesAsyncWritesGivenFlags( $flags ),
 177                                 'set',
 178                                 [ $key, $value, $exptime, $flags ]
 179                         );
 180                 }
 181
 182                 return false;
 183         }
 184
 185         public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
 186                 return $this->doWrite(
 187                         $this->cacheIndexes,
 188                         $this->usesAsyncWritesGivenFlags( $flags ),
 189                         __FUNCTION__,
 190                         func_get_args()
 191                 );
 192         }
 193
 194         public function changeTTL( $key, $exptime = 0, $flags = 0 ) {
 195                 return $this->doWrite(
 196                         $this->cacheIndexes,
 197                         $this->usesAsyncWritesGivenFlags( $flags ),
 198                         __FUNCTION__,
 199                         func_get_args()
 200                 );
 201         }
 202
 203         public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
 204                 // Only need to lock the first cache; also avoids deadlocks
 205                 return $this->caches[0]->lock( $key, $timeout, $expiry, $rclass );
 206         }
 207
 208         public function unlock( $key ) {
 209                 // Only the first cache is locked
 210                 return $this->caches[0]->unlock( $key );
 211         }
 212
 213         public function deleteObjectsExpiringBefore(
 214                 $timestamp,
 215                 callable $progress = null,
 216                 $limit = INF
 217         ) {
 218                 $ret = false;
 219                 foreach ( $this->caches as $cache ) {
 220                         if ( $cache->deleteObjectsExpiringBefore( $timestamp, $progress, $limit ) ) {
 221                                 $ret = true;
 222                         }
 223                 }
 224
 225                 return $ret;
 226         }
 227
 228         public function getMulti( array $keys, $flags = 0 ) {
 229                 // Just iterate over each key in order to handle all the backfill logic
 230                 $res = [];
 231                 foreach ( $keys as $key ) {
 232                         $val = $this->get( $key, $flags );
 233                         if ( $val !== false ) {
 234                                 $res[$key] = $val;
 235                         }
 236                 }
 237
 238                 return $res;
 239         }
 240
 241         public function setMulti( array $data, $exptime = 0, $flags = 0 ) {
 242                 return $this->doWrite(
 243                         $this->cacheIndexes,
 244                         $this->usesAsyncWritesGivenFlags( $flags ),
 245                         __FUNCTION__,
 246                         func_get_args()
 247                 );
 248         }
 249
 250         public function deleteMulti( array $data, $flags = 0 ) {
 251                 return $this->doWrite(
 252                         $this->cacheIndexes,
 253                         $this->usesAsyncWritesGivenFlags( $flags ),
 254                         __FUNCTION__,
 255                         func_get_args()
 256                 );
 257         }
 258
 259         public function changeTTLMulti( array $keys, $exptime, $flags = 0 ) {
 260                 return $this->doWrite(
 261                         $this->cacheIndexes,
 262                         $this->usesAsyncWritesGivenFlags( $flags ),
 263                         __FUNCTION__,
 264                         func_get_args()
 265                 );
 266         }
 267
 268         public function incr( $key, $value = 1 ) {
 269                 return $this->doWrite(
 270                         $this->cacheIndexes,
 271                         $this->asyncWrites,
 272                         __FUNCTION__,
 273                         func_get_args()
 274                 );
 275         }
 276
 277         public function decr( $key, $value = 1 ) {
 278                 return $this->doWrite(
 279                         $this->cacheIndexes,
 280                         $this->asyncWrites,
 281                         __FUNCTION__,
 282                         func_get_args()
 283                 );
 284         }
 285
 286         public function incrWithInit( $key, $ttl, $value = 1, $init = 1 ) {
 287                 return $this->doWrite(
 288                         $this->cacheIndexes,
 289                         $this->asyncWrites,
 290                         __FUNCTION__,
 291                         func_get_args()
 292                 );
 293         }
 294
 295         public function getLastError() {
 296                 return $this->caches[0]->getLastError();
 297         }
 298
 299         public function clearLastError() {
 300                 $this->caches[0]->clearLastError();
 301         }
 302
 303         /**
 304          * Apply a write method to the backing caches specified by $indexes (in order)
 305          *
 306          * @param int[] $indexes List of backing cache indexes
 307          * @param bool $asyncWrites
 308          * @param string $method Method name of backing caches
 309          * @param array $args Arguments to the method of backing caches
 310          * @return bool
 311          */
 312         protected function doWrite( $indexes, $asyncWrites, $method, array $args ) {
 313                 $ret = true;
 314
 315                 if ( array_diff( $indexes, [ 0 ] ) && $asyncWrites && $method !== 'merge' ) {
 316                         // Deep-clone $args to prevent misbehavior when something writes an
 317                         // object to the BagOStuff then modifies it afterwards, e.g. T168040.
 318                         $args = unserialize( serialize( $args ) );
 319                 }
 320
 321                 foreach ( $indexes as $i ) {
 322                         $cache = $this->caches[$i];
 323                         if ( $i == 0 || !$asyncWrites ) {
 324                                 // First store or in sync mode: write now and get result
 325                                 if ( !$cache->$method( ...$args ) ) {
 326                                         $ret = false;
 327                                 }
 328                         } else {
 329                                 // Secondary write in async mode: do not block this HTTP request
 330                                 $logger = $this->logger;
 331                                 ( $this->asyncHandler )(
 332                                         function () use ( $cache, $method, $args, $logger ) {
 333                                                 if ( !$cache->$method( ...$args ) ) {
 334                                                         $logger->warning( "Async $method op failed" );
 335                                                 }
 336                                         }
 337                                 );
 338                         }
 339                 }
 340
 341                 return $ret;
 342         }
 343
 344         /**
 345          * @param int $flags
 346          * @return bool
 347          */
 348         protected function usesAsyncWritesGivenFlags( $flags ) {
 349                 return ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) ? false : $this->asyncWrites;
 350         }
 351
 352         public function makeKeyInternal( $keyspace, $args ) {
 353                 return $this->caches[0]->makeKeyInternal( ...func_get_args() );
 354         }
 355
 356         public function makeKey( $class, $component = null ) {
 357                 return $this->caches[0]->makeKey( ...func_get_args() );
 358         }
 359
 360         public function makeGlobalKey( $class, $component = null ) {
 361                 return $this->caches[0]->makeGlobalKey( ...func_get_args() );
 362         }
 363
 364         public function addBusyCallback( callable $workCallback ) {
 365                 $this->caches[0]->addBusyCallback( $workCallback );
 366         }
 367
 368         public function setMockTime( &$time ) {
 369                 parent::setMockTime( $time );
 370                 foreach ( $this->caches as $cache ) {
 371                         $cache->setMockTime( $time );
 372                         $cache->setMockTime( $time );
 373                 }
 374         }
 375 }