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 arm64e-apple-tvos target #130614

Merged
merged 1 commit into from
Sep 20, 2024
Merged

Add arm64e-apple-tvos target #130614

merged 1 commit into from
Sep 20, 2024

Conversation

arttet
Copy link
Contributor

@arttet arttet commented Sep 20, 2024

This introduces

  • arm64e-apple-tvos

Tier 3 Target Policy

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

I will be a target maintainer.

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

The arm64e-apple-tvos target names like arm64e-apple-ios, arm64e-apple-darwin.
So, I have chosen this name because there are similar triplets in LLVM. I think there are no more suitable names for these 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 be
    subject 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.

No dependencies were added to Rust.

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

Understood.
I am not a member of a Rust team.

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

Understood.
std is supported.

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

Building is described in the derived target doc.

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

Understood.

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

Understood.

#121663
#73628

@rustbot
Copy link
Collaborator

rustbot commented Sep 20, 2024

r? @GuillaumeGomez

rustbot has assigned @GuillaumeGomez.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Sep 20, 2024
@rustbot
Copy link
Collaborator

rustbot commented Sep 20, 2024

Some changes occurred in src/doc/rustc/src/platform-support

cc @Noratrieb

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

@arttet
Copy link
Contributor Author

arttet commented Sep 20, 2024

r? @bjorn3

@rustbot rustbot assigned bjorn3 and unassigned GuillaumeGomez Sep 20, 2024
@arttet
Copy link
Contributor Author

arttet commented Sep 20, 2024

The arm64e-apple-tvos target spec
{
  "abi-return-struct-as-int": true,
  "arch": "aarch64",
  "archive-format": "darwin",
  "cpu": "apple-a12",
  "crt-objects-fallback": "false",
  "data-layout": "e-m:o-i64:64-i128:128-n32:64-S128-Fn32",
  "debuginfo-kind": "dwarf-dsym",
  "dll-suffix": ".dylib",
  "dynamic-linking": true,
  "eh-frame-header": false,
  "emit-debug-gdb-scripts": false,
  "features": "+neon,+fp-armv8,+apple-a12,+v8.3a,+pauth",
  "frame-pointer": "non-leaf",
  "function-sections": false,
  "has-rpath": true,
  "has-thread-local": true,
  "is-builtin": true,
  "is-like-osx": true,
  "link-env": [
    "ZERO_AR_DATE=1"
  ],
  "link-env-remove": [
    "MACOSX_DEPLOYMENT_TARGET"
  ],
  "linker-flavor": "darwin-cc",
  "linker-is-gnu": false,
  "lld-flavor": "darwin",
  "llvm-target": "arm64e-apple-tvos14.0.0",
  "max-atomic-width": 128,
  "metadata": {
    "description": "ARM64e Apple tvOS",
    "host_tools": false,
    "std": true,
    "tier": 3
  },
  "os": "tvos",
  "pre-link-args": {
    "darwin": [
      "-arch",
      "arm64e",
      "-platform_version",
      "tvos",
      "14.0.0",
      "14.0.0"
    ],
    "darwin-cc": [
      "-target",
      "arm64e-apple-tvos14.0.0"
    ],
    "darwin-lld": [
      "-arch",
      "arm64e",
      "-platform_version",
      "tvos",
      "14.0.0",
      "14.0.0"
    ],
    "darwin-lld-cc": [
      "-target",
      "arm64e-apple-tvos14.0.0"
    ]
  },
  "split-debuginfo": "packed",
  "stack-probes": {
    "kind": "inline"
  },
  "supported-split-debuginfo": [
    "packed",
    "unpacked",
    "off"
  ],
  "target-family": [
    "unix"
  ],
  "target-pointer-width": "64",
  "vendor": "apple"
}

