STD support for the Nintendo 3DS #95897

AzureMarker · 2022-04-10T21:08:17Z

Rustc already supports compiling for the Nintendo 3DS using the armv6k-nintendo-3ds target (Tier 3). Until now though, only core and alloc were supported. This PR adds standard library support for the Nintendo 3DS. A notable exclusion is std::thread support, which will come in a follow-up PR as it requires more complicated changes.

This has been a joint effort by @Meziu, @ian-h-chamberlain, myself, and prior work by @rust3ds members.

Background

The Nintendo 3DS (Horizon OS) is a mostly-UNIX looking system, with the caveat that it does not come with a full libc implementation out of the box. On the homebrew side (I'm not under NDA), the libc interface is partially implemented by the devkitPro toolchain and a user library like libctru. This is important because there are some possible legal barriers to linking directly to a library that uses the underlying platform APIs, since they might be considered a trade secret or under NDA.

To get around this, the standard library impl for the 3DS does not directly depend on any platform-level APIs. Instead, it expects standard libc functions to be linked in. The implementation of these libc functions is left to the user. Some functions are provided by the devkitPro toolchain, but in our testing, we used the following to fill in the other functions:

libctru - provides more basic APIs, such as nanosleep. Linked in by way of ctru-sys.
pthread-3ds - provides pthread APIs for std::thread. Implemented using libctru.
linker-fix-3ds - fulfills some other missing libc APIs. Implemented using libctru.

For more details, see the src/doc/rustc/src/platform-support/armv6k-nintendo-3ds.md file added in this PR.

Notes

We've already upstreamed changes to the libc crate to support this PR, as well as the upcoming threading PR. These changes have all been released as of 0.2.121, so we bump the crate version in this PR.
Edit: After some rebases, the version bump has already been merged so it doesn't appear in this PR.

A lot of the changes in this PR are straightforward, and follow in the footsteps of the ESP-IDF target: #87666.

The 3DS does not support user space process spawning, so these APIs are unimplemented (similar to ESP-IDF).

rust-highfive · 2022-04-10T21:08:20Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @m-ou-se (or someone else) soon.

Please see the contribution instructions for more information.

src/doc/rustc/src/platform-support.md

bors · 2022-04-15T19:05:28Z

☔ The latest upstream changes (presumably #94079) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2022-04-24T22:19:09Z

☔ The latest upstream changes (presumably #94609) made this pull request unmergeable. Please resolve the merge conflicts.

AzureMarker · 2022-04-27T02:29:47Z

@m-ou-se Can you take a look at this PR?

bors · 2022-05-06T09:57:44Z

☔ The latest upstream changes (presumably #96510) made this pull request unmergeable. Please resolve the merge conflicts.

AzureMarker · 2022-05-07T22:29:41Z

r? rust-lang/libs

bors · 2022-05-10T18:38:25Z

☔ The latest upstream changes (presumably #96904) made this pull request unmergeable. Please resolve the merge conflicts.

AzureMarker · 2022-05-13T04:24:50Z

@kennytm @m-ou-se Can someone look at this PR? Resolving merge conflicts has gotten pretty annoying.

bors · 2022-05-13T06:06:54Z

☔ The latest upstream changes (presumably #97000) made this pull request unmergeable. Please resolve the merge conflicts.

Meziu · 2022-05-23T15:07:23Z

r? @nagisa

Meziu · 2022-05-23T15:08:37Z

@nagisa IDK if you are suited for reviewing this PR, but since I know you are active and have responded to my PRs already maybe you could give us some help.

bors · 2022-06-04T14:13:20Z

☔ The latest upstream changes (presumably #97729) made this pull request unmergeable. Please resolve the merge conflicts.

nagisa · 2022-06-04T14:35:21Z

r? @nagisa

library/std/src/os/horizon/raw.rs

Co-authored-by: Mark Drobnak <mark.drobnak@gmail.com>

Always use fallback thread_local destructor, since __cxa_thread_atexit_impl is never defined on the target. See #2

For example, in the following issue the `thread_info` thread-local is not correctly initialized in debug builds: rust3ds/ctru-rs#60

I checked with t-libs to make sure this is OK to do on stable functions: https://rust-lang.zulipchat.com/#narrow/stream/219381-t-libs/topic/Replacing.20std.20function.20arg.20type.20with.20private.20type.20def.3F

AzureMarker · 2022-06-14T21:48:25Z

@nagisa can you reapprove since I rebased?

nagisa · 2022-06-15T13:49:14Z

@bors r+

bors · 2022-06-15T13:49:16Z

📌 Commit c814f84 has been approved by nagisa

bors · 2022-06-15T14:21:32Z

⌛ Testing commit c814f84 with merge c3605f8...

bors · 2022-06-15T17:02:11Z

☀️ Test successful - checks-actions
Approved by: nagisa
Pushing c3605f8 to master...

ian-h-chamberlain · 2022-06-15T19:04:34Z

Thanks @AzureMarker and @nagisa for maintaining + reviewing this PR!

rust-timer · 2022-06-15T19:54:45Z

Finished benchmarking commit (c3605f8): comparison url.

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

Primary benchmarks: 🎉 relevant improvements found
Secondary benchmarks: mixed results

	mean¹	max	count²
Regressions 😿 (primary)	N/A	N/A	0
Regressions 😿 (secondary)	2.8%	3.0%	2
Improvements 🎉 (primary)	-2.9%	-5.0%	2
Improvements 🎉 (secondary)	-2.3%	-2.7%	4
All 😿🎉 (primary)	-2.9%	-5.0%	2

Cycles

Results

Primary benchmarks: 😿 relevant regression found
Secondary benchmarks: 😿 relevant regression found

	mean¹	max	count²
Regressions 😿 (primary)	2.4%	2.4%	1
Regressions 😿 (secondary)	2.2%	2.2%	1
Improvements 🎉 (primary)	N/A	N/A	0
Improvements 🎉 (secondary)	N/A	N/A	0
All 😿🎉 (primary)	2.4%	2.4%	1

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

@rustbot label: -perf-regression

the arithmetic mean of the percent change ↩ ↩²
number of relevant changes ↩ ↩²

Pkgsrc changes: * Adjust patches as needed & checksum updates. Upstream changes: Version 1.63.0 (2022-08-11) ========================== Language -------- - [Remove migrate borrowck mode for pre-NLL errors.][95565] - [Modify MIR building to drop repeat expressions with length zero.][95953] - [Remove label/lifetime shadowing warnings.][96296] - [Allow explicit generic arguments in the presence of `impl Trait` args.] [96868] - [Make `cenum_impl_drop_cast` warnings deny-by-default.][97652] - [Prevent unwinding when `-C panic=abort` is used regardless of declared ABI.][96959] - [lub: don't bail out due to empty binders.][97867] Compiler -------- - [Stabilize the `bundle` native library modifier,][95818] also removing the deprecated `static-nobundle` linking kind. - [Add Apple WatchOS compile targets\*.][95243] - [Add a Windows application manifest to rustc-main.][96737] \* Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support. Libraries --------- - [Implement `Copy`, `Clone`, `PartialEq` and `Eq` for `core::fmt::Alignment`.][94530] - [Extend `ptr::null` and `null_mut` to all thin (including extern) types.][94954] - [`impl Read and Write for VecDeque<u8>`.][95632] - [STD support for the Nintendo 3DS.][95897] - [Make write/print macros eagerly drop temporaries.][96455] - [Implement internal traits that enable `[OsStr]::join`.][96881] - [Implement `Hash` for `core::alloc::Layout`.][97034] - [Add capacity documentation for `OsString`.][97202] - [Put a bound on collection misbehavior.][97316] - [Make `std::mem::needs_drop` accept `?Sized`.][97675] - [`impl Termination for Infallible` and then make the `Result` impls of `Termination` more generic.][97803] - [Document Rust's stance on `/proc/self/mem`.][97837] Stabilized APIs --------------- - [`array::from_fn`] - [`Box::into_pin`] - [`BinaryHeap::try_reserve`] - [`BinaryHeap::try_reserve_exact`] - [`OsString::try_reserve`] - [`OsString::try_reserve_exact`] - [`PathBuf::try_reserve`] - [`PathBuf::try_reserve_exact`] - [`Path::try_exists`] - [`Ref::filter_map`] - [`RefMut::filter_map`] - [`NonNull::<[T]>::len`][`NonNull::<slice>::len`] - [`ToOwned::clone_into`] - [`Ipv6Addr::to_ipv4_mapped`] - [`unix::io::AsFd`] - [`unix::io::BorrowedFd<'fd>`] - [`unix::io::OwnedFd`] - [`windows::io::AsHandle`] - [`windows::io::BorrowedHandle<'handle>`] - [`windows::io::OwnedHandle`] - [`windows::io::HandleOrInvalid`] - [`windows::io::HandleOrNull`] - [`windows::io::InvalidHandleError`] - [`windows::io::NullHandleError`] - [`windows::io::AsSocket`] - [`windows::io::BorrowedSocket<'handle>`] - [`windows::io::OwnedSocket`] - [`thread::scope`] - [`thread::Scope`] - [`thread::ScopedJoinHandle`] These APIs are now usable in const contexts: - [`array::from_ref`] - [`slice::from_ref`] - [`intrinsics::copy`] - [`intrinsics::copy_nonoverlapping`] - [`<*const T>::copy_to`] - [`<*const T>::copy_to_nonoverlapping`] - [`<*mut T>::copy_to`] - [`<*mut T>::copy_to_nonoverlapping`] - [`<*mut T>::copy_from`] - [`<*mut T>::copy_from_nonoverlapping`] - [`str::from_utf8`] - [`Utf8Error::error_len`] - [`Utf8Error::valid_up_to`] - [`Condvar::new`] - [`Mutex::new`] - [`RwLock::new`] Cargo ----- - [Stabilize the `--config path` command-line argument.][cargo/10755] - [Expose rust-version in the environment as `CARGO_PKG_RUST_VERSION`.][cargo/10713] Compatibility Notes ------------------- - [`#[link]` attributes are now checked more strictly,][96885] which may introduce errors for invalid attribute arguments that were previously ignored. Internal Changes ---------------- These changes provide no direct user facing benefits, but represent significant improvements to the internals and overall performance of rustc and related tools. - [Prepare Rust for LLVM opaque pointers.][94214] [94214]: rust-lang/rust#94214 [94530]: rust-lang/rust#94530 [94954]: rust-lang/rust#94954 [95243]: rust-lang/rust#95243 [95565]: rust-lang/rust#95565 [95632]: rust-lang/rust#95632 [95818]: rust-lang/rust#95818 [95897]: rust-lang/rust#95897 [95953]: rust-lang/rust#95953 [96296]: rust-lang/rust#96296 [96455]: rust-lang/rust#96455 [96737]: rust-lang/rust#96737 [96868]: rust-lang/rust#96868 [96881]: rust-lang/rust#96881 [96885]: rust-lang/rust#96885 [96959]: rust-lang/rust#96959 [97034]: rust-lang/rust#97034 [97202]: rust-lang/rust#97202 [97316]: rust-lang/rust#97316 [97652]: rust-lang/rust#97652 [97675]: rust-lang/rust#97675 [97803]: rust-lang/rust#97803 [97837]: rust-lang/rust#97837 [97867]: rust-lang/rust#97867 [cargo/10713]: rust-lang/cargo#10713 [cargo/10755]: rust-lang/cargo#10755 [`array::from_fn`]: https://doc.rust-lang.org/stable/std/array/fn.from_fn.html [`Box::into_pin`]: https://doc.rust-lang.org/stable/std/boxed/struct.Box.html#method.into_pin [`BinaryHeap::try_reserve_exact`]: https://doc.rust-lang.org/stable/alloc/collections/binary_heap/struct.BinaryHeap.html#method.try_reserve_exact [`BinaryHeap::try_reserve`]: https://doc.rust-lang.org/stable/std/collections/struct.BinaryHeap.html#method.try_reserve [`OsString::try_reserve`]: https://doc.rust-lang.org/stable/std/ffi/struct.OsString.html#method.try_reserve [`OsString::try_reserve_exact`]: https://doc.rust-lang.org/stable/std/ffi/struct.OsString.html#method.try_reserve_exact [`PathBuf::try_reserve`]: https://doc.rust-lang.org/stable/std/path/struct.PathBuf.html#method.try_reserve [`PathBuf::try_reserve_exact`]: https://doc.rust-lang.org/stable/std/path/struct.PathBuf.html#method.try_reserve_exact [`Path::try_exists`]: https://doc.rust-lang.org/stable/std/path/struct.Path.html#method.try_exists [`Ref::filter_map`]: https://doc.rust-lang.org/stable/std/cell/struct.Ref.html#method.filter_map [`RefMut::filter_map`]: https://doc.rust-lang.org/stable/std/cell/struct.RefMut.html#method.filter_map [`NonNull::<slice>::len`]: https://doc.rust-lang.org/stable/std/ptr/struct.NonNull.html#method.len [`ToOwned::clone_into`]: https://doc.rust-lang.org/stable/std/borrow/trait.ToOwned.html#method.clone_into [`Ipv6Addr::to_ipv4_mapped`]: https://doc.rust-lang.org/stable/std/net/struct.Ipv6Addr.html#method.to_ipv4_mapped [`unix::io::AsFd`]: https://doc.rust-lang.org/stable/std/os/unix/io/trait.AsFd.html [`unix::io::BorrowedFd<'fd>`]: https://doc.rust-lang.org/stable/std/os/unix/io/struct.BorrowedFd.html [`unix::io::OwnedFd`]: https://doc.rust-lang.org/stable/std/os/unix/io/struct.OwnedFd.html [`windows::io::AsHandle`]: https://doc.rust-lang.org/stable/std/os/windows/io/trait.AsHandle.html [`windows::io::BorrowedHandle<'handle>`]: https://doc.rust-lang.org/stable/std/os/windows/io/struct.BorrowedHandle.html [`windows::io::OwnedHandle`]: https://doc.rust-lang.org/stable/std/os/windows/io/struct.OwnedHandle.html [`windows::io::HandleOrInvalid`]: https://doc.rust-lang.org/stable/std/os/windows/io/struct.HandleOrInvalid.html [`windows::io::HandleOrNull`]: https://doc.rust-lang.org/stable/std/os/windows/io/struct.HandleOrNull.html [`windows::io::InvalidHandleError`]: https://doc.rust-lang.org/stable/std/os/windows/io/struct.InvalidHandleError.html [`windows::io::NullHandleError`]: https://doc.rust-lang.org/stable/std/os/windows/io/struct.NullHandleError.html [`windows::io::AsSocket`]: https://doc.rust-lang.org/stable/std/os/windows/io/trait.AsSocket.html [`windows::io::BorrowedSocket<'handle>`]: https://doc.rust-lang.org/stable/std/os/windows/io/struct.BorrowedSocket.html [`windows::io::OwnedSocket`]: https://doc.rust-lang.org/stable/std/os/windows/io/struct.OwnedSocket.html [`thread::scope`]: https://doc.rust-lang.org/stable/std/thread/fn.scope.html [`thread::Scope`]: https://doc.rust-lang.org/stable/std/thread/struct.Scope.html [`thread::ScopedJoinHandle`]: https://doc.rust-lang.org/stable/std/thread/struct.ScopedJoinHandle.html [`array::from_ref`]: https://doc.rust-lang.org/stable/std/array/fn.from_ref.html [`slice::from_ref`]: https://doc.rust-lang.org/stable/std/slice/fn.from_ref.html [`intrinsics::copy`]: https://doc.rust-lang.org/stable/std/intrinsics/fn.copy.html [`intrinsics::copy_nonoverlapping`]: https://doc.rust-lang.org/stable/std/intrinsics/fn.copy_nonoverlapping.html [`<*const T>::copy_to`]: https://doc.rust-lang.org/stable/std/primitive.pointer.html#method.copy_to [`<*const T>::copy_to_nonoverlapping`]: https://doc.rust-lang.org/stable/std/primitive.pointer.html#method.copy_to_nonoverlapping [`<*mut T>::copy_to`]: https://doc.rust-lang.org/stable/std/primitive.pointer.html#method.copy_to-1 [`<*mut T>::copy_to_nonoverlapping`]: https://doc.rust-lang.org/stable/std/primitive.pointer.html#method.copy_to_nonoverlapping-1 [`<*mut T>::copy_from`]: https://doc.rust-lang.org/stable/std/primitive.pointer.html#method.copy_from [`<*mut T>::copy_from_nonoverlapping`]: https://doc.rust-lang.org/stable/std/primitive.pointer.html#method.copy_from_nonoverlapping [`str::from_utf8`]: https://doc.rust-lang.org/stable/std/str/fn.from_utf8.html [`Utf8Error::error_len`]: https://doc.rust-lang.org/stable/std/str/struct.Utf8Error.html#method.error_len [`Utf8Error::valid_up_to`]: https://doc.rust-lang.org/stable/std/str/struct.Utf8Error.html#method.valid_up_to [`Condvar::new`]: https://doc.rust-lang.org/stable/std/sync/struct.Condvar.html#method.new [`Mutex::new`]: https://doc.rust-lang.org/stable/std/sync/struct.Mutex.html#method.new [`RwLock::new`]: https://doc.rust-lang.org/stable/std/sync/struct.RwLock.html#method.new

STD support for PSVita This PR adds std support for `armv7-sony-vita-newlibeabihf` target. The work here is fairly similar to rust-lang#95897, just for a different target platform. This depends on the following pull requests: rust-lang/backtrace-rs#523 rust-lang/libc#3209

rust-highfive assigned m-ou-se Apr 10, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 10, 2022

AzureMarker mentioned this pull request Apr 10, 2022

STD Cleanup and Test Meziu/rust-horizon#6

Closed

ian-h-chamberlain reviewed Apr 10, 2022

View reviewed changes

src/doc/rustc/src/platform-support.md Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

AzureMarker force-pushed the feature/horizon-std branch from 011e9d4 to a32cea6 Compare April 16, 2022 20:40

rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Apr 16, 2022

AzureMarker force-pushed the feature/horizon-std branch from a32cea6 to 170d2d0 Compare April 27, 2022 02:29

AzureMarker force-pushed the feature/horizon-std branch from 170d2d0 to f7b29b1 Compare May 7, 2022 22:23

rust-highfive assigned kennytm and unassigned m-ou-se May 7, 2022

AzureMarker force-pushed the feature/horizon-std branch from 836146c to e2bf193 Compare May 13, 2022 04:23

AzureMarker force-pushed the feature/horizon-std branch from e2bf193 to 17e97b1 Compare May 15, 2022 19:22

rust-highfive assigned nagisa and unassigned kennytm Jun 4, 2022

AzureMarker force-pushed the feature/horizon-std branch from f80c67d to d0198dd Compare June 4, 2022 22:16

nagisa reviewed Jun 5, 2022

View reviewed changes

library/std/src/os/horizon/raw.rs Show resolved Hide resolved

ian-h-chamberlain and others added 4 commits June 13, 2022 20:45

Add platform-support page for armv6k-nintendo-3ds

82e8cd4

Co-authored-by: Mark Drobnak <mark.drobnak@gmail.com>

Enable thread_local_dtor on horizon OS

bc63d5a

Always use fallback thread_local destructor, since __cxa_thread_atexit_impl is never defined on the target. See #2

Disable has_thread_local due to weird issues in some programs

5d5039e

For example, in the following issue the `thread_info` thread-local is not correctly initialized in debug builds: rust3ds/ctru-rs#60

Use a private type definition to reduce cfg noise

c814f84

I checked with t-libs to make sure this is OK to do on stable functions: https://rust-lang.zulipchat.com/#narrow/stream/219381-t-libs/topic/Replacing.20std.20function.20arg.20type.20with.20private.20type.20def.3F

AzureMarker force-pushed the feature/horizon-std branch from 9c78858 to c814f84 Compare June 14, 2022 04:03

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 15, 2022

bors added the merged-by-bors This PR was explicitly merged by bors. label Jun 15, 2022

bors merged commit c3605f8 into rust-lang:master Jun 15, 2022

rustbot added this to the 1.63.0 milestone Jun 15, 2022

This was referenced Jun 15, 2022

Add vectored positioned I/O on Unix #89518

Merged

Unlimit UNIX remove_dir_all() implementation (take 2) #95925

Closed

add UnboundUdpSocket to std::net #97672

Closed

stdlib support for Apple WatchOS #98101

Merged

AzureMarker deleted the feature/horizon-std branch June 25, 2022 23:37

AzureMarker mentioned this pull request Jun 26, 2022

std::thread support for the Nintendo 3DS #98514

Open

AzureMarker mentioned this pull request Jul 16, 2022

Add Special Thread Builder Functions for the Nintendo 3DS rust-lang/libs-team#71

Closed

ozkriff mentioned this pull request Jul 29, 2022

Newsletter 36 - July 2022 rust-gamedev/rust-gamedev.github.io#1098

Closed

72 tasks

nikarh mentioned this pull request Apr 21, 2023

STD support for PSVita #110638

Merged

matthiaskrgr mentioned this pull request Apr 20, 2024

ICE: expected principal trait object #124092

Closed

tgross35 mentioned this pull request Jul 20, 2024

Clean up warnings + unsafe_op_in_unsafe_fn when building std for armv6k-nintendo-3ds #127996

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

STD support for the Nintendo 3DS #95897

STD support for the Nintendo 3DS #95897

AzureMarker commented Apr 10, 2022 •

edited

Loading

rust-highfive commented Apr 10, 2022

This comment has been minimized.

bors commented Apr 15, 2022

bors commented Apr 24, 2022

AzureMarker commented Apr 27, 2022

bors commented May 6, 2022

AzureMarker commented May 7, 2022

bors commented May 10, 2022

AzureMarker commented May 13, 2022

bors commented May 13, 2022

Meziu commented May 23, 2022

Meziu commented May 23, 2022

bors commented Jun 4, 2022

nagisa commented Jun 4, 2022

AzureMarker commented Jun 14, 2022

nagisa commented Jun 15, 2022

bors commented Jun 15, 2022

bors commented Jun 15, 2022

bors commented Jun 15, 2022

ian-h-chamberlain commented Jun 15, 2022

rust-timer commented Jun 15, 2022

STD support for the Nintendo 3DS #95897

STD support for the Nintendo 3DS #95897

Conversation

AzureMarker commented Apr 10, 2022 • edited Loading

Background

Notes

rust-highfive commented Apr 10, 2022

This comment has been minimized.

bors commented Apr 15, 2022

bors commented Apr 24, 2022

AzureMarker commented Apr 27, 2022

bors commented May 6, 2022

AzureMarker commented May 7, 2022

bors commented May 10, 2022

AzureMarker commented May 13, 2022

bors commented May 13, 2022

Meziu commented May 23, 2022

Meziu commented May 23, 2022

bors commented Jun 4, 2022

nagisa commented Jun 4, 2022

AzureMarker commented Jun 14, 2022

nagisa commented Jun 15, 2022

bors commented Jun 15, 2022

bors commented Jun 15, 2022

bors commented Jun 15, 2022

ian-h-chamberlain commented Jun 15, 2022

rust-timer commented Jun 15, 2022

Instruction count

Max RSS (memory usage)

Cycles

Footnotes

AzureMarker commented Apr 10, 2022 •

edited

Loading