rust/tests/codegen-llvm at 4230c3ab254349f870e9a23720bbcbdebcbf297d - rust

mirror of https://github.com/rust-lang/rust.git synced 2026-05-04 18:40:57 +03:00

Files

T

Jonathan Brouwer 27d6b3c9b7 Rollup merge of #151576 - tgross35:stabilize-cold-path, r=jhpratt

Stabilize `core::hint::cold_path`

`cold_path` has been around unstably for a while and is a rather useful tool to have. It does what it is supposed to and there are no known remaining issues, so stabilize it here (including const).

Newly stable API:

```rust
// in core::hint
pub const fn cold_path();
```

I have opted to exclude `likely` and `unlikely` for now since they have had some concerns about ease of use that `cold_path` doesn't suffer from. `cold_path` is also significantly more flexible; in addition to working with boolean `if` conditions, it can be used in `match` arms, `if let`, closures, and other control flow blocks. `likely` and `unlikely` are also possible to implement in user code via `cold_path`, if desired.

Closes: https://github.com/rust-lang/rust/issues/136873 (tracking issue)

---

There has been some design and implementation work for making `#[cold]` function in more places, such as `if` arms, `match` arms, and closure bodies. Considering a stable `cold_path` will cover all of these usecases, it does not seem worth pursuing a more powerful `#[cold]` as an alternative way to do the same thing. If the lang team agrees, then:

Closes: https://github.com/rust-lang/rust/issues/26179
Closes: https://github.com/rust-lang/rust/pull/120193

2026-02-07 13:06:35 +01:00

annotate-moves

…

asm

…

autodiff

…

autovec

…

auxiliary

…

avr

…

bounds-checking

…

cffi

…

compiletest-self-test

…

cross-crate-inlining

…

debug-accessibility

…

debuginfo-proc-macro

…

dllimports

…

enum

…

ergonomic-clones

…

float

…

gpu_offload

…

hint

…

instrument-coverage

…

instrument-xray

…

intrinsics

…

issues

…

lib-optimizations

…

loongarch

…

loongarch-abi

…

macos

…

meta-filecheck

…

naked-fn

…

non-terminate

…

option-niche-unfixed

…

patchable-function-entry

…

remap_path_prefix

…

repr

…

riscv-abi

…

sanitizer

…

scalable-vectors

…

simd

…

simd-intrinsic

…

src-hash-algorithm

…

unwind-abis

…

aarch64-softfloat.rs

…

aarch64-struct-align-128.rs

…

aarch64v8r-softfloat.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-win64-zst.rs

…

abi-x86_64_sysv.rs

…

abi-x86-interrupt.rs

…

abi-x86-sse.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-static.rs

…

align-struct.rs

…

alloc-optimisation.rs

…

amdgpu-addrspacecast.rs

…

amdgpu-dispatch-ptr.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

…

assign-desugar-debuginfo.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

…

become-musttail.rs

…

bigint-helpers.rs

…

binary-heap-peek-mut-pop-no-panic.rs

…

binary-search-index-no-bound-check.rs

…

bool-cmp.rs

…

bounds-check-elision-slice-min.rs

…

box-default-debug-copies.rs

…

box-uninit-bytes.rs

…

bpf-abi-indirect-return.rs

…

bpf-alu32.rs

…

branch-protection.rs

…

c-variadic-lifetime.rs

…

call-llvm-intrinsics.rs

…

call-tmps-lifetime.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

…

char-escape-debug-no-bounds-check.rs

…

checked_ilog.rs

…

checked_math.rs

…

clone_as_copy.rs

…

clone-shims.rs

…

codemodels.rs

…

coercions.rs

…

cold-attribute.rs

…

cold-call-declare-and-call.rs

…

common_prim_int_ptr.rs

…

comparison-operators-2-struct.rs

…

comparison-operators-2-tuple.rs

…

comparison-operators-newtype.rs

…

const_scalar_pair.rs

…

const-array.rs

…

const-vector.rs

…

constant-branch.rs

…

consts.rs

…

coroutine-debug-msvc.rs

…

coroutine-debug.rs

…

darwin-no-objc.rs

…

darwin-objc-abi-v1.rs

…

darwin-objc-abi-v2.rs

…

darwin-objc-cross-crate.rs

…

dead_on_return.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-cyclic-structure.rs

…

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

…

diverging-function-call-debuginfo.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

…

emscripten-catch-unwind-js-eh.rs

…

emscripten-catch-unwind-wasm-eh.rs

…

enable-lto-unit-splitting.rs

…

error-provide.rs

…

export-no-mangle.rs

…

external-no-mangle-fns.rs

…

external-no-mangle-statics.rs

…

f128-wasm32-callconv.rs

…

fastcall-inreg.rs

…

fatptr.rs

…

fewer-names.rs

…

fixed-x18.rs

…

float_math.rs

…

fn-impl-trait-self.rs

…

fn-parameters-on-different-lines-debuginfo.rs

…

force-frame-pointers.rs

…

force-no-unwind-tables.rs

…

force-unwind-tables.rs

…

frame-pointer-cli-control.rs

…

frame-pointer.rs

…

fromrangeiter-overflow-checks.rs

…

function-arguments-noopt.rs

…

function-arguments.rs

…

function-return.rs

…

gdb_debug_script_load.rs

…

generic-debug.rs

…

gep-index.rs

…

global-allocator-attributes.rs

…

gpu-kernel-abi.rs

…

i128-wasm32-callconv.rs

…

i128-x86-align.rs

…

i128-x86-callconv.rs

…

indirect-branch-cs-prefix.rs

…

infallible-unwrap-in-opt-z.rs

…

inherit_overflow.rs

…

inline-always-callsite.rs

…

inline-always-works-always.rs

…

inline-debuginfo.rs

…

inline-function-args-debug-info.rs

…

inline-hint.rs

…

instrument-mcount.rs

…

int-ptr-int-enum-miscompile.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

…

match-optimized.rs

…

match-optimizes-away.rs

…

match-unoptimized.rs

…

maybeuninit-array.rs

…

maybeuninit-rvo.rs

…

mem-replace-big-type.rs

…

mem-replace-simple-type.rs

…

merge-functions.rs

…

method-declaration.rs

…

min-function-alignment.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

…

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

…

preserve-none.rs

…

ptr-arithmetic.rs

…

ptr-read-metadata.rs

…

range_to_inclusive.rs

…

range-attribute.rs

…

range-loop.rs

…

read-only-capture-opt.rs

…

README.md

…

refs.rs

…

reg-struct-return.rs

…

regparm-inreg.rs

…

repeat-operand-zero-len.rs

…

repeat-operand-zst-elem.rs

…

repeat-trusted-len.rs

…

retpoline.rs

…

riscv-target-abi.rs

…

rust-abi-arch-specific-adjustment.rs

…

s390x-simd.rs

…

scalar-pair-bool.rs

…

set-discriminant-invalid.rs

…

skip-mono-inside-if-false.rs

…

slice_as_from_ptr_range.rs

…

slice_cse_optimization.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-last-elements-optimization.rs

…

slice-len-math.rs

…

slice-pointer-nonnull-unwrap.rs

…

slice-position-bounds-check.rs

…

slice-ref-equality.rs

…

slice-reverse.rs

…

slice-split-at.rs

…

slice-windows-no-bounds-check.rs

…

slp-vectorization-mul3.rs

…

some-abis-do-extend-params-to-32-bits.rs

…

some-global-nonnull.rs

…

some-non-zero-from-atomic-optimization.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

…

string-push.rs

…

swap-large-types.rs

…

swap-small-types.rs

…

target-cpu-on-functions.rs

…

target-feature-inline-closure.rs

…

target-feature-negative-implication.rs

…

target-feature-overrides.rs

…

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

…

uninhabited-transparent-return-abi.rs

…

uninit-consts.rs

…

uninit-repeat-in-aggregate.rs

…

union-abi.rs

…

union-aggregate.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-call-attrs-issue-137646.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

…

README.md

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