Target {
llvm_target,
metadata: crate::spec::TargetMetadata {
description: Some("ARM64e Apple tvOS".into()),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The aarch64-apple-tvos target spec omits "Apple" from the description, as does the aarch64-apple-ios target spec.

Copy link
Contributor Author

@arttet arttet Sep 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have the same description for arm64e_apple_darwin & arm64e_apple_ios.
I can remove it if it needs

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If other targets are already inconsistent, I don't think you need to make them consistent in this PR.

@rust-log-analyzer

This comment has been minimized.

@bjorn3
Copy link
Member

bjorn3 commented Sep 20, 2024

You will need to fix the CI failure. Other than that this PR looks fine. However #130085 is a bit concerning. It feels like that issue should be fixed before we add new apple targets with pointer authentication. Especially if there is a genuine ABI break as opposed to just apple's linker marking them as incompatible.

@arttet
Copy link
Contributor Author

arttet commented Sep 20, 2024

You will need to fix the CI failure. Other than that this PR looks fine. However #130085 is a bit concerning. It feels like that issue should be fixed before we add new apple targets with pointer authentication. Especially if there is a genuine ABI break as opposed to just apple's linker marking them as incompatible.

As for #130085, it relates to LLVM issue #80200. It seems like this is beyond the Rust compiler itself. If I understand correctly, we started using the LLD linker by default, which allows these targets to be built without errors. Furthermore, Apple has made their LLVM repository on GitHub private, so I hope that one of the LLVM contributors can address this issue directly.

Anyway, we can build these targets and use them. I will update some docs about it.

P.S. Now we need to look at Swift LLVM

@bjorn3
Copy link
Member

bjorn3 commented Sep 20, 2024

@bors r+ rollup=always

@bors
Copy link
Contributor

bors commented Sep 20, 2024

📌 Commit 340b38e has been approved by bjorn3

It is now in the queue for this repository.

@bors 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-review Status: Awaiting review from the assignee but also interested parties. labels Sep 20, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 20, 2024
…llaumeGomez

Rollup of 7 pull requests

Successful merges:

 - rust-lang#128209 (Remove macOS 10.10 dynamic linker bug workaround)
 - rust-lang#130526 (Begin experimental support for pin reborrowing)
 - rust-lang#130611 (Address diagnostics regression for `const_char_encode_utf8`.)
 - rust-lang#130614 (Add arm64e-apple-tvos target)
 - rust-lang#130617 (bail if there are too many non-region infer vars in the query response)
 - rust-lang#130619 (Fix scraped examples height)
 - rust-lang#130624 (Add `Vec::as_non_null`)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit df2b730 into rust-lang:master Sep 20, 2024
6 checks passed
@rustbot rustbot added this to the 1.83.0 milestone Sep 20, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Sep 20, 2024
Rollup merge of rust-lang#130614 - arttet:arm64e-apple-tvos, r=bjorn3

Add arm64e-apple-tvos target

This introduces

* `arm64e-apple-tvos`

## Tier 3 Target Policy

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

I will be a target maintainer.

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

The `arm64e-apple-tvos` target names like `arm64e-apple-ios`, `arm64e-apple-darwin`.
So, **I have chosen this name because there are similar triplets in LLVM**. I think there are no more suitable names for these 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 be
subject 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.

No dependencies were added to Rust.

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

Understood.
I am not a member of a Rust team.

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

Understood.
`std` is supported.

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

Building is described in the derived target doc.

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

Understood.

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

Understood.

rust-lang#121663
rust-lang#73628
@arttet arttet deleted the arm64e-apple-tvos branch September 20, 2024 22:47
workingjubilee added a commit to workingjubilee/rustc that referenced this pull request Sep 22, 2024
…sistency, r=jieyouxu

Fixup Apple target's description strings

Noticed this inconsistency in how the Apple target's had their new descriptions written while looking at rust-lang#130614, and figured it was easy enough to fixup shortly. I think prefixing every OS with `Apple` is clearer, especially for less known ones like `visionOS` and `watchOS`; so that's what was done here along with making the architecture names more consistent and then some other small tweaks.

~~r​? `@thomcc~~`

cc `@madsmtm`
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Sep 22, 2024
Rollup merge of rust-lang#130650 - BlackHoleFox:apple-target-desc-consistency, r=jieyouxu

Fixup Apple target's description strings

Noticed this inconsistency in how the Apple target's had their new descriptions written while looking at rust-lang#130614, and figured it was easy enough to fixup shortly. I think prefixing every OS with `Apple` is clearer, especially for less known ones like `visionOS` and `watchOS`; so that's what was done here along with making the architecture names more consistent and then some other small tweaks.

~~r​? `@thomcc~~`

cc `@madsmtm`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants