ohos-ffrt 0.1.0

ohos ffrt runtime bindings
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
use ohos_ffrt_sys::*;
use std::cell::UnsafeCell;
use std::future::Future;
use std::pin::Pin;
use std::ptr::NonNull;
use std::sync::Arc;
use std::task::{Context, Poll, Waker};

/// oneshot 接收错误
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct RecvError;

impl std::fmt::Display for RecvError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "channel closed")
    }
}

impl std::error::Error for RecvError {}

/// oneshot 发送错误
#[derive(Debug, PartialEq, Eq)]
pub struct SendError<T>(pub T);

impl<T> std::fmt::Display for SendError<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "receiver dropped")
    }
}

impl<T: std::fmt::Debug> std::error::Error for SendError<T> {}

/// 创建一个新的 oneshot channel
///
/// 返回一个 (Sender, Receiver) 对,只能发送一个值
///
/// # Examples
///
/// ```no_run
/// use ohos_ffrt::signal::oneshot;
///
/// let (tx, rx) = oneshot::channel();
///
/// ohos_ffrt::spawn(async move {
///     if let Err(_) = tx.send(42) {
///         println!("Receiver dropped");
///     }
/// });
///
/// match rx.await {
///     Ok(value) => println!("Got: {}", value),
///     Err(_) => println!("Sender dropped"),
/// }
/// ```
pub fn channel<T>() -> (Sender<T>, Receiver<T>) {
    let shared = Arc::new(Shared::new());
    (
        Sender {
            shared: Some(shared.clone()),
        },
        Receiver {
            shared: Some(shared),
        },
    )
}

struct Inner<T> {
    value: Option<T>,
    sender_alive: bool,
    receiver_alive: bool,
    waker: Option<Waker>,
}

/// 基于 FFRT 同步原语的共享状态
struct Shared<T> {
    mutex: NonNull<ffrt_mutex_t>,
    cond: NonNull<ffrt_cond_t>,
    data: UnsafeCell<Inner<T>>,
}

impl<T> Shared<T> {
    fn new() -> Self {
        use std::mem::MaybeUninit;

        let mut uninit_mutex = Box::new(MaybeUninit::<ffrt_mutex_t>::uninit());
        let mut uninit_cond = Box::new(MaybeUninit::<ffrt_cond_t>::uninit());

        unsafe {
            ffrt_mutex_init(uninit_mutex.as_mut_ptr(), std::ptr::null());
            ffrt_cond_init(uninit_cond.as_mut_ptr(), std::ptr::null());
        }

        let mutex = unsafe { uninit_mutex.assume_init() };
        let cond = unsafe { uninit_cond.assume_init() };

        Self {
            mutex: unsafe { NonNull::new_unchecked(Box::into_raw(mutex)) },
            cond: unsafe { NonNull::new_unchecked(Box::into_raw(cond)) },
            data: UnsafeCell::new(Inner {
                value: None,
                sender_alive: true,
                receiver_alive: true,
                waker: None,
            }),
        }
    }

    fn lock(&self) -> SharedGuard<'_, T> {
        unsafe {
            ffrt_mutex_lock(self.mutex.as_ptr());
        }
        SharedGuard { shared: self }
    }
}

struct SharedGuard<'a, T> {
    shared: &'a Shared<T>,
}

impl<'a, T> SharedGuard<'a, T> {
    fn inner(&self) -> &Inner<T> {
        unsafe { &*self.shared.data.get() }
    }

    fn inner_mut(&mut self) -> &mut Inner<T> {
        unsafe { &mut *self.shared.data.get() }
    }

    fn broadcast(&self) {
        unsafe {
            ffrt_cond_broadcast(self.shared.cond.as_ptr());
        }
    }
}

impl<'a, T> Drop for SharedGuard<'a, T> {
    fn drop(&mut self) {
        unsafe {
            ffrt_mutex_unlock(self.shared.mutex.as_ptr());
        }
    }
}

impl<T> Drop for Shared<T> {
    fn drop(&mut self) {
        unsafe {
            ffrt_cond_destroy(self.cond.as_ptr());
            ffrt_mutex_destroy(self.mutex.as_ptr());
            let _ = Box::from_raw(self.mutex.as_ptr());
            let _ = Box::from_raw(self.cond.as_ptr());
        }
    }
}

unsafe impl<T: Send> Send for Shared<T> {}
unsafe impl<T: Send> Sync for Shared<T> {}

/// oneshot channel 的发送端
///
/// 通过此类型发送单个值到对应的 Receiver
pub struct Sender<T> {
    shared: Option<Arc<Shared<T>>>,
}

impl<T> Sender<T> {
    /// 发送值到 channel
    ///
    /// 如果接收端已经被丢弃,则返回错误
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use ohos_ffrt::signal::oneshot;
    ///
    /// let (tx, rx) = oneshot::channel();
    ///
    /// tx.send(42).unwrap();
    /// ```
    pub fn send(mut self, value: T) -> Result<(), SendError<T>> {
        if let Some(shared) = self.shared.take() {
            let mut guard = shared.lock();

            if !guard.inner().receiver_alive {
                return Err(SendError(value));
            }

            guard.inner_mut().value = Some(value);

            // 唤醒等待的 waker
            if let Some(waker) = guard.inner_mut().waker.take() {
                waker.wake();
            }

            guard.broadcast();
            Ok(())
        } else {
            Err(SendError(value))
        }
    }

