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

agg23 · 2024-02-21T23:53:09Z

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 · 2024-02-21T23:53:17Z

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 · 2024-02-21T23:53:20Z

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 · 2024-02-22T00:29:39Z

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 · 2024-02-22T00:46:44Z

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

eugenehp · 2024-02-22T04:16:43Z

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 · 2024-02-22T04:32:12Z

@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 · 2024-02-22T04:23:47Z

compiler/rustc_target/src/spec/targets/aarch64_apple_xros.rs

+        data_layout: "e-m:o-i64:64-i128:128-n32:64-S128".into(),
+        arch: arch.target_arch(),
+        options: TargetOptions {
+            features: "+neon,+fp-armv8,+apple-a7".into(),


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

Same for the simulator target.

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

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

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

compiler/rustc_target/src/spec/mod.rs

agg23 · 2024-02-24T15:39:33Z

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 · 2024-02-24T17:33:35Z

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

agg23 · 2024-04-09T20:12:11Z

@agg23, rustup target add aarch64-apple-visionos produces the error error: toolchain 'stable-aarch64-apple-darwin' does not support target 'aarch64-apple-visionos'. Specifying --toolchain nightly produces a similar error.

I believe you want rustup +nightly target add aarch64-apple-visionos. You'll have to search around and play with it. I was able to successfully pull it after updating to the latest nightly.

coolbluewater · 2024-04-09T21:05:26Z

I believe you want rustup +nightly target add aarch64-apple-visionos. You'll have to search around and play with it. I was able to successfully pull it after updating to the latest nightly.

@agg23, that exact command fails with error: toolchain 'nightly-aarch64-apple-darwin' does not support target 'aarch64-apple-visionos'

Doesn't seem to be much leeway to 'search around and play with it', lol!

@QuentinPerez did you have any luck, and if so could you please post the step(s) to build against the visionos targets?

cklokmose · 2024-04-10T06:39:24Z

I believe you want rustup +nightly target add aarch64-apple-visionos. You'll have to search around and play with it. I was able to successfully pull it after updating to the latest nightly.

@agg23, that exact command fails with error: toolchain 'nightly-aarch64-apple-darwin' does not support target 'aarch64-apple-visionos'

Doesn't seem to be much leeway to 'search around and play with it', lol!

@QuentinPerez did you have any luck, and if so could you please post the step(s) to build against the visionos targets?

I've been trying to build a library for visionos and run into the same problem even though rustc does list the targets:

rustc --print=target-list | grep visionos
aarch64-apple-visionos
aarch64-apple-visionos-sim

nikic · 2024-04-10T06:56:55Z

It's a tier 3 target, that means that no components are shipped in rustup. You can either use it as no_core by just passing --target, or you can build your own libcore/libstd (using -Z build-std, xargo, or whatever).

coolbluewater · 2024-04-10T07:23:14Z

I'm wondering why I can't get @cklokmose's output to appear:
rustc --print=target-list | grep visionos produces no output.

Guess I may have to uninstall and reinstall rust.

cklokmose · 2024-04-10T07:45:06Z

I got a bit further by updating my cargo.toml with the following patch to use a visionos compatible libc (as suggested earlier by @agg23 )

[patch.crates-io]
libc = { git = "https://github.com/agg23/libc.git", rev = "014bfe6361af08302afba591c587699eba1f36c1" }

However, when I then try to run xargo update -p libc --precise 0.2.151 I get

Updating git repository `https://github.com/agg23/libc.git`
error: Unable to update https://github.com/agg23/libc.git?rev=014bfe6361af08302afba591c587699eba1f36c1#0.2.151

Caused by:
  revspec '0.2.151' not found; class=Reference (4); code=NotFound (-3)

cklokmose · 2024-04-10T07:56:44Z

I got a bit further by updating my cargo.toml with the following patch to use a visionos compatible libc (as suggested earlier by @agg23 )
[patch.crates-io]
libc = { git = "https://github.com/agg23/libc.git", rev = "014bfe6361af08302afba591c587699eba1f36c1" }
However, when I then try to run xargo update -p libc --precise 0.2.151 I get
Updating git repository `https://github.com/agg23/libc.git`
error: Unable to update https://github.com/agg23/libc.git?rev=014bfe6361af08302afba591c587699eba1f36c1#0.2.151

Caused by:
  revspec '0.2.151' not found; class=Reference (4); code=NotFound (-3)

Hm. I seem to have gotten passed that, but now when I do try to compile I get the following warning

Updating git repository `https://github.com/agg23/libc.git`
warning: Patch `libc v0.2.151 (https://github.com/agg23/libc.git?rev=014bfe6361af08302afba591c587699eba1f36c1#014bfe63)` was not used in the crate graph.
Patch `rustc-std-workspace-std v1.99.0 (/Users/au166305/.rustup/toolchains/nightly-2024-04-10-aarch64-apple-darwin/lib/rustlib/src/rust/library/rustc-std-workspace-std)` was not used in the crate graph.
Check that the patched package version and available features are compatible
with the dependency requirements. If the patch has a different version from
what is locked in the Cargo.lock file, run `cargo update` to use the new
version. This may also occur with an optional dependency that is not enabled.

coolbluewater · 2024-04-10T08:30:17Z

Now that the visionos targets are part of rust, why do we need any of the previous contingencies like xargo or a special libc?
Shouldn't building a crate with
cargo build --target aarch64-apple-visionos -Zbuild-std
be all that's needed, as is the case with e.g. mac catalyst, another tier 3 target?

cklokmose · 2024-04-10T09:04:07Z

Now that the visionos targets are part of rust, why do we need any of the previous contingencies like xargo or a special libc? Shouldn't building a crate with cargo build --target aarch64-apple-visionos -Zbuild-std be all that's needed, as is the case with e.g. mac catalyst, another tier 3 target?

I think the problem is that libc doesn't support visionos currently

coolbluewater · 2024-04-10T10:10:52Z

@agg23, appreciate if you could summarize what work remains before the above, i.e.
cargo build --target aarch64-apple-visionos -Zbuild-std
is all that we need to compile for visionos. Please include the relevant git issues.

agg23 · 2024-04-10T13:12:32Z

I think you need xargo update -p libc --precise 0.2.153 as 0.2.153 is the latest version. I would run it without specifying the version though.

You still have to use xargo to patch the libc version to include these changes (rust-lang/libc#3568), as important Apple stuff won't be set up without it. See instructions: rust-lang/compiler-team#642 (comment)

As far as I know that's all you need.

cklokmose · 2024-04-10T13:27:17Z

I think you need xargo update -p libc --precise 0.2.153 as 0.2.153 is the latest version. I would run it without specifying the version though.

You still have to use xargo to patch the libc version to include these changes (rust-lang/libc#3568), as important Apple stuff won't be set up without it. See instructions: rust-lang/compiler-team#642 (comment)

As far as I know that's all you need.

If I run xargo update -p libc --precise 0.2.153 same if I do 0.2.151

I get

xargo update -p libc --precise 0.2.153
    Updating git repository `https://github.com/agg23/libc.git`
error: Unable to update https://github.com/agg23/libc.git?rev=014bfe6361af08302afba591c587699eba1f36c1#0.2.153

Caused by:
  revspec '0.2.153' not found; class=Reference (4); code=NotFound (-3)

madsmtm · 2024-04-10T13:35:12Z

The libc that core/std is built with when using -Zbuild-std cannot be overridden (as far as I know) using Cargo, you will have to build a custom sysroot with a patched libc instead.

Edit both rust/Cargo.toml and your own Cargo.toml to contain:

[patch.crates-io]
libc = { git = "https://github.com/agg23/libc.git", branch = "main" }
# Optional: Use `cc` with customizations for visionOS
cc = { git = "https://github.com/madsmtm/cc-rs.git", branch = "visionos" }

Build a stage1 sysroot using that, see https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html. It'll be roughly:

cargo +nightly update -plibc -pcc
rustup toolchain link stage1 build/host/stage1
./x build library --target=aarch64-apple-darwin,aarch64-apple-visionos,aarch64-apple-visionos-sim

Run cargo +stage1 build --target=aarch64-apple-visionos in the project that you want to build.

Note that to do all of this, you'll need to also grab the changes from #123721 and #123723, as those are needed to build the compiler without warnings.

Or you can wait until #123721 and rust-lang/libc#3568 are merged and released, and rust/Cargo.lock has been updated to use a newer version of libc, then -Zbuild-std should work (most real-world applications will likely also need rust-lang/cc-rs#1029).

agg23 · 2024-04-10T13:38:02Z

You definitely can do this with the shipping tier 3 compiler; no need to build Rust yourself. As far as I know, all I'm doing is running with xargo, patching libc to my custom version, and forcing panic-unwind

madsmtm · 2024-04-10T14:04:13Z

no need to build Rust yourself.

I have never touched xargo, but if you say so then it's probably true, especially after #123721 is fixed, and by using a compatible version of libc (like the ones in my fork).

coolbluewater · 2024-04-10T15:08:39Z

Is a build with no patches or xargo needed likely within days, or is it expected to take a lot longer?

agg23 · 2024-04-10T15:15:17Z

Is a build with no patches or xargo needed likely within days, or is it expected to take a lot longer?

You will not need patches or xargo once libc merges and is updated in the compiler. However, given that the PR is not passing CI and the maintainer hasn't been around for a while, who knows how long that will take.

coolbluewater · 2024-04-10T15:37:47Z

The maintainer of libc is just one guy? That's a tad concerning,

coolbluewater · 2024-04-10T16:25:34Z

@agg23 jokes apart, might be a good thing to escalate this up the rust org.

Various visionOS fixes A few small mistakes was introduced in rust-lang#121419, probably after the rename from `xros` to `visionos`. See the commits for details. CC `@agg23` Since you reviewed rust-lang#121419 r? davidtwco

Rollup merge of rust-lang#123721 - madsmtm:fix-visionos, r=davidtwco Various visionOS fixes A few small mistakes was introduced in rust-lang#121419, probably after the rename from `xros` to `visionos`. See the commits for details. CC `@agg23` Since you reviewed rust-lang#121419 r? davidtwco

rustbot assigned Mark-Simulacrum Feb 21, 2024

This comment has been minimized.

Sign in to view

rustbot added has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 22, 2024

This comment has been minimized.

Sign in to view

madsmtm reviewed Feb 22, 2024

View reviewed changes

Mark-Simulacrum added O-visionos Apple visionOS and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 24, 2024

agg23 force-pushed the xrOS-pr branch from 649810d to af1d837 Compare February 24, 2024 17:33

rustbot removed has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 24, 2024

This comment has been minimized.

Sign in to view

madsmtm mentioned this pull request Apr 10, 2024

Various visionOS fixes #123721

Merged

madsmtm mentioned this pull request Apr 10, 2024

Make std::os::tvos, std::os::visionos and std::os::watchos public #123723

Open

madsmtm mentioned this pull request Apr 10, 2024

Specialize sleep_until implementation #118480

Draft

QuentinPerez mentioned this pull request Apr 13, 2024

Add Apple visionOS support rust-lang/backtrace-rs#613

Open

This was referenced Apr 16, 2024

Add Apple visionOS support briansmith/ring#2032

Open

Add Apple visionOS support rust-random/getrandom#410

Merged

simlay mentioned this pull request Apr 20, 2024

Fix watchOS and visionOS for pread64 and pwrite64 calls #124089

Merged

madsmtm mentioned this pull request Apr 24, 2024

Add support for visionOS amodm/webbrowser-rs#86

Merged

simlay mentioned this pull request May 7, 2024

Add visionOS support lambda-fairy/rust-errno#95

Merged

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

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

Conversation

agg23 commented Feb 21, 2024 • edited

Tier 3 Target Policy

rustbot commented Feb 21, 2024

rustbot commented Feb 21, 2024

This comment has been minimized.

rustbot commented Feb 22, 2024

This comment has been minimized.

eugenehp commented Feb 22, 2024

eugenehp commented Feb 22, 2024

agg23 commented Feb 22, 2024

madsmtm Feb 22, 2024 • edited

Choose a reason for hiding this comment

agg23 Feb 22, 2024

Choose a reason for hiding this comment

nikic Feb 22, 2024

Choose a reason for hiding this comment

agg23 Mar 23, 2024

Choose a reason for hiding this comment

agg23 commented Feb 24, 2024

rustbot commented Feb 24, 2024

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

agg23 commented Apr 9, 2024

coolbluewater commented Apr 9, 2024 • edited

cklokmose commented Apr 10, 2024

nikic commented Apr 10, 2024

coolbluewater commented Apr 10, 2024

cklokmose commented Apr 10, 2024

cklokmose commented Apr 10, 2024

coolbluewater commented Apr 10, 2024 • edited

cklokmose commented Apr 10, 2024

coolbluewater commented Apr 10, 2024

agg23 commented Apr 10, 2024

cklokmose commented Apr 10, 2024

madsmtm commented Apr 10, 2024 • edited

agg23 commented Apr 10, 2024

madsmtm commented Apr 10, 2024 • edited

coolbluewater commented Apr 10, 2024

agg23 commented Apr 10, 2024

coolbluewater commented Apr 10, 2024

coolbluewater commented Apr 10, 2024

agg23 commented Feb 21, 2024 •

edited

madsmtm Feb 22, 2024 •

edited

coolbluewater commented Apr 9, 2024 •

edited

coolbluewater commented Apr 10, 2024 •

edited

madsmtm commented Apr 10, 2024 •

edited

madsmtm commented Apr 10, 2024 •

edited