Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Apple WatchOS #662

Merged
merged 9 commits into from Jul 6, 2022
Merged

Conversation

vladimir-ea
Copy link
Contributor

Hello, I am hoping to add Apple WatchOS targets and the changes here are prerequisites for that.
Thanks! Vlad.

@alexcrichton
Copy link
Member

Sorry but I'll be honest in that I have no idea how ios/watchos/etc all work. I'm not sure I can in good conscience continue to just slurp up everyone's patches for all sorts of esoteric platforms, especially when they're doing nontrivial things like this PR. If this can be unified with something else in this crate (I don't know what) that would be great, otherwise I'm not sure I can keep taking these patches for all these targets.

@vladimir-ea
Copy link
Contributor Author

Thanks for taking a look. This is the first platform I have tried to add ...

WatchOS is similar to iOS, I will see if I can do something to commonise the code for those 2 platforms.

@vladimir-ea
Copy link
Contributor Author

Given that this crate is a dependency of rustc, what would you suggest as a way forward to adding support for different platforms, if not adding them here?

@vladimir-ea
Copy link
Contributor Author

@alexcrichton I have updated so that the WatchOS changes are consolidated with the existing iOS specific parts - hopefully this is better / clearer?

@alexcrichton
Copy link
Member

Sorry but I've decided that the current development trajectory of cc is not one that I can maintain, so this crate will need to grow new maintainers before merging.

@vladimir-ea
Copy link
Contributor Author

I see. If I understand correctly, this crate is a dependency of rustc. So adding targets for this platform to Rust is gated on this crate acquiring new maintainers, is that correct?

@dot-asm
Copy link
Contributor

dot-asm commented Mar 11, 2022

I see. If I understand correctly, this crate is a dependency of rustc. So adding targets for this platform to Rust is gated on this crate acquiring new maintainers, is that correct?

No. Rust is self-sufficient and this crate is required only when you need to compile an external C/C++ code and call it from Rust.

@vladimir-ea
Copy link
Contributor Author

vladimir-ea commented Mar 14, 2022

No. Rust is self-sufficient and this crate is required only when you need to compile an external C/C++ code and call it from Rust.

Thank you for clarifying. This crate appears to be a dependency of rustc_codegen_ssa and rustc_llvm (https://github.com/rust-lang/rust/tree/master/compiler), but I don't follow exactly how it is used.

@dot-asm
Copy link
Contributor

dot-asm commented Mar 14, 2022

Those dependencies are required by the Rust compiler itself. In other words you'd need cc-rs if you were to build the Rust compiler for executing it on your watch. I assumed it was a safe assumption that it's not the actual goal of your endeavour.

@vladimir-ea
Copy link
Contributor Author

Those dependencies are required by the Rust compiler itself. In other words you'd need cc-rs if you were to build the Rust compiler for executing it on your watch. I assumed it was a safe assumption that it's not the actual goal of your endeavour.

Ok, makes sense. I do not think there will ever be a requirement to compile on WatchOS.

I have experimented with building without the changes to cc-rs made in this diff, and it does not work. I am also building the standard library.

What I am doing is:

  • building rust compiler with WatchOS changes (see Add Apple WatchOS compile targets and stdlib support rust#94736)
  • building the 3 WatchOS targets (armv7k-apple-watchos, arm64_32-apple-watchos, and x86_64-apple-watchos-sim)
  • cross-compiling an application for those 3 targets (with dependency on cc-rs as modified by this PR)

This all works, in as much as everything compiles. To deploy to WatchOS you create multi-architecture bundle using lipo. This fails with errors about mismatched cpu types.

If I update the rust project dependency on cc-rs to point at this PR, then this all works, I can deploy and run the application on all 3 architectures.

@dot-asm
Copy link
Contributor

dot-asm commented Mar 14, 2022

I [for one] find all this environment variable chasing tedious and even counterproductive, so I what you would think of #664.

@vladimir-ea
Copy link
Contributor Author

I [for one] find all this environment variable chasing tedious and even counterproductive, so I what you would think of #664.

To find the SDK? I think it makes sense. It is the approach taken in rustc here: https://github.com/rust-lang/rust/blob/bce19cf7f19ee5729defaccc86b068cc3c206c9c/compiler/rustc_codegen_ssa/src/back/link.rs#L2496

In this diff I followed the existing approach for iOS, but certainly making things simpler is a good idea!

@dot-asm
Copy link
Contributor

dot-asm commented Mar 14, 2022

To find the SDK?

No, to start the compiler. Instead of looking at environment variables like THIS_N_THAT_DEPLOYMENT_TARGET and map it to --target, -mx-version-min, you just let xcrun handle all this. Taking this PR as example. You suggest to set specific version-min if WATCHOS_DEPLOYMENT_TARGET is not set. Why this specific version? Will it still work with next after next xcode version? Would it still match the average expectations? Aren't the said expectations "whatever xcode says" anyway? So why not simply let xcode do its thing?

@vladimir-ea
Copy link
Contributor Author

vladimir-ea commented Mar 14, 2022

So why not simply let xcode do its thing?

I don't disagree - this seems like a good idea. Would you like to make these changes? As part of this PR? I am not super familiar with xcode myself, but happy to test any changes.

@vladimir-ea
Copy link
Contributor Author

@rustbot ready

@rustbot
Copy link

rustbot commented May 23, 2022

Error: This repository is not enabled to use triagebot.
Add a triagebot.toml in the root of the master branch to enable it.

Please let @rust-lang/release know if you're having trouble with this bot.

JohnTitor added a commit to JohnTitor/rust that referenced this pull request Jun 13, 2022
…gisa

Add Apple WatchOS compile targets

Hello,

I would like to add the following target triples for Apple WatchOS as Tier 3 platforms:

armv7k-apple-watchos
arm64_32-apple-watchos
x86_64-apple-watchos-sim
There are some pre-requisites Pull Requests:
rust-lang/compiler-builtins#456 (merged)
rust-lang/cc-rs#662 (pending)
rust-lang/libc#2717 (merged)

There will be a subsequent PR with standard library changes for WatchOS.  Previous compiler and library changes were in a single PR (rust-lang#94736) which is now closed in favour of separate PRs.

Many thanks!
Vlad.

### Tier 3 Target Requirements

Adds support for Apple WatchOS compile targets.

Below are details on how this target meets the requirements for tier 3:

>   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.)

`@deg4uss3r` has volunteered to be the target maintainer. I am also happy to help if a second maintainer is required.

> 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.

Uses the same naming as the LLVM target, and the same convention as other Apple targets.

> 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.

I don't believe there is any ambiguity here.

> 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.

I don't see any legal issues here.

> 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 be subject to any new license requirements.
> If the target supports building host tools (such as rustc or cargo), those host tools must not depend on proprietary (non-FOSS) libraries, other than ordinary runtime libraries supplied by the platform and commonly used by other binaries built for the target. 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.
> Targets should not require proprietary (non-FOSS) components to link a functional binary or library.
> "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.

I see no issues with any of the above.

> 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.

Only relevant to those making approval decisions.

> 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.

core and alloc can be used. std support will be added in a subsequent PR.

> 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 tests (even if they do not pass), the documentation must explain how to run tests for the target, using emulation if possible or dedicated hardware if necessary.

Use --target=<target> option to cross compile, just like any target. Tests can be run using the WatchOS simulator (see https://developer.apple.com/documentation/xcode/running-your-app-in-the-simulator-or-on-a-device).

> 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.

I don't foresee this being a problem.

> 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.

No other targets should be affected by the pull request.
@vladimir-ea
Copy link
Contributor Author

does this repo now have maintainers and / or reviewers? does anyone know?

@dot-asm
@m-ou-se

??

@dot-asm
Copy link
Contributor

dot-asm commented Jun 14, 2022

I'm just a cc-rs user trying to do my part. As for #664, just see last comments...

@m-ou-se
Copy link
Member

m-ou-se commented Jun 14, 2022

does this repo now have maintainers and / or reviewers? does anyone know?

Yes, but we're short on bandwidth. I'll try to look at this tomorrow, but I currently have 302 GitHub notifications that I need to check, so I can't make any promises.

@vladimir-ea
Copy link
Contributor Author

does this repo now have maintainers and / or reviewers? does anyone know?

Yes, but we're short on bandwidth. I'll try to look at this tomorrow, but I currently have 302 GitHub notifications that I need to check, so I can't make any promises.

Thanks! Just wanted to check that someone was looking after things.

@m-ou-se m-ou-se merged commit 53272c5 into rust-lang:main Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants