includes/libs/HashRing.php

   1 <?php
   2 /**
   3  * Convenience class for weighted consistent hash rings.
   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  */
  22
  23 /**
  24  * Convenience class for weighted consistent hash rings
  25  *
  26  * @since 1.22
  27  */
  28 class HashRing {
  29         /** @var Array (location => weight) */
  30         protected $sourceMap = [];
  31         /** @var Array (location => (start, end)) */
  32         protected $ring = [];
  33
  34         /** @var HashRing|null */
  35         protected $liveRing;
  36         /** @var Array (location => UNIX timestamp) */
  37         protected $ejectionExpiries = [];
  38         /** @var int UNIX timestamp */
  39         protected $ejectionNextExpiry = INF;
  40
  41         const RING_SIZE = 268435456; // 2^28
  42
  43         /**
  44          * @param array $map (location => weight)
  45          */
  46         public function __construct( array $map ) {
  47                 $map = array_filter( $map, function ( $w ) {
  48                         return $w > 0;
  49                 } );
  50                 if ( !count( $map ) ) {
  51                         throw new UnexpectedValueException( "Ring is empty or all weights are zero." );
  52                 }
  53                 $this->sourceMap = $map;
  54                 // Sort the locations based on the hash of their names
  55                 $hashes = [];
  56                 foreach ( $map as $location => $weight ) {
  57                         $hashes[$location] = sha1( $location );
  58                 }
  59                 uksort( $map, function ( $a, $b ) use ( $hashes ) {
  60                         return strcmp( $hashes[$a], $hashes[$b] );
  61                 } );
  62                 // Fit the map to weight-proportionate one with a space of size RING_SIZE
  63                 $sum = array_sum( $map );
  64                 $standardMap = [];
  65                 foreach ( $map as $location => $weight ) {
  66                         $standardMap[$location] = (int)floor( $weight / $sum * self::RING_SIZE );
  67                 }
  68                 // Build a ring of RING_SIZE spots, with each location at a spot in location hash order
  69                 $index = 0;
  70                 foreach ( $standardMap as $location => $weight ) {
  71                         // Location covers half-closed interval [$index,$index + $weight)
  72                         $this->ring[$location] = [ $index, $index + $weight ];
  73                         $index += $weight;
  74                 }
  75                 // Make sure the last location covers what is left
  76                 end( $this->ring );
  77                 $this->ring[key( $this->ring )][1] = self::RING_SIZE;
  78         }
  79
  80         /**
  81          * Get the location of an item on the ring
  82          *
  83          * @param string $item
  84          * @return string Location
  85          */
  86         public function getLocation( $item ) {
  87                 $locations = $this->getLocations( $item, 1 );
  88
  89                 return $locations[0];
  90         }
  91
  92         /**
  93          * Get the location of an item on the ring, as well as the next locations
  94          *
  95          * @param string $item
  96          * @param int $limit Maximum number of locations to return
  97          * @return array List of locations
  98          */
  99         public function getLocations( $item, $limit ) {
 100                 $locations = [];
 101                 $primaryLocation = null;
 102                 $spot = hexdec( substr( sha1( $item ), 0, 7 ) ); // first 28 bits
 103                 foreach ( $this->ring as $location => $range ) {
 104                         if ( count( $locations ) >= $limit ) {
 105                                 break;
 106                         }
 107                         // The $primaryLocation is the location the item spot is in.
 108                         // After that is reached, keep appending the next locations.
 109                         if ( ( $range[0] <= $spot && $spot < $range[1] ) || $primaryLocation !== null ) {
 110                                 if ( $primaryLocation === null ) {
 111                                         $primaryLocation = $location;
 112                                 }
 113                                 $locations[] = $location;
 114                         }
 115                 }
 116                 // If more locations are requested, wrap-around and keep adding them
 117                 reset( $this->ring );
 118                 while ( count( $locations ) < $limit ) {
 119                         list( $location, ) = each( $this->ring );
 120                         if ( $location === $primaryLocation ) {
 121                                 break; // don't go in circles
 122                         }
 123                         $locations[] = $location;
 124                 }
 125
 126                 return $locations;
 127         }
 128
 129         /**
 130          * Get the map of locations to weight (ignores 0-weight items)
 131          *
 132          * @return array
 133          */
 134         public function getLocationWeights() {
 135                 return $this->sourceMap;
 136         }
 137
 138         /**
 139          * Get a new hash ring with a location removed from the ring
 140          *
 141          * @param string $location
 142          * @return HashRing|bool Returns false if no non-zero weighted spots are left
 143          */
 144         public function newWithoutLocation( $location ) {
 145                 $map = $this->sourceMap;
 146                 unset( $map[$location] );
 147
 148                 return count( $map ) ? new self( $map ) : false;
 149         }
 150
 151         /**
 152          * Remove a location from the "live" hash ring
 153          *
 154          * @param string $location
 155          * @param int $ttl Seconds
 156          * @return bool Whether some non-ejected locations are left
 157          */
 158         public function ejectFromLiveRing( $location, $ttl ) {
 159                 if ( !isset( $this->sourceMap[$location] ) ) {
 160                         throw new UnexpectedValueException( "No location '$location' in the ring." );
 161                 }
 162                 $expiry = time() + $ttl;
 163                 $this->liveRing = null; // stale
 164                 $this->ejectionExpiries[$location] = $expiry;
 165                 $this->ejectionNextExpiry = min( $expiry, $this->ejectionNextExpiry );
 166
 167                 return ( count( $this->ejectionExpiries ) < count( $this->sourceMap ) );
 168         }
 169
 170         /**
 171          * Get the "live" hash ring (which does not include ejected locations)
 172          *
 173          * @return HashRing
 174          * @throws UnexpectedValueException
 175          */
 176         public function getLiveRing() {
 177                 $now = time();
 178                 if ( $this->liveRing === null || $this->ejectionNextExpiry <= $now ) {
 179                         $this->ejectionExpiries = array_filter(
 180                                 $this->ejectionExpiries,
 181                                 function ( $expiry ) use ( $now ) {
 182                                         return ( $expiry > $now );
 183                                 }
 184                         );
 185                         if ( count( $this->ejectionExpiries ) ) {
 186                                 $map = array_diff_key( $this->sourceMap, $this->ejectionExpiries );
 187                                 $this->liveRing = count( $map ) ? new self( $map ) : false;
 188
 189                                 $this->ejectionNextExpiry = min( $this->ejectionExpiries );
 190                         } else { // common case; avoid recalculating ring
 191                                 $this->liveRing = clone $this;
 192                                 $this->liveRing->ejectionExpiries = [];
 193                                 $this->liveRing->ejectionNextExpiry = INF;
 194                                 $this->liveRing->liveRing = null;
 195
 196                                 $this->ejectionNextExpiry = INF;
 197                         }
 198                 }
 199                 if ( !$this->liveRing ) {
 200                         throw new UnexpectedValueException( "The live ring is currently empty." );
 201                 }
 202
 203                 return $this->liveRing;
 204         }
 205
 206         /**
 207          * Get the location of an item on the "live" ring
 208          *
 209          * @param string $item
 210          * @return string Location
 211          * @throws UnexpectedValueException
 212          */
 213         public function getLiveLocation( $item ) {
 214                 return $this->getLiveRing()->getLocation( $item );
 215         }
 216
 217         /**
 218          * Get the location of an item on the "live" ring, as well as the next locations
 219          *
 220          * @param string $item
 221          * @param int $limit Maximum number of locations to return
 222          * @return array List of locations
 223          * @throws UnexpectedValueException
 224          */
 225         public function getLiveLocations( $item, $limit ) {
 226                 return $this->getLiveRing()->getLocations( $item, $limit );
 227         }
 228
 229         /**
 230          * Get the map of "live" locations to weight (ignores 0-weight items)
 231          *
 232          * @return array
 233          * @throws UnexpectedValueException
 234          */
 235         public function getLiveLocationWeights() {
 236                 return $this->getLiveRing()->getLocationWeights();
 237         }
 238 }