linux_android: Use direct syscall on x86-64 to support x86_64-*-linux-none.

Remove the last libc dependency from `linux_android`, as a step
towards supporting x86_64-unknown-linux-none.

This requires bumping the MSRV to 1.59.

Author: briansmith

.clippy.toml

@@ -1 +1 @@
-msrv = "1.57"
+msrv = "1.59"

.github/workflows/tests.yml

@@ -44,7 +44,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-22.04, windows-2022]
-        toolchain: [nightly, beta, stable, 1.57]
+        toolchain: [nightly, beta, stable, 1.59]
         # Only Test macOS on stable to reduce macOS CI jobs
         include:
           # x86_64-apple-darwin.
@@ -61,6 +61,8 @@ jobs:
       - uses: Swatinem/rust-cache@v2
       - run: cargo test
       - run: cargo test --features=std
+      # This is assumed to be the same code path as x86_64-*-linux-none, since
+      # we don't/can't run tests for that target yet.
       - run: cargo test --features=linux_disable_fallback
       - run: cargo test --features=custom # custom should do nothing here
       - if: ${{ matrix.toolchain == 'nightly' }}
@@ -361,6 +363,8 @@ jobs:
             features: ["rdrand"]
           - target: i686-unknown-hurd-gnu
             features: ["std"]
+          - target: x86_64-unknown-linux-none
+            features: ["rdrand"]
     steps:
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@nightly # Required to build libcore

Cargo.toml

@@ -2,7 +2,7 @@
 name = "getrandom"
 version = "0.2.15" # Also update html_root_url in lib.rs when bumping this
 edition = "2021"
-rust-version = "1.57" # Sync .clippy.toml, tests.yml, and README.md.
+rust-version = "1.59" # Sync .clippy.toml, tests.yml, and README.md.
 authors = ["The Rand Project Developers"]
 license = "MIT OR Apache-2.0"
 description = "A small cross-platform library for retrieving random data from system source"
@@ -18,7 +18,11 @@ cfg-if = "1"
 compiler_builtins = { version = "0.1", optional = true }
 core = { version = "1.0", optional = true, package = "rustc-std-workspace-core" }
 
-[target.'cfg(unix)'.dependencies]
+# XXX: Additionally, we don't use libc when feature `linux_disable_fallback` is
+# enabled on `x86_64-{*-linux-*,linux-android}`, but we can't express this. In
+# that case, we require libc to be built, and we force it to be linked, but we
+# don't actually use anything from it.
+[target.'cfg(all(unix, not(all(target_arch = "x86_64", target_os = "linux", target_env = ""))))'.dependencies]
 libc = { version = "0.2.154", default-features = false }
 
 [target.'cfg(target_os = "wasi")'.dependencies]

README.md

@@ -52,7 +52,7 @@ crate features, WASM support and Custom RNGs see the
 
 ## Minimum Supported Rust Version
 
-This crate requires Rust 1.57.0 or later.
+This crate requires Rust 1.59.0 or later.
 
 ## Platform Support
 

src/lib.rs

@@ -259,7 +259,12 @@ cfg_if! {
         mod util_libc;
         #[path = "getrandom.rs"] mod imp;
     } else if #[cfg(all(
-        not(feature = "linux_disable_fallback"),
+        // Always treat feature="linux_disable_fallback" identically to
+        // all(target_os = "linux", target_env="") to ensure the code paths are
+        // the same. This is important because we can't run tests for
+        // *-*-linux-none (yet). Note that target_env="" for common Android
+        // targets.
+        not(any(feature = "linux_disable_fallback", all(target_os = "linux", target_env=""))),
         any(
             // Rust supports Android API level 19 (KitKat) [0] and the next upgrade targets
             // level 21 (Lollipop) [1], while `getrandom(2)` was added only in
@@ -304,8 +309,8 @@ cfg_if! {
         mod linux_android;
         #[path = "linux_android_with_fallback.rs"] mod imp;
     } else if #[cfg(any(target_os = "android", target_os = "linux"))] {
-        mod util_libc;
-        #[path = "linux_android.rs"] mod imp;
+        mod linux_android;
+        use linux_android as imp;
     } else if #[cfg(target_os = "solaris")] {
         mod util_libc;
         #[path = "solaris.rs"] mod imp;

src/linux_android.rs

@@ -6,18 +6,75 @@ pub fn getrandom_inner(dest: &mut [MaybeUninit<u8>]) -> Result<(), Error> {
     sys_fill_exact(dest, getrandom_syscall)
 }
 
+// The value of `EINTR` is not architecture-specific. It is checked against
+// `libc::EINTR` by linux_android_with_fallback.rs.
+pub const EINTR: i32 = 4;
+
 // Also used by linux_android_with_fallback to check if the syscall is available.
