Add aarch64-apple-visionos and aarch64-apple-visionos-sim tier 3 targets

[agg23]

Introduces aarch64-apple-visionos and aarch64-apple-visionos-sim as tier 3 targets. This allows native development for the Apple Vision Pro's visionOS platform.

This work has been tracked in rust-lang/compiler-team#642. There is a corresponding libc change rust-lang/libc#3568 that is not required for merge.

Ideally we would be able to incorporate this change to the object crate, but the author has stated that a release will not be cut for quite a while. Therefore, the two locations that would reference the xrOS constant from object are hardcoded to their MachO values of 11 and 12, accompanied by TODOs to mark the code as needing change. I am open to suggestions on what to do here to get this checked in.

Tier 3 Target Policy

At this tier, the Rust project provides no official support for a target, so we place minimal requirements on the introduction of targets.

A tier 3 target must have a designated developer or developers (the "target maintainers") on record to be CCed when issues arise regarding the target. (The mechanism to track and CC such developers may evolve over time.)

See src/doc/rustc/src/platform-support/apple-visionos.md

Targets must use naming consistent with any existing targets; for instance, a target for the same CPU or OS as an existing Rust target should use the same name for that CPU or OS. Targets should normally use the same names and naming conventions as used elsewhere in the broader ecosystem beyond Rust (such as in other toolchains), unless they have a very good reason to diverge. Changing the name of a target can be highly disruptive, especially once the target reaches a higher tier, so getting the name right is important even for a tier 3 target.

• Target names should not introduce undue confusion or ambiguity unless absolutely necessary to maintain ecosystem compatibility. For example, if the name of the target makes people extremely likely to form incorrect beliefs about what it targets, the name should be changed or augmented to disambiguate it.
• If possible, use only letters, numbers, dashes and underscores for the name. Periods (.) are known to cause issues in Cargo.

This naming scheme matches $ARCH-$VENDOR-$OS-$ABI which is matches the iOS Apple Silicon simulator (aarch64-apple-ios-sim) and other Apple targets.

Tier 3 targets may have unusual requirements to build or use, but must not
create legal issues or impose onerous legal terms for the Rust project or for
Rust developers or users.

• The target must not introduce license incompatibilities.
• Anything added to the Rust repository must be under the standard Rust license (MIT OR Apache-2.0).
• The target must not cause the Rust tools or libraries built for any other host (even when supporting cross-compilation to the target) to depend on any new dependency less permissive than the Rust licensing policy. This applies whether the dependency is a Rust crate that would require adding new license exceptions (as specified by the tidy tool in the rust-lang/rust repository), or whether the dependency is a native library or binary. In other words, the introduction of the target must not cause a user installing or running a version of Rust or the Rust tools to besubject to any new license requirements.
• Compiling, linking, and emitting functional binaries, libraries, or other code for the target (whether hosted on the target itself or cross-compiling from another target) must not depend on proprietary (non-FOSS) libraries. Host tools built for the target itself may depend on the ordinary runtime libraries supplied by the platform and commonly used by other applications built for the target, but those libraries must not be required for code generation for the target; cross-compilation to the target must not require such libraries at all. For instance, rustc built for the target may depend on a common proprietary C runtime library or console output library, but must not depend on a proprietary code generation library or code optimization library. Rust's license permits such combinations, but the Rust project has no interest in maintaining such combinations within the scope of Rust itself, even at tier 3.
• "onerous" here is an intentionally subjective term. At a minimum, "onerous" legal/licensing terms include but are not limited to: non-disclosure requirements, non-compete requirements, contributor license agreements (CLAs) or equivalent, "non-commercial"/"research-only"/etc terms, requirements conditional on the employer or employment of any particular Rust developers, revocable terms, any requirements that create liability for the Rust project or its developers or users, or any requirements that adversely affect the livelihood or prospects of the Rust project or its developers or users.

This contribution is fully available under the standard Rust license with no additional legal restrictions whatsoever. This PR does not introduce any new dependency less permissive than the Rust license policy.

The new targets do not depend on proprietary libraries.

Tier 3 targets should attempt to implement as much of the standard libraries as possible and appropriate (core for most targets, alloc for targets that can support dynamic memory allocation, std for targets with an operating system or equivalent layer of system-provided functionality), but may leave some code unimplemented (either unavailable or stubbed out as appropriate), whether because the target makes it impossible to implement or challenging to implement. The authors of pull requests are not obligated to avoid calling any portions of the standard library on the basis of a tier 3 target not implementing those portions.

This new target mirrors the standard library for watchOS and iOS, with minor divergences.

