]> git.lizzy.rs Git - rust.git/blob - library/std/src/sys/hermit/mod.rs
Document that `init` and `cleanup` are not guaranteed to run
[rust.git] / library / std / src / sys / hermit / mod.rs
1 //! System bindings for HermitCore
2 //!
3 //! This module contains the facade (aka platform-specific) implementations of
4 //! OS level functionality for HermitCore.
5 //!
6 //! This is all super highly experimental and not actually intended for
7 //! wide/production use yet, it's still all in the experimental category. This
8 //! will likely change over time.
9 //!
10 //! Currently all functions here are basically stubs that immediately return
11 //! errors. The hope is that with a portability lint we can turn actually just
12 //! remove all this and just omit parts of the standard library if we're
13 //! compiling for wasm. That way it's a compile time error for something that's
14 //! guaranteed to be a runtime error!
15
16 #![allow(unsafe_op_in_unsafe_fn)]
17
18 use crate::intrinsics;
19 use crate::os::raw::c_char;
20
21 pub mod alloc;
22 pub mod args;
23 pub mod cmath;
24 pub mod condvar;
25 pub mod env;
26 pub mod ext;
27 pub mod fd;
28 pub mod fs;
29 pub mod io;
30 pub mod memchr;
31 pub mod mutex;
32 pub mod net;
33 pub mod os;
34 pub mod path;
35 #[path = "../unsupported/pipe.rs"]
36 pub mod pipe;
37 #[path = "../unsupported/process.rs"]
38 pub mod process;
39 pub mod rwlock;
40 pub mod stdio;
41 pub mod thread;
42 pub mod thread_local_dtor;
43 pub mod thread_local_key;
44 pub mod time;
45
46 use crate::io::ErrorKind;
47 pub use crate::sys_common::os_str_bytes as os_str;
48
49 #[allow(unused_extern_crates)]
50 pub extern crate hermit_abi as abi;
51
52 pub fn unsupported<T>() -> crate::io::Result<T> {
53     Err(unsupported_err())
54 }
55
56 pub fn unsupported_err() -> crate::io::Error {
57     crate::io::Error::new_const(
58         crate::io::ErrorKind::Unsupported,
59         &"operation not supported on HermitCore yet",
60     )
61 }
62
63 pub unsafe fn strlen(start: *const c_char) -> usize {
64     let mut str = start;
65
66     while *str != 0 {
67         str = str.offset(1);
68     }
69
70     (str as usize) - (start as usize)
71 }
72
73 #[no_mangle]
74 pub extern "C" fn floor(x: f64) -> f64 {
75     unsafe { intrinsics::floorf64(x) }
76 }
77
78 pub fn abort_internal() -> ! {
79     unsafe {
80         abi::abort();
81     }
82 }
83
84 // FIXME: just a workaround to test the system
85 pub fn hashmap_random_keys() -> (u64, u64) {
86     (1, 2)
87 }
88
89 // This function is needed by the panic runtime. The symbol is named in
90 // pre-link args for the target specification, so keep that in sync.
91 #[cfg(not(test))]
92 #[no_mangle]
93 // NB. used by both libunwind and libpanic_abort
94 pub extern "C" fn __rust_abort() {
95     abort_internal();
96 }
97
98 // SAFETY: must be called only once during runtime initialization.
99 // NOTE: this is not guaranteed to run, for example when Rust code is called externally.
100 pub unsafe fn init(argc: isize, argv: *const *const u8) {
101     let _ = net::init();
102     args::init(argc, argv);
103 }
104
105 // SAFETY: must be called only once during runtime cleanup.
106 // NOTE: this is not guaranteed to run, for example when the program aborts.
107 pub unsafe fn cleanup() {
108     args::cleanup();
109 }
110
111 #[cfg(not(test))]
112 #[no_mangle]
113 pub unsafe extern "C" fn runtime_entry(
114     argc: i32,
115     argv: *const *const c_char,
116     env: *const *const c_char,
117 ) -> ! {
118     use crate::sys::hermit::thread_local_dtor::run_dtors;
119     extern "C" {
120         fn main(argc: isize, argv: *const *const c_char) -> i32;
121     }
122
123     // initialize environment
124     os::init_environment(env as *const *const i8);
125
126     let result = main(argc as isize, argv);
127
128     run_dtors();
129     abi::exit(result);
130 }
131
132 pub fn decode_error_kind(errno: i32) -> ErrorKind {
133     match errno {
134         x if x == 13 as i32 => ErrorKind::PermissionDenied,
135         x if x == 98 as i32 => ErrorKind::AddrInUse,
136         x if x == 99 as i32 => ErrorKind::AddrNotAvailable,
137         x if x == 11 as i32 => ErrorKind::WouldBlock,
138         x if x == 103 as i32 => ErrorKind::ConnectionAborted,
139         x if x == 111 as i32 => ErrorKind::ConnectionRefused,
140         x if x == 104 as i32 => ErrorKind::ConnectionReset,
141         x if x == 17 as i32 => ErrorKind::AlreadyExists,
142         x if x == 4 as i32 => ErrorKind::Interrupted,
143         x if x == 22 as i32 => ErrorKind::InvalidInput,
144         x if x == 2 as i32 => ErrorKind::NotFound,
145         x if x == 107 as i32 => ErrorKind::NotConnected,
146         x if x == 1 as i32 => ErrorKind::PermissionDenied,
147         x if x == 32 as i32 => ErrorKind::BrokenPipe,
148         x if x == 110 as i32 => ErrorKind::TimedOut,
149         _ => ErrorKind::Other,
150     }
151 }
152
153 pub fn cvt(result: i32) -> crate::io::Result<usize> {
154     if result < 0 { Err(crate::io::Error::from_raw_os_error(-result)) } else { Ok(result as usize) }
155 }