includes/objectcache/ObjectCache.php

   1 <?php
   2 /**
   3  * Functions to get cache objects.
   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
  24 use MediaWiki\Logger\LoggerFactory;
  25
  26 /**
  27  * Functions to get cache objects
  28  *
  29  * The word "cache" has two main dictionary meanings, and both
  30  * are used in this factory class. They are:
  31  *
  32  *   - a) Cache (the computer science definition).
  33  *        A place to store copies or computations on existing data for
  34  *        higher access speeds.
  35  *   - b) Storage.
  36  *        A place to store lightweight data that is not canonically
  37  *        stored anywhere else (e.g. a "hoard" of objects).
  38  *
  39  * The former should always use strongly consistent stores, so callers don't
  40  * have to deal with stale reads. The later may be eventually consistent, but
  41  * callers can use BagOStuff:READ_LATEST to see the latest available data.
  42  *
  43  * Primary entry points:
  44  *
  45  * - ObjectCache::newAccelerator( $fallbackType )
  46  *   Purpose: Cache for very hot keys.
  47  *   Stored only on the individual web server.
  48  *   Not associated with other servers.
  49  *
  50  * - ObjectCache::getMainWANInstance()
  51  *   Purpose: Cache.
  52  *   Stored in the local data-center's main cache (uses different cache keys).
  53  *   Delete events are broadcasted to other DCs. See WANObjectCache for details.
  54  *
  55  * - ObjectCache::getMainStashInstance()
  56  *   Purpose: Ephemeral storage.
  57  *   Stored centrally within the primary data-center.
  58  *   Changes are applied there first and replicated to other DCs (best-effort).
  59  *   To retrieve the latest value (e.g. not from a slave), use BagOStuff:READ_LATEST.
  60  *   This store may be subject to LRU style evictions.
  61  *
  62  * - ObjectCache::getLocalClusterInstance()
  63  *   Purpose: Memory storage for per-cluster coordination and tracking.
  64  *   A typical use case would be a rate limit counter or cache regeneration mutex.
  65  *   Stored centrally within the local data-center. Not replicated to other DCs.
  66  *   Also known as $wgMemc. Configured by $wgMainCacheType.
  67  *
  68  * - wfGetCache( $cacheType )
  69  *   Get a specific cache type by key in $wgObjectCaches.
  70  *
  71  * All the above cache instances (BagOStuff and WANObjectCache) have their makeKey()
  72  * method scoped to the *current* wiki ID. Use makeGlobalKey() to avoid this scoping
  73  * when using keys that need to be shared amongst wikis.
  74  *
  75  * @ingroup Cache
  76  */
  77 class ObjectCache {
  78         /** @var BagOStuff[] Map of (id => BagOStuff) */
  79         public static $instances = array();
  80         /** @var WANObjectCache[] Map of (id => WANObjectCache) */
  81         public static $wanInstances = array();
  82
  83         /**
  84          * Get a cached instance of the specified type of cache object.
  85          *
  86          * @param string $id A key in $wgObjectCaches.
  87          * @return BagOStuff
  88          */
  89         public static function getInstance( $id ) {
  90                 if ( !isset( self::$instances[$id] ) ) {
  91                         self::$instances[$id] = self::newFromId( $id );
  92                 }
  93
  94                 return self::$instances[$id];
  95         }
  96
  97         /**
  98          * Get a cached instance of the specified type of WAN cache object.
  99          *
 100          * @since 1.26
 101          * @param string $id A key in $wgWANObjectCaches.
 102          * @return WANObjectCache
 103          */
 104         public static function getWANInstance( $id ) {
 105                 if ( !isset( self::$wanInstances[$id] ) ) {
 106                         self::$wanInstances[$id] = self::newWANCacheFromId( $id );
 107                 }
 108
 109                 return self::$wanInstances[$id];
 110         }
 111
 112         /**
 113          * Create a new cache object of the specified type.
 114          *
 115          * @param string $id A key in $wgObjectCaches.
 116          * @return BagOStuff
 117          * @throws MWException
 118          */
 119         public static function newFromId( $id ) {
 120                 global $wgObjectCaches;
 121
 122                 if ( !isset( $wgObjectCaches[$id] ) ) {
 123                         throw new MWException( "Invalid object cache type \"$id\" requested. " .
 124                                 "It is not present in \$wgObjectCaches." );
 125                 }
 126
 127                 return self::newFromParams( $wgObjectCaches[$id] );
 128         }
 129
 130         /**
 131          * Get the default keyspace for this wiki.
 132          *
 133          * This is either the value of the `CachePrefix` configuration variable,
 134          * or (if the former is unset) the `DBname` configuration variable, with
 135          * `DBprefix` (if defined).
 136          *
 137          * @return string
 138          */
 139         public static function getDefaultKeyspace() {
 140                 global $wgCachePrefix, $wgDBname, $wgDBprefix;
 141
 142                 $keyspace = $wgCachePrefix;
 143                 if ( is_string( $keyspace ) && $keyspace !== '' ) {
 144                         return $keyspace;
 145                 }
 146
 147                 $keyspace = $wgDBname;
 148                 if ( is_string( $wgDBprefix ) && $wgDBprefix !== '' ) {
 149                         $keyspace .= '-' . $wgDBprefix;
 150                 }
 151
 152                 return $keyspace;
 153         }
 154
 155         /**
 156          * Create a new cache object from parameters.
 157          *
 158          * @param array $params Must have 'factory' or 'class' property.
 159          *  - factory: Callback passed $params that returns BagOStuff.
 160          *  - class: BagOStuff subclass constructed with $params.
 161          *  - loggroup: Alias to set 'logger' key with LoggerFactory group.
 162          *  - .. Other parameters passed to factory or class.
 163          * @return BagOStuff
 164          * @throws MWException
 165          */
 166         public static function newFromParams( $params ) {
 167                 if ( isset( $params['loggroup'] ) ) {
 168                         $params['logger'] = LoggerFactory::getInstance( $params['loggroup'] );
 169                 } else {
 170                         $params['logger'] = LoggerFactory::getInstance( 'objectcache' );
 171                 }
 172                 if ( !isset( $params['keyspace'] ) ) {
 173                         $params['keyspace'] = self::getDefaultKeyspace();
 174                 }
 175                 if ( isset( $params['factory'] ) ) {
 176                         return call_user_func( $params['factory'], $params );
 177                 } elseif ( isset( $params['class'] ) ) {
 178                         $class = $params['class'];
 179                         if ( $class === 'MultiWriteBagOStuff' && !isset( $params['asyncHandler'] ) ) {
 180                                 $params['asyncHandler'] = 'DeferredUpdates::addCallableUpdate';
 181                         }
 182                         return new $class( $params );
 183                 } else {
 184                         throw new MWException( "The definition of cache type \""
 185                                 . print_r( $params, true ) . "\" lacks both "
 186                                 . "factory and class parameters." );
 187                 }
 188         }
 189
 190         /**
 191          * Factory function for CACHE_ANYTHING (referenced from DefaultSettings.php)
 192          *
 193          * CACHE_ANYTHING means that stuff has to be cached, not caching is not an option.
 194          * If a caching method is configured for any of the main caches ($wgMainCacheType,
 195          * $wgMessageCacheType, $wgParserCacheType), then CACHE_ANYTHING will effectively
 196          * be an alias to the configured cache choice for that.
 197          * If no cache choice is configured (by default $wgMainCacheType is CACHE_NONE),
 198          * then CACHE_ANYTHING will forward to CACHE_DB.
 199          *
 200          * @param array $params
 201          * @return BagOStuff
 202          */
 203         public static function newAnything( $params ) {
 204                 global $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType;
 205                 $candidates = array( $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType );
 206                 foreach ( $candidates as $candidate ) {
 207                         if ( $candidate !== CACHE_NONE && $candidate !== CACHE_ANYTHING ) {
 208                                 return self::getInstance( $candidate );
 209                         }
 210                 }
 211                 return self::getInstance( CACHE_DB );
 212         }
 213
 214         /**
 215          * Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
 216          *
 217          * This will look for any APC style server-local cache.
 218          * A fallback cache can be specified if none is found.
 219          *
 220          *     // Direct calls
 221          *     ObjectCache::newAccelerator( $fallbackType );
 222          *
 223          *     // From $wgObjectCaches via newFromParams()
 224          *     ObjectCache::newAccelerator( array( 'fallback' => $fallbackType ) );
 225          *
 226          * @param array $params [optional] Array key 'fallback' for $fallback.
 227          * @param int|string $fallback Fallback cache, e.g. (CACHE_NONE, "hash") (since 1.24)
 228          * @return BagOStuff
 229          * @throws MWException
 230          */
 231         public static function newAccelerator( $params = array(), $fallback = null ) {
 232                 if ( $fallback === null ) {
 233                         // The is_array check here is needed because in PHP 5.3:
 234                         // $a = 'hash'; isset( $params['fallback'] ); yields true
 235                         if ( is_array( $params ) && isset( $params['fallback'] ) ) {
 236                                 $fallback = $params['fallback'];
 237                         } elseif ( !is_array( $params ) ) {
 238                                 $fallback = $params;
 239                         }
 240                 }
 241                 if ( function_exists( 'apc_fetch' ) ) {
 242                         $id = 'apc';
 243                 } elseif ( function_exists( 'xcache_get' ) && wfIniGetBool( 'xcache.var_size' ) ) {
 244                         $id = 'xcache';
 245                 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
 246                         $id = 'wincache';
 247                 } else {
 248                         if ( $fallback === null ) {
 249                                 throw new MWException( 'CACHE_ACCEL requested but no suitable object ' .
 250                                         'cache is present. You may want to install APC.' );
 251                         }
 252                         $id = $fallback;
 253                 }
 254                 return self::newFromId( $id );
 255         }
 256
 257         /**
 258          * Factory function that creates a memcached client object.
 259          *
 260          * This always uses the PHP client, since the PECL client has a different
 261          * hashing scheme and a different interpretation of the flags bitfield, so
 262          * switching between the two clients randomly would be disastrous.
 263          *
 264          * @param array $params
 265          * @return MemcachedPhpBagOStuff
 266          */
 267         public static function newMemcached( $params ) {
 268                 return new MemcachedPhpBagOStuff( $params );
 269         }
 270
 271         /**
 272          * Create a new cache object of the specified type.
 273          *
 274          * @since 1.26
 275          * @param string $id A key in $wgWANObjectCaches.
 276          * @return WANObjectCache
 277          * @throws MWException
 278          */
 279         public static function newWANCacheFromId( $id ) {
 280                 global $wgWANObjectCaches;
 281
 282                 if ( !isset( $wgWANObjectCaches[$id] ) ) {
 283                         throw new MWException( "Invalid object cache type \"$id\" requested. " .
 284                                 "It is not present in \$wgWANObjectCaches." );
 285                 }
 286
 287                 $params = $wgWANObjectCaches[$id];
 288                 $class = $params['relayerConfig']['class'];
 289                 $params['relayer'] = new $class( $params['relayerConfig'] );
 290                 $params['cache'] = self::newFromId( $params['cacheId'] );
 291                 if ( isset( $params['loggroup'] ) ) {
 292                         $params['logger'] = LoggerFactory::getInstance( $params['loggroup'] );
 293                 } else {
 294                         $params['logger'] = LoggerFactory::getInstance( 'objectcache' );
 295                 }
 296                 $class = $params['class'];
 297
 298                 return new $class( $params );
 299         }
 300
 301         /**
 302          * Get the main cluster-local cache object.
 303          *
 304          * @since 1.27
 305          * @return BagOStuff
 306          */
 307         public static function getLocalClusterInstance() {
 308                 global $wgMainCacheType;
 309
 310                 return self::getInstance( $wgMainCacheType );
 311         }
 312
 313         /**
 314          * Get the main WAN cache object.
 315          *
 316          * @since 1.26
 317          * @return WANObjectCache
 318          */
 319         public static function getMainWANInstance() {
 320                 global $wgMainWANCache;
 321
 322                 return self::getWANInstance( $wgMainWANCache );
 323         }
 324
 325         /**
 326          * Get the cache object for the main stash.
 327          *
 328          * Stash objects are BagOStuff instances suitable for storing light
 329          * weight data that is not canonically stored elsewhere (such as RDBMS).
 330          * Stashes should be configured to propagate changes to all data-centers.
 331          *
 332          * Callers should be prepared for:
 333          *   - a) Writes to be slower in non-"primary" (e.g. HTTP GET/HEAD only) DCs
 334          *   - b) Reads to be eventually consistent, e.g. for get()/getMulti()
 335          * In general, this means avoiding updates on idempotent HTTP requests and
 336          * avoiding an assumption of perfect serializability (or accepting anomalies).
 337          * Reads may be eventually consistent or data might rollback as nodes flap.
 338          * Callers can use BagOStuff:READ_LATEST to see the latest available data.
 339          *
 340          * @return BagOStuff
 341          * @since 1.26
 342          */
 343         public static function getMainStashInstance() {
 344                 global $wgMainStash;
 345
 346                 return self::getInstance( $wgMainStash );
 347         }
 348
 349         /**
 350          * Clear all the cached instances.
 351          */
 352         public static function clear() {
 353                 self::$instances = array();
 354                 self::$wanInstances = array();
 355         }
 356 }