    /// 检查接收端是否已关闭
    pub fn is_closed(&self) -> bool {
        if let Some(shared) = &self.shared {
            let guard = shared.lock();
            !guard.inner().receiver_alive
        } else {
            true
        }
    }

    /// 异步等待接收端关闭
    pub async fn closed(&mut self) {
        if let Some(shared) = &self.shared {
            ClosedFuture {
                shared: shared.clone(),
            }
            .await
        }
    }
}

impl<T> Drop for Sender<T> {
    fn drop(&mut self) {
        if let Some(shared) = self.shared.take() {
            let mut guard = shared.lock();
            guard.inner_mut().sender_alive = false;

            if let Some(waker) = guard.inner_mut().waker.take() {
                waker.wake();
            }

            guard.broadcast();
        }
    }
}

/// 等待接收端关闭的 Future
struct ClosedFuture<T> {
    shared: Arc<Shared<T>>,
}

impl<T> Future for ClosedFuture<T> {
    type Output = ();

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> {
        let mut guard = self.shared.lock();

        if !guard.inner().receiver_alive {
            Poll::Ready(())
        } else {
            guard.inner_mut().waker = Some(cx.waker().clone());
            Poll::Pending
        }
    }
}

/// oneshot channel 的接收端
///
/// 通过 await 或 blocking_recv 接收单个值
pub struct Receiver<T> {
    shared: Option<Arc<Shared<T>>>,
}

impl<T> Receiver<T> {
    /// 尝试非阻塞地接收值
    ///
    /// 如果值还没准备好或发送端已关闭,返回错误
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use ohos_ffrt::signal::oneshot;
    ///
    /// let (tx, mut rx) = oneshot::channel();
    ///
    /// // 没有值可接收
    /// assert!(rx.try_recv().is_err());
    ///
    /// tx.send(42).unwrap();
    ///
    /// // 现在可以接收了
    /// assert_eq!(rx.try_recv().unwrap(), 42);
    /// ```
    pub fn try_recv(&mut self) -> Result<T, RecvError> {
        if let Some(shared) = &self.shared {
            let mut guard = shared.lock();

            if let Some(value) = guard.inner_mut().value.take() {
                Ok(value)
            } else if !guard.inner().sender_alive {
                Err(RecvError)
            } else {
                Err(RecvError)
            }
        } else {
            Err(RecvError)
        }
    }

    /// 阻塞式接收值
    ///
    /// 会阻塞当前线程直到接收到值或发送端关闭
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use ohos_ffrt::signal::oneshot;
    /// use std::thread;
    ///
    /// let (tx, rx) = oneshot::channel();
    ///
    /// thread::spawn(move || {
    ///     tx.send(42).unwrap();
    /// });
    ///
    /// assert_eq!(rx.blocking_recv().unwrap(), 42);
    /// ```
    pub fn blocking_recv(mut self) -> Result<T, RecvError> {
        if let Some(shared) = self.shared.take() {
            let mut guard = shared.lock();

            loop {
                if let Some(value) = guard.inner_mut().value.take() {
                    return Ok(value);
                }

                if !guard.inner().sender_alive {
                    return Err(RecvError);
                }

                // 等待条件变量
                unsafe {
                    ffrt_cond_wait(shared.cond.as_ptr(), shared.mutex.as_ptr());
                }
            }
        } else {
            Err(RecvError)
        }
    }

    /// 关闭接收端
    pub fn close(&mut self) {
        if let Some(shared) = &self.shared {
            let mut guard = shared.lock();
            guard.inner_mut().receiver_alive = false;
            guard.broadcast();
        }
    }
}

impl<T> Future for Receiver<T> {
    type Output = Result<T, RecvError>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        if let Some(shared) = &self.shared {
            let mut guard = shared.lock();

            if let Some(value) = guard.inner_mut().value.take() {
                return Poll::Ready(Ok(value));
            }

            if !guard.inner().sender_alive {
                return Poll::Ready(Err(RecvError));
            }

            guard.inner_mut().waker = Some(cx.waker().clone());
            Poll::Pending
        } else {
            Poll::Ready(Err(RecvError))
        }
    }
}

impl<T> Drop for Receiver<T> {
    fn drop(&mut self) {
        if let Some(shared) = self.shared.take() {
            let mut guard = shared.lock();
            guard.inner_mut().receiver_alive = false;

            if let Some(waker) = guard.inner_mut().waker.take() {
                waker.wake();
            }

            guard.broadcast();
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_send_recv() {
        let (tx, rx) = channel();
        tx.send(42).unwrap();
        assert_eq!(rx.blocking_recv().unwrap(), 42);
    }

    #[test]
    fn test_sender_dropped() {
        let (tx, rx) = channel::<i32>();
        drop(tx);
        assert!(rx.blocking_recv().is_err());
    }

    #[test]
    fn test_receiver_dropped() {
        let (tx, _rx) = channel();
        assert!(tx.send(42).is_err());
    }
}