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
#[doc(hidden)]
pub mod re_export {
    pub extern crate serde;
    pub extern crate tracing;

    pub use std::{
        boxed::Box,
        concat,
        pin::Pin,
        stringify,
        sync::{
            atomic::{AtomicU64, Ordering},
            Arc,
        },
    };

    pub use futures::{Future, Sink, Stream};
    pub use serde_derive::{Deserialize, Serialize};
    pub use tracing::Instrument;

    pub use super::*;
    pub use crate::error::{Error, Result};
}

use std::{collections::HashMap, fmt::Debug, marker::PhantomData, pin::Pin, sync::Arc};

use futures::{
    channel::{mpsc, oneshot},
    future::{select, Either},
    Future, FutureExt, Sink, SinkExt, Stream, StreamExt,
};
use tracing::Instrument;

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

/// The `Rpc` trait defined a rpc service by definding several necessary items.
///
/// The implementation is usually generated by macro.
pub trait Rpc {
    type Request;
    type Response;
}

/// The `RpcServerStub` trait allows making responses for requests.
///
/// The implementation is usually generated by macro.
pub trait RpcServerStub<R: Rpc, I: RpcFrame<R::Request>, O: RpcFrame<R::Response>> {
    fn make_response(self: Arc<Self>, req: I) -> Pin<Box<dyn Future<Output = Option<O>> + Send>>;
}

/// A unique identifier of a rpc call.
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub struct RequestId(pub u64);

impl std::fmt::Display for RequestId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "[{:016X}]", self.0)
    }
}

pub trait RpcFrame<T>: Sized + Send + 'static {
    fn from_parts(id: RequestId, data: T) -> Result<Self>;
    fn get_id(&self) -> RequestId;
    fn get_data(self) -> Result<T>;
}

impl<T: Sized + Send + 'static> RpcFrame<T> for (RequestId, T) {
    fn from_parts(id: RequestId, data: T) -> Result<Self> {
        Ok((id, data))
    }

    fn get_id(&self) -> RequestId {
        self.0
    }

    fn get_data(self) -> Result<T> {
        Ok(self.1)
    }
}

pub async fn serve<R, S, I, O, T, U>(
    stub: impl Into<Arc<S>>,
    mut recv: T,
    mut send: U,
) -> Result<()>
where
    R: Rpc,
    S: RpcServerStub<R, I, O>,
    I: RpcFrame<R::Request>,
    O: RpcFrame<R::Response>,
    T: Stream<Item = Result<I>> + Unpin,
    U: Sink<O, Error = Error> + Unpin,
{
    let stub: Arc<S> = stub.into();

    let (tx, mut rx) = mpsc::channel::<O>(128);
    let mut fut = select(recv.next(), rx.next());
    loop {
        match fut.await {
            Either::Left((Some(req), r)) => {
                let req = req?;
                let id = req.get_id();
                let stub = stub.clone();
                let mut tx = tx.clone();
                tokio::spawn(
                    stub.make_response(req)
                        .instrument(debug_span!("server", %id))
                        .then(move |res| async move {
                            if let Some(res) = res {
                                if let Err(e) = tx.send(res).await {
                                    assert!(e.is_disconnected());
                                    error!("driver closed unexpectedly");
                                }
                            }
                        }),
                );
                fut = select(recv.next(), r);
            }
            Either::Right((Some(rsp), r)) => {
                send.send(rsp).await?;
                fut = select(r, rx.next());
            }
            _ => {
                // None is returned from client or remote. Stop driver.
                break Ok(());
            }
        }
    }
}

pub struct RpcClient<'a, R: Rpc, I: RpcFrame<R::Response>, O: RpcFrame<R::Request>>(
    mpsc::Sender<(oneshot::Sender<Result<I>>, O)>,
    PhantomData<&'a R>,
);