-pub fn getrandom_syscall(buf: &mut [MaybeUninit<u8>]) -> Result<usize, Error> {
-    use crate::util_libc::last_os_error;
+cfg_if! {
+    // TODO: Expand inilne assembly to other architectures to avoid depending
+    // on libc on Linux.
+    if #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))] {
+        type Word = u64;
+        type IWord = i64;
+
+        // TODO(MSRV(1.78 feature(target_abi))): Enable this and remove `target_pointer_width`
+        // restriction above.
+        //
+        // #[cfg(target_abi = "x32")]
+        // const __X32_SYSCALL_BIT: Word = 0x40000000;
+        //
+        // #[cfg(target_abi = "x832")]
+        // #[allow(non_upper_case_globals)]
+        // pub const SYS_getrandom: IWord = 318 | __X32_SYSCALL_BIT;
+
+        // #[cfg(not(target_abi = "x832"))]
+        #[allow(non_upper_case_globals)]
+        pub const SYS_getrandom: IWord = 318;
+
+        pub fn getrandom_syscall(buf: &mut [MaybeUninit<u8>]) -> Result<usize, Error> {
+            // Clamp request length to word size; no-op on regular (non-x32) x86_64.
+            let buflen: Word = Word::try_from(buf.len()).unwrap_or(Word::MAX);
+            let mut ret: IWord;
+            let flags = 0;
+            unsafe {
+                core::arch::asm!(
+                    "syscall",
+                    inout("rax") SYS_getrandom => ret,
+                    in("rdi") buf.as_mut_ptr(),
+                    in("rsi") buflen,
+                    in("rdx") flags,
+                    lateout("rcx") _,
+                    lateout("r11") _,
+                    options(nostack),
+                );
+            }
+            match Word::try_from(ret) {
+                Ok(written) => {
+                    const _:() = assert!(core::mem::size_of::<Word>() <= core::mem::size_of::<usize>());
+                    Ok(written as usize)
+                },
+                Err(_) => {
+                    Err(u32::try_from(ret.unsigned_abs()).map_or(
+                        Error::UNEXPECTED, Error::from_os_error))
+                }
+            }
+        }
+    } else {
+        use crate::util_libc::last_os_error;
+        pub use libc::SYS_getrandom;
 
-    let ret: libc::c_long = unsafe {
-        libc::syscall(
-            libc::SYS_getrandom,
-            buf.as_mut_ptr().cast::<core::ffi::c_void>(),
-            buf.len(),
-            0,
-        )
-    };
-    const _: () = assert!(core::mem::size_of::<libc::c_long>() == core::mem::size_of::<isize>());
-    usize::try_from(ret as isize).map_err(|_| last_os_error())
+        pub fn getrandom_syscall(buf: &mut [MaybeUninit<u8>]) -> Result<usize, Error> {
+            let ret: libc::c_long = unsafe {
+                libc::syscall(
+                    SYS_getrandom,
+                    buf.as_mut_ptr().cast::<core::ffi::c_void>(),
+                    buf.len(),
+                    0,
+                )
+            };
+            const _:() = assert!(core::mem::size_of::<libc::c_long>() == core::mem::size_of::<isize>());
+            usize::try_from(ret as isize).map_err(|_| last_os_error())
+        }
+    }
 }

src/linux_android_with_fallback.rs

@@ -2,6 +2,9 @@
 use crate::{lazy::LazyBool, linux_android, use_file, Error};
 use core::mem::MaybeUninit;
 
+const _: () = assert!(linux_android::EINTR == libc::EINTR);
+const _: () = assert!(linux_android::SYS_getrandom == libc::SYS_getrandom);
+
 pub fn getrandom_inner(dest: &mut [MaybeUninit<u8>]) -> Result<(), Error> {
     // getrandom(2) was introduced in Linux 3.17
     static HAS_GETRANDOM: LazyBool = LazyBool::new();

src/util_unix.rs

@@ -9,12 +9,18 @@ pub fn sys_fill_exact(
     mut buf: &mut [MaybeUninit<u8>],
     sys_fill: impl Fn(&mut [MaybeUninit<u8>]) -> Result<usize, Error>,
 ) -> Result<(), Error> {
+    // Avoid depending on libc for Linux/Android.
+    #[cfg(any(target_os = "android", target_os = "linux"))]
+    use crate::linux_android::EINTR;
+    #[cfg(not(any(target_os = "android", target_os = "linux")))]
+    use libc::EINTR;
+
     while !buf.is_empty() {
         match sys_fill(buf) {
             Ok(res) if res > 0 => buf = buf.get_mut(res..).ok_or(Error::UNEXPECTED)?,
             Err(err) => {
                 // We should try again if the call was interrupted.
-                if err.raw_os_error() != Some(libc::EINTR) {
+                if err.raw_os_error() != Some(EINTR) {
                     return Err(err);
                 }
             }