gstd 1.10.0

Gear programs standard library
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

// This file is part of Gear.

// Copyright (C) 2021-2025 Gear Technologies Inc.
// 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 <https://www.gnu.org/licenses/>.

mod futures;
mod locks;
mod signals;

#[cfg(not(feature = "ethexe"))]
mod reply_hooks;

pub use self::futures::message_loop;
pub(crate) use locks::Lock;
pub(crate) use signals::ReplyPoll;

#[cfg(not(feature = "ethexe"))]
pub(crate) use reply_hooks::HooksMap;

use self::futures::FuturesMap;
use hashbrown::HashMap;
use locks::LocksMap;
use signals::WakeSignals;

#[cfg(not(feature = "ethexe"))]
use crate::critical;

static mut FUTURES: Option<FuturesMap> = None;

pub(crate) fn futures() -> &'static mut FuturesMap {
    unsafe { crate::static_mut!(FUTURES).get_or_insert_with(HashMap::new) }
}

static mut SIGNALS: Option<WakeSignals> = None;

pub(crate) fn signals() -> &'static mut WakeSignals {
    unsafe { crate::static_mut!(SIGNALS).get_or_insert_with(WakeSignals::new) }
}

static mut LOCKS: Option<LocksMap> = None;

pub(crate) fn locks() -> &'static mut LocksMap {
    unsafe { crate::static_mut!(LOCKS).get_or_insert_with(LocksMap::default) }
}

#[cfg(not(feature = "ethexe"))]
static mut REPLY_HOOKS: Option<HooksMap> = None;

#[cfg(not(feature = "ethexe"))]
pub(crate) fn reply_hooks() -> &'static mut HooksMap {
    unsafe { crate::static_mut!(REPLY_HOOKS).get_or_insert_with(HooksMap::new) }
}

/// Default reply handler.
pub fn handle_reply_with_hook() {
    signals().record_reply();

    // Execute reply hook (if it was registered)
    let replied_to =
        crate::msg::reply_to().expect("`gstd::handle_reply_with_hook()` called in wrong context");

    #[cfg(not(feature = "ethexe"))]
    reply_hooks().execute_and_remove(replied_to);

    #[cfg(feature = "ethexe")]
    let _ = replied_to;
}

/// Default signal handler.
#[cfg(not(feature = "ethexe"))]
pub fn handle_signal() {
    let msg_id = crate::msg::signal_from().expect(
        "`gstd::async_runtime::handle_signal()` must be called only in `handle_signal` entrypoint",
    );

    critical::take_and_execute();

    futures().remove(&msg_id);
    locks().remove_message_entry(msg_id);
    reply_hooks().remove(msg_id)
}