xitca_postgres/driver/
generic.rs

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
use core::{
    future::{poll_fn, Future},
    pin::Pin,
    task::Poll,
};

use std::{
    collections::VecDeque,
    io,
    sync::{Arc, Mutex},
};

use futures_core::task::__internal::AtomicWaker;
use postgres_protocol::message::{backend, frontend};
use xitca_io::{
    bytes::{Buf, BufRead, BytesMut},
    io::{AsyncIo, Interest},
};
use xitca_unsafe_collection::futures::{Select as _, SelectOutput};

use crate::error::{DriverDown, Error};

use super::codec::{Response, ResponseMessage, ResponseSender, SenderState};

type PagedBytesMut = xitca_unsafe_collection::bytes::PagedBytesMut<4096>;

const INTEREST_READ_WRITE: Interest = Interest::READABLE.add(Interest::WRITABLE);

pub(crate) struct DriverTx(Arc<SharedState>);

impl Drop for DriverTx {
    fn drop(&mut self) {
        {
            let mut state = self.0.guarded.lock().unwrap();
            frontend::terminate(&mut state.buf);
            state.closed = true;
        }
        self.0.waker.wake();
    }
}

impl DriverTx {
    pub(crate) fn is_closed(&self) -> bool {
        Arc::strong_count(&self.0) == 1
    }

    pub(crate) fn send_one_way<F>(&self, func: F) -> Result<(), Error>
    where
        F: FnOnce(&mut BytesMut) -> Result<(), Error>,
    {
        self._send(func, |_| {})?;
        Ok(())
    }

    pub(crate) fn send<F, O>(&self, func: F, msg_count: usize) -> Result<(O, Response), Error>
    where
        F: FnOnce(&mut BytesMut) -> Result<O, Error>,
    {
        self._send(func, |inner| {
            let (tx, rx) = super::codec::request_pair(msg_count);
            inner.res.push_back(tx);
            rx
        })
    }

    fn _send<F, F2, O, T>(&self, func: F, on_send: F2) -> Result<(O, T), Error>
    where
        F: FnOnce(&mut BytesMut) -> Result<O, Error>,
        F2: FnOnce(&mut State) -> T,
    {
        let mut inner = self.0.guarded.lock().unwrap();

        if inner.closed {
            return Err(DriverDown.into());
        }

        let len = inner.buf.len();

        let o = func(&mut inner.buf).inspect_err(|_| inner.buf.truncate(len))?;
        let t = on_send(&mut inner);

        drop(inner);
        self.0.waker.wake();

        Ok((o, t))
    }
}

pub(crate) struct SharedState {
    guarded: Mutex<State>,
    waker: AtomicWaker,
}

impl SharedState {
    async fn wait(&self) -> WaitState {
        poll_fn(|cx| {
            let inner = self.guarded.lock().unwrap();
            if !inner.buf.is_empty() {
                Poll::Ready(WaitState::WantWrite)
            } else if inner.closed {
                Poll::Ready(WaitState::WantClose)
            } else {
                drop(inner);
                self.waker.register(cx.waker());
                Poll::Pending
            }
        })
        .await
    }
}

enum WaitState {
    WantWrite,
    WantClose,
}

struct State {
    closed: bool,
    buf: BytesMut,
    res: VecDeque<ResponseSender>,
}

pub struct GenericDriver<Io> {
    io: Io,
    read_buf: PagedBytesMut,
    shared_state: Arc<SharedState>,
    read_state: ReadState,
    write_state: WriteState,
}

// in case driver is dropped without closing the shared state
impl<Io> Drop for GenericDriver<Io> {
    fn drop(&mut self) {
        self.shared_state.guarded.lock().unwrap().closed = true;
    }
}

enum WriteState {
    Waiting,
    WantWrite,
    WantFlush,
    Closed(Option<io::Error>),
}

enum ReadState {
    WantRead,
    Closed(Option<io::Error>),
}

