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 remove_backend(&self, addr: &Address) -> bool {
123        if self.state.lb_strategy.remove_backend(addr) {
124            // 清除缓存
125            self.clear_bs_inner(addr);
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 get_sender(&self, bs: &BackendState) -> Option<Sender> {
143        let mut guard = self.free_conn_map.lock().unwrap();
144
145        // 这里虽然删除了一些closed状态的, 但算法却有延迟性,它无法及时删除所有的closed
146        let inners = guard.get_mut(&bs.hash_code())?;
147        for idx in (0..inners.len()).rev() {
148            let inner = &mut inners[idx];
149            if inner.is_closed() {
150                // 无效了
151                assert!(self.state.cur_conn.fetch_sub(1, Relaxed) > 0);
152                trace!(
153                    "[http/2.0 pool] [desc] current connection count: {}",
154                    self.state.cur_conn.load(Relaxed)
155                );
156                inners.remove(idx);
157                continue;
158            }
159
160            if inner.limited(self.get_max_streams()) {
161                continue;
162            }
163
164            let tls = <Pool as net_pool::pool::Pool>::tls(self);
165            return Some(inner.new_sender(crate::utils::base_url(tls, bs.get_address())));
166        }
167
168        None
169    }
170
171    fn add_inner(&self, hash_code: u64, inner: Inner) {
172        let mut guard = self.free_conn_map.lock().unwrap();
173        if let Some(inners) = guard.get_mut(&hash_code) {
174            inners.push(inner);
175        } else {
176            guard.insert(hash_code, vec![inner]);
177        }
178    }
179
180    fn clear_bs_inner(&self, addr: &Address) {
181        let mut guard = self.free_conn_map.lock().unwrap();
182        if let Some(inners) = guard.remove(&addr.hash_code()) {
183            assert!(self.state.cur_conn.fetch_sub(inners.len(), Relaxed) > 0);
184            trace!(
185                "[http/2.0 pool] [desc] current connection count: {}",
186                self.state.cur_conn.load(Relaxed)
187            );
188        }
189    }
190
191    fn remove_inner(&self, hash_code: u64, id: u32) {
192        let mut guard = self.free_conn_map.lock().unwrap();
193        if let Some(inners) = guard.get_mut(&hash_code) {
194            let mut del = false;
195            inners.retain(|inner| {
196                if inner.id() == id {
197                    del = true;
198                    assert!(self.state.cur_conn.fetch_sub(1, Relaxed) > 0);
199                    false
200                } else {
201                    true
202                }
203            });
204            if del {
205                trace!(
206                    "[http/2.0 pool] [desc] current connection count: {}",
207                    self.state.cur_conn.load(Relaxed)
208                );
209            }
210        }
211    }
212
213    fn run_conn<C: Future<Output = Result<(), hyper::Error>> + Send + 'static>(
214        pool: Arc<Self>,
215        c: C,
216        sr: SendRequest,
217        bs: &BackendState,
218    ) -> Sender {
219        let tls = <Pool as net_pool::pool::Pool>::tls(&pool);
220        let inner = Inner::new(sr);
221        let sender = inner.new_sender(crate::utils::base_url(tls, bs.get_address()));
222
223        let tuple = (
224            bs.hash_code(),
225            <Pool as net_pool::pool::Pool>::get_keepalive(&pool),
226            inner.reference(),
227            inner.id(),
228        );
229
230        // 加入
231        pool.add_inner(tuple.0, inner);
232
233        // 驱动
234        tokio_spawn! {
235            instrument_current_span! {
236                async move {
237                    let _r = crate::utils::run_conn(tuple.2, c, tuple.1).await;
238                    debug!("[http/2.0 pool] connection closed: {:?}", _r);
239                    pool.remove_inner(tuple.0, tuple.3);
240                }
241            }
242        };
243
244        sender
245    }
246
247    async fn create_tls_sender(
248        self: Arc<Self>,
249        bs: &BackendState,
250        exec: hyper_util::rt::TokioExecutor,
251    ) -> Result<Sender, Error> {
252        let addr = bs.get_address();
253
254        // 获取连接
255        let tcp = crate::utils::create_https_stream(addr).await?;
256        let tls_tcp =
257            crate::utils::create_tls_tcp(tcp, addr, crate::utils::HTTP2_TLS_CLIENT_CFG.clone())
258                .await?;
259
260        // 握手建立 sender 和 connection
261        let max_streams = self.get_max_streams();
262        let io = hyper_util::rt::TokioIo::new(tls_tcp);
263        let pair = http2::Builder::new(exec)
264            .max_concurrent_streams(max_streams.map(|m| m as u32))
265            .handshake(io)
266            .await
267            .map_err(|e| Error::from_other(e))?;
268
269        // 启动连接驱动
270        let sender = Pool::run_conn(self, pair.1, pair.0, &bs);
271        Ok(sender)
272    }
273
274    async fn create_non_tls_sender(
275        self: Arc<Self>,
276        bs: &BackendState,
277        exec: hyper_util::rt::TokioExecutor,
278    ) -> Result<Sender, Error> {
279        let tcp = crate::utils::create_http_stream(bs.get_address()).await?;
280
281        // 握手建立 sender 和 connection
282        let io = hyper_util::rt::TokioIo::new(tcp);
283        let pair = http2::handshake(exec, io)
284            .await
285            .map_err(|e| Error::from_other(e))?;
286
287        // 启动连接驱动
288        let sender = Pool::run_conn(self, pair.1, pair.0, bs);
289        Ok(sender)
290    }
291
292    async fn create_sender(self: Arc<Self>, bs: &BackendState) -> Result<Sender, Error> {
293        let exec = hyper_util::rt::tokio::TokioExecutor::new();
294        if <Pool as net_pool::pool::Pool>::tls(&self) {
295            self.create_tls_sender(bs, exec).await
296        } else {
297            self.create_non_tls_sender(bs, exec).await
298        }
299    }
300}
301
302pub trait HttpPool {
303    fn get(self: Arc<Self>, key: &str) -> impl Future<Output = Result<Sender, Error>> + Send;
304
305    fn get_id(&self) -> &String;
306}
307
308impl HttpPool for Pool {
309    async fn get(self: Arc<Self>, key: &str) -> Result<Sender, Error> {
310        let bs = self
311            .state
312            .lb_strategy
313            .get_backend(key)
314            .ok_or(Error::NoBackend)?;
315
316        let sender = match self.get_sender(&bs) {
317            Some(s) => Ok(s),
318            None => {
319                // 预分配数量
320                net_pool::pool::increase_current(&self.state.max_conn, &self.state.cur_conn)?;
321                self.clone().create_sender(&bs).await.map(|s| {
322                    trace!(
323                        "[http/2.0 pool] [incr] current connection count: {}",
324                        self.state.cur_conn.load(Relaxed)
325                    );
326                    s
327                })
328            }
329        };
330
331        if sender.is_err() {
332            assert!(self.state.cur_conn.fetch_sub(1, Relaxed) > 0);
333        }
334
335        sender
336    }
337
338    fn get_id(&self) -> &String {
339        &self.id
340    }
341}
342
343pub async fn get<P: HttpPool>(pool: Arc<P>, key: &str) -> Result<Sender, Error> {
344    HttpPool::get(pool, key).await
345}