1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
//! An in-memory rate limiter that can keep track of rates for
//! multiple keys, e.g. per-customer or per-IP rates.
use parking_lot::Mutex;
use std::collections::hash_map::RandomState;
use std::fmt;
use std::hash::BuildHasher;
use std::hash::Hash;
use std::marker::PhantomData;
use std::num::NonZeroU32;
use std::sync::Arc;
use std::time::{Duration, Instant};
use evmap::{self, ReadHandle, WriteHandle};
use {
algorithms::{Algorithm, DefaultAlgorithm, RateLimitState},
InconsistentCapacity, NegativeMultiDecision,
};
type MapWriteHandle<K, A, H> = Arc<Mutex<WriteHandle<K, <A as Algorithm>::BucketState, (), H>>>;
/// An in-memory rate limiter that regulates a single rate limit for
/// multiple keys.
///
/// Keyed rate limiters can be used to e.g. enforce a per-IP address
/// or a per-customer request limit on the server side.
///
/// This implementation of the keyed rate limiter uses
/// [`evmap`](../../../evmap/index.html), a read lock-free, concurrent
/// hash map. Addition of new keys (e.g. a new customer making their
/// first request) is synchronized and happens one at a time (it
/// synchronizes writes to minimize the effects from `evmap`'s
/// eventually consistent behavior on key addition), while reads of
/// existing keys all happen simultaneously, then get synchronized by
/// the rate limiting algorithm itself.
///
/// ```
/// # use std::num::NonZeroU32;
/// # use std::time::Duration;
/// use ratelimit_meter::{KeyedRateLimiter};
/// # #[macro_use] extern crate nonzero_ext;
/// # extern crate ratelimit_meter;
/// # fn main () {
/// let mut limiter = KeyedRateLimiter::<&str>::new(nonzero!(1u32), Duration::from_secs(5));
/// assert_eq!(Ok(()), limiter.check("customer1")); // allowed!
/// assert_ne!(Ok(()), limiter.check("customer1")); // ...but now customer1 must wait 5 seconds.
///
/// assert_eq!(Ok(()), limiter.check("customer2")); // it's customer2's first request!
/// # }
/// ```
///
/// # Expiring old keys
/// If a key has not been checked in a long time, that key can be
/// expired safely (the next rate limit check for that key would
/// behave as if the key was not present in the map, after all). To
/// remove the unused keys and free up space, use the
/// [`cleanup`](method.cleanup) method:
///
/// ```
/// # use std::num::NonZeroU32;
/// # use std::time::Duration;
/// use ratelimit_meter::{KeyedRateLimiter};
/// # #[macro_use] extern crate nonzero_ext;
/// # extern crate ratelimit_meter;
/// # fn main () {
/// let mut limiter = KeyedRateLimiter::<&str>::new(nonzero!(100u32), Duration::from_secs(5));
/// limiter.check("hi there");
/// // time passes...
///
/// // remove all keys that have been expireable for 10 minutes:
/// limiter.cleanup(Duration::from_secs(600));
/// # }
/// ```
#[derive(Clone)]
pub struct KeyedRateLimiter<
K: Eq + Hash + Clone,
A: Algorithm = DefaultAlgorithm,
H: BuildHasher + Clone = RandomState,
> {
algorithm: A,
map_reader: ReadHandle<K, A::BucketState, (), H>,
map_writer: MapWriteHandle<K, A, H>,
}
impl<A, K> fmt::Debug for KeyedRateLimiter<K, A>
where
A: Algorithm,
K: Eq + Hash + Clone,
{
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
write!(f, "KeyedRateLimiter{{{params:?}}}", params = self.algorithm)
}
}
impl<A, K> KeyedRateLimiter<K, A>
where
A: Algorithm,
K: Eq + Hash + Clone,
{
/// Construct a new rate limiter that allows `capacity` cells per
/// time unit through.
/// # Examples
/// ```
/// # use std::num::NonZeroU32;
/// # use std::time::Duration;
/// use ratelimit_meter::{KeyedRateLimiter};
/// # #[macro_use] extern crate nonzero_ext;
/// # extern crate ratelimit_meter;
/// # fn main () {
/// let _limiter = KeyedRateLimiter::<&str>::new(nonzero!(100u32), Duration::from_secs(5));
/// # }
/// ```
pub fn new(capacity: NonZeroU32, per_time_unit: Duration) -> Self {
let (r, mut w): (
ReadHandle<K, A::BucketState>,
WriteHandle<K, A::BucketState>,
) = evmap::new();
w.refresh();
KeyedRateLimiter {
algorithm: <A as Algorithm>::construct(capacity, nonzero!(1u32), per_time_unit)
.unwrap(),
map_reader: r,
map_writer: Arc::new(Mutex::new(w)),
}
}
/// Construct a new keyed rate limiter that allows `capacity`
/// cells per second.
///
/// # Examples
/// Constructing a rate limiter keyed by `&str` that lets through
/// 100 cells per second:
///
/// ```
/// # use std::time::Duration;
/// use ratelimit_meter::{KeyedRateLimiter, GCRA};
/// # #[macro_use] extern crate nonzero_ext;
/// # extern crate ratelimit_meter;
/// # fn main () {
/// let _limiter = KeyedRateLimiter::<&str, GCRA>::per_second(nonzero!(100u32));
/// # }
/// ```
pub fn per_second(capacity: NonZeroU32) -> Self {
Self::new(capacity, Duration::from_secs(1))
}
/// Return a constructor that can be used to construct a keyed
/// rate limiter with the builder pattern.
pub fn build_with_capacity(capacity: NonZeroU32) -> Builder<K, A, RandomState> {
Builder {
capacity,
..Default::default()
}
}
fn check_and_update_key<E, F>(&self, key: K, update: F) -> Result<(), E>
where
F: Fn(&A::BucketState) -> Result<(), E>,
{
self.map_reader
.get_and(&key, |v| {
// we have at least one element (owing to the nature of
// the evmap, it says there could be >1
// entries, but we'll only ever add one):
let state = &v[0];
update(state)
}).unwrap_or_else(|| {
// entry does not exist, let's add one.
let mut w = self.map_writer.lock();
let state: A::BucketState = Default::default();
let result = update(&state);
w.update(key, state);
w.flush();
result
})
}
/// Tests if a single cell for the given key can be accommodated
/// at `Instant::now()`. If it can be, `check` updates the rate
/// limiter state on that key to account for the conforming cell
/// and returns `Ok(())`.
///
/// If the cell is non-conforming (i.e., it can't be accomodated
/// at this time stamp), `check_at` returns `Err` with information
/// about the earliest time at which a cell could be considered
/// conforming under that key.
pub fn check(&mut self, key: K) -> Result<(), <A as Algorithm>::NegativeDecision> {
self.check_at(key, Instant::now())
}
/// Tests if `n` cells for the given key can be accommodated at
/// the current time stamp. If (and only if) all cells in the
/// batch can be accomodated, the `MultiDecider` updates the rate
/// limiter state on that key to account for all cells and returns
/// `Ok(())`.
///
/// If the entire batch of cells would not be conforming but the
/// rate limiter has the capacity to accomodate the cells at any
/// point in time, `check_n_at` returns error
/// [`NegativeMultiDecision::BatchNonConforming`](../../enum.NegativeMultiDecision.html#variant.BatchNonConforming),
/// holding the number of cells and the rate limiter's negative
/// outcome result.
///
/// If `n` exceeds the bucket capacity, `check_n_at` returns
/// [`NegativeMultiDecision::InsufficientCapacity`](../../enum.NegativeMultiDecision.html#variant.InsufficientCapacity),
/// indicating that a batch of this many cells can never succeed.
pub fn check_n(
&mut self,
key: K,
n: u32,
) -> Result<(), NegativeMultiDecision<<A as Algorithm>::NegativeDecision>> {
self.check_n_at(key, n, Instant::now())
}
/// Tests whether a single cell for the given key can be
/// accommodated at the given time stamp. See
/// [`check`](#method.check).
pub fn check_at(
&mut self,
key: K,
at: Instant,
) -> Result<(), <A as Algorithm>::NegativeDecision> {
self.check_and_update_key(key, |state| self.algorithm.test_and_update(state, at))
}
/// Tests if `n` cells for the given key can be accommodated at
/// the given time (`Instant::now()`), using
/// [`check_n`](#method.check_n)
pub fn check_n_at(
&mut self,
key: K,
n: u32,
at: Instant,
) -> Result<(), NegativeMultiDecision<<A as Algorithm>::NegativeDecision>> {
self.check_and_update_key(key, |state| self.algorithm.test_n_and_update(state, n, at))
}
/// Removes the keys from this rate limiter that can be expired
/// safely and returns the keys that were removed.
///
/// To be eligible for expiration, a key's rate limiter state must
/// be at least `min_age` past its last relevance (see
/// [`RateLimitState.last_touched`](../../algorithms/trait.RateLimitState.html#method.last_touched)).
///
/// This method works in two parts, but both parts block new keys
/// from getting added while they're running:
/// * First, it collects the keys that are eligible for expiration.
/// * Then, it expires these keys.
///
/// Note that this only affects new keys that need to be
/// added. Rate-limiting operations on existing keys continue
/// concurrently.
///
/// # Race conditions
/// Since this is happening concurrently with other operations,
/// race conditions can & will occur. It's possible that cells are
/// accounted between the time `cleanup_at` is called and their
/// expiry. These cells will lost.
///
/// The time window in which this can occur is hopefully short
/// enough that this is an acceptable risk of loss in accuracy.
pub fn cleanup<D: Into<Option<Duration>>>(&mut self, min_age: D) -> Vec<K> {
self.cleanup_at(min_age, Instant::now())
}
/// Removes the keys from this rate limiter that can be expired
/// safely at the given time stamp. See
/// [`cleanup`](#method.cleanup). It returns the list of expired
/// keys.
pub fn cleanup_at<D: Into<Option<Duration>>, I: Into<Option<Instant>>>(
&mut self,
min_age: D,
at: I,
) -> Vec<K> {
let params = &self.algorithm;
let min_age = min_age.into().unwrap_or_else(|| Duration::new(0, 0));
let at = at.into().unwrap_or_else(Instant::now);
let mut expireable: Vec<K> = vec![];
self.map_reader.for_each(|k, v| {
if let Some(state) = v.get(0) {
if state.last_touched(params) < at - min_age {
expireable.push(k.clone());
}
}
});
// Now take the map write lock and remove all the keys that we
// collected:
let mut w = self.map_writer.lock();
for key in expireable.iter().cloned() {
w.empty(key);
}
w.refresh();
expireable
}
}
/// A constructor for keyed rate limiters.
pub struct Builder<K: Eq + Hash + Clone, A: Algorithm, H: BuildHasher> {
end_result: PhantomData<(K, A)>,
capacity: NonZeroU32,
cell_weight: NonZeroU32,
per_time_unit: Duration,
hasher: H,
map_capacity: Option<usize>,
}
impl<K, A> Default for Builder<K, A, RandomState>
where
K: Eq + Hash + Clone,
A: Algorithm,
{
fn default() -> Builder<K, A, RandomState> {
Builder {
end_result: PhantomData,
map_capacity: None,
capacity: nonzero!(1u32),
cell_weight: nonzero!(1u32),
per_time_unit: Duration::from_secs(1),
hasher: RandomState::new(),
}
}
}
impl<K, A, H> Builder<K, A, H>
where
K: Eq + Hash + Clone,
A: Algorithm,
H: BuildHasher,
{
/// Sets the hashing method used for the map.
pub fn with_hasher<H2: BuildHasher>(self, hash_builder: H2) -> Builder<K, A, H2> {
Builder {
hasher: hash_builder,
end_result: self.end_result,
capacity: self.capacity,
cell_weight: self.cell_weight,
per_time_unit: self.per_time_unit,
map_capacity: self.map_capacity,
}
}
/// Sets the "weight" of each cell that is checked against the
/// bucket.
pub fn with_cell_weight(self, cell_weight: NonZeroU32) -> Result<Self, InconsistentCapacity> {
if self.cell_weight > self.capacity {
return Err(InconsistentCapacity {
capacity: self.capacity,
cell_weight,
});
}
Ok(Builder {
cell_weight,
..self
})
}
/// Sets the initial number of keys that the map can hold before
/// rehashing.
pub fn with_map_capacity(self, map_capacity: usize) -> Self {
Builder {
map_capacity: Some(map_capacity),
..self
}
}
/// Constructs a keyed rate limiter with the given options.
pub fn build(self) -> Result<KeyedRateLimiter<K, A, H>, InconsistentCapacity>
where
H: Clone,
{
let map_opts = evmap::Options::default().with_hasher(self.hasher);
let (r, mut w) = if self.map_capacity.is_some() {
map_opts
.with_capacity(self.map_capacity.unwrap())
.construct()
} else {
map_opts.construct()
};
w.refresh();
Ok(KeyedRateLimiter {
algorithm: <A as Algorithm>::construct(
self.capacity,
self.cell_weight,
self.per_time_unit,
)?,
map_reader: r,
map_writer: Arc::new(Mutex::new(w)),
})
}
}