impl<Io> GenericDriver<Io>
where
    Io: AsyncIo + Send,
{
    pub(crate) fn new(io: Io) -> (Self, DriverTx) {
        let state = Arc::new(SharedState {
            guarded: Mutex::new(State {
                closed: false,
                buf: BytesMut::new(),
                res: VecDeque::new(),
            }),
            waker: AtomicWaker::new(),
        });

        (
            Self {
                io,
                read_buf: PagedBytesMut::new(),
                shared_state: state.clone(),
                read_state: ReadState::WantRead,
                write_state: WriteState::Waiting,
            },
            DriverTx(state),
        )
    }

    pub(crate) async fn send(&mut self, msg: BytesMut) -> Result<(), Error> {
        self.shared_state.guarded.lock().unwrap().buf.extend_from_slice(&msg);
        self.write_state = WriteState::WantWrite;
        loop {
            self.try_write()?;
            if matches!(self.write_state, WriteState::Waiting) {
                return Ok(());
            }
            self.io.ready(Interest::WRITABLE).await?;
        }
    }

    pub(crate) fn recv(&mut self) -> impl Future<Output = Result<backend::Message, Error>> + Send + '_ {
        self.recv_with(|buf| backend::Message::parse(buf).map_err(Error::from).transpose())
    }

    pub(crate) async fn try_next(&mut self) -> Result<Option<backend::Message>, Error> {
        loop {
            if let Some(msg) = self.try_decode()? {
                return Ok(Some(msg));
            }

            let ready = match (&mut self.read_state, &mut self.write_state) {
                (ReadState::WantRead, WriteState::Waiting) => {
                    match self.shared_state.wait().select(self.io.ready(Interest::READABLE)).await {
                        SelectOutput::A(WaitState::WantWrite) => {
                            self.write_state = WriteState::WantWrite;
                            self.io.ready(INTEREST_READ_WRITE).await?
                        }
                        SelectOutput::A(WaitState::WantClose) => {
                            self.write_state = WriteState::Closed(None);
                            continue;
                        }
                        SelectOutput::B(ready) => ready?,
                    }
                }
                (ReadState::WantRead, WriteState::WantWrite) => self.io.ready(INTEREST_READ_WRITE).await?,
                (ReadState::WantRead, WriteState::WantFlush) => {
                    // before flush io do a quick buffer check and go into write io state if possible.
                    if !self.shared_state.guarded.lock().unwrap().buf.is_empty() {
                        self.write_state = WriteState::WantWrite;
                    }
                    self.io.ready(INTEREST_READ_WRITE).await?
                }
                (ReadState::WantRead, WriteState::Closed(_)) => self.io.ready(Interest::READABLE).await?,
                (ReadState::Closed(_), WriteState::WantFlush | WriteState::WantWrite) => {
                    self.io.ready(Interest::WRITABLE).await?
                }
                (ReadState::Closed(_), WriteState::Waiting) => match self.shared_state.wait().await {
                    WaitState::WantWrite => {
                        self.write_state = WriteState::WantWrite;
                        self.io.ready(Interest::WRITABLE).await?
                    }
                    WaitState::WantClose => {
                        self.write_state = WriteState::Closed(None);
                        continue;
                    }
                },
                (ReadState::Closed(None), WriteState::Closed(None)) => {
                    poll_fn(|cx| Pin::new(&mut self.io).poll_shutdown(cx)).await?;
                    return Ok(None);
                }
                (ReadState::Closed(read_err), WriteState::Closed(write_err)) => {
                    return Err(Error::driver_io(read_err.take(), write_err.take()))
                }
            };

            if ready.is_readable() {
                if let Err(e) = self.try_read() {
                    self.on_read_err(e);
                };
            }

            if ready.is_writable() {
                if let Err(e) = self.try_write() {
                    self.on_write_err(e);
                }
            }
        }
    }

    async fn recv_with<F, O>(&mut self, mut func: F) -> Result<O, Error>
    where
        F: FnMut(&mut BytesMut) -> Option<Result<O, Error>>,
    {
        loop {
            if let Some(o) = func(self.read_buf.get_mut()) {
                return o;
            }
            self.io.ready(Interest::READABLE).await?;
            self.try_read()?;
        }
    }

    fn try_read(&mut self) -> io::Result<()> {
        self.read_buf.do_io(&mut self.io)
    }

    fn try_write(&mut self) -> io::Result<()> {
        loop {
            match self.write_state {
                WriteState::WantFlush => {
                    match io::Write::flush(&mut self.io) {
                        Ok(_) => self.write_state = WriteState::Waiting,
                        Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {}
                        Err(e) => return Err(e),
                    }
                    break;
                }
                WriteState::WantWrite => {
                    let mut inner = self.shared_state.guarded.lock().unwrap();

                    match io::Write::write(&mut self.io, &inner.buf) {
                        Ok(0) => return Err(io::ErrorKind::WriteZero.into()),
                        Ok(n) => {
                            inner.buf.advance(n);

                            if inner.buf.is_empty() {
                                self.write_state = WriteState::WantFlush;
                            }
                        }
                        Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => break,
                        Err(e) => return Err(e),
                    }
                }
                _ => unreachable!("try_write must not be called when WriteState is wait or closed"),
            }
        }

        Ok(())
    }

    #[cold]
    fn on_read_err(&mut self, e: io::Error) {
        let reason = (e.kind() != io::ErrorKind::UnexpectedEof).then_some(e);
        self.read_state = ReadState::Closed(reason);
    }

    #[cold]
    fn on_write_err(&mut self, e: io::Error) {
        {
            // when write error occur the driver would go into half close state(read only).
            // clearing write_buf would drop all pending requests in it and hint the driver
            // no future Interest::WRITABLE should be passed to AsyncIo::ready method.
            let mut inner = self.shared_state.guarded.lock().unwrap();
            inner.buf.clear();
            // close shared state early so driver tx can observe the shutdown in first hand
            inner.closed = true;
        }
        self.write_state = WriteState::Closed(Some(e));
    }

    fn try_decode(&mut self) -> Result<Option<backend::Message>, Error> {
        while let Some(res) = ResponseMessage::try_from_buf(self.read_buf.get_mut())? {
            match res {
                ResponseMessage::Normal(mut msg) => {
                    let mut inner = self.shared_state.guarded.lock().unwrap();
                    let front = inner.res.front_mut().ok_or_else(|| msg.parse_error())?;
                    match front.send(msg) {
                        SenderState::Finish => {
                            inner.res.pop_front();
                        }
                        SenderState::Continue => {}
                    }
                }
                ResponseMessage::Async(msg) => return Ok(Some(msg)),
            }
        }
        Ok(None)
    }
}