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
// This file is part of Gear.
// Copyright (C) 2021-2024 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/>.
use gprimitives::{ActorId, CodeId, MessageId, ReservationId};
pub(crate) trait AsRawPtr: AsRef<[u8]> + AsMut<[u8]> {
fn as_ptr(&self) -> *const [u8; 32] {
self.as_ref().as_ptr() as *const _
}
fn as_mut_ptr(&mut self) -> *mut [u8; 32] {
self.as_mut().as_mut_ptr() as *mut _
}
}
impl AsRawPtr for ActorId {}
impl AsRawPtr for CodeId {}
impl AsRawPtr for MessageId {}
impl AsRawPtr for ReservationId {}
/// Extensions for additional features.
pub mod ext {
#[cfg(any(feature = "debug", debug_assertions))]
use crate::errors::{Error, Result};
/// Add a `data` string to the debug log.
///
/// # Examples
///
/// ```
/// use gcore::ext;
///
/// #[no_mangle]
/// extern "C" fn handle() {
/// ext::debug("Hello, world!").expect("Unable to log");
/// }
/// ```
#[cfg(any(feature = "debug", debug_assertions))]
pub fn debug(data: &str) -> Result<()> {
let data_len = data.len().try_into().map_err(|_| Error::SyscallUsage)?;
unsafe { gsys::gr_debug(data.as_ptr(), data_len) }
Ok(())
}
/// Panic
///
/// Function is completely free in terms of gas usage.
///
/// # Examples
///
/// ```
/// use gcore::ext;
///
/// #[no_mangle]
/// extern "C" fn handle() {
/// ext::panic("I decided to panic");
/// }
/// ```
pub fn panic(data: &str) -> ! {
unsafe { gsys::gr_panic(data.as_ptr(), data.len() as u32) }
}
/// Out of memory panic
///
/// Function is completely free in terms of gas usage.
///
/// # Examples
///
/// ```rust,ignore
/// #![no_std]
/// #![feature(alloc_error_handler)]
/// #![feature(allocator_api)]
///
/// extern crate alloc;
///
/// use alloc::alloc::{Global, Layout, Allocator};
/// use gcore::ext;
///
/// #[alloc_error_handler]
/// fn oom(_layout: Layout) -> ! {
/// ext::oom_panic()
/// }
///
/// #[no_mangle]
/// extern "C" fn handle() {
/// let layout = Layout::new::<[u8; 64 * 1024]>();
/// if Global.allocate(layout).is_err() {
/// alloc::alloc::handle_alloc_error(layout);
/// }
/// }
/// ```
pub fn oom_panic() -> ! {
unsafe { gsys::gr_oom_panic() }
}
}