impl<R: Rpc, I: RpcFrame<R::Response>, O: RpcFrame<R::Request>> RpcClient<'static, R, I, O> {
    pub fn new<
        T: Stream<Item = Result<I>> + Unpin + Send + 'static,
        U: Sink<O, Error = Error> + Unpin + Send + 'static,
    >(
        recv: T,
        send: U,
    ) -> Self {
        let (d, r) = Self::new_with_driver(recv, send);
        tokio::spawn(d);
        r
    }
}

impl<'a, R: Rpc, I: RpcFrame<R::Response>, O: RpcFrame<R::Request>> RpcClient<'a, R, I, O> {
    pub fn new_with_driver<T, U>(recv: T, send: U) -> (impl Future<Output = ()> + 'a, Self)
    where
        T: Stream<Item = Result<I>> + Unpin + 'a,
        U: Sink<O, Error = Error> + Unpin + 'a,
    {
        async fn driver<'a, R, I, O, T, U>(
            mut rx: mpsc::Receiver<(oneshot::Sender<Result<I>>, O)>,
            mut recv: T,
            mut send: U,
        ) where
            R: Rpc,
            I: RpcFrame<R::Response>,
            O: RpcFrame<R::Request>,
            T: Stream<Item = Result<I>> + Unpin + 'a,
            U: Sink<O, Error = Error> + Unpin + 'a,
        {
            let mut fut = select(rx.next(), recv.next());
            let mut req_map = HashMap::with_capacity(128);
            let ret = loop {
                match fut.await {
                    Either::Left((Some((callback, req)), r)) => {
                        let id = req.get_id();
                        if let Err(e) = send.send(req).await {
                            callback
                                .send(Err(e))
                                .unwrap_or_else(|_| error!("client closed unexpectedly"));
                        } else if req_map.insert(id, callback).is_some() {
                            panic!("request id is not unique")
                        }
                        fut = select(rx.next(), r);
                    }
                    Either::Right((Some(rsp), r)) => {
                        let rsp = match rsp {
                            Ok(rsp) => rsp,
                            Err(e) => break Err(e),
                        };
                        let id = rsp.get_id();
                        if let Some(callback) = req_map.remove(&id) {
                            callback
                                .send(Ok(rsp))
                                .unwrap_or_else(|_| error!("client closed unexpectedly"));
                        } else {
                            warn!("Server responeded for nonexist request: {}", id);
                        }
                        fut = select(r, recv.next());
                    }
                    _ => {
                        // None is returned from client or remote. Stop driver.
                        break Ok(());
                    }
                }
            };
            if let Err(e) = ret {
                let mut e = Some(e);
                for (_id, r) in req_map.into_iter() {
                    match r.send(Err(e.take().unwrap())) {
                        Ok(()) => break,
                        Err(r) => {
                            e = match r {
                                Err(x) => Some(x),
                                _ => unreachable!(),
                            };
                        }
                    }
                }
                if let Some(e) = e {
                    error!("failed to send error in driver: {}", e);
                }
            }
        }

        let (tx, rx) = mpsc::channel::<(oneshot::Sender<Result<I>>, O)>(128);
        (
            driver::<'a, R, I, O, T, U>(rx, recv, send),
            Self(tx, PhantomData),
        )
    }

    pub async fn make_request(&mut self, req: O) -> Result<I> {
        let (tx, rx) = oneshot::channel();
        self.0.send((tx, req)).await.map_err(|e| {
            assert!(e.is_disconnected());
            Error::DriverStopped
        })?;
        rx.await.unwrap_or(Err(Error::DriverStopped))
    }
}

impl<'a, R: Rpc, I: RpcFrame<R::Response>, O: RpcFrame<R::Request>> Debug
    for RpcClient<'a, R, I, O>
{
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "RpcClient")
    }
}

impl<'a, R: Rpc, I: RpcFrame<R::Response>, O: RpcFrame<R::Request>> Clone
    for RpcClient<'a, R, I, O>
{
    #[inline]
    fn clone(&self) -> Self {
        Self(self.0.clone(), PhantomData)
    }
}