Skip to content

The extern "C" ABI of SIMD vector types depends on target features (tracking issue for abi_unsupported_vector_types future-incompatibility lint) #116558

Description

@RalfJung

The following program has UB, for very surprising reasons:

use std::mem::transmute;
#[cfg(target_arch = "x86")]
use std::arch::x86::*;
#[cfg(target_arch = "x86_64")]
use std::arch::x86_64::*;

extern "C" fn no_target_feature(_dummy: f32, x: __m256) {
    let val = unsafe { transmute::<_, [u32; 8]>(x) };
    dbg!(val);
}

#[target_feature(enable = "avx")]
unsafe fn with_target_feature(x: __m256) {
  // Here we're seemingly just calling a safe function... but actually this call is UB!
  // Caller and callee do not agree on the ABI; specifically they disagree on how the
  // `__m256` argument gets passed.
  no_target_feature(0.0, x);
}

fn main() {
    assert!(is_x86_feature_detected!("avx"));
    // SAFETY: we checked that the `avx` feature is present.
    unsafe {
        with_target_feature(transmute([1; 8]));
    }
}

The reason is that the ABI of the __m256 type depends on the set of target features, so the caller (with_target_feature) and callee (no_target_feature) do not agree on how the argument should be passed. The result is a vector half-filled with junk. (The same issue also arises in the other direction, where the caller has fewer features than the callee: example here.)

Currently, we have no good way to do correct code generation here. See #132865 for a discussion of how we could support such code in the future; it will require some non-trivial work. So instead, the current plan is to reject such code entirely.

This is the tracking issue for the lint that moves us in that direction. The hope is that passing SIMD vectors across a C ABI is sufficiently rare, and most of the cases being rejected have anyway already been broken, that we can reject this without much of an ecosystem impact. Crater showed no regressions.

This is linted against since Rust 1.84, and shown in future breakage reports starting with Rust 1.85. The plan is to move to a hard error with Rust 1.87.

When this becomes a hard error:


Original issue text:

I'm not sure if this is currently even properly documented? We are mentioning it in #115476 but the program above doesn't involve any function pointers so we really cannot expect people to be aware of that part of the docs. We show a general warning about the type not being FFI-compatible, but that warning shows up a lot and anyway in this case both caller and callee are Rust functions!

I think we need to do better here, but backwards compatibility might make that hard. @chorman0773 suggested we should just reject functions like no_target_feature that take an AVX type by-val without having declared the AVX feature. That seems reasonable; a crater run would be needed to assess whether it breaks too much code. An alternative might be to have a deny-by-default lint that very clearly explains what is happening.

There are also details to work out wrt what exactly the lint should check. Newtypes around __m256 will have the same problem. What about other larger types that contain __m256? Behind a ptr indirection it's obviously fine, but what about (__m256, __m256)? If we apply the ScalarPair optimization this will be passed in registers even on x86.

A possible place to put the check could be somewhere around here.

In terms of process, I am not sure if an RFC is required; a t-compiler MCP might be sufficient. Currently we accept code that clearly doesn't do what it looks like it should do.

And finally -- are there any other targets (besides x86 and x86-64) that have target-features that affect the ABI? They should get the same treatment.

Note that this is different from #116344 in two ways:

  • This issue only affects non-"Rust" ABIs; the other issue affects even the "Rust" ABI. (The Rust ABI passes __m256 by-pointer exactly to work-around this issue.)
  • This issue comes about when the user enables extra features (which is possible also locally via #[target_feature]), the other issue comes about when the user disables features (which is only possible on a per-crate level via -C, and if you're mixing crates with different -C flags then you're already already on very shaky grounds -- we do that with std but nobody else really gets to do that, I think).

Cc @workingjubilee more ABI fun ;)

