96477c55bc
Support clobber_abi and vector registers (clobber-only) in PowerPC inline assembly This supports `clobber_abi` which is one of the requirements of stabilization mentioned in #93335. This basically does a similar thing I did in https://github.com/rust-lang/rust/pull/130630 to implement `clobber_abi` for s390x, but for powerpc/powerpc64/powerpc64le. - This also supports vector registers (as `vreg`) as clobber-only, which need to support clobbering of them to implement `clobber_abi`. - `vreg` should be able to accept `#[repr(simd)]` types as input/output if the unstable `altivec` target feature is enabled, but `core::arch::{powerpc,powerpc64}` vector types, `#[repr(simd)]`, and `core::simd` are all unstable, so the fact that this is currently a clobber-only should not be considered a blocker of clobber_abi implementation or stabilization. So I have not implemented it in this PR. - See https://github.com/rust-lang/rust/pull/131551 (which is based on this PR) for a PR to implement this. - (I'm not sticking to whether that PR should be a separate PR or part of this PR, so I can merge that PR into this PR if needed.) Refs: - PPC32 SysV: Section "Function Calling Sequence" in [System V Application Binary Interface PowerPC Processor Supplement](https://refspecs.linuxfoundation.org/elf/elfspec_ppc.pdf) - PPC64 ELFv1: Section 3.2 "Function Calling Sequence" in [64-bit PowerPC ELF Application Binary Interface Supplement](https://refspecs.linuxfoundation.org/ELF/ppc64/PPC-elf64abi.html#FUNC-CALL) - PPC64 ELFv2: Section 2.2 "Function Calling Sequence" in [64-Bit ELF V2 ABI Specification](https://openpowerfoundation.org/specifications/64bitelfabi/) - AIX: [Register usage and conventions](https://www.ibm.com/docs/en/aix/7.3?topic=overview-register-usage-conventions), [Special registers in the PowerPC®](https://www.ibm.com/docs/en/aix/7.3?topic=overview-special-registers-in-powerpc), [AIX vector programming](https://www.ibm.com/docs/en/aix/7.3?topic=concepts-aix-vector-programming) - Register definition in LLVM: https://github.com/llvm/llvm-project/blob/llvmorg-19.1.0/llvm/lib/Target/PowerPC/PPCRegisterInfo.td#L189 If I understand the above four ABI documentations correctly, except for the PPC32 SysV's VR (Vector Registers) and 32-bit AIX (currently not supported by rustc)'s r13, there does not appear to be important differences in terms of implementing `clobber_abi`: - The above four ABIs are consistent about FPR (0-13: volatile, 14-31: nonvolatile), CR (0-1,5-7: volatile, 2-4: nonvolatile), XER (volatile), and CTR (volatile). - As for GPR, only the registers we are treating as reserved are slightly different - r0, r3-r12 are volatile - r1(sp, reserved), r14-31 are nonvolatile - r2(reserved) is TOC pointer in PPC64 ELF/AIX, system-reserved register in PPC32 SysV (AFAIK used as thread pointer in Linux/BSDs) - r13(reserved for non-32-bit-AIX) is thread pointer in PPC64 ELF, small data area pointer register in PPC32 SysV, "reserved under 64-bit environment; not restored across system calls[^r13]" in AIX) - As for FPSCR, volatile in PPC64 ELFv1/AIX, some fields are volatile only in certain situations (rest are volatile) in PPC32 SysV/PPC64 ELFv2. - As for VR (Vector Registers), it is not mentioned in PPC32 SysV, v0-v19 are volatile in both in PPC64 ELF/AIX, v20-v31 are nonvolatile in PPC64 ELF, reserved or nonvolatile depending on the ABI ([vec-extabi vs vec-default in LLVM](https://reviews.llvm.org/D89684), we are [using vec-extabi](https://github.com/rust-lang/rust/pull/131341#discussion_r1797693299)) in AIX: > When the default Vector enabled mode is used, these registers are reserved and must not be used. > In the extended ABI vector enabled mode, these registers are nonvolatile and their values are preserved across function calls I left [FIXME comment about PPC32 SysV](https://github.com/rust-lang/rust/pull/131341#discussion_r1790496095) and added ABI check for AIX. - As for VRSAVE, it is not mentioned in PPC32 SysV, nonvolatile in PPC64 ELFv1, reserved in PPC64 ELFv2/AIX - As for VSCR, it is not mentioned in PPC32 SysV/PPC64 ELFv1, some fields are volatile only in certain situations (rest are volatile) in PPC64 ELFv2, volatile in AIX We are currently treating r1-r2, r13 (non-32-bit-AIX), r29-r31, LR, CTR, and VRSAVE as reserved. We are currently not processing anything about FPSCR and VSCR, but I feel those are things that should be processed by `preserves_flags` rather than `clobber_abi` if we need to do something about them. (However, PPCRegisterInfo.td in LLVM does not seem to define anything about them.) Replaces #111335 and #124279 cc `@ecnelises` `@bzEq` `@lu-zero` r? `@Amanieu` `@rustbot` label +O-PowerPC +A-inline-assembly [^r13]: callee-saved, according to [LLVM]( |
||
|---|---|---|
| .. | ||
| asm | ||
| auxiliary | ||
| avr | ||
| cffi | ||
| compiletest-self-test | ||
| cross-crate-inlining | ||
| debug-accessibility | ||
| dllimports | ||
| enum | ||
| float | ||
| instrument-coverage | ||
| instrument-xray | ||
| intrinsics | ||
| issues | ||
| lib-optimizations | ||
| loongarch-abi | ||
| macos | ||
| meta-filecheck | ||
| naked-fn | ||
| non-terminate | ||
| patchable-function-entry | ||
| remap_path_prefix | ||
| repr | ||
| riscv-abi | ||
| sanitizer | ||
| simd | ||
| simd-intrinsic | ||
| src-hash-algorithm | ||
| unwind-abis | ||
| aarch64-struct-align-128.rs | ||
| abi-efiapi.rs | ||
| abi-main-signature-16bit-c-int.rs | ||
| abi-main-signature-32bit-c-int.rs | ||
| abi-repr-ext.rs | ||
| abi-sysv64.rs | ||
| abi-x86_64_sysv.rs | ||
| abi-x86-interrupt.rs | ||
| addr-of-mutate.rs | ||
| adjustments.rs | ||
| align-byval-alignment-mismatch.rs | ||
| align-byval-vector.rs | ||
| align-byval.rs | ||
| align-enum.rs | ||
| align-fn.rs | ||
| align-offset.rs | ||
| align-struct.rs | ||
| alloc-optimisation.rs | ||
| array-clone.rs | ||
| array-cmp.rs | ||
| array-codegen.rs | ||
| array-equality.rs | ||
| array-from_fn.rs | ||
| array-map.rs | ||
| array-optimized.rs | ||
| array-repeat.rs | ||
| ascii-char.rs | ||
| async-closure-debug.rs | ||
| async-fn-debug-awaitee-field.rs | ||
| async-fn-debug-msvc.rs | ||
| async-fn-debug.rs | ||
| atomic-operations.rs | ||
| atomicptr.rs | ||
| autovectorize-f32x4.rs | ||
| binary-heap-peek-mut-pop-no-panic.rs | ||
| binary-search-index-no-bound-check.rs | ||
| bool-cmp.rs | ||
| box-uninit-bytes.rs | ||
| bpf-alu32.rs | ||
| branch-protection-old-llvm.rs | ||
| branch-protection.rs | ||
| call-llvm-intrinsics.rs | ||
| call-metadata.rs | ||
| cast-optimized.rs | ||
| cast-target-abi.rs | ||
| catch-unwind.rs | ||
| cdylib-external-inline-fns.rs | ||
| cf-protection.rs | ||
| cfguard-checks.rs | ||
| cfguard-disabled.rs | ||
| cfguard-nochecks.rs | ||
| cfguard-non-msvc.rs | ||
| char-ascii-branchless.rs | ||
| checked_ilog.rs | ||
| checked_math.rs | ||
| clone_as_copy.rs | ||
| clone-shims.rs | ||
| codemodels.rs | ||
| coercions.rs | ||
| cold-call-declare-and-call.rs | ||
| common_prim_int_ptr.rs | ||
| comparison-operators-2-tuple.rs | ||
| comparison-operators-newtype.rs | ||
| const_scalar_pair.rs | ||
| const-vector.rs | ||
| constant-branch.rs | ||
| consts.rs | ||
| coroutine-debug-msvc.rs | ||
| coroutine-debug.rs | ||
| dealloc-no-unwind.rs | ||
| debug-alignment.rs | ||
| debug-column-msvc.rs | ||
| debug-column.rs | ||
| debug-compile-unit-path.rs | ||
| debug-fndef-size.rs | ||
| debug-limited.rs | ||
| debug-line-directives-only.rs | ||
| debug-line-tables-only.rs | ||
| debug-linkage-name.rs | ||
| debug-vtable.rs | ||
| debuginfo-constant-locals.rs | ||
| debuginfo-generic-closure-env-names.rs | ||
| debuginfo-inline-callsite-location.rs | ||
| deduced-param-attrs.rs | ||
| default-requires-uwtable.rs | ||
| default-visibility.rs | ||
| direct-access-external-data.rs | ||
| dont_codegen_private_const_fn_only_used_in_const_eval.rs | ||
| drop-in-place-noalias.rs | ||
| drop.rs | ||
| dst-offset.rs | ||
| dst-vtable-align-nonzero.rs | ||
| dst-vtable-size-range.rs | ||
| ehcontguard_disabled.rs | ||
| ehcontguard_enabled.rs | ||
| emcripten-catch-unwind.rs | ||
| enable-lto-unit-splitting.rs | ||
| error-provide.rs | ||
| export-no-mangle.rs | ||
| external-no-mangle-fns.rs | ||
| external-no-mangle-statics.rs | ||
| fastcall-inreg.rs | ||
| fatptr.rs | ||
| fewer-names.rs | ||
| fixed-x18.rs | ||
| float_math.rs | ||
| fn-impl-trait-self.rs | ||
| force-frame-pointers.rs | ||
| force-no-unwind-tables.rs | ||
| force-unwind-tables.rs | ||
| frame-pointer.rs | ||
| function-arguments-noopt.rs | ||
| function-arguments.rs | ||
| function-return.rs | ||
| gdb_debug_script_load.rs | ||
| generic-debug.rs | ||
| i128-x86-align.rs | ||
| infallible-unwrap-in-opt-z.rs | ||
| inherit_overflow.rs | ||
| inline-always-works-always.rs | ||
| inline-debuginfo.rs | ||
| inline-function-args-debug-info.rs | ||
| inline-hint.rs | ||
| instrument-mcount.rs | ||
| integer-cmp.rs | ||
| integer-overflow.rs | ||
| internalize-closures.rs | ||
| intrinsic-no-unnamed-attr.rs | ||
| is_val_statically_known.rs | ||
| issue-97217.rs | ||
| iter-repeat-n-trivial-drop.rs | ||
| layout-size-checks.rs | ||
| lifetime_start_end.rs | ||
| link_section.rs | ||
| link-dead-code.rs | ||
| llvm_module_flags.rs | ||
| llvm-ident.rs | ||
| loads.rs | ||
| local-generics-in-exe-internalized.rs | ||
| lto-removes-invokes.rs | ||
| mainsubprogram.rs | ||
| mainsubprogramstart.rs | ||
| match-optimized.rs | ||
| match-optimizes-away.rs | ||
| match-unoptimized.rs | ||
| maybeuninit-rvo.rs | ||
| mem-replace-big-type.rs | ||
| mem-replace-simple-type.rs | ||
| merge-functions.rs | ||
| method-declaration.rs | ||
| mir_zst_stores.rs | ||
| mir-aggregate-no-alloca.rs | ||
| mir-inlined-line-numbers.rs | ||
| move-before-nocapture-ref-arg.rs | ||
| move-operands.rs | ||
| naked-asan.rs | ||
| no_builtins-at-crate.rs | ||
| no-alloca-inside-if-false.rs | ||
| no-assumes-on-casts.rs | ||
| no-dllimport-w-cross-lang-lto.rs | ||
| no-jump-tables.rs | ||
| no-plt.rs | ||
| no-redundant-item-monomorphization.rs | ||
| noalias-box-off.rs | ||
| noalias-box.rs | ||
| noalias-flag.rs | ||
| noalias-freeze.rs | ||
| noalias-refcell.rs | ||
| noalias-rwlockreadguard.rs | ||
| noalias-unpin.rs | ||
| noreturn-uninhabited.rs | ||
| noreturnflag.rs | ||
| nounwind.rs | ||
| nrvo.rs | ||
| optimize-attr-1.rs | ||
| option-as-slice.rs | ||
| option-niche-eq.rs | ||
| overaligned-constant.rs | ||
| packed.rs | ||
| panic-abort-windows.rs | ||
| panic-in-drop-abort.rs | ||
| panic-unwind-default-uwtable.rs | ||
| pattern_type_symbols.rs | ||
| personality_lifetimes.rs | ||
| pgo-counter-bias.rs | ||
| pgo-instrumentation.rs | ||
| pic-relocation-model.rs | ||
| pie-relocation-model.rs | ||
| placement-new.rs | ||
| powerpc64le-struct-align-128.rs | ||
| precondition-checks.rs | ||
| ptr-arithmetic.rs | ||
| ptr-read-metadata.rs | ||
| range-attribute.rs | ||
| README.md | ||
| refs.rs | ||
| regparm-inreg.rs | ||
| repeat-trusted-len.rs | ||
| riscv-target-abi.rs | ||
| rust-abi-arch-specific-adjustment.rs | ||
| scalar-pair-bool.rs | ||
| set-discriminant-invalid.rs | ||
| skip-mono-inside-if-false.rs | ||
| slice_as_from_ptr_range.rs | ||
| slice-as_chunks.rs | ||
| slice-indexing.rs | ||
| slice-init.rs | ||
| slice-iter-fold.rs | ||
| slice-iter-len-eq-zero.rs | ||
| slice-iter-nonnull.rs | ||
| slice-pointer-nonnull-unwrap.rs | ||
| slice-position-bounds-check.rs | ||
| slice-ref-equality.rs | ||
| slice-reverse.rs | ||
| slice-windows-no-bounds-check.rs | ||
| some-abis-do-extend-params-to-32-bits.rs | ||
| some-global-nonnull.rs | ||
| sparc-struct-abi.rs | ||
| split-lto-unit.rs | ||
| sroa-fragment-debuginfo.rs | ||
| sse42-implies-crc32.rs | ||
| stack-probes-inline.rs | ||
| stack-protector.rs | ||
| static-relocation-model-msvc.rs | ||
| staticlib-external-inline-fns.rs | ||
| step_by-overflow-checks.rs | ||
| stores.rs | ||
| swap-large-types.rs | ||
| swap-small-types.rs | ||
| target-cpu-on-functions.rs | ||
| target-feature-inline-closure.rs | ||
| target-feature-overrides.rs | ||
| thread-local.rs | ||
| tied-features-strength.rs | ||
| to_vec.rs | ||
| trailing_zeros.rs | ||
| transmute-optimized.rs | ||
| transmute-scalar.rs | ||
| try_question_mark_nop.rs | ||
| tune-cpu-on-functions.rs | ||
| tuple-layout-opt.rs | ||
| ub-checks.rs | ||
| unchecked_shifts.rs | ||
| unchecked-float-casts.rs | ||
| uninit-consts.rs | ||
| union-abi.rs | ||
| unwind-and-panic-abort.rs | ||
| unwind-extern-exports.rs | ||
| unwind-extern-imports.rs | ||
| unwind-landingpad-cold.rs | ||
| unwind-landingpad-inline.rs | ||
| used_with_arg.rs | ||
| var-names.rs | ||
| vec_pop_push_noop.rs | ||
| vec-as-ptr.rs | ||
| vec-calloc.rs | ||
| vec-in-place.rs | ||
| vec-iter-collect-len.rs | ||
| vec-iter.rs | ||
| vec-len-invariant.rs | ||
| vec-optimizes-away.rs | ||
| vec-reserve-extend.rs | ||
| vec-shrink-panik.rs | ||
| vec-with-capacity.rs | ||
| vecdeque_no_panic.rs | ||
| vecdeque_pop_push.rs | ||
| vecdeque-drain.rs | ||
| vecdeque-nonempty-get-no-panic.rs | ||
| virtual-function-elimination-32bit.rs | ||
| virtual-function-elimination.rs | ||
| vtable-loads.rs | ||
| vtable-upcast.rs | ||
| wasm_casts_trapping.rs | ||
| wasm_exceptions.rs | ||
| zip.rs | ||
| zst-offset.rs | ||
The files here use the LLVM FileCheck framework, documented at https://llvm.org/docs/CommandGuide/FileCheck.html.
One extension worth noting is the use of revisions as custom prefixes for FileCheck. If your codegen test has different behavior based on the chosen target or different compiler flags that you want to exercise, you can use a revisions annotation, like so:
// revisions: aaa bbb
// [bbb] compile-flags: --flags-for-bbb
After specifying those variations, you can write different expected, or
explicitly unexpected output by using <prefix>-SAME: and <prefix>-NOT:,
like so:
// CHECK: expected code
// aaa-SAME: emitted-only-for-aaa
// aaa-NOT: emitted-only-for-bbb
// bbb-NOT: emitted-only-for-aaa
// bbb-SAME: emitted-only-for-bbb