2016-03-04 17:37:11 -05:00
|
|
|
//! OS-specific functionality.
|
2012-03-02 17:20:00 -08:00
|
|
|
|
2015-03-30 11:00:05 -07:00
|
|
|
#![stable(feature = "os", since = "1.0.0")]
|
2018-08-29 08:21:01 -05:00
|
|
|
#![allow(missing_docs, nonstandard_style, missing_debug_implementations)]
|
2012-03-06 18:49:08 -08:00
|
|
|
|
2015-04-15 23:21:13 -07:00
|
|
|
pub mod raw;
|
2021-03-04 14:03:26 +01:00
|
|
|
|
2021-04-14 21:36:13 +02:00
|
|
|
// The code below could be written clearer using `cfg_if!`. However, the items below are
|
|
|
|
|
// publicly exported by `std` and external tools can have trouble analysing them because of the use
|
|
|
|
|
// of a macro that is not vendored by Rust and included in the toolchain.
|
|
|
|
|
// See https://github.com/rust-analyzer/rust-analyzer/issues/6038.
|
|
|
|
|
|
2021-09-03 17:21:52 +02:00
|
|
|
// On certain platforms right now the "main modules" modules that are
|
|
|
|
|
// documented don't compile (missing things in `libc` which is empty),
|
|
|
|
|
// so just omit them with an empty module and add the "unstable" attribute.
|
|
|
|
|
|
|
|
|
|
// Unix, linux, wasi and windows are handled a bit differently.
|
2021-09-03 21:13:52 +02:00
|
|
|
#[cfg(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
|
|
|
|
))]
|
|
|
|
|
#[unstable(issue = "none", feature = "std_internals")]
|
|
|
|
|
pub mod unix {}
|
|
|
|
|
#[cfg(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
|
|
|
|
))]
|
|
|
|
|
#[unstable(issue = "none", feature = "std_internals")]
|
|
|
|
|
pub mod linux {}
|
|
|
|
|
#[cfg(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
|
|
|
|
))]
|
|
|
|
|
#[unstable(issue = "none", feature = "std_internals")]
|
|
|
|
|
pub mod wasi {}
|
|
|
|
|
#[cfg(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
|
|
|
|
))]
|
|
|
|
|
#[unstable(issue = "none", feature = "std_internals")]
|
|
|
|
|
pub mod windows {}
|
2021-09-03 17:21:52 +02:00
|
|
|
|
2021-09-03 21:13:52 +02:00
|
|
|
// unix
|
2021-09-07 15:44:08 +02:00
|
|
|
#[cfg(not(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
2021-09-03 21:13:52 +02:00
|
|
|
)))]
|
2021-09-07 15:44:08 +02:00
|
|
|
#[cfg(target_os = "hermit")]
|
2021-09-03 21:13:52 +02:00
|
|
|
#[path = "hermit/mod.rs"]
|
|
|
|
|
pub mod unix;
|
2021-09-07 15:44:08 +02:00
|
|
|
#[cfg(not(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
2021-09-03 21:13:52 +02:00
|
|
|
)))]
|
2021-09-07 15:44:08 +02:00
|
|
|
#[cfg(all(not(target_os = "hermit"), any(unix, doc)))]
|
2021-09-03 21:13:52 +02:00
|
|
|
pub mod unix;
|
2021-09-03 17:21:52 +02:00
|
|
|
|
2021-09-03 21:13:52 +02:00
|
|
|
// linux
|
2021-09-07 15:44:08 +02:00
|
|
|
#[cfg(not(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
2021-09-03 21:13:52 +02:00
|
|
|
)))]
|
2021-10-18 17:17:54 +02:00
|
|
|
#[cfg(any(target_os = "linux", doc))]
|
2021-09-03 21:13:52 +02:00
|
|
|
pub mod linux;
|
2021-09-03 17:21:52 +02:00
|
|
|
|
2021-09-03 21:13:52 +02:00
|
|
|
// wasi
|
2021-09-07 15:44:08 +02:00
|
|
|
#[cfg(not(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
2021-09-03 21:13:52 +02:00
|
|
|
)))]
|
|
|
|
|
#[cfg(any(target_os = "wasi", doc))]
|
|
|
|
|
pub mod wasi;
|
2021-09-03 17:21:52 +02:00
|
|
|
|
2021-09-03 21:13:52 +02:00
|
|
|
// windows
|
2021-09-07 15:44:08 +02:00
|
|
|
#[cfg(not(all(
|
|
|
|
|
doc,
|
|
|
|
|
any(
|
|
|
|
|
all(target_arch = "wasm32", not(target_os = "wasi")),
|
|
|
|
|
all(target_vendor = "fortanix", target_env = "sgx")
|
|
|
|
|
)
|
2021-09-03 21:13:52 +02:00
|
|
|
)))]
|
|
|
|
|
#[cfg(any(windows, doc))]
|
|
|
|
|
pub mod windows;
|
2021-04-14 21:36:13 +02:00
|
|
|
|
2021-09-03 17:21:52 +02:00
|
|
|
// Others.
|
|
|
|
|
#[cfg(target_os = "android")]
|
|
|
|
|
pub mod android;
|
|
|
|
|
#[cfg(target_os = "dragonfly")]
|
|
|
|
|
pub mod dragonfly;
|
|
|
|
|
#[cfg(target_os = "emscripten")]
|
|
|
|
|
pub mod emscripten;
|
|
|
|
|
#[cfg(target_os = "espidf")]
|
|
|
|
|
pub mod espidf;
|
2021-09-07 15:44:08 +02:00
|
|
|
#[cfg(all(target_vendor = "fortanix", target_env = "sgx"))]
|
|
|
|
|
pub mod fortanix_sgx;
|
2021-09-03 17:21:52 +02:00
|
|
|
#[cfg(target_os = "freebsd")]
|
|
|
|
|
pub mod freebsd;
|
|
|
|
|
#[cfg(target_os = "fuchsia")]
|
|
|
|
|
pub mod fuchsia;
|
|
|
|
|
#[cfg(target_os = "haiku")]
|
|
|
|
|
pub mod haiku;
|
|
|
|
|
#[cfg(target_os = "illumos")]
|
|
|
|
|
pub mod illumos;
|
|
|
|
|
#[cfg(target_os = "ios")]
|
|
|
|
|
pub mod ios;
|
2021-10-18 17:17:54 +02:00
|
|
|
#[cfg(target_os = "l4re")]
|
|
|
|
|
pub mod l4re;
|
2021-09-03 17:21:52 +02:00
|
|
|
#[cfg(target_os = "macos")]
|
|
|
|
|
pub mod macos;
|
|
|
|
|
#[cfg(target_os = "netbsd")]
|
|
|
|
|
pub mod netbsd;
|
|
|
|
|
#[cfg(target_os = "openbsd")]
|
|
|
|
|
pub mod openbsd;
|
|
|
|
|
#[cfg(target_os = "redox")]
|
|
|
|
|
pub mod redox;
|
|
|
|
|
#[cfg(target_os = "solaris")]
|
|
|
|
|
pub mod solaris;
|
|
|
|
|
|
Add SOLID targets
SOLID[1] is an embedded development platform provided by Kyoto
Microcomputer Co., Ltd. This commit introduces a basic Tier 3 support
for SOLID.
# New Targets
The following targets are added:
- `aarch64-kmc-solid_asp3`
- `armv7a-kmc-solid_asp3-eabi`
- `armv7a-kmc-solid_asp3-eabihf`
SOLID's target software system can be divided into two parts: an
RTOS kernel, which is responsible for threading and synchronization,
and Core Services, which provides filesystems, networking, and other
things. The RTOS kernel is a μITRON4.0[2][3]-derived kernel based on
the open-source TOPPERS RTOS kernels[4]. For uniprocessor systems
(more precisely, systems where only one processor core is allocated for
SOLID), this will be the TOPPERS/ASP3 kernel. As μITRON is
traditionally only specified at the source-code level, the ABI is
unique to each implementation, which is why `asp3` is included in the
target names.
More targets could be added later, as we support other base kernels
(there are at least three at the point of writing) and are interested
in supporting other processor architectures in the future.
# C Compiler
Although SOLID provides its own supported C/C++ build toolchain, GNU Arm
Embedded Toolchain seems to work for the purpose of building Rust.
# Unresolved Questions
A μITRON4 kernel can support `Thread::unpark` natively, but it's not
used by this commit's implementation because the underlying kernel
feature is also used to implement `Condvar`, and it's unclear whether
`std` should guarantee that parking tokens are not clobbered by other
synchronization primitives.
# Unsupported or Unimplemented Features
Most features are implemented. The following features are not
implemented due to the lack of native support:
- `fs::File::{file_attr, truncate, duplicate, set_permissions}`
- `fs::{symlink, link, canonicalize}`
- Process creation
- Command-line arguments
Backtrace generation is not really a good fit for embedded targets, so
it's intentionally left unimplemented. Unwinding is functional, however.
## Dynamic Linking
Dynamic linking is not supported. The target platform supports dynamic
linking, but enabling this in Rust causes several problems.
- The linker invocation used to build the shared object of `std` is
too long for the platform-provided linker to handle.
- A linker script with specific requirements is required for the
compiled shared object to be actually loadable.
As such, we decided to disable dynamic linking for now. Regardless, the
users can try to create shared objects by manually invoking the linker.
## Executable
Building an executable is not supported as the notion of "executable
files" isn't well-defined for these targets.
[1] https://solid.kmckk.com/SOLID/
[2] http://ertl.jp/ITRON/SPEC/mitron4-e.html
[3] https://en.wikipedia.org/wiki/ITRON_project
[4] https://toppers.jp/
2021-09-28 11:20:46 +09:00
|
|
|
#[cfg(target_os = "solid_asp3")]
|
|
|
|
|
pub mod solid;
|
2021-09-03 17:21:52 +02:00
|
|
|
#[cfg(target_os = "vxworks")]
|
|
|
|
|
pub mod vxworks;
|
2021-07-28 07:28:58 -07:00
|
|
|
|
2021-08-19 12:24:25 -07:00
|
|
|
#[cfg(any(unix, target_os = "wasi", doc))]
|
2021-07-28 07:28:58 -07:00
|
|
|
mod fd;
|