Activity

  1. added
    A-ABIArea: Concerning the application binary interface (ABI)
    on Oct 9, 2023
  2. added
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Oct 9, 2023
  3. chorman0773 commented on Oct 9, 2023

    @chorman0773
    Contributor

    For a hard error, I think it probably should go through RFC. I can start drafting that now. As for what it would check, I'd expect a hard error on any time a simd type is passed by value and the appropriate feature is unavailable, even if the specific ABI wouldn't necessarily pass it in registers, including inside a structure, and the lint should probably check the same thing.

  4. RalfJung commented on Oct 9, 2023

    @RalfJung
    MemberAuthor

    That can have potentially surprising effects, e.g. when a closure captures something of type __m256 and the closure gets passed by-value to a generic function.

    It also means adding adding a private field that contains by-val repr(simd) data can be a semver-breaking change. Cc @ehuss

  5. chorman0773 commented on Oct 9, 2023

    @chorman0773
    Contributor

    It also means adding adding a private field that contains by-val repr(simd) data can be a semver-breaking change

    This would already be the case with replacing several fields with a SIMD type. For example, changing struct Foo(u64,u64,u64,u64); to struct Foo(__m256i);

    Although thinking about it, because features can be per-crate, this might be a problem on crates that specialize based on target features.

    Perhaps #[repr(Rust)] types should be exempted and always passed indirectly when they contain SIMD types (but not #[repr(C)] types).

  6. coastalwhite commented on Oct 9, 2023

    @coastalwhite
    Contributor

    With RISC-V, you have Zfinx and Zdinx which have hard-floats but have moved the floats to the normal general purpose registers. In this case, forbidding the passing of floats by-value, if the f (RISC-V's version of single-precision float) target is not present, is very restrictive and probably not what you would want. Otherwise, allowing the passing-by-value of floats between f and Zfinx is also UB.

  7. RalfJung commented on Oct 9, 2023

    @RalfJung
    MemberAuthor

    But the ABI only changes when f is present or not present, I assume? When f is present, Zfinx just means more instructions can be used but the ABI still says f32 is passed on float registers? And when f is not present, softfloat and Zfinx use the same ABI?

    So that sounds like whether or not f is present should be a different target triple. Code with vs without f simply cannot be linked together. But having or not having Zfinx doesn't make an ABI difference. Or am I misunderstanding?

  8. coastalwhite commented on Oct 9, 2023

    @coastalwhite
    Contributor

    No, that is exactly it. Do I understand correctly that you essentially want to do something similar to thumb with the eabi and eabihf?

  9. RalfJung commented on Oct 9, 2023

    @RalfJung
    MemberAuthor

    I'm not an expert on target details. 🙈 Usually my purview ends when I have given precise abstract semantics to nasty pieces of unsafe Rust and MIR.^^ But every now and then terrible low-level CPU nightmares creep onto my territory and then I have to learn how to deal with them...

    So, I don't know what ARM does with eabi vs eabihf. But it sounds like they are considering "hard float" and "soft float" two different ABIs that presumably use different registers for argument passing (so they are indeed different ABIs), and then have corresponding target triples to tell apart the ABIs. So yeah that sounds like what I am suggesting we should do for other targets as well. (We could also consider different ABI strings, like "C" vs "C-softfloat" or so. No idea if that makes any sense.)

    Obviously we don't actually care whether the functions behind those ABIs use x87/d/f hardware instructions or do some softfloat stuff, we just care how arguments are passed. But sadly it seems that in LLVM, there's no way to say "you have the d,f target features available but please use the softfloat ABI anyway"? If that is something people need (enable d,f or x87,sse,sse2 on softfloat targets without affecting ABI) we should start talking with LLVM people about whether and how that could be achieved.

    This may all be completely naive since I'm just coming at this with my principled approach of making everything safe or at least sound and giving it semantics at a high level; I rely on people like @chorman0773 to tell me when my ideas make no sense "in the field". ;)

  10. Skgland commented on Oct 9, 2023

    @Skgland
    Contributor

    If with_target_feature calling no_target_feature is UB due do different target features, shouldn't main calling with_target_feature have the same problem? just the other way around?
    Or is this specific to "C" being a non Rust-ABI?

  11. RalfJung commented on Oct 9, 2023

    @RalfJung
    MemberAuthor

    Yeah for the Rust ABI we do apply a work-around (it always passes such types in memory), so that call is fine. But the combination of extern fn and target_feature is a big minefield currently.

    (I updated the example to actually use the Rust ABI for with_target_feature.)

  12. Skgland commented on Oct 9, 2023

    @Skgland
    Contributor

    Would adding a inline(never) Rust ABI intermediate function be a valid workaround to prevent UB here?
    Unconditional code generation #[target_feature]: Note 1 making #[inline(never)] required as otherwise the compiler may inline the function and then we would be back to the incorrect feature set.

    EDIT: The referenced Note

    Note 1: a function has the features of the crate where the function is defined +/- #[target_feature] annotations. Iff the function is inlined into a context that extends its feature set, then the compiler is allowed to generate code for the function using this extended feature set (sub-note: inlining is forbidden in the opposite case).

  13. RalfJung commented on Oct 9, 2023

    @RalfJung
    MemberAuthor

    Inlining should be aware of target features, so inline(never) should not be needed. If it is needed that's a critical bug in the inliner that we should track and fix.

    Yes such an intermediate Rust ABI function works around the problem successfully. But the fundamental problem remains with function pointers: we have to decide whether an extern "C" fn(__m256) has the AVX ABI or some fallback ABI, without having any clue where and how the function it points to was declared. We probably want it to have the AVX ABI since people that use AVX and interface between Rust and C code likely will have their C code built in a way that it uses the AVX ABI. This means all extern "C" fn declared in Rust that take __m256 as arguments should do this the AVX style, no matter the set of enabled target features -- or they should fail to build.

  14. RalfJung commented on Oct 9, 2023

    @RalfJung
    MemberAuthor

    Ah, the inline actually does make a difference here... well that's bad, I opened #116573 to track that.

  15. briansmith commented on Oct 9, 2023

    @briansmith
    Contributor

    The compiler does report improper_ctypes_definitions warnings for the given code so I guess it isn't unexpected? It would e better to have an example that doesn't trigger improper_ctypes_definitions.

  16. 128 remaining items

  17. oconnor663 commented on Jun 1, 2025

    @oconnor663
    Contributor

    @RalfJung I've noticed new warnings as a result of this change. Here's a CI run: https://github.com/BLAKE3-team/BLAKE3/actions/runs/15326026728/job/43120654065. Reproducing that locally:

    $ git clone https://github.com/BLAKE3-team/BLAKE3                                                                                                  
    ...
    $ cd BLAKE3                                                                                                                                        
    $ cross rustc --release --target i686-unknown-linux-musl -- -C target-cpu=i386                                                                     
    ...
    warning: this function definition uses SIMD vector type `std::arch::x86::__m128i` which (with the chosen ABI) requires the `sse` target feature, wh
    ich is not enabled                                                                                                                                 
      --> src/rust_sse2.rs:75:1                                                                                                                        
       |                                                                                                                                               
    75 | / unsafe fn g1(                                                                                                                               
    76 | |     row0: &mut __m128i,                                                                                                                     
    77 | |     row1: &mut __m128i,                                                                                                                     
    78 | |     row2: &mut __m128i,                                                                                                                     
    79 | |     row3: &mut __m128i,                                                                                                                     
    80 | |     m: __m128i,                                                                                                                             
    81 | | ) {                                                                                                                                         
       | |_^ function defined here
       |
       = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
       = note: for more information, see issue #116558 <https://github.com/rust-lang/rust/issues/116558>
       = help: consider enabling it globally (`-C target-feature=+sse`) or locally (`#[target_feature(enable="sse")]`)
    ...
    

    The code in that file is divided into two types of functions, public ones annotated with #[target_feature(enable = "sse2")], and private ones annotated with #[inline(always)]. I had thought (or read somewhere) that inline(always) functions assumed the CPU features of their caller and didn't need to be annotated. Either way it seems to be incompatible with target_feature. What's should this code be doing differently?

  18. RalfJung commented on Jun 1, 2025

    @RalfJung
    MemberAuthor

    @oconnor663 please file a new issue.

    I'm surprised this only came up now, this was an FCW for 4 releases...

  19. oconnor663 commented on Jun 1, 2025

    @oconnor663
    Contributor

    Weird, I'm pretty sure this test target has been running regularly for years. Thanks for getting back to me so quickly. Opened: #141848

  20. RalfJung commented on Jun 1, 2025

    @RalfJung
    MemberAuthor
  21. RalfJung commented on Jun 1, 2025

    @RalfJung
    MemberAuthor

    Ah this is with 1.87, not with nightly, I see -- so it is still a warning. It'll be a hard error with 1.88.

    But it has been a warning for local crates since 1.84, and for all dependencies since 1.85.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-ABIArea: Concerning the application binary interface (ABI)A-SIMDArea: SIMD (Single Instruction Multiple Data)A-target-featureArea: Enabling/disabling target features like AVX, Neon, etc.C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCF-simd_ffi`#![feature(simd_ffi)]`I-unsoundIssue: A soundness hole (worst kind of bug), see: https://en.wikipedia.org/wiki/SoundnessL-abi_unsupported_vector_typesLint: abi_unsupported_vector_typesT-compilerRelevant to the compiler team, which will review and decide on the PR/issue.T-opsemRelevant to the opsem team

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions