Add new Tier-3 target: powerpc64-sony-ps3

[ZephyrCodesStuff]

View all comments

Implements a compatible target for the Sony PlayStation 3 console's PPU processor.

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 (@ZephyrCodesStuff) am the maintainer and developer, both for this PR's target, as well as a Rust PS3 SDK to help developers get started.

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.

Addressed. The PPU is a standard powerpc64 core, with only marginal changes made for the PS3's hardware configuration. sony is used among other Sony console targets, and ps3 is the console's shorthand.

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.

Addressed.

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.

Although it does require a separate linker (mold) and a post-fix binary patching tool (included in the SDK above), no part of the build process, from the code, to the compiler, linker or SDK are closed-source. This target is compatible with the aformentioned SDK without any reliance on community "homebrew" tools, nor any licensed Sony / SN Systems compiler or linker.

Anything added to the Rust repository must be under the standard Rust license (MIT OR Apache-2.0).

All of my code in this PR, including the SDK above, are licensed 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.

Addressed.

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

All of the components are free, open-source software.

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.

Addressed.

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 target currently does not support the std library, but can fully support the core and alloc feature-sets. Tested and verified on official hardware with the aid of the SDK above.

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 included, both in this PR's Markdown files, as well as the SDK's repository.

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.

This target should not cause issues, as its scope is relatively limited to Sony PlayStation 3 development.

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.

Noted.

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.

This patch does not touch any other 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.

This target only has one feature, +altivec, universally supported on any Sony PlayStation 3 unit.

Tier 3 targets must be able to produce assembly using at least one of rustc’s supported backends from any host target. (Having support in a fork of the backend is not sufficient, it must be upstream.)

Artifacts built by this target are confirmed to be fully functional on official hardware, once linked with the mold linker and patched by the SDK toolchain.

[rustbot]

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

cc @Noratrieb

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

[rustbot]

Thanks for the pull request, and welcome! The Rust Project has assigned @khyperia (or someone else) to review your changes, you should hear from them (or someone else) within the next two weeks.

Please see the contribution instructions and our LLM policy for more information.

Why was this reviewer chosen?

The reviewer was selected based on:

• Owners of files modified in this PR: compiler
• compiler expanded to 75 candidates
• Random selection from 19 candidates

[rustbot]

compiler-builtins is developed in its own repository. If possible, consider making this change to rust-lang/compiler-builtins instead.

cc @tgross35

[ZephyrCodesStuff]

Whoops -- just wanted to make the CI checks succeed. Feel free to [ask me to] revert that if those files are handled in some other, better way.

[rustbot]

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

[rustbot]

rust-analyzer is developed in its own repository. If possible, consider making this change to rust-lang/rust-analyzer instead.

cc @rust-lang/rust-analyzer

[ZephyrCodesStuff]

Condensed all the commits into one proper to reduce clutter and fix-up noise

[khyperia]

aah neat! unfortunately I'm not very knowledgeable about the new target process and don't feel confident enough to be able to effectively review this or what all is required, so, rerolling:

r? compiler

[ZephyrCodesStuff]

Yes.

I do eventually want to support the Rust Standard Library, although it might not be very soon and the mechanics for it may be more (or less) clunky.

From initial research I did though, the CellOS kernel, "Lv2", and the stock libraries present on the OS should expose almost everything I would need (minus TLS which will be a hurdle).

I will gather up a complete overview of what's supported and what isn't, when the time to implement stdlib comes.

May I ask what drives the question?

EDIT: Corrections upon double-checking documentation.

[tgross35]

Mostly just getting context. At some point the psp module in libc was removed, I believe for copyright reasons—wondering if this would run into the same issue. If it's not POSIX-y then it wouldn't make sense to have in libc anyway, though.

[ZephyrCodesStuff]

Changes:

• Added @RipleyTom as a co-maintainer for the target. They will act as a fallback in case I am unreachable.
• Added comments explaining every decision.
• Updated -e to use _start as entrypoint for consistency with all standards.
• Updated disable_redzone to false since this target mostly targets user-mode applications running below the Lv2 kernel. Kernel-mode developers should override this to true.
• Updated frame_pointer to MayOmit since PPC64 handles this, and it frees up a GPR (r31).
• Removed DWARF 2 compatibility, as legacy debuggers aren't capable of parsing it anyway, due to 64-bit pointers generated by LLVM's PPC64 target, whereas they expect 32-bit ones. Using GDB servers is the recommended path for debugging.
• Removed --no-gc-sections, instead using -u to keep necessary sections

[davidtwco]

LGTM, we only need an approving review to accept a tier three target

View changes since this review

[davidtwco]

@bors r+

[rust-bors]

📌 Commit 2489df9 has been approved by davidtwco

It is now in the queue for this repository.

[rust-timer]

Note

This PR was benchmarked as part of triage of its containing rollup: triage URL.

Finished benchmarking commit (d499399): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This perf run didn't have relevant results for this metric.

Max RSS (memory usage)

Results (primary -6.9%, secondary 5.1%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	5.1%	[5.1%, 5.1%]	1
Improvements ✅ (primary)	-6.9%	[-11.3%, -2.6%]	2
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-6.9%	[-11.3%, -2.6%]	2

Cycles

This perf run didn't have relevant results for this metric.

Binary size

This perf run didn't have relevant results for this metric.

Bootstrap: missing data
Artifact size: 403.29 MiB -> 403.38 MiB (0.02%)