src/libstd/sys/mod.rs

   1 //! Platform-dependent platform abstraction.
   2 //!
   3 //! The `std::sys` module is the abstracted interface through which
   4 //! `std` talks to the underlying operating system. It has different
   5 //! implementations for different operating system families, today
   6 //! just Unix and Windows, and initial support for Redox.
   7 //!
   8 //! The centralization of platform-specific code in this module is
   9 //! enforced by the "platform abstraction layer" tidy script in
  10 //! `tools/tidy/src/pal.rs`.
  11 //!
  12 //! This module is closely related to the platform-independent system
  13 //! integration code in `std::sys_common`. See that module's
  14 //! documentation for details.
  15 //!
  16 //! In the future it would be desirable for the independent
  17 //! implementations of this module to be extracted to their own crates
  18 //! that `std` can link to, thus enabling their implementation
  19 //! out-of-tree via crate replacement. Though due to the complex
  20 //! inter-dependencies within `std` that will be a challenging goal to
  21 //! achieve.
  22
  23 #![allow(missing_debug_implementations)]
  24
  25 cfg_if! {
  26     if #[cfg(unix)] {
  27         mod unix;
  28         pub use self::unix::*;
  29     } else if #[cfg(windows)] {
  30         mod windows;
  31         pub use self::windows::*;
  32     } else if #[cfg(target_os = "cloudabi")] {
  33         mod cloudabi;
  34         pub use self::cloudabi::*;
  35     } else if #[cfg(target_os = "redox")] {
  36         mod redox;
  37         pub use self::redox::*;
  38     } else if #[cfg(target_env = "wasi")] {
  39         mod wasi;
  40         pub use self::wasi::*;
  41     } else if #[cfg(target_arch = "wasm32")] {
  42         mod wasm;
  43         pub use self::wasm::*;
  44     } else if #[cfg(all(target_vendor = "fortanix", target_env = "sgx"))] {
  45         mod sgx;
  46         pub use self::sgx::*;
  47     } else {
  48         compile_error!("libstd doesn't compile for this platform yet");
  49     }
  50 }
  51
  52 // Import essential modules from both platforms when documenting. These are
  53 // then later used in the `std::os` module when documenting, for example,
  54 // Windows when we're compiling for Linux.
  55
  56 #[cfg(rustdoc)]
  57 cfg_if! {
  58     if #[cfg(any(unix, target_os = "redox"))] {
  59         // On unix we'll document what's already available
  60         #[stable(feature = "rust1", since = "1.0.0")]
  61         pub use self::ext as unix_ext;
  62     } else if #[cfg(any(target_os = "cloudabi",
  63                         target_arch = "wasm32",
  64                         all(target_vendor = "fortanix", target_env = "sgx")))] {
  65         // On CloudABI and wasm right now the module below doesn't compile
  66         // (missing things in `libc` which is empty) so just omit everything
  67         // with an empty module
  68         #[unstable(issue = "0", feature = "std_internals")]
  69         #[allow(missing_docs)]
  70         pub mod unix_ext {}
  71     } else {
  72         // On other platforms like Windows document the bare bones of unix
  73         use crate::os::linux as platform;
  74         #[path = "unix/ext/mod.rs"]
  75         pub mod unix_ext;
  76     }
  77 }
  78
  79 #[cfg(rustdoc)]
  80 cfg_if! {
  81     if #[cfg(windows)] {
  82         // On windows we'll just be documenting what's already available
  83         #[allow(missing_docs)]
  84         #[stable(feature = "rust1", since = "1.0.0")]
  85         pub use self::ext as windows_ext;
  86     } else if #[cfg(any(target_os = "cloudabi",
  87                         target_arch = "wasm32",
  88                         all(target_vendor = "fortanix", target_env = "sgx")))] {
  89         // On CloudABI and wasm right now the shim below doesn't compile, so
  90         // just omit it
  91         #[unstable(issue = "0", feature = "std_internals")]
  92         #[allow(missing_docs)]
  93         pub mod windows_ext {}
  94     } else {
  95         // On all other platforms (aka linux/osx/etc) then pull in a "minimal"
  96         // amount of windows goop which ends up compiling
  97         #[macro_use]
  98         #[path = "windows/compat.rs"]
  99         mod compat;
 100
 101         #[path = "windows/c.rs"]
 102         mod c;
 103
 104         #[path = "windows/ext/mod.rs"]
 105         pub mod windows_ext;
 106     }
 107 }