Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
19.41% covered (danger)
19.41%
73 / 376
13.04% covered (danger)
13.04%
6 / 46
CRAP
0.00% covered (danger)
0.00%
0 / 1
MediumSpecificBagOStuff
19.47% covered (danger)
19.47%
73 / 375
13.04% covered (danger)
13.04%
6 / 46
10823.68
0.00% covered (danger)
0.00%
0 / 1
 __construct
80.00% covered (warning)
80.00%
4 / 5
0.00% covered (danger)
0.00%
0 / 1
3.07
 get
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 trackDuplicateKeys
13.33% covered (danger)
13.33%
2 / 15
0.00% covered (danger)
0.00%
0 / 1
21.27
 doGet
n/a
0 / 0
n/a
0 / 0
0
 set
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
 doSet
n/a
0 / 0
n/a
0 / 0
0
 delete
14.29% covered (danger)
14.29%
2 / 14
0.00% covered (danger)
0.00%
0 / 1
14.08
 doDelete
n/a
0 / 0
n/a
0 / 0
0
 add
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
6
 doAdd
n/a
0 / 0
n/a
0 / 0
0
 merge
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 mergeViaCas
0.00% covered (danger)
0.00%
0 / 34
0.00% covered (danger)
0.00%
0 / 1
90
 cas
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
12
 doCas
0.00% covered (danger)
0.00%
0 / 20
0.00% covered (danger)
0.00%
0 / 1
30
 tokensMatch
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
20
 changeTTL
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 doChangeTTL
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
30
 incrWithInit
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 doIncrWithInit
n/a
0 / 0
n/a
0 / 0
0
 lock
0.00% covered (danger)
0.00%
0 / 16
0.00% covered (danger)
0.00%
0 / 1
42
 doLock
0.00% covered (danger)
0.00%
0 / 25
0.00% covered (danger)
0.00%
0 / 1
20
 unlock
0.00% covered (danger)
0.00%
0 / 16
0.00% covered (danger)
0.00%
0 / 1
20
 doUnlock
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
12
 makeLockKey
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 deleteObjectsExpiringBefore
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getMulti
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
20
 doGetMulti
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 setMulti
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 doSetMulti
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
12
 deleteMulti
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 doDeleteMulti
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
12
 changeTTLMulti
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 doChangeTTLMulti
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
12
 resolveSegments
13.33% covered (danger)
13.33%
2 / 15
0.00% covered (danger)
0.00%
0 / 1
14.42
 useSegmentationWrapper
30.00% covered (danger)
30.00%
3 / 10
0.00% covered (danger)
0.00%
0 / 1
29.95
 makeValueOrSegmentList
16.00% covered (danger)
16.00%
4 / 25
0.00% covered (danger)
0.00%
0 / 1
19.82
 isRelativeExpiration
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
2
 getExpirationAsTimestamp
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
3
 getExpirationAsTTL
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
 isInteger
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 getQoS
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getSegmentationSize
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 getSegmentedValueMaxSize
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 getSerialized
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 checkValueSerializability
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
30
 checkIterableMapSerializability
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
30
 serialize
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
6
 unserialize
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
6
 debug
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 determinekeyGroupForStats
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 updateOpStats
89.36% covered (warning)
89.36%
42 / 47
0.00% covered (danger)
0.00%
0 / 1
8.08
1<?php
2/**
3 * Storage medium specific cache for storing items.
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
24namespace Wikimedia\ObjectCache;
25
26use InvalidArgumentException;
27use JsonSerializable;
28use SerializedValueContainer;
29use stdClass;
30use Wikimedia\WaitConditionLoop;
31
32/**
33 * Storage medium specific cache for storing items (e.g. redis, memcached, ...)
34 *
35 * This should not be used for proxy classes that simply wrap other cache instances
36 *
37 * @ingroup Cache
38 * @since 1.34
39 */
40abstract class MediumSpecificBagOStuff extends BagOStuff {
41    /** @var array<string,array> Map of (key => (class LOCK_* constant => value) */
42    protected $locks = [];
43    /** @var int Bytes; chunk size of segmented cache values */
44    protected $segmentationSize;
45    /** @var int Bytes; maximum total size of a segmented cache value */
46    protected $segmentedValueMaxSize;
47
48    /** @var float Seconds; maximum expected seconds for a lock ping to reach the backend */
49    protected $maxLockSendDelay = 0.05;
50
51    /** @var array */
52    private $duplicateKeyLookups = [];
53    /** @var bool */
54    private $reportDupes = false;
55    /** @var bool */
56    private $dupeTrackScheduled = false;
57
58    /** Component to use for key construction of blob segment keys */
59    private const SEGMENT_COMPONENT = 'segment';
60
61    /** Idiom for doGet() to return extra information by reference */
62    protected const PASS_BY_REF = -1;
63
64    protected const METRIC_OP_GET = 'get';
65    protected const METRIC_OP_SET = 'set';
66    protected const METRIC_OP_DELETE = 'delete';
67    protected const METRIC_OP_CHANGE_TTL = 'change_ttl';
68    protected const METRIC_OP_ADD = 'add';
69    protected const METRIC_OP_INCR = 'incr';
70    protected const METRIC_OP_DECR = 'decr';
71    protected const METRIC_OP_CAS = 'cas';
72
73    protected const LOCK_RCLASS = 0;
74    protected const LOCK_DEPTH = 1;
75    protected const LOCK_TIME = 2;
76    protected const LOCK_EXPIRY = 3;
77
78    /**
79     * @see BagOStuff::__construct()
80     * Additional $params options include:
81     *   - logger: Psr\Log\LoggerInterface instance
82     *   - reportDupes: Whether to emit warning log messages for all keys that were
83     *      requested more than once (requires an asyncHandler).
84     *   - segmentationSize: The chunk size, in bytes, of segmented values. The value should
85     *      not exceed the maximum size of values in the storage backend, as configured by
86     *      the site administrator.
87     *   - segmentedValueMaxSize: The maximum total size, in bytes, of segmented values.
88     *      This should be configured to a reasonable size give the site traffic and the
89     *      amount of I/O between application and cache servers that the network can handle.
90     *
91     * @param array $params
92     *
93     * @phpcs:ignore Generic.Files.LineLength
94     * @phan-param array{logger?:\Psr\Log\LoggerInterface,asyncHandler?:callable,reportDupes?:bool,segmentationSize?:int|float,segmentedValueMaxSize?:int} $params
95     */
96    public function __construct( array $params = [] ) {
97        parent::__construct( $params );
98
99        if ( !empty( $params['reportDupes'] ) && $this->asyncHandler ) {
100            $this->reportDupes = true;
101        }
102
103        // Default to 8MiB if segmentationSize is not set
104        $this->segmentationSize = $params['segmentationSize'] ?? 8_388_608;
105        // Default to 64MiB if segmentedValueMaxSize is not set
106        $this->segmentedValueMaxSize = $params['segmentedValueMaxSize'] ?? 67_108_864;
107    }
108
109    /**
110     * Get an item with the given key
111     *
112     * If the key includes a deterministic input hash (e.g. the key can only have
113     * the correct value) or complete staleness checks are handled by the caller
114     * (e.g. nothing relies on the TTL), then the READ_VERIFIED flag should be set.
115     * This lets tiered backends know they can safely upgrade a cached value to
116     * higher tiers using standard TTLs.
117     *
118     * @param string $key
119     * @param int $flags Bitfield of BagOStuff::READ_* constants [optional]
120     *
121     * @return mixed Returns false on failure or if the item does not exist
122     */
123    public function get( $key, $flags = 0 ) {
124        $this->trackDuplicateKeys( $key );
125
126        return $this->resolveSegments( $key, $this->doGet( $key, $flags ) );
127    }
128
129    /**
130     * Track the number of times that a given key has been used.
131     *
132     * @param string $key
133     */
134    private function trackDuplicateKeys( $key ) {
135        if ( !$this->reportDupes ) {
136            return;
137        }
138
139        if ( !isset( $this->duplicateKeyLookups[$key] ) ) {
140            // Track that we have seen this key. This N-1 counting style allows
141            // easy filtering with array_filter() later.
142            $this->duplicateKeyLookups[$key] = 0;
143        } else {
144            $this->duplicateKeyLookups[$key] += 1;
145
146            if ( $this->dupeTrackScheduled === false ) {
147                $this->dupeTrackScheduled = true;
148                // Schedule a callback that logs keys processed more than once by get().
149                call_user_func( $this->asyncHandler, function () {
150                    $dups = array_filter( $this->duplicateKeyLookups );
151                    foreach ( $dups as $key => $count ) {
152                        $this->logger->warning(
153                            'Duplicate get(): "{key}" fetched {count} times',
154                            // Count is N-1 of the actual lookup count
155                            [ 'key' => $key, 'count' => $count + 1, ]
156                        );
157                    }
158                } );
159            }
160        }
161    }
162
163    /**
164     * Get an item
165     *
166     * The CAS token should be null if the key does not exist or the value is corrupt
167     *
168     * @param string $key
169     * @param int $flags Bitfield of BagOStuff::READ_* constants [optional]
170     * @param mixed &$casToken CAS token if MediumSpecificBagOStuff::PASS_BY_REF [returned]
171     *
172     * @return mixed Returns false on failure or if the item does not exist
173     */
174    abstract protected function doGet( $key, $flags = 0, &$casToken = null );
175
176    /**
177     * Set an item
178     *
179     * @param string $key
180     * @param mixed $value
181     * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
182     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
183     *
184     * @return bool Success
185     */
186    public function set( $key, $value, $exptime = 0, $flags = 0 ) {
187        $entry = $this->makeValueOrSegmentList( $key, $value, $exptime, $flags, $ok );
188
189        // Only when all segments (if any) are stored should the main key be changed
190        return $ok && $this->doSet( $key, $entry, $exptime, $flags );
191    }
192
193    /**
194     * Set an item
195     *
196     * @param string $key
197     * @param mixed $value
198     * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
199     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
200     *
201     * @return bool Success
202     */
203    abstract protected function doSet( $key, $value, $exptime = 0, $flags = 0 );
204
205    /**
206     * Delete an item
207     *
208     * For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main
209     * segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment
210     * list key has the effect of functionally deleting the key, it leaves unused blobs in cache.
211     *
212     * @param string $key
213     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
214     *
215     * @return bool True if the item was deleted or not found, false on failure
216     */
217    public function delete( $key, $flags = 0 ) {
218        if ( !$this->fieldHasFlags( $flags, self::WRITE_PRUNE_SEGMENTS ) ) {
219            return $this->doDelete( $key, $flags );
220        }
221
222        $mainValue = $this->doGet( $key, self::READ_LATEST );
223        if ( !$this->doDelete( $key, $flags ) ) {
224            return false;
225        }
226
227        if ( !SerializedValueContainer::isSegmented( $mainValue ) ) {
228            // no segments to delete
229            return true;
230        }
231
232        $orderedKeys = array_map(
233            function ( $segmentHash ) use ( $key ) {
234                return $this->makeGlobalKey( self::SEGMENT_COMPONENT, $key, $segmentHash );
235            },
236            $mainValue->{SerializedValueContainer::SEGMENTED_HASHES}
237        );
238
239        return $this->deleteMulti( $orderedKeys, $flags & ~self::WRITE_PRUNE_SEGMENTS );
240    }
241
242    /**
243     * Delete an item
244     *
245     * @param string $key
246     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
247     *
248     * @return bool True if the item was deleted or not found, false on failure
249     */
250    abstract protected function doDelete( $key, $flags = 0 );
251
252    public function add( $key, $value, $exptime = 0, $flags = 0 ) {
253        $entry = $this->makeValueOrSegmentList( $key, $value, $exptime, $flags, $ok );
254
255        // Only when all segments (if any) are stored should the main key be changed
256        return $ok && $this->doAdd( $key, $entry, $exptime, $flags );
257    }
258
259    /**
260     * Insert an item if it does not already exist
261     *
262     * @param string $key
263     * @param mixed $value
264     * @param int $exptime
265     * @param int $flags Bitfield of BagOStuff::WRITE_* constants (since 1.33)
266     *
267     * @return bool Success
268     */
269    abstract protected function doAdd( $key, $value, $exptime = 0, $flags = 0 );
270
271    /**
272     * Merge changes into the existing cache value (possibly creating a new one)
273     *
274     * The callback function returns the new value given the current value
275     * (which will be false if not present), and takes the arguments:
276     * (this BagOStuff, cache key, current value, TTL).
277     * The TTL parameter is reference set to $exptime. It can be overridden in the callback.
278     * Nothing is stored nor deleted if the callback returns false.
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     *
286     * @return bool Success
287     */
288    public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
289        return $this->mergeViaCas( $key, $callback, $exptime, $attempts, $flags );
290    }
291
292    /**
293     * @param string $key
294     * @param callable $callback Callback method to be executed
295     * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
296     * @param int $attempts The amount of times to attempt a merge in case of failure
297     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
298     *
299     * @return bool Success
300     * @see BagOStuff::merge()
301     */
302    final protected function mergeViaCas( $key, callable $callback, $exptime, $attempts, $flags ) {
303        $attemptsLeft = $attempts;
304        do {
305            $token = self::PASS_BY_REF;
306            // Get the old value and CAS token from cache
307            $watchPoint = $this->watchErrors();
308            $currentValue = $this->resolveSegments(
309                $key,
310                $this->doGet( $key, $flags, $token )
311            );
312            if ( $this->getLastError( $watchPoint ) ) {
313                // Don't spam slow retries due to network problems (retry only on races)
314                $this->logger->warning(
315                    __METHOD__ . ' failed due to read I/O error on get() for {key}.', [ 'key' => $key ]
316                );
317                $success = false;
318                break;
319            }
320
321            // Derive the new value from the old value
322            $value = $callback( $this, $key, $currentValue, $exptime );
323            $keyWasNonexistent = ( $currentValue === false );
324            $valueMatchesOldValue = ( $value === $currentValue );
325            // free RAM in case the value is large
326            unset( $currentValue );
327
328            $watchPoint = $this->watchErrors();
329            if ( $value === false || $exptime < 0 ) {
330                // do nothing
331                $success = true;
332            } elseif ( $valueMatchesOldValue && $attemptsLeft !== $attempts ) {
333                // recently set by another thread to the same value
334                $success = true;
335            } elseif ( $keyWasNonexistent ) {
336                // Try to create the key, failing if it gets created in the meantime
337                $success = $this->add( $key, $value, $exptime, $flags );
338            } else {
339                // Try to update the key, failing if it gets changed in the meantime
340                $success = $this->cas( $token, $key, $value, $exptime, $flags );
341            }
342            if ( $this->getLastError( $watchPoint ) ) {
343                // Don't spam slow retries due to network problems (retry only on races)
344                $this->logger->warning(
345                    __METHOD__ . ' failed due to write I/O error for {key}.',
346                    [ 'key' => $key ]
347                );
348                $success = false;
349                break;
350            }
351
352        } while ( !$success && --$attemptsLeft );
353
354        return $success;
355    }
356
357    /**
358     * Set an item if the current CAS token matches the provided CAS token
359     *
360     * @param mixed $casToken Only set the item if it still has this CAS token
361     * @param string $key
362     * @param mixed $value
363     * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
364     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
365     *
366     * @return bool Success
367     */
368    protected function cas( $casToken, $key, $value, $exptime = 0, $flags = 0 ) {
369        if ( $casToken === null ) {
370            $this->logger->warning(
371                __METHOD__ . ' got empty CAS token for {key}.',
372                [ 'key' => $key ]
373            );
374
375            // caller may have meant to use add()?
376            return false;
377        }
378
379        $entry = $this->makeValueOrSegmentList( $key, $value, $exptime, $flags, $ok );
380
381        // Only when all segments (if any) are stored should the main key be changed
382        return $ok && $this->doCas( $casToken, $key, $entry, $exptime, $flags );
383    }
384
385    /**
386     * Set an item if the current CAS token matches the provided CAS token
387     *
388     * @param mixed $casToken CAS token from an existing version of the key
389     * @param string $key
390     * @param mixed $value
391     * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
392     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
393     *
394     * @return bool Success
395     */
396    protected function doCas( $casToken, $key, $value, $exptime = 0, $flags = 0 ) {
397        // @TODO: the use of lock() assumes that all other relevant sets() use a lock
398        if ( !$this->lock( $key, 0 ) ) {
399            // non-blocking
400            return false;
401        }
402
403        $curCasToken = self::PASS_BY_REF;
404        $watchPoint = $this->watchErrors();
405        $exists = ( $this->doGet( $key, self::READ_LATEST, $curCasToken ) !== false );
406        if ( $this->getLastError( $watchPoint ) ) {
407            // Fail if the old CAS token could not be read
408            $success = false;
409            $this->logger->warning(
410                __METHOD__ . ' failed due to write I/O error for {key}.',
411                [ 'key' => $key ]
412            );
413        } elseif ( $exists && $this->tokensMatch( $casToken, $curCasToken ) ) {
414            $success = $this->doSet( $key, $value, $exptime, $flags );
415        } else {
416            // mismatched or failed
417            $success = false;
418            $this->logger->info(
419                __METHOD__ . ' failed due to race condition for {key}.',
420                [ 'key' => $key, 'key_exists' => $exists ]
421            );
422        }
423
424        $this->unlock( $key );
425
426        return $success;
427    }
428
429    /**
430     * @param mixed $value CAS token for an existing key
431     * @param mixed $otherValue CAS token for an existing key
432     *
433     * @return bool Whether the two tokens match
434     */
435    final protected function tokensMatch( $value, $otherValue ) {
436        $type = gettype( $value );
437        // Ideally, tokens are counters, timestamps, hashes, or serialized PHP values.
438        // However, some classes might use the PHP values themselves.
439        if ( $type !== gettype( $otherValue ) ) {
440            return false;
441        }
442        // Serialize both tokens to strictly compare objects or arrays (which might objects
443        // nested inside). Note that this will not apply if integer/string CAS tokens are used.
444        if ( $type === 'array' || $type === 'object' ) {
445            return ( serialize( $value ) === serialize( $otherValue ) );
446        }
447
448        // For string/integer tokens, use a simple comparison
449        return ( $value === $otherValue );
450    }
451
452    /**
453     * Change the expiration on a key if it exists
454     *
455     * If an expiry in the past is given then the key will immediately be expired
456     *
457     * For large values written using WRITE_ALLOW_SEGMENTS, this only changes the TTL of the
458     * main segment list key. While lowering the TTL of the segment list key has the effect of
459     * functionally lowering the TTL of the key, it might leave unused blobs in cache for longer.
460     * Raising the TTL of such keys is not effective, since the expiration of a single segment
461     * key effectively expires the entire value.
462     *
463     * @param string $key
464     * @param int $exptime TTL or UNIX timestamp
465     * @param int $flags Bitfield of BagOStuff::WRITE_* constants (since 1.33)
466     *
467     * @return bool Success Returns false on failure or if the item does not exist
468     * @since 1.28
469     */
470    public function changeTTL( $key, $exptime = 0, $flags = 0 ) {
471        return $this->doChangeTTL( $key, $exptime, $flags );
472    }
473
474    /**
475     * @param string $key
476     * @param int $exptime
477     * @param int $flags
478     *
479     * @return bool
480     */
481    protected function doChangeTTL( $key, $exptime, $flags ) {
482        // @TODO: the use of lock() assumes that all other relevant sets() use a lock
483        if ( !$this->lock( $key, 0 ) ) {
484            return false;
485        }
486
487        $expiry = $this->getExpirationAsTimestamp( $exptime );
488        $delete = ( $expiry != self::TTL_INDEFINITE && $expiry < $this->getCurrentTime() );
489
490        // Use doGet() to avoid having to trigger resolveSegments()
491        $blob = $this->doGet( $key, self::READ_LATEST );
492        if ( $blob ) {
493            if ( $delete ) {
494                $ok = $this->doDelete( $key, $flags );
495            } else {
496                $ok = $this->doSet( $key, $blob, $exptime, $flags );
497            }
498        } else {
499            $ok = false;
500        }
501
502        $this->unlock( $key );
503
504        return $ok;
505    }
506
507    public function incrWithInit( $key, $exptime, $step = 1, $init = null, $flags = 0 ) {
508        $step = (int)$step;
509        $init = is_int( $init ) ? $init : $step;
510
511        return $this->doIncrWithInit( $key, $exptime, $step, $init, $flags );
512    }
513
514    /**
515     * @param string $key
516     * @param int $exptime
517     * @param int $step
518     * @param int $init
519     * @param int $flags
520     *
521     * @return int|bool New value or false on failure
522     */
523    abstract protected function doIncrWithInit( $key, $exptime, $step, $init, $flags );
524
525    /**
526     * @param string $key
527     * @param int $timeout
528     * @param int $exptime
529     * @param string $rclass
530     *
531     * @return bool
532     */
533    public function lock( $key, $timeout = 6, $exptime = 6, $rclass = '' ) {
534        $exptime = min( $exptime ?: INF, self::TTL_DAY );
535
536        $acquired = false;
537
538        if ( isset( $this->locks[$key] ) ) {
539            // Already locked; avoid deadlocks and allow lock reentry if specified
540            if ( $rclass != '' && $this->locks[$key][self::LOCK_RCLASS] === $rclass ) {
541                ++$this->locks[$key][self::LOCK_DEPTH];
542                $acquired = true;
543            }
544        } else {
545            // Not already locked; acquire a lock on the backend
546            $lockTsUnix = $this->doLock( $key, $timeout, $exptime );
547            if ( $lockTsUnix !== null ) {
548                $this->locks[$key] = [
549                    self::LOCK_RCLASS => $rclass,
550                    self::LOCK_DEPTH  => 1,
551                    self::LOCK_TIME   => $lockTsUnix,
552                    self::LOCK_EXPIRY => $lockTsUnix + $exptime
553                ];
554                $acquired = true;
555            }
556        }
557
558        return $acquired;
559    }
560
561    /**
562     * @see MediumSpecificBagOStuff::lock()
563     *
564     * @param string $key
565     * @param int $timeout Lock wait timeout; 0 for non-blocking [optional]
566     * @param int $exptime Lock time-to-live 1 day maximum [optional]
567     *
568     * @return float|null UNIX timestamp of acquisition; null on failure
569     */
570    protected function doLock( $key, $timeout, $exptime ) {
571        $lockTsUnix = null;
572
573        $fname = __METHOD__;
574        $loop = new WaitConditionLoop(
575            function () use ( $key, $exptime, $fname, &$lockTsUnix ) {
576                $watchPoint = $this->watchErrors();
577                if ( $this->add( $this->makeLockKey( $key ), 1, $exptime ) ) {
578                    $lockTsUnix = microtime( true );
579
580                    return WaitConditionLoop::CONDITION_REACHED;
581                } elseif ( $this->getLastError( $watchPoint ) ) {
582                    $this->logger->warning(
583                        "$fname failed due to I/O error for {key}.",
584                        [ 'key' => $key ]
585                    );
586
587                    return WaitConditionLoop::CONDITION_ABORTED;
588                }
589
590                return WaitConditionLoop::CONDITION_CONTINUE;
591            },
592            $timeout
593        );
594        $code = $loop->invoke();
595
596        if ( $code === $loop::CONDITION_TIMED_OUT ) {
597            $this->logger->warning(
598                "$fname failed due to timeout for {key}.",
599                [ 'key' => $key, 'timeout' => $timeout ]
600            );
601        }
602
603        return $lockTsUnix;
604    }
605
606    /**
607     * Release an advisory lock on a key string
608     *
609     * @param string $key
610     *
611     * @return bool Success
612     */
613    public function unlock( $key ) {
614        $released = false;
615
616        if ( isset( $this->locks[$key] ) ) {
617            if ( --$this->locks[$key][self::LOCK_DEPTH] > 0 ) {
618                $released = true;
619            } else {
620                $released = $this->doUnlock( $key );
621                unset( $this->locks[$key] );
622                if ( !$released ) {
623                    $this->logger->warning(
624                        __METHOD__ . ' failed to release lock for {key}.',
625                        [ 'key' => $key ]
626                    );
627                }
628            }
629        } else {
630            $this->logger->warning(
631                __METHOD__ . ' no lock to release for {key}.',
632                [ 'key' => $key ]
633            );
634        }
635
636        return $released;
637    }
638
639    /**
640     * @see MediumSpecificBagOStuff::unlock()
641     *
642     * @param string $key
643     *
644     * @return bool Success
645     */
646    protected function doUnlock( $key ) {
647        $released = false;
648
649        // Estimate the remaining TTL of the lock key
650        $curTTL = $this->locks[$key][self::LOCK_EXPIRY] - $this->getCurrentTime();
651
652        // Check the risk of race conditions for key deletion
653        if ( $this->getQoS( self::ATTR_DURABILITY ) <= self::QOS_DURABILITY_SCRIPT ) {
654            // Lock (and data) keys use memory specific to this request (e.g. HashBagOStuff)
655            $isSafe = true;
656        } else {
657            // It is unsafe to delete the lock key if there is a serious risk of the key already
658            // being claimed by another thread before the delete operation reaches the backend
659            $isSafe = ( $curTTL > $this->maxLockSendDelay );
660        }
661
662        if ( $isSafe ) {
663            $released = $this->doDelete( $this->makeLockKey( $key ) );
664        } else {
665            $this->logger->warning(
666                "Lock for {key} held too long ({age} sec).",
667                [ 'key' => $key, 'curTTL' => $curTTL ]
668            );
669        }
670
671        return $released;
672    }
673
674    /**
675     * @param string $key
676     *
677     * @return string
678     */
679    protected function makeLockKey( $key ) {
680        return "$key:lock";
681    }
682
683    public function deleteObjectsExpiringBefore(
684        $timestamp,
685        callable $progress = null,
686        $limit = INF,
687        string $tag = null
688    ) {
689        return false;
690    }
691
692    /**
693     * Get an associative array containing the item for each of the keys that have items.
694     *
695     * @param string[] $keys List of keys; can be a map of (unused => key) for convenience
696     * @param int $flags Bitfield; supports READ_LATEST [optional]
697     *
698     * @return mixed[] Map of (key => value) for existing keys; preserves the order of $keys
699     */
700    public function getMulti( array $keys, $flags = 0 ) {
701        $foundByKey = $this->doGetMulti( $keys, $flags );
702
703        $res = [];
704        foreach ( $keys as $key ) {
705            // Resolve one blob at a time (avoids too much I/O at once)
706            if ( array_key_exists( $key, $foundByKey ) ) {
707                // A value should not appear in the key if a segment is missing
708                $value = $this->resolveSegments( $key, $foundByKey[$key] );
709                if ( $value !== false ) {
710                    $res[$key] = $value;
711                }
712            }
713        }
714
715        return $res;
716    }
717
718    /**
719     * Get an associative array containing the item for each of the keys that have items.
720     *
721     * @param string[] $keys List of keys
722     * @param int $flags Bitfield; supports READ_LATEST [optional]
723     *
724     * @return array Map of (key => value) for existing keys; preserves the order of $keys
725     */
726    protected function doGetMulti( array $keys, $flags = 0 ) {
727        $res = [];
728        foreach ( $keys as $key ) {
729            $val = $this->doGet( $key, $flags );
730            if ( $val !== false ) {
731                $res[$key] = $val;
732            }
733        }
734
735        return $res;
736    }
737
738    /**
739     * Batch insertion/replace
740     *
741     * This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
742     *
743     * @param mixed[] $valueByKey Map of (key => value)
744     * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
745     * @param int $flags Bitfield of BagOStuff::WRITE_* constants (since 1.33)
746     *
747     * @return bool Success
748     * @since 1.24
749     */
750    public function setMulti( array $valueByKey, $exptime = 0, $flags = 0 ) {
751        if ( $this->fieldHasFlags( $flags, self::WRITE_ALLOW_SEGMENTS ) ) {
752            throw new InvalidArgumentException( __METHOD__ . ' got WRITE_ALLOW_SEGMENTS' );
753        }
754
755        return $this->doSetMulti( $valueByKey, $exptime, $flags );
756    }
757
758    /**
759     * @param mixed[] $data Map of (key => value)
760     * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
761     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
762     *
763     * @return bool Success
764     */
765    protected function doSetMulti( array $data, $exptime = 0, $flags = 0 ) {
766        $res = true;
767        foreach ( $data as $key => $value ) {
768            $res = $this->doSet( $key, $value, $exptime, $flags ) && $res;
769        }
770
771        return $res;
772    }
773
774    /**
775     * Batch deletion
776     *
777     * This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
778     *
779     * @param string[] $keys List of keys
780     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
781     *
782     * @return bool Success
783     * @since 1.33
784     */
785    public function deleteMulti( array $keys, $flags = 0 ) {
786        if ( $this->fieldHasFlags( $flags, self::WRITE_PRUNE_SEGMENTS ) ) {
787            throw new InvalidArgumentException( __METHOD__ . ' got WRITE_PRUNE_SEGMENTS' );
788        }
789
790        return $this->doDeleteMulti( $keys, $flags );
791    }
792
793    /**
794     * @param string[] $keys List of keys
795     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
796     *
797     * @return bool Success
798     */
799    protected function doDeleteMulti( array $keys, $flags = 0 ) {
800        $res = true;
801        foreach ( $keys as $key ) {
802            $res = $this->doDelete( $key, $flags ) && $res;
803        }
804
805        return $res;
806    }
807
808    /**
809     * Change the expiration of multiple keys that exist
810     *
811     * @param string[] $keys List of keys
812     * @param int $exptime TTL or UNIX timestamp
813     * @param int $flags Bitfield of BagOStuff::WRITE_* constants (since 1.33)
814     *
815     * @return bool Success
816     *
817     * @since 1.34
818     */
819    public function changeTTLMulti( array $keys, $exptime, $flags = 0 ) {
820        return $this->doChangeTTLMulti( $keys, $exptime, $flags );
821    }
822
823    /**
824     * @param string[] $keys List of keys
825     * @param int $exptime TTL or UNIX timestamp
826     * @param int $flags Bitfield of BagOStuff::WRITE_* constants
827     *
828     * @return bool Success
829     */
830    protected function doChangeTTLMulti( array $keys, $exptime, $flags = 0 ) {
831        $res = true;
832        foreach ( $keys as $key ) {
833            $res = $this->doChangeTTL( $key, $exptime, $flags ) && $res;
834        }
835
836        return $res;
837    }
838
839    /**
840     * Get and reassemble the chunks of blob at the given key
841     *
842     * @param string $key
843     * @param mixed $mainValue
844     *
845     * @return string|null|bool The combined string, false if missing, null on error
846     */
847    final protected function resolveSegments( $key, $mainValue ) {
848        if ( SerializedValueContainer::isSegmented( $mainValue ) ) {
849            $orderedKeys = array_map(
850                function ( $segmentHash ) use ( $key ) {
851                    return $this->makeGlobalKey( self::SEGMENT_COMPONENT, $key, $segmentHash );
852                },
853                $mainValue->{SerializedValueContainer::SEGMENTED_HASHES}
854            );
855
856            $segmentsByKey = $this->doGetMulti( $orderedKeys );
857
858            $parts = [];
859            foreach ( $orderedKeys as $segmentKey ) {
860                if ( isset( $segmentsByKey[$segmentKey] ) ) {
861                    $parts[] = $segmentsByKey[$segmentKey];
862                } else {
863                    // missing segment
864                    return false;
865                }
866            }
867
868            return $this->unserialize( implode( '', $parts ) );
869        }
870
871        return $mainValue;
872    }
873
874    /**
875     * Check if a value should use a segmentation wrapper due to its size
876     *
877     * In order to avoid extra serialization and/or twice-serialized wrappers, just check if
878     * the value is a large string. Support cache wrappers (e.g. WANObjectCache) that use 2D
879     * arrays to wrap values. This does not recurse in order to avoid overhead from complex
880     * structures and the risk of infinite loops (due to references).
881     *
882     * @param mixed $value
883     * @param int $flags
884     *
885     * @return bool
886     */
887    private function useSegmentationWrapper( $value, $flags ) {
888        if (
889            $this->segmentationSize === INF ||
890            !$this->fieldHasFlags( $flags, self::WRITE_ALLOW_SEGMENTS )
891        ) {
892            return false;
893        }
894
895        if ( is_string( $value ) ) {
896            return ( strlen( $value ) >= $this->segmentationSize );
897        }
898
899        if ( is_array( $value ) ) {
900            // Expect that the contained value will be one of the first array entries
901            foreach ( array_slice( $value, 0, 4 ) as $v ) {
902                if ( is_string( $v ) && strlen( $v ) >= $this->segmentationSize ) {
903                    return true;
904                }
905            }
906        }
907
908        // Avoid breaking functions for incrementing/decrementing integer key values
909        return false;
910    }
911
912    /**
913     * Make the entry to store at a key (inline or segment list), storing any segments
914     *
915     * @param string $key
916     * @param mixed $value
917     * @param int $exptime
918     * @param int $flags
919     * @param mixed|null &$ok Whether the entry is usable (e.g. no missing segments) [returned]
920     *
921     * @return mixed The entry (inline value, wrapped inline value, or wrapped segment list)
922     * @since 1.34
923     */
924    final protected function makeValueOrSegmentList( $key, $value, $exptime, $flags, &$ok ) {
925        $entry = $value;
926        $ok = true;
927
928        if ( $this->useSegmentationWrapper( $value, $flags ) ) {
929            $segmentSize = $this->segmentationSize;
930            $maxTotalSize = $this->segmentedValueMaxSize;
931            $serialized = $this->getSerialized( $value, $key );
932            $size = strlen( $serialized );
933            if ( $size > $maxTotalSize ) {
934                $this->logger->warning(
935                    "Value for {key} exceeds $maxTotalSize bytes; cannot segment.",
936                    [ 'key' => $key ]
937                );
938            } else {
939                // Split the serialized value into chunks and store them at different keys
940                $chunksByKey = [];
941                $segmentHashes = [];
942                $count = intdiv( $size, $segmentSize ) + ( ( $size % $segmentSize ) ? 1 : 0 );
943                for ( $i = 0; $i < $count; ++$i ) {
944                    $segment = substr( $serialized, $i * $segmentSize, $segmentSize );
945                    $hash = sha1( $segment );
946                    $chunkKey = $this->makeGlobalKey( self::SEGMENT_COMPONENT, $key, $hash );
947                    $chunksByKey[$chunkKey] = $segment;
948                    $segmentHashes[] = $hash;
949                }
950                $flags &= ~self::WRITE_ALLOW_SEGMENTS;
951                $ok = $this->setMulti( $chunksByKey, $exptime, $flags );
952                $entry = SerializedValueContainer::newSegmented( $segmentHashes );
953            }
954        }
955
956        return $entry;
957    }
958
959    /**
960     * @param int|float $exptime
961     *
962     * @return bool Whether the expiry is non-infinite, and, negative or not a UNIX timestamp
963     * @since 1.34
964     */
965    final protected function isRelativeExpiration( $exptime ) {
966        return ( $exptime !== self::TTL_INDEFINITE && $exptime < ( 10 * self::TTL_YEAR ) );
967    }
968
969    /**
970     * Convert an optionally relative timestamp to an absolute time
971     *
972     * The input value will be cast to an integer and interpreted as follows:
973     *   - zero: no expiry; return zero (e.g. TTL_INDEFINITE)
974     *   - negative: relative TTL; return UNIX timestamp offset by this value
975     *   - positive (< 10 years): relative TTL; return UNIX timestamp offset by this value
976     *   - positive (>= 10 years): absolute UNIX timestamp; return this value
977     *
978     * @param int $exptime
979     *
980     * @return int Expiration timestamp or TTL_INDEFINITE for indefinite
981     * @since 1.34
982     */
983    final protected function getExpirationAsTimestamp( $exptime ) {
984        if ( $exptime == self::TTL_INDEFINITE ) {
985            return $exptime;
986        }
987
988        return $this->isRelativeExpiration( $exptime )
989            ? intval( $this->getCurrentTime() + $exptime )
990            : $exptime;
991    }
992
993    /**
994     * Convert an optionally absolute expiry time to a relative time. If an
995     * absolute time is specified which is in the past, use a short expiry time.
996     *
997     * The input value will be cast to an integer and interpreted as follows:
998     *   - zero: no expiry; return zero (e.g. TTL_INDEFINITE)
999     *   - negative: relative TTL; return a short expiry time (1 second)
1000     *   - positive (< 10 years): relative TTL; return this value
1001     *   - positive (>= 10 years): absolute UNIX timestamp; return offset to current time
1002     *
1003     * @param int $exptime
1004     *
1005     * @return int Relative TTL or TTL_INDEFINITE for indefinite
1006     * @since 1.34
1007     */
1008    final protected function getExpirationAsTTL( $exptime ) {
1009        if ( $exptime == self::TTL_INDEFINITE ) {
1010            return $exptime;
1011        }
1012
1013        return $this->isRelativeExpiration( $exptime )
1014            ? $exptime
1015            : (int)max( $exptime - $this->getCurrentTime(), 1 );
1016    }
1017
1018    /**
1019     * Check if a value is an integer
1020     *
1021     * @param mixed $value
1022     *
1023     * @return bool
1024     */
1025    final protected function isInteger( $value ) {
1026        if ( is_int( $value ) ) {
1027            return true;
1028        } elseif ( !is_string( $value ) ) {
1029            return false;
1030        }
1031
1032        $integer = (int)$value;
1033
1034        return ( $value === (string)$integer );
1035    }
1036
1037    public function getQoS( $flag ) {
1038        return $this->attrMap[$flag] ?? self::QOS_UNKNOWN;
1039    }
1040
1041    /**
1042     * @deprecated since 1.43, not used anywhere.
1043     */
1044    public function getSegmentationSize() {
1045        wfDeprecated( __METHOD__, '1.43' );
1046
1047        return $this->segmentationSize;
1048    }
1049
1050    /**
1051     * @deprecated since 1.43, not used anywhere.
1052     */
1053    public function getSegmentedValueMaxSize() {
1054        wfDeprecated( __METHOD__, '1.43' );
1055
1056        return $this->segmentedValueMaxSize;
1057    }
1058
1059    /**
1060     * Get the serialized form a value, logging a warning if it involves custom classes
1061     *
1062     * @param mixed $value
1063     * @param string $key
1064     *
1065     * @return string|int String/integer representation of value
1066     * @since 1.35
1067     */
1068    protected function getSerialized( $value, $key ) {
1069        $this->checkValueSerializability( $value, $key );
1070
1071        return $this->serialize( $value );
1072    }
1073
1074    /**
1075     * Log if a new cache value does not appear suitable for serialization at a quick glance
1076     *
1077     * This aids migration of values to JSON-like structures and the debugging of exceptions
1078     * due to serialization failure.
1079     *
1080     * This does not recurse more than one level into container structures.
1081     *
1082     * A proper cache key value is one of the following:
1083     *  - null
1084     *  - a scalar
1085     *  - an array with scalar/null values
1086     *  - an array tree with scalar/null "leaf" values
1087     *  - an stdClass instance with scalar/null field values
1088     *  - an stdClass instance tree with scalar/null "leaf" values
1089     *  - an instance of a class that implements JsonSerializable
1090     *
1091     * @param mixed $value Result of the value generation callback for the key
1092     * @param string $key Cache key
1093     */
1094    private function checkValueSerializability( $value, $key ) {
1095        if ( is_array( $value ) ) {
1096            $this->checkIterableMapSerializability( $value, $key );
1097        } elseif ( is_object( $value ) ) {
1098            // Note that Closure instances count as objects
1099            if ( $value instanceof stdClass ) {
1100                $this->checkIterableMapSerializability( $value, $key );
1101            } elseif ( !( $value instanceof JsonSerializable ) ) {
1102                $this->logger->warning(
1103                    "{class} value for '{cachekey}'; serialization is suspect.",
1104                    [ 'cachekey' => $key, 'class' => get_class( $value ) ]
1105                );
1106            }
1107        }
1108    }
1109
1110    /**
1111     * @param array|stdClass $value Result of the value generation callback for the key
1112     * @param string $key Cache key
1113     */
1114    private function checkIterableMapSerializability( $value, $key ) {
1115        foreach ( $value as $index => $entry ) {
1116            if ( is_object( $entry ) ) {
1117                // Note that Closure instances count as objects
1118                if (
1119                    !( $entry instanceof \stdClass ) &&
1120                    !( $entry instanceof \JsonSerializable )
1121                ) {
1122                    $this->logger->warning(
1123                        "{class} value for '{cachekey}' at '$index'; serialization is suspect.",
1124                        [ 'cachekey' => $key, 'class' => get_class( $entry ) ]
1125                    );
1126
1127                    return;
1128                }
1129            }
1130        }
1131    }
1132
1133    /**
1134     * @param mixed $value
1135     *
1136     * @return string|int|false String/integer representation
1137     * @note Special handling is usually needed for integers so incr()/decr() work
1138     */
1139    protected function serialize( $value ) {
1140        return is_int( $value ) ? $value : serialize( $value );
1141    }
1142
1143    /**
1144     * @param string|int|false $value
1145     *
1146     * @return mixed Original value or false on error
1147     * @note Special handling is usually needed for integers so incr()/decr() work
1148     */
1149    protected function unserialize( $value ) {
1150        return $this->isInteger( $value ) ? (int)$value : unserialize( $value );
1151    }
1152
1153    /**
1154     * @param string $text
1155     */
1156    protected function debug( $text ) {
1157        $this->logger->debug( "{class} debug: $text", [ 'class' => static::class ] );
1158    }
1159
1160    /**
1161     * @param string $key Key generated by BagOStuff::makeKeyInternal
1162     *
1163     * @return string A stats prefix to describe this class of key (e.g. "objectcache.file")
1164     */
1165    private function determinekeyGroupForStats( $key ): string {
1166        // Key came directly from BagOStuff::makeKey() or BagOStuff::makeGlobalKey()
1167        // and thus has the format of "<scope>:<collection>[:<constant or variable>]..."
1168        $components = explode( ':', $key, 3 );
1169        // Handle legacy callers that fail to use the key building methods
1170        $keygroup = $components[1] ?? 'UNKNOWN';
1171
1172        return strtr( $keygroup, '.', '_' );
1173    }
1174
1175    /**
1176     * @param string $op Operation name as a MediumSpecificBagOStuff::METRIC_OP_* constant
1177     * @param array<int,string>|array<string,int[]> $keyInfo Key list, if payload sizes are not
1178     *  applicable, otherwise, map of (key => (send payload size, receive payload size)); send
1179     *  and receive sizes are 0 where not applicable and receive sizes are "false" for keys
1180     *  that were not found during read operations
1181     */
1182    protected function updateOpStats( string $op, array $keyInfo ) {
1183        $deltasByMetric = [];
1184
1185        foreach ( $keyInfo as $indexOrKey => $keyOrSizes ) {
1186            if ( is_array( $keyOrSizes ) ) {
1187                $key = $indexOrKey;
1188                [ $sPayloadSize, $rPayloadSize ] = $keyOrSizes;
1189            } else {
1190                $key = $keyOrSizes;
1191                $sPayloadSize = 0;
1192                $rPayloadSize = 0;
1193            }
1194
1195            // Metric prefix for the cache wrapper and key collection name
1196            $keygroup = $this->determinekeyGroupForStats( $key );
1197
1198            if ( $op === self::METRIC_OP_GET ) {
1199                // This operation was either a "hit" or "miss" for this key
1200                if ( $rPayloadSize === false ) {
1201                    $statsdName = "objectcache.{$keygroup}.{$op}_miss_rate";
1202                    $statsName = "bagostuff_miss_total";
1203                } else {
1204                    $statsdName = "objectcache.{$keygroup}.{$op}_hit_rate";
1205                    $statsName = "bagostuff_hit_total";
1206                }
1207            } else {
1208                // There is no concept of "hit" or "miss" for this operation
1209                $statsdName = "objectcache.{$keygroup}.{$op}_call_rate";
1210                $statsName = "bagostuff_call_total";
1211            }
1212            $deltasByMetric[$statsdName] = [
1213                'delta' => ( $deltasByMetric[$statsdName]['delta'] ?? 0 ) + 1,
1214                'metric' => $statsName,
1215                'keygroup' => $keygroup,
1216                'operation' => $op,
1217            ];
1218
1219            if ( $sPayloadSize > 0 ) {
1220                $statsdName = "objectcache.{$keygroup}.{$op}_bytes_sent";
1221                $statsName = "bagostuff_bytes_sent_total";
1222                $deltasByMetric[$statsdName] = [
1223                    'delta' => ( $deltasByMetric[$statsdName]['delta'] ?? 0 ) + $sPayloadSize,
1224                    'metric' => $statsName,
1225                    'keygroup' => $keygroup,
1226                    'operation' => $op,
1227                ];
1228            }
1229
1230            if ( $rPayloadSize > 0 ) {
1231                $statsdName = "objectcache.{$keygroup}.{$op}_bytes_read";
1232                $statsName = "bagostuff_bytes_read_total";
1233                $deltasByMetric[$statsdName] = [
1234                    'delta' => ( $deltasByMetric[$statsdName]['delta'] ?? 0 ) + $rPayloadSize,
1235                    'metric' => $statsName,
1236                    'keygroup' => $keygroup,
1237                    'operation' => $op,
1238                ];
1239            }
1240        }
1241
1242        foreach ( $deltasByMetric as $statsdName => $delta ) {
1243            $this->stats->getCounter( $delta['metric'] )
1244                ->setLabel( 'keygroup', $delta['keygroup'] )
1245                ->setLabel( 'operation', $delta['operation'] )
1246                ->copyToStatsdAt( $statsdName )
1247                ->incrementBy( $delta['delta'] );
1248        }
1249    }
1250}
1251
1252/** @deprecated class alias since 1.43 */
1253class_alias( MediumSpecificBagOStuff::class, 'MediumSpecificBagOStuff' );