Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 42
0.00% covered (danger)
0.00%
0 / 6
CRAP
0.00% covered (danger)
0.00%
0 / 1
APCUBagOStuff
0.00% covered (danger)
0.00%
0 / 41
0.00% covered (danger)
0.00%
0 / 6
306
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
12
 doGet
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 doSet
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 doAdd
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 doDelete
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 doIncrWithInit
0.00% covered (danger)
0.00%
0 / 19
0.00% covered (danger)
0.00%
0 / 1
56
1<?php
2/**
3 * Object caching using PHP's APCU accelerator.
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
26/**
27 * This is a wrapper for APCu's shared memory functions
28 *
29 * Use PHP serialization to avoid bugs and easily create CAS tokens.
30 * APCu has a memory corruption bug when the serializer is set to 'default'.
31 * See T120267, and upstream bug reports:
32 *  - https://github.com/krakjoe/apcu/issues/38
33 *  - https://github.com/krakjoe/apcu/issues/35
34 *  - https://github.com/krakjoe/apcu/issues/111
35 *
36 * @ingroup Cache
37 */
38class APCUBagOStuff extends MediumSpecificBagOStuff {
39    /**
40     * @var string String to append to each APC key. This may be changed
41     *  whenever the handling of values is changed, to prevent existing code
42     *  from encountering older values which it cannot handle.
43     */
44    private const KEY_SUFFIX = ':5';
45
46    /** @var int Max attempts for implicit CAS operations */
47    private static $CAS_MAX_ATTEMPTS = 100;
48
49    public function __construct( array $params = [] ) {
50        // No use in segmenting values
51        $params['segmentationSize'] = INF;
52        parent::__construct( $params );
53        // Versions of apcu < 5.1.19 use apc.use_request_time=1 by default, causing new keys
54        // to be assigned timestamps based on the start of the PHP request/script. The longer
55        // the request has been running, the more likely that newly stored keys will instantly
56        // be seen as expired by other requests. Disable apc.use_request_time.
57        ini_set( 'apc.use_request_time', '0' );
58
59        if ( PHP_SAPI === 'cli' ) {
60            $this->attrMap[self::ATTR_DURABILITY] = ini_get( 'apc.enable_cli' )
61                ? self::QOS_DURABILITY_SCRIPT
62                : self::QOS_DURABILITY_NONE;
63        } else {
64            $this->attrMap[self::ATTR_DURABILITY] = self::QOS_DURABILITY_SERVICE;
65        }
66    }
67
68    protected function doGet( $key, $flags = 0, &$casToken = null ) {
69        $getToken = ( $casToken === self::PASS_BY_REF );
70        $casToken = null;
71
72        $value = apcu_fetch( $key . self::KEY_SUFFIX );
73        if ( $getToken && $value !== false ) {
74            // Note that if the driver handles serialization then this uses the PHP value
75            // as the token. This might require inspection or re-serialization in doCas().
76            $casToken = $value;
77        }
78
79        return $value;
80    }
81
82    protected function doSet( $key, $value, $exptime = 0, $flags = 0 ) {
83        $ttl = $this->getExpirationAsTTL( $exptime );
84
85        return apcu_store( $key . self::KEY_SUFFIX, $value, $ttl );
86    }
87
88    protected function doAdd( $key, $value, $exptime = 0, $flags = 0 ) {
89        if ( apcu_exists( $key . self::KEY_SUFFIX ) ) {
90            // Avoid global write locks for high contention keys
91            return false;
92        }
93
94        $ttl = $this->getExpirationAsTTL( $exptime );
95
96        return apcu_add( $key . self::KEY_SUFFIX, $value, $ttl );
97    }
98
99    protected function doDelete( $key, $flags = 0 ) {
100        apcu_delete( $key . self::KEY_SUFFIX );
101
102        return true;
103    }
104
105    protected function doIncrWithInit( $key, $exptime, $step, $init, $flags ) {
106        // Use apcu 5.1.12 $ttl argument if apcu_inc() will initialize to $init:
107        // https://www.php.net/manual/en/function.apcu-inc.php
108        if ( $step === $init ) {
109            /** @noinspection PhpMethodParametersCountMismatchInspection */
110            $ttl = $this->getExpirationAsTTL( $exptime );
111            $result = apcu_inc( $key . self::KEY_SUFFIX, $step, $success, $ttl );
112        } else {
113            $result = false;
114            for ( $i = 0; $i < self::$CAS_MAX_ATTEMPTS; ++$i ) {
115                $oldCount = apcu_fetch( $key . self::KEY_SUFFIX );
116                if ( $oldCount === false ) {
117                    $count = $init;
118                    $ttl = $this->getExpirationAsTTL( $exptime );
119                    if ( apcu_add( $key . self::KEY_SUFFIX, $count, $ttl ) ) {
120                        $result = $count;
121                        break;
122                    }
123                } elseif ( is_int( $oldCount ) ) {
124                    $count = $oldCount + $step;
125                    if ( apcu_cas( $key . self::KEY_SUFFIX, $oldCount, $count ) ) {
126                        $result = $count;
127                        break;
128                    }
129                } else {
130                    break;
131                }
132            }
133        }
134
135        return $result;
136    }
137}
138
139/** @deprecated class alias since 1.43 */
140class_alias( APCUBagOStuff::class, 'APCUBagOStuff' );