http_pool/http2/
pool.rs

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