The target must provide documentation for the Rust community explaining how to build for the target, using cross-compilation if possible. If the target supports running binaries, or running tests (even if they do not pass), the documentation must explain how to run such binaries or tests for the target, using emulation if possible or dedicated hardware if necessary.

Documentation is provided in src/doc/rustc/src/platform-support/apple-visionos.md

Neither this policy nor any decisions made regarding targets shall create any binding agreement or estoppel by any party. If any member of an approving Rust team serves as one of the maintainers of a target, or has any legal or employment requirement (explicit or implicit) that might affect their decisions regarding a target, they must recuse themselves from any approval decisions regarding the target's tier status, though they may otherwise participate in discussions.

• This requirement does not prevent part or all of this policy from being cited in an explicit contract or work agreement (e.g. to implement or maintain support for a target). This requirement exists to ensure that a developer or team responsible for reviewing and approving a target does not face any legal threats or obligations that would prevent them from freely exercising their judgment in such approval, even if such judgment involves subjective matters or goes beyond the letter of these requirements.

Tier 3 targets must not impose burden on the authors of pull requests, or other developers in the community, to maintain the target. In particular, do not post comments (automated or manual) on a PR that derail or suggest a block on the PR based on a tier 3 target. Do not send automated messages or notifications (via any medium, including via @) to a PR author or others involved with a PR regarding a tier 3 target, unless they have opted into such messages.

• Backlinks such as those generated by the issue/PR tracker when linking to an issue or PR are not considered a violation of this policy, within reason. However, such messages (even on a separate repository) must not generate notifications to anyone involved with a PR who has not requested such notifications.

Patches adding or updating tier 3 targets must not break any existing tier 2 or tier 1 target, and must not knowingly break another tier 3 target without approval of either the compiler team or the maintainers of the other tier 3 target.

• In particular, this may come up when working on closely related targets, such as variations of the same architecture with different features. Avoid introducing unconditional uses of features that another variation of the target may not have; use conditional compilation or runtime detection, as appropriate, to let each target run code supported by that target.

I acknowledge these requirements and intend to ensure that they are met.

This target does not touch any existing tier 2 or tier 1 targets and should not break any other targets.

[rustbot]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

• @rustbot author: the review is finished, PR author should check the comments and take action accordingly
• @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

[rustbot]

These commits modify compiler targets.
(See the Target Tier Policy.)

This PR changes how LLVM is built. Consider updating src/bootstrap/download-ci-llvm-stamp.

[rustbot]

There are merge commits (commits with multiple parents) in your changes. We have a no merge policy so these commits will need to be removed for this pull request to be merged.

You can start a rebase with the following commands:

$ # rebase
$ git rebase -i master
$ # delete any merge commits in the editor that appears
$ git push --force-with-lease

The following commits are merge commits:

• 67e7d4a

[eugenehp]

Great work @agg23
Looking forward to seeing this PR merged!

[eugenehp]

Tried to compile this PR inside a nightly rust and build a simple binary with it, here's the error I got:

Looks like rustup toolchain has to be connected to this to be able to pull this target and get it installed first.

[agg23]

@eugenehp It sounds like you might have built something incorrectly. Since you're using cargo directly, are you sure you've selected the newly built toolchain with rustup?

