quota 0.1.6

High-performance Rate-limiter
Documentation 
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

use std::cell::{Cell};
use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::marker::PhantomData;
use crate::{Quota, QuotaRef, QuotaResult};
use crate::QuotaPolicy;
pub struct StaleQuotaRef;
pub struct QuotaPool<'a> {
    initial_available_tokens: u64,
    policy: QuotaPolicy,
    key_map: Cell<HashMap<&'static str, usize>>,
    quotas: Cell<Vec<Quota>>,
    last_access_times_ns: Cell<Vec<std::time::Instant>>,
    last_refill_times_ns: Cell<Vec<std::time::Instant>>,
    epoch: Cell<std::time::Instant>,
    generations: Cell<Vec<u32>>,
    occupied: Cell<Vec<bool>>,
    _marker: PhantomData<&'a ()>,
}

impl<'a> QuotaPool<'a> {
    #[inline]
    pub fn new(policy: QuotaPolicy, initial_available_tokens: u64) -> Self {
        Self {
            initial_available_tokens,
            policy,
            key_map: Cell::new(HashMap::new()),
            quotas: Cell::new(Vec::new()),
            last_access_times_ns: Cell::new(Vec::new()),
            last_refill_times_ns: Cell::new(Vec::new()),
            epoch: Cell::new(std::time::Instant::now()),
            generations: Cell::new(Vec::new()),
            occupied: Cell::new(Vec::new()),
            _marker: PhantomData,
        }
    }

    #[inline]
    pub fn reset(&mut self) {
        let now = std::time::Instant::now();
        self.epoch = Cell::new(now);
        self.last_access_times_ns.get_mut().fill(now);
    }
/*
    #[inline]
    pub fn quota(&self, key: &'static str) -> &Quota {
        unsafe {
            let key_map = &mut *self.key_map.as_ptr();
            let quotas = &mut *self.quotas.as_ptr();
            match key_map.entry(key) {
                Entry::Occupied(occupied_entry) => {
                    &quotas[*occupied_entry.get()]
                }
                Entry::Vacant(vacant_entry) => {
                    let last_access_times_ns = &mut *self.last_access_times_ns.as_ptr();
                    let last_refill_times_ns = &mut *self.last_refill_times_ns.as_ptr();
                    let new_index = quotas.len();
                    vacant_entry.insert(new_index);
                    quotas.push(Quota::with_initial_tokens(self.initial_available_tokens));
                    let t = std::time::Instant::now();
                    last_access_times_ns.push(t);
                    last_refill_times_ns.push(t);
                    &quotas.get_unchecked(new_index)
                }
            }
        }
    }
*/

    #[inline]
    pub fn quota(&'a self, key: &'static str) -> QuotaRef<'a> {
        unsafe {
            let key_map = &mut *self.key_map.as_ptr();
            let quotas = &mut *self.quotas.as_ptr();
            match key_map.entry(key) {
                Entry::Occupied(occupied_entry) => {
                    QuotaRef {
                        pool: &self,
                        index: *occupied_entry.get(),
                        generation: 0
                    }
                }
                Entry::Vacant(vacant_entry) => {
                    let last_access_times_ns = &mut *self.last_access_times_ns.as_ptr();
                    let last_refill_times_ns = &mut *self.last_refill_times_ns.as_ptr();
                    let new_index = quotas.len();
                    vacant_entry.insert(new_index);
                    quotas.push(Quota::with_initial_tokens(self.initial_available_tokens));
                    let t = std::time::Instant::now();
                    last_access_times_ns.push(t);
                    last_refill_times_ns.push(t);
                    QuotaRef {
                        pool: &self,
                        index: new_index,
                        generation: 0
                    }
                }
            }
        }
    }
    #[inline]
    pub(crate) fn quota_with_index(&self, key: &'static str) -> (&Quota, usize) {
        unsafe {
            let key_map = &mut *self.key_map.as_ptr();
            let quotas = &mut *self.quotas.as_ptr();
            match key_map.entry(key) {
                Entry::Occupied(occupied_entry) => {
                    let i = *occupied_entry.get();
                    (&quotas[i], i)
                }
                Entry::Vacant(vacant_entry) => {
                    let last_access_times_ns = &mut *self.last_access_times_ns.as_ptr();
                    let last_refill_times_ns = &mut *self.last_refill_times_ns.as_ptr();
                    let new_index = quotas.len();
                    vacant_entry.insert(new_index);
                    quotas.push(Quota::with_initial_tokens(self.initial_available_tokens));
                    let t = std::time::Instant::now();
                    last_access_times_ns.push(t);
                    last_refill_times_ns.push(t);
                    (&quotas.get_unchecked(new_index), new_index)
                }
            }
        }
    }

    /// Ticks the Quota with the time difference since last access
    /// and then consumes the cost and returns the result
    #[inline]
    pub fn consume(&self, key: &'static str, cost: u64) -> QuotaResult {
        let (quota, index) = self.quota_with_index(key);
        let last_access_time_ns = unsafe { (&mut *self.last_access_times_ns.as_ptr())[index] };

        let delta = last_access_time_ns.elapsed();

        self.policy.tick(delta.as_nanos() as u64, &quota);
        quota.consume(cost)
    }


    #[inline]
    pub(crate) fn consume_at(
        &self,
        index: usize,
        generation: u32,
        cost: u64,
    ) -> Result<QuotaResult, StaleQuotaRef> {
        unsafe {
            let quotas = &mut *self.quotas.as_ptr();
            let generations = &*self.generations.as_ptr();
            let occupied = &*self.occupied.as_ptr();
            let last_access_times = &mut *self.last_access_times_ns.as_ptr();

            if index >= quotas.len()
                || generations[index] != generation
                || !occupied[index]
            {
                return Err(StaleQuotaRef);
            }

            let now = std::time::Instant::now();
            let dt = now.duration_since(last_access_times[index]);
            last_access_times[index] = now;

            self.policy.tick(dt.as_nanos() as u64, &quotas[index]);

            Ok(quotas[index].consume(cost))
        }
    }
}

#[cfg(test)]
mod tests;