smoldot 1.0.0

Primitives to build a client for Substrate-based blockchains
Documentation 
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

// Smoldot
// Copyright (C) 2023  Pierre Krieger
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

use alloc::sync::Arc;
use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};

// TODO: this implementation could probably be optimized, but well, it works

// TODO: should be bounded
pub fn deliver_channel<T>() -> (DeliverSender<T>, DeliverReceiver<T>) {
    let common = Arc::new(Common {
        queue: crossbeam_queue::SegQueue::new(),
        num_senders_alive: AtomicUsize::new(1),
        sender_did_something: event_listener::Event::new(),
        receiver_is_dead: AtomicBool::new(false),
        receiver_did_something: event_listener::Event::new(),
    });

    let tx = DeliverSender {
        common: common.clone(),
    };
    let rx = DeliverReceiver { common };
    (tx, rx)
}

pub struct DeliverSender<T> {
    common: Arc<Common<T>>,
}

impl<T> DeliverSender<T> {
    /// Sends the given payload to the receiver and waits for it to have been received.
    ///
    /// If the [`DeliverReceiver`] has been dropped, an error is returned with the original value.
    pub async fn deliver(&mut self, payload: T) -> Result<(), T> {
        let message = Arc::new(atomic_take::AtomicTake::new(payload));

        self.common.queue.push(message.clone());
        self.common.sender_did_something.notify(1);

        let mut waiter = None;
        loop {
            if message.is_taken() {
                return Ok(());
            }

            if self.common.receiver_is_dead.load(Ordering::Acquire) {
                return match message.take() {
                    Some(payload) => Err(payload),
                    None => Ok(()),
                };
            }

            if let Some(waiter) = waiter.take() {
                waiter.await;
            } else {
                waiter = Some(self.common.receiver_did_something.listen());
            }
        }
    }
}

impl<T> Clone for DeliverSender<T> {
    fn clone(&self) -> Self {
        self.common
            .num_senders_alive
            .fetch_add(1, Ordering::Release);
        DeliverSender {
            common: self.common.clone(),
        }
    }
}

impl<T> Drop for DeliverSender<T> {
    fn drop(&mut self) {
        let _num_remain = self
            .common
            .num_senders_alive
            .fetch_sub(1, Ordering::Release);
        debug_assert!(_num_remain != usize::MAX); // Check for underflow.
        self.common.sender_did_something.notify(usize::MAX);
    }
}

pub struct DeliverReceiver<T> {
    common: Arc<Common<T>>,
}

impl<T> DeliverReceiver<T> {
    /// Returns the next item that was sent. If no item is available, waits until one is.
    ///
    /// Returns `None` if all the [`DeliverSender`]s have been dropped.
    pub async fn next(&mut self) -> Option<T> {
        let message: Arc<atomic_take::AtomicTake<T>> = {
            let mut waiter = None;
            loop {
                if let Some(item) = self.common.queue.pop() {
                    break item;
                }

                if self.common.num_senders_alive.load(Ordering::Acquire) == 0 {
                    return None;
                }

                if let Some(waiter) = waiter.take() {
                    waiter.await;
                } else {
                    waiter = Some(self.common.sender_did_something.listen());
                }
            }
        };

        let payload = message.take().unwrap();
        self.common.receiver_did_something.notify(usize::MAX);
        Some(payload)
    }
}

impl<T> Drop for DeliverReceiver<T> {
    fn drop(&mut self) {
        self.common.receiver_is_dead.store(true, Ordering::Release);
        self.common.receiver_did_something.notify(usize::MAX);
    }
}

struct Common<T> {
    queue: crossbeam_queue::SegQueue<Arc<atomic_take::AtomicTake<T>>>,
    /// `true` if the sending side is dead.
    num_senders_alive: AtomicUsize,
    /// Notified after an element has been pushed to the queue, or after a sender died.
    sender_did_something: event_listener::Event,
    /// `true` if the receiving side is dead.
    receiver_is_dead: AtomicBool,
    /// Notified after an element has been popped from the queue, or after a receiver died.
    receiver_did_something: event_listener::Event,
}