If you run (note, this needs to be the custom built toolchain's rustc) rustc --print target-list, you should see:

aarch64-apple-xros
aarch64-apple-xros-sim

amongst the other options.

Beware that you cannot build libc, and thus std, so you can't actually build anything of use really. This requires my libc PR.

If you want to work on visionOS now, I have published instructions on how to set it up. I have tested this both in the simulator and on an actual headset.

[madsmtm]

I suspect that this can be much higher, possibly even apple-a15 or apple-m2?

Same for the simulator target.

[agg23]

Very good point. Do you know how I would find out what is acceptable? Just poking around in LLVM?

[nikic]

See https://github.com/llvm/llvm-project/blob/fde344aef20bc4280f01294ac6e14a5c2db2d572/clang/lib/Driver/ToolChains/Arch/AArch64.cpp#L50-L60

[agg23]

I am unsure why, but in use rustc reports that apple-m1 is not a valid feature for this target. I see nothing obvious in the codebase where we whitelist LLVM architectures.

Reverting to the latest available in rustc, apple-a16

[agg23]

Is there a recommended way for testing a no libc target? I previously was testing static libraries generated with a rustc built with my libc PR, so I know the compiler works, but I want to make sure that it's building something usable still.

[rustbot]

These commits modify the Cargo.lock file. Unintentional changes to Cargo.lock can be introduced when switching branches and rebasing PRs.

If this was unintentional then you should revert the changes before this PR is merged.
Otherwise, you can ignore this comment.

triagebot.toml has been modified, there may have been changes to the review queue.

cc @davidtwco, @wesleywiser

[duncanthomson]

Are visionos toolchains available through rustup standard release channels? If not, what would this take?

[madsmtm]

Are visionos toolchains available through rustup standard release channels?

No, you'll need to use cargo +nightly build -Zbuild-std --target aarch64-apple-visionos.

If not, what would this take?

It would take an MCP to raise the target to Tier 2, see the policy. I'm a bit weary about doing so myself, because I don't feel that visionOS is sufficiently supported, especially so in the broader ecosystem. But I could be persuaded otherwise.

[agg23]

I would concur that visionOS is not sufficiently supported, and while the platform support is simple, it is extremely sparingly tested. I'd be surprised if more than 10-20 people have actually tried building their own projects using aarch64-apple-visionos.

[bcardarella]

We're the ones who pushed for this target to be added to Rust as we're using it in LiveView Native. And there's more than 10 - 20 people using it.

[eugenehp]

we use it too for a bunch of internal projects.

[cklokmose]

We plan to use it for research projects too using the Rust-based Automerge framework.Sendt fra min iPhoneDen 3. jan. 2025 kl. 16.15 skrev Eugene Hauptmann ***@***.***>: we use it too for a bunch of internal projects. —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>

[duncanthomson]

Our use case is this: take a large C++ application that runs on desktop, mobile, embedded, and visionOS platforms and integrate new foundational components written in Rust. We need to build those new components for visionOS if all features of the application are to remain cross-platform.

[madsmtm]

I appreciate the feedback here, it's interesting to hear about the places people are using this.

I'm unsure of what would be necessary for me to really consider visionOS well supported (and I won't be the one making the decision anyhow). I guess one indicator, though not necessarily a good one, is how used it is (so do feel free to continue posting here if you use the target, and would like it to become Tier 2).

[madsmtm]

Another indicator, like I alluded to before, is the ecosystem support. To get a measure of the current support here, I went and compiled the crates in here and here (in a VM, I'm not that reckless ;) ), filtered out the ones that didn't support macOS, and found the following crates that didn't support iOS nor visionOS:

• aws-lc-sys (and by extension rustls by default)
• openssl-sys (aarch64 iOS simulator support rust-openssl/rust-openssl#1622)
• UI crates like floem, rfd, iced and glutin
• pyo3 also didn't work out the box (but that's to be expected)

And the following that don't support visionOS at the time of writing:

• ctrlc (Add support for tvOS, visionOS and watchOS Detegr/rust-ctrlc#128)
• nix (at least their support is somewhat poor)
• objc (and by extension wgpu, tauri, miniquad) (feat: Added visionOS support for Apple Vision Pro SSheldon/rust-objc#123)
• rocksdb (compiles C code)
• skia-bindings
• manganis-core (and by extension dioxus)

(This list excludes crates that didn't built because they hadn't updated a dependency to an updated version that has visionOS support, so might be under-representative).

Idk., I compiled this list mostly because I was curious, I don't expect people here to go and fix those crates (though that would be cool), I meant it more as a showcase of where we are currently.

[madsmtm]

Another current problem for me at least is that Rust's test suite is fairly difficult to run for cross-compiled targets, and especially so for these devices where it cannot be tested without sending it to the simulator. And yes, that's also a problem on iOS, but those targets are a) much more widely used, and b) we can use Mac Catalyst to somewhat test parts of it.

[bcardarella]

@madsmtm well, it just seems like it comes down to if you want to do it or not and it feels lke you don't want to do it. FWIW our needs are met in the current state.

[edko99]

Does using this target involve creating a custom build of the Rust compiler? Are there any step-by-step instructions on how to do it? I would love to use it, but wouldn't know where to start.

[simlay]

Does using this target involve creating a custom build of the Rust compiler? Are there any step-by-step instructions on how to do it? I would love to use it, but wouldn't know where to start.

Nah, you shouldn't need to compile the rust compiler yourself. You'll need to use the build-std nightly feature to use the stdlib. I and other people have gone around and patched a lot of the crates in the ecosystem so things like tokio and tls should work I'm sure there are things still needing support.

Liveview Native Core is an example of a project using visionOS.

Getting the rust into a visionOS simulator or an actual device is a bit trickier. Last time I touched this PR tocargo-dinghy, it was working for he simulator. Otherwise, you kinda have to bundle stuff as a static library into an xcode project like bevy does.

[madsmtm]

FYI, I've now filed rust-lang/compiler-team#918 for promoting the aarch64-apple-visionos* targets to tier 2.