http_pool/http1/
pool.rs

1use crate::http1::{SendRequest, Sender};
2use cpool::backend::{Address, BackendState};
3use cpool::strategy::LbStrategy;
4use cpool::{Error, debug, instrument_current_span, tokio_spawn, trace};
5use hyper::client::conn::http1;
6use std::collections::HashMap;
7use std::sync::atomic::Ordering::Relaxed;
8use std::sync::atomic::{AtomicBool, AtomicU32};
9use std::sync::{Arc, LazyLock, Mutex};
10
11/// sender id 分配
12static SENDER_ID: LazyLock<AtomicU32> = LazyLock::new(|| AtomicU32::new(1));
13
14struct Inner {
15    /// 空闲的sr
16    free: HashMap<u32, Arc<SendRequest>>,
17    /// 在用的sr
18    work: HashMap<u32, Arc<SendRequest>>,
19}
20
21impl Inner {
22    fn new() -> Self {
23        Inner {
24            free: HashMap::new(),
25            work: HashMap::new(),
26        }
27    }
28
29    fn add_work_sr(&mut self, sr: Arc<SendRequest>) -> u32 {
30        let id = SENDER_ID.fetch_add(1, Relaxed);
31        self.work.insert(id, sr);
32        id
33    }
34
35    fn remove_sr(&mut self, id: u32) -> bool {
36        // 不应该同时处于work和free中
37        if self.work.remove(&id).is_some() {
38            true
39        } else if self.free.remove(&id).is_some() {
40            true
41        } else {
42            false
43        }
44    }
45
46    /// 返回值是被删除的元素个数, 及查找到的sr
47    fn get_sr(&mut self) -> (usize, Option<Arc<SendRequest>>) {
48        if self.free.is_empty() {
49            // 挪动
50            self.work.retain(|id, sr| {
51                // 引用计数为2时,代表外界不存在引用, 队列里一份, run那里一份
52                if Arc::strong_count(sr) == 2 {
53                    self.free.insert(*id, sr.clone());
54                    false
55                } else {
56                    true
57                }
58            });
59        }
60
61        // 这里虽然删除了一些closed状态的, 但算法却有延迟性,它无法及时删除所有的closed
62        let mut del = 0;
63        let ks: Vec<u32> = self.free.keys().cloned().collect();
64        for k in ks {
65            if let Some(sr) = self.free.remove(&k) {
66                if sr.is_closed() {
67                    del += 1;
68                } else {
69                    // 挪入work
70                    self.work.insert(k, sr.clone());
71                    return (del, Some(sr));
72                }
73            }
74        }
75
76        (del, None)
77    }
78}
79
80/// http1连接池
81/// 连接池中的连接受max_conn数据限制
82/// 默认的keepalive是一分钟
83/// 有三种行为会导致连接池中的连接被释放
84///     1.对方主动关闭连接
85///     2.remove_backend被调用清除后端地址, 这会导致该地址的所有连接失效
86///     3.在外界没有引用sender达到keepalive时间后, 注意如果没有设置keepalive则此条无效
87pub struct Pool {
88    id: String,
89    state: cpool::pool::BaseState,
90    use_tls: AtomicBool,
91    free_conn_map: Mutex<HashMap<u64, Inner>>,
92}
93
94impl Pool {
95    pub fn new(id: String, strategy: Arc<dyn LbStrategy>) -> Self {
96        let p = Pool {
97            id,
98            state: cpool::pool::BaseState::new(strategy),
99            use_tls: AtomicBool::new(false),
100            free_conn_map: Mutex::new(HashMap::new()),
101        };
102        <Pool as cpool::pool::Pool>::set_keepalive(
103            &p,
104            Some(std::time::Duration::from_secs(60 * 1)),
105        );
106        p
107    }
108}
109
110impl Default for Pool {
111    fn default() -> Self {
112        Pool::new(
113            "".to_string(),
114            Arc::new(cpool::strategy::CHStrategy::default()),
115        )
116    }
117}
118
119impl cpool::pool::Pool for Pool {
120    cpool::macros::base_pool_impl! {state}
121
122    fn remove_backend(&self, addr: &Address) -> bool {
123        if self.state.lb_strategy.remove_backend(addr) {
124            // 清除缓存
125            self.clear_bs_sr(addr.hash_code());
126            true
127        } else {
128            false
129        }
130    }
131
132    fn use_tls(&self, tls: bool) {
133        self.use_tls.store(tls, Relaxed);
134    }
135
136    fn tls(&self) -> bool {
137        self.use_tls.load(Relaxed)
138    }
139}
140
141impl Pool {
142    fn clear_bs_sr(&self, hash_code: u64) {
143        let mut guard = self.free_conn_map.lock().unwrap();
144        if let Some(inner) = guard.remove(&hash_code) {
145            assert!(
146                self.state
147                    .cur_conn
148                    .fetch_sub(inner.free.len() + inner.work.len(), Relaxed)
149                    > 0
150            );
151            trace!(
152                "[http/1.1 pool] [desc] current connection count: {}",
153                self.state.cur_conn.load(Relaxed)
154            );
155        }
156    }
157
158    fn get_sender(&self, bs: &BackendState) -> Option<Sender> {
159        let mut guard = self.free_conn_map.lock().unwrap();
160        let inner = guard.get_mut(&bs.hash_code())?;
161
162        let sr = {
163            let (del_cnt, sr) = inner.get_sr();
164            if del_cnt > 0 {
165                assert!(self.state.cur_conn.fetch_sub(del_cnt, Relaxed) > 0);
166                trace!(
167                    "[http/1.1 pool] [desc] current connection count: {}",
168                    self.state.cur_conn.load(Relaxed)
169                );
170            }
171            sr
172        };
173
174        let tls = <Pool as cpool::pool::Pool>::tls(self);
175        sr.map(|s| Sender::new(s, crate::utils::base_url(tls, bs.get_address())))
176    }
177
178    fn add_sr(&self, hash_code: u64, sr: Arc<SendRequest>) -> u32 {
179        let mut guard = self.free_conn_map.lock().unwrap();
180        if let Some(inner) = guard.get_mut(&hash_code) {
181            inner.add_work_sr(sr)
182        } else {
183            let mut inner = Inner::new();
184            let id = inner.add_work_sr(sr);
185            guard.insert(hash_code, inner);
186            id
187        }
188    }
189
190    fn remove_sr(&self, hash_code: u64, id: u32) {
191        let mut guard = self.free_conn_map.lock().unwrap();
192        if let Some(inner) = guard.get_mut(&hash_code) {
193            if inner.remove_sr(id) {
194                assert!(self.state.cur_conn.fetch_sub(1, Relaxed) > 0);
195                trace!(
196                    "[http/1.1 pool] [desc] current connection count: {}",
197                    self.state.cur_conn.load(Relaxed)
198                );
199            }
200        }
201    }
202
203    fn run_conn<C: Future<Output = Result<(), hyper::Error>> + Send + 'static>(
204        pool: Arc<Self>,
205        c: C,
206        sr: Arc<SendRequest>,
207        bs: &BackendState,
208    ) {
209        let hash_code = bs.hash_code();
210
211        // 加入work,且必须在下面执行super::run_conn之前加入
212        let id = pool.add_sr(hash_code, sr.clone());
213        let ka = <Pool as cpool::pool::Pool>::get_keepalive(&pool);
214
215        tokio_spawn! {
216            instrument_current_span! {
217                async move {
218                    let _r = crate::utils::run_conn(sr, c, ka).await;
219                    debug!("[http/1.1 pool] connection closed: {:?}", _r);
220                    pool.remove_sr(hash_code, id);
221                }
222            }
223        };
224    }
225
226    async fn create_tls_sender(self: Arc<Self>, bs: &BackendState) -> Result<Sender, Error> {
227        let tls = <Pool as cpool::pool::Pool>::tls(&self);
228        let addr = bs.get_address();
229
230        // 获取连接
231        let tcp = crate::utils::create_https_stream(addr).await?;
232        let tls_tcp =
233            crate::utils::create_tls_tcp(tcp, addr, crate::utils::HTTP1_TLS_CLIENT_CFG.clone())
234                .await?;
235
236        // 握手建立 sender 和 connection
237        let io = hyper_util::rt::TokioIo::new(tls_tcp);
238        let pair = http1::handshake(io)
239            .await
240            .map_err(|e| Error::from_other(e))?;
241
242        // 启动连接驱动
243        let sr = Arc::new(pair.0);
244        Pool::run_conn(self, pair.1, sr.clone(), &bs);
245
246        // 返回一份
247        Ok(Sender::new(sr, crate::utils::base_url(tls, addr)))
248    }
249
250    async fn create_non_tls_sender(self: Arc<Self>, bs: &BackendState) -> Result<Sender, Error> {
251        let addr = bs.get_address();
252        let tls = <Pool as cpool::pool::Pool>::tls(&self);
253
254        // 获取连接
255        let tcp = crate::utils::create_http_stream(addr).await?;
256
257        // 握手建立 sender 和 connection
258        let io = hyper_util::rt::TokioIo::new(tcp);
259        let pair = http1::handshake(io)
260            .await
261            .map_err(|e| Error::from_other(e))?;
262
263        // 启动连接驱动
264        let sr = Arc::new(pair.0);
265        Pool::run_conn(self, pair.1, sr.clone(), &bs);
266
267        // 返回一份
268        Ok(Sender::new(sr, crate::utils::base_url(tls, addr)))
269    }
270
271    async fn create_sender(self: Arc<Self>, bs: &BackendState) -> Result<Sender, Error> {
272        if <Pool as cpool::pool::Pool>::tls(&self) {
273            self.create_tls_sender(bs).await
274        } else {
275            self.create_non_tls_sender(bs).await
276        }
277    }
278}
279
280pub trait Http1Pool {
281    fn get(self: Arc<Self>, key: &str) -> impl Future<Output = Result<Sender, Error>> + Send;
282
283    fn get_id(&self) -> &String;
284}
285
286impl Http1Pool for Pool {
287    async fn get(self: Arc<Self>, key: &str) -> Result<Sender, Error> {
288        let bs = self
289            .state
290            .lb_strategy
291            .get_backend(key)
292            .ok_or(Error::NoBackend)?;
293
294        if let Some(sender) = self.clone().get_sender(&bs) {
295            return Ok(sender);
296        }
297
298        let sender = {
299            // 预分配数量
300            cpool::pool::increase_current(&self.state.max_conn, &self.state.cur_conn)?;
301            self.clone().create_sender(&bs).await.map(|s| {
302                trace!(
303                    "[http/1.1 pool] [incr] current connection count: {}",
304                    self.state.cur_conn.load(Relaxed)
305                );
306                s
307            })
308        };
309
310        if sender.is_err() {
311            assert!(self.state.cur_conn.fetch_sub(1, Relaxed) > 0);
312        }
313
314        sender
315    }
316
317    fn get_id(&self) -> &String {
318        &self.id
319    }
320}
321
322pub async fn get<P: Http1Pool>(pool: Arc<P>, key: &str) -> Result<Sender, Error> {
323    Http1Pool::get(pool, key).await
324}