Skip to content

Add (back) unsupported_calling_conventions lint to reject more invalid calling conventions #141435

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

RalfJung
Copy link
Member

@RalfJung RalfJung commented May 23, 2025

This adds back the unsupported_calling_conventions lint that was removed in #129935, in order to start the process of dealing with #137018. Specifically, we are going for the plan laid out here:

  • thiscall, stdcall, fastcall, cdecl should only be accepted on x86-32
  • vectorcall should only be accepted on x86-32 and x86-64

The difference to the status quo is that:

  • We stop accepting stdcall, fastcall on targets that are windows && non-x86-32 (we already don't accept these on targets that are non-windows && non-x86-32)
  • We stop accepting cdecl on targets that are non-x86-32
  • (There is no difference for thiscall, this was already a hard error on non-x86-32)
  • We stop accepting vectorcall on targets that are windows && non-x86-*

Vectorcall is an unstable ABI so we can just make this a hard error immediately. The others are stable, so we emit the unsupported_calling_conventions forward-compat lint. I set up the lint to show up in dependencies via cargo's future-compat report immediately, but we could also make it show up just for the local crate first if that is preferred.

@rustbot
Copy link
Collaborator

rustbot commented May 23, 2025

r? @lcnr

rustbot has assigned @lcnr.
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
Copy link
Collaborator

rustbot commented May 23, 2025

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

@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 May 23, 2025
@RalfJung RalfJung force-pushed the unsupported_calling_conventions branch 2 times, most recently from 3251270 to f4146aa Compare May 23, 2025 12:02
also unify error messages that do not seem to have a good reason to be different
@RalfJung RalfJung force-pushed the unsupported_calling_conventions branch from f4146aa to b8f4367 Compare May 23, 2025 12:09
@RalfJung RalfJung added the T-lang Relevant to the language team, which will review and decide on the PR/issue. label May 23, 2025
@RalfJung
Copy link
Member Author

@rust-lang/lang following positive vibes expressed here, I'd like to land this PR as a first step to implement the plan from that issue. Can we get this FCPd? :)

The one potential open question here is whether this should be a regular FCW first or whether it can immediately become an FCW that shows up in dependencies. I assume stdcall and fastcall are sufficiently rare that we can go for report-in-deps immediately (since they already get rejected on non-x86-32 non-Windows targets). "cdecl" might be more widely used though so it may be worth ramping up the lint more slowly.

@RalfJung RalfJung added the I-lang-nominated Nominated for discussion during a lang team meeting. label May 23, 2025
@traviscross traviscross added P-lang-drag-1 Lang team prioritization drag level 1. https://rust-lang.zulipchat.com/#narrow/channel/410516-t-lang and removed T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels May 23, 2025
@traviscross
Copy link
Contributor

Searching across GitHub, there are 506 Rust file hits on extern "cdecl".

Regarding whether to fire the FCW in deps immediately, I lean toward it probably being OK. Given that this may show up in cfg-heavy code, I could imagine that many library authors may not notice until their downstreams report anyway. But if anyone on lang feels we should walk this more slowly, that's what I'd estimate we'd do, so I'm curious to hear what others think.

@RalfJung
Copy link
Member Author

Oh that's the syntax for doing such a search... I tried and failed to get a similar result out of github search.^^

@traviscross traviscross changed the title add (back) unsupported_calling_conventions lint to reject more invalid calling conventions Add (back) unsupported_calling_conventions lint to reject more invalid calling conventions May 27, 2025
@traviscross
Copy link
Contributor

Let's propose to do it.

@rfcbot fcp merge

@rfcbot
Copy link
Collaborator

rfcbot commented May 28, 2025

Team member @traviscross has proposed to merge this. The next step is review by the rest of the tagged team members:

No concerns currently listed.

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

cc @rust-lang/lang-advisors: FCP proposed for lang, please feel free to register concerns.
See this document for info about what commands tagged team members can give me.

@rfcbot rfcbot added proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. labels May 28, 2025
@tmandry
Copy link
Member

tmandry commented May 28, 2025

@rfcbot reviewed

@joshtriplett
Copy link
Member

@rfcbot reviewed

I think, in the case of extern "stdcall", we should consider proviing a suggestion for extern "system".

extern "fastcall" is uncommon enough that it's not that onerous if we tell people to either use cfg (despite the substantial duplication at the moment) or use a macro for this.

@rfcbot rfcbot added final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. and removed proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. labels May 28, 2025
@rfcbot
Copy link
Collaborator

rfcbot commented May 28, 2025

🔔 This is now entering its final comment period, as per the review above. 🔔

@traviscross traviscross added I-lang-radar Items that are on lang's radar and will need eventual work or consideration. and removed I-lang-nominated Nominated for discussion during a lang team meeting. P-lang-drag-1 Lang team prioritization drag level 1. https://rust-lang.zulipchat.com/#narrow/channel/410516-t-lang I-lang-radar Items that are on lang's radar and will need eventual work or consideration. labels May 28, 2025
@workingjubilee
Copy link
Member

workingjubilee commented May 28, 2025

Noting using such searches as TC mentioned:

  • extern "stdcall" has over ~2000 hits
  • extern "cdecl" has ~522 hits (maybe some DB shards didn't respond to TC's query?)
  • extern "fastcall" has ~480 hits
  • extern "thiscall" has ~300 hits
  • extern "vectorcall" has ~128 hits (unsurprising, it's still unstable)

...and many of these hits are just on our own repo but forked.

@workingjubilee
Copy link
Member

workingjubilee commented May 28, 2025

Somewhat unscientifically skimming the searches, I notice:

  • most users of extern "cdecl" seem to be
    • operating systems or bootloaders, primarily with cfg on x86
    • modding tech, either general solutions akin to Detours, or more specific ones targeted at one application, sometimes without cfg but with READMEs that contain explicit instructions to compile the code for i686-pc-windows-msvc
    • various forms of cross-language binding tools
  • extern "fastcall" is similarly diverse
  • extern "vectorcall" is much more biased towards cross-language bindings
  • extern "stdcall" appears in a lot more things intended for on-Windows usage, including the previous categories (though OS-y stuff only in the sense of drivers) but also Windows applications and, importantly, a number of utility crates

So I agree that we should probably offer suggestions for migrating extern "stdcall" code, as it seems to be the one most likely to appear in an actual library case.

@RalfJung RalfJung force-pushed the unsupported_calling_conventions branch from b73f7b4 to cf20f7b Compare May 29, 2025 10:16
@RalfJung
Copy link
Member Author

I added targeted help messages for "stdcall" and "cdecl". I made them also show up for the hard error since they should be helpful there too, e.g. when someone tries to use "stdcall" on x86_64-Linux.

@RalfJung RalfJung force-pushed the unsupported_calling_conventions branch from cf20f7b to 0d3a7bb Compare May 29, 2025 10:18
@lcnr
Copy link
Contributor

lcnr commented May 29, 2025

r? @workingjubilee maybe, feel free to reassign

@rustbot rustbot assigned workingjubilee and unassigned lcnr May 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-lang Relevant to the language team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants