src/libstd/sys/sgx/mod.rs

   1 //! System bindings for the Fortanix SGX platform
   2 //!
   3 //! This module contains the facade (aka platform-specific) implementations of
   4 //! OS level functionality for Fortanix SGX.
   5
   6 use crate::io::ErrorKind;
   7 use crate::os::raw::c_char;
   8 use crate::sync::atomic::{AtomicBool, Ordering};
   9
  10 pub mod abi;
  11 mod waitqueue;
  12
  13 pub mod alloc;
  14 pub mod args;
  15 pub mod cmath;
  16 pub mod condvar;
  17 pub mod env;
  18 pub mod ext;
  19 pub mod fd;
  20 pub mod fs;
  21 pub mod io;
  22 pub mod memchr;
  23 pub mod mutex;
  24 pub mod net;
  25 pub mod os;
  26 pub mod path;
  27 pub mod pipe;
  28 pub mod process;
  29 pub mod rwlock;
  30 pub mod stack_overflow;
  31 pub mod stdio;
  32 pub mod thread;
  33 pub mod thread_local_key;
  34 pub mod time;
  35
  36 pub use crate::sys_common::os_str_bytes as os_str;
  37
  38 #[cfg(not(test))]
  39 pub fn init() {}
  40
  41 /// This function is used to implement functionality that simply doesn't exist.
  42 /// Programs relying on this functionality will need to deal with the error.
  43 pub fn unsupported<T>() -> crate::io::Result<T> {
  44     Err(unsupported_err())
  45 }
  46
  47 pub fn unsupported_err() -> crate::io::Error {
  48     crate::io::Error::new(ErrorKind::Other, "operation not supported on SGX yet")
  49 }
  50
  51 /// This function is used to implement various functions that doesn't exist,
  52 /// but the lack of which might not be reason for error. If no error is
  53 /// returned, the program might very well be able to function normally. This is
  54 /// what happens when `SGX_INEFFECTIVE_ERROR` is set to `true`. If it is
  55 /// `false`, the behavior is the same as `unsupported`.
  56 pub fn sgx_ineffective<T>(v: T) -> crate::io::Result<T> {
  57     static SGX_INEFFECTIVE_ERROR: AtomicBool = AtomicBool::new(false);
  58     if SGX_INEFFECTIVE_ERROR.load(Ordering::Relaxed) {
  59         Err(crate::io::Error::new(
  60             ErrorKind::Other,
  61             "operation can't be trusted to have any effect on SGX",
  62         ))
  63     } else {
  64         Ok(v)
  65     }
  66 }
  67
  68 pub fn decode_error_kind(code: i32) -> ErrorKind {
  69     use fortanix_sgx_abi::Error;
  70
  71     // FIXME: not sure how to make sure all variants of Error are covered
  72     if code == Error::NotFound as _ {
  73         ErrorKind::NotFound
  74     } else if code == Error::PermissionDenied as _ {
  75         ErrorKind::PermissionDenied
  76     } else if code == Error::ConnectionRefused as _ {
  77         ErrorKind::ConnectionRefused
  78     } else if code == Error::ConnectionReset as _ {
  79         ErrorKind::ConnectionReset
  80     } else if code == Error::ConnectionAborted as _ {
  81         ErrorKind::ConnectionAborted
  82     } else if code == Error::NotConnected as _ {
  83         ErrorKind::NotConnected
  84     } else if code == Error::AddrInUse as _ {
  85         ErrorKind::AddrInUse
  86     } else if code == Error::AddrNotAvailable as _ {
  87         ErrorKind::AddrNotAvailable
  88     } else if code == Error::BrokenPipe as _ {
  89         ErrorKind::BrokenPipe
  90     } else if code == Error::AlreadyExists as _ {
  91         ErrorKind::AlreadyExists
  92     } else if code == Error::WouldBlock as _ {
  93         ErrorKind::WouldBlock
  94     } else if code == Error::InvalidInput as _ {
  95         ErrorKind::InvalidInput
  96     } else if code == Error::InvalidData as _ {
  97         ErrorKind::InvalidData
  98     } else if code == Error::TimedOut as _ {
  99         ErrorKind::TimedOut
 100     } else if code == Error::WriteZero as _ {
 101         ErrorKind::WriteZero
 102     } else if code == Error::Interrupted as _ {
 103         ErrorKind::Interrupted
 104     } else if code == Error::Other as _ {
 105         ErrorKind::Other
 106     } else if code == Error::UnexpectedEof as _ {
 107         ErrorKind::UnexpectedEof
 108     } else {
 109         ErrorKind::Other
 110     }
 111 }
 112
 113 // This enum is used as the storage for a bunch of types which can't actually
 114 // exist.
 115 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
 116 pub enum Void {}
 117
 118 pub unsafe fn strlen(mut s: *const c_char) -> usize {
 119     let mut n = 0;
 120     while *s != 0 {
 121         n += 1;
 122         s = s.offset(1);
 123     }
 124     return n;
 125 }
 126
 127 pub fn abort_internal() -> ! {
 128     abi::usercalls::exit(true)
 129 }
 130
 131 // This function is needed by the panic runtime. The symbol is named in
 132 // pre-link args for the target specification, so keep that in sync.
 133 #[cfg(not(test))]
 134 #[no_mangle]
 135 // NB. used by both libunwind and libpanic_abort
 136 pub extern "C" fn __rust_abort() {
 137     abort_internal();
 138 }
 139
 140 pub mod rand {
 141     pub fn rdrand64() -> u64 {
 142         unsafe {
 143             let mut ret: u64 = 0;
 144             for _ in 0..10 {
 145                 if crate::arch::x86_64::_rdrand64_step(&mut ret) == 1 {
 146                     return ret;
 147                 }
 148             }
 149             rtabort!("Failed to obtain random data");
 150         }
 151     }
 152 }
 153
 154 pub fn hashmap_random_keys() -> (u64, u64) {
 155     (self::rand::rdrand64(), self::rand::rdrand64())
 156 }
 157
 158 pub use crate::sys_common::{AsInner, FromInner, IntoInner};
 159
 160 pub trait TryIntoInner<Inner>: Sized {
 161     fn try_into_inner(self) -> Result<Inner, Self>;
 162 }