summaryrefslogtreecommitdiff
path: root/nrf-softdevice/src/util/portal.rs
blob: 92505a6ab564011059a339c561e01f394a87458d (plain)
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
use core::cell::UnsafeCell;
use core::future::Future;
use core::mem;
use core::mem::MaybeUninit;

use crate::util::{OnDrop, Signal};

/// Utility to call a closure across tasks.
pub struct Portal<T> {
    state: UnsafeCell<State<T>>,
}

enum State<T> {
    None,
    Running,
    Waiting(*mut dyn FnMut(T)),
    Done,
}

unsafe impl<T> Send for Portal<T> {}
unsafe impl<T> Sync for Portal<T> {}

fn assert_thread_mode() {
    assert!(
        cortex_m::peripheral::SCB::vect_active() == cortex_m::peripheral::scb::VectActive::ThreadMode,
        "portals are not usable from interrupts"
    );
}

impl<T> Portal<T> {
    pub const fn new() -> Self {
        Self {
            state: UnsafeCell::new(State::None),
        }
    }

    pub fn call(&self, val: T) -> bool {
        assert_thread_mode();

        // safety: this runs from thread mode
        unsafe {
            match *self.state.get() {
                State::None => false,
                State::Done => false,
                State::Running => panic!("Portall::call() called reentrantly"),
                State::Waiting(func) => {
                    (*func)(val);
                    true
                }
            }
        }
    }

    pub fn wait_once<'a, R, F>(&'a self, mut func: F) -> impl Future<Output = R> + 'a
    where
        F: FnMut(T) -> R + 'a,
    {
        assert_thread_mode();

        async move {
            let signal = Signal::new();
            let mut result: MaybeUninit<R> = MaybeUninit::uninit();
            let mut call_func = |val: T| unsafe {
                let state = &mut *self.state.get();

                // Set state to Running while running the function to avoid reentrancy.
                *state = State::Running;
                result.as_mut_ptr().write(func(val));

                *state = State::Done;
                signal.signal(());
            };

            let func_ptr: *mut dyn FnMut(T) = &mut call_func as _;
            let func_ptr: *mut dyn FnMut(T) = unsafe { mem::transmute(func_ptr) };

            let _bomb = OnDrop::new(|| unsafe {
                let state = &mut *self.state.get();
                *state = State::None;
            });

            // safety: this runs from thread mode
            unsafe {
                let state = &mut *self.state.get();
                match state {
                    State::None => {}
                    _ => panic!("Multiple tasks waiting on same portal"),
                }
                *state = State::Waiting(func_ptr);
            }

            signal.wait().await;

            unsafe { result.assume_init() }
            // dropbomb sets self.state = None
        }
    }

    #[allow(unused)]
    pub fn wait_many<'a, R, F>(&'a self, mut func: F) -> impl Future<Output = R> + 'a
    where
        F: FnMut(T) -> Option<R> + 'a,
    {
        assert_thread_mode();

        async move {
            let signal = Signal::new();
            let mut result: MaybeUninit<R> = MaybeUninit::uninit();
            let mut call_func = |val: T| {
                unsafe {
                    let state = &mut *self.state.get();

                    let func_ptr = match *state {
                        State::Waiting(p) => p,
                        _ => unreachable!(),
                    };

                    // Set state to Running while running the function to avoid reentrancy.
                    *state = State::Running;

                    *state = match func(val) {
                        None => State::Waiting(func_ptr),
                        Some(res) => {
                            result.as_mut_ptr().write(res);
                            signal.signal(());
                            State::Done
                        }
                    };
                };
            };

            let func_ptr: *mut dyn FnMut(T) = &mut call_func as _;
            let func_ptr: *mut dyn FnMut(T) = unsafe { mem::transmute(func_ptr) };

            let _bomb = OnDrop::new(|| unsafe {
                let state = &mut *self.state.get();
                *state = State::None;
            });

            // safety: this runs from thread mode
            unsafe {
                let state = &mut *self.state.get();
                match *state {
                    State::None => {}
                    _ => panic!("Multiple tasks waiting on same portal"),
                }
                *state = State::Waiting(func_ptr);
            }

            signal.wait().await;

            unsafe { result.assume_init() }
            // dropbomb sets self.state = None
        }
    }
}