mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve diagnostic of no_mangle_with_rust_abi

Browse Source
This commit is contained in:
Jason Newcomb 2023-02-27 22:01:12 -05:00
parent 8b65632b6e
commit 003a2119e7
4 changed files with 71 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
clippy_lints/src/no_mangle_with_rust_abi.rs
View File

@ -1,9 +1,10 @@
use clippy_utils::diagnostics::span_lint_and_sugg; use clippy_utils::diagnostics::span_lint_and_then;
use clippy_utils::source::snippet_with_applicability; use clippy_utils::source::snippet_with_applicability;
use rustc_errors::Applicability; use rustc_errors::Applicability;
use rustc_hir::{Item, ItemKind}; use rustc_hir::{Item, ItemKind};
use rustc_lint::{LateContext, LateLintPass}; use rustc_lint::{LateContext, LateLintPass};
use rustc_session::{declare_lint_pass, declare_tool_lint}; use rustc_session::{declare_lint_pass, declare_tool_lint};
use rustc_span::{BytePos, Pos};
use rustc_target::spec::abi::Abi; use rustc_target::spec::abi::Abi;
declare_clippy_lint! { declare_clippy_lint! {
@ -38,25 +39,28 @@ impl<'tcx> LateLintPass<'tcx> for NoMangleWithRustAbi {
fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'tcx>) { fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'tcx>) {
if let ItemKind::Fn(fn_sig, _, _) = &item.kind { if let ItemKind::Fn(fn_sig, _, _) = &item.kind {
let attrs = cx.tcx.hir().attrs(item.hir_id()); let attrs = cx.tcx.hir().attrs(item.hir_id());
let mut applicability = Applicability::MachineApplicable; let mut app = Applicability::MaybeIncorrect;
let snippet = snippet_with_applicability(cx, fn_sig.span, "..", &mut applicability); let snippet = snippet_with_applicability(cx, fn_sig.span, "..", &mut app);
for attr in attrs { for attr in attrs {
if let Some(ident) = attr.ident() if let Some(ident) = attr.ident()
&& ident.name == rustc_span::sym::no_mangle && ident.name == rustc_span::sym::no_mangle
&& fn_sig.header.abi == Abi::Rust && fn_sig.header.abi == Abi::Rust
&& !snippet.contains("extern") { && let Some((fn_attrs, _)) = snippet.split_once("fn")
&& !fn_attrs.contains("extern")
{
let sugg_span = fn_sig.span
.with_lo(fn_sig.span.lo() + BytePos::from_usize(fn_attrs.len()))
.shrink_to_lo();
let suggestion = snippet.split_once("fn") span_lint_and_then(
.map_or(String::new(), |(first, second)| format!(r#"{first}extern "C" fn{second}"#));
span_lint_and_sugg(
cx, cx,
NO_MANGLE_WITH_RUST_ABI, NO_MANGLE_WITH_RUST_ABI,
fn_sig.span, fn_sig.span,
"attribute #[no_mangle] set on a Rust ABI function", "`#[no_mangle]` set on a function with the default (`Rust`) ABI",
"try", |diag| {
suggestion, diag.span_suggestion(sugg_span, "set an ABI", "extern \"C\" ", app)
applicability .span_suggestion(sugg_span, "or explicitly set the default", "extern \"Rust\" ", app);
},
); );
} }
} }

48
tests/ui/no_mangle_with_rust_abi.fixed
View File

@ -1,48 +0,0 @@
// run-rustfix
#![allow(unused)]
#![warn(clippy::no_mangle_with_rust_abi)]
#[no_mangle]
extern "C" fn rust_abi_fn_one(arg_one: u32, arg_two: usize) {}
#[no_mangle]
pub extern "C" fn rust_abi_fn_two(arg_one: u32, arg_two: usize) {}
/// # Safety
/// This function shouldn't be called unless the horsemen are ready
#[no_mangle]
pub unsafe extern "C" fn rust_abi_fn_three(arg_one: u32, arg_two: usize) {}
/// # Safety
/// This function shouldn't be called unless the horsemen are ready
#[no_mangle]
unsafe extern "C" fn rust_abi_fn_four(arg_one: u32, arg_two: usize) {}
#[no_mangle]
extern "C" fn rust_abi_multiline_function_really_long_name_to_overflow_args_to_multiple_lines(
arg_one: u32,
arg_two: usize,
) -> u32 {
0
}
// Must not run on functions that explicitly opt in to Rust ABI with `extern "Rust"`
#[no_mangle]
#[rustfmt::skip]
extern "Rust" fn rust_abi_fn_explicit_opt_in(arg_one: u32, arg_two: usize) {}
fn rust_abi_fn_again(arg_one: u32, arg_two: usize) {}
#[no_mangle]
extern "C" fn c_abi_fn(arg_one: u32, arg_two: usize) {}
extern "C" fn c_abi_fn_again(arg_one: u32, arg_two: usize) {}
extern "C" {
fn c_abi_in_block(arg_one: u32, arg_two: usize);
}
fn main() {
// test code goes here
}

2
tests/ui/no_mangle_with_rust_abi.rs
View File

@ -1,5 +1,3 @@
// run-rustfix
#![allow(unused)] #![allow(unused)]
#![warn(clippy::no_mangle_with_rust_abi)] #![warn(clippy::no_mangle_with_rust_abi)]

74
tests/ui/no_mangle_with_rust_abi.stderr
View File

@ -1,31 +1,66 @@
error: attribute #[no_mangle] set on a Rust ABI function error: `#[no_mangle]` set on a function with the default (`Rust`) ABI
--> $DIR/no_mangle_with_rust_abi.rs:7:1 --> $DIR/no_mangle_with_rust_abi.rs:5:1
| |
LL | fn rust_abi_fn_one(arg_one: u32, arg_two: usize) {} LL | fn rust_abi_fn_one(arg_one: u32, arg_two: usize) {}
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `extern "C" fn rust_abi_fn_one(arg_one: u32, arg_two: usize)` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| |
= note: `-D clippy::no-mangle-with-rust-abi` implied by `-D warnings` = note: `-D clippy::no-mangle-with-rust-abi` implied by `-D warnings`
help: set an ABI
|
LL | extern "C" fn rust_abi_fn_one(arg_one: u32, arg_two: usize) {}
| ++++++++++
help: or explicitly set the default
|
LL | extern "Rust" fn rust_abi_fn_one(arg_one: u32, arg_two: usize) {}
| +++++++++++++
error: attribute #[no_mangle] set on a Rust ABI function error: `#[no_mangle]` set on a function with the default (`Rust`) ABI
--> $DIR/no_mangle_with_rust_abi.rs:10:1 --> $DIR/no_mangle_with_rust_abi.rs:8:1
| |
LL | pub fn rust_abi_fn_two(arg_one: u32, arg_two: usize) {} LL | pub fn rust_abi_fn_two(arg_one: u32, arg_two: usize) {}
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `pub extern "C" fn rust_abi_fn_two(arg_one: u32, arg_two: usize)` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
help: set an ABI
|
LL | pub extern "C" fn rust_abi_fn_two(arg_one: u32, arg_two: usize) {}
| ++++++++++
help: or explicitly set the default
|
LL | pub extern "Rust" fn rust_abi_fn_two(arg_one: u32, arg_two: usize) {}
| +++++++++++++
error: attribute #[no_mangle] set on a Rust ABI function error: `#[no_mangle]` set on a function with the default (`Rust`) ABI
--> $DIR/no_mangle_with_rust_abi.rs:15:1 --> $DIR/no_mangle_with_rust_abi.rs:13:1
| |
LL | pub unsafe fn rust_abi_fn_three(arg_one: u32, arg_two: usize) {} LL | pub unsafe fn rust_abi_fn_three(arg_one: u32, arg_two: usize) {}
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `pub unsafe extern "C" fn rust_abi_fn_three(arg_one: u32, arg_two: usize)` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
help: set an ABI
|
LL | pub unsafe extern "C" fn rust_abi_fn_three(arg_one: u32, arg_two: usize) {}
| ++++++++++
help: or explicitly set the default
|
LL | pub unsafe extern "Rust" fn rust_abi_fn_three(arg_one: u32, arg_two: usize) {}
| +++++++++++++
error: attribute #[no_mangle] set on a Rust ABI function error: `#[no_mangle]` set on a function with the default (`Rust`) ABI
--> $DIR/no_mangle_with_rust_abi.rs:20:1 --> $DIR/no_mangle_with_rust_abi.rs:18:1
| |
LL | unsafe fn rust_abi_fn_four(arg_one: u32, arg_two: usize) {} LL | unsafe fn rust_abi_fn_four(arg_one: u32, arg_two: usize) {}
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `unsafe extern "C" fn rust_abi_fn_four(arg_one: u32, arg_two: usize)` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
help: set an ABI
|
LL | unsafe extern "C" fn rust_abi_fn_four(arg_one: u32, arg_two: usize) {}
| ++++++++++
help: or explicitly set the default
|
LL | unsafe extern "Rust" fn rust_abi_fn_four(arg_one: u32, arg_two: usize) {}
| +++++++++++++
error: attribute #[no_mangle] set on a Rust ABI function error: `#[no_mangle]` set on a function with the default (`Rust`) ABI
--> $DIR/no_mangle_with_rust_abi.rs:23:1 --> $DIR/no_mangle_with_rust_abi.rs:21:1
| |
LL | / fn rust_abi_multiline_function_really_long_name_to_overflow_args_to_multiple_lines( LL | / fn rust_abi_multiline_function_really_long_name_to_overflow_args_to_multiple_lines(
LL | | arg_one: u32, LL | | arg_one: u32,
@ -33,13 +68,14 @@ LL | | arg_two: usize,
LL | | ) -> u32 { LL | | ) -> u32 {
| |________^ | |________^
| |
help: try help: set an ABI
| |
LL + extern "C" fn rust_abi_multiline_function_really_long_name_to_overflow_args_to_multiple_lines( LL | extern "C" fn rust_abi_multiline_function_really_long_name_to_overflow_args_to_multiple_lines(
LL + arg_one: u32, | ++++++++++
LL + arg_two: usize, help: or explicitly set the default
LL ~ ) -> u32 {
| |
LL | extern "Rust" fn rust_abi_multiline_function_really_long_name_to_overflow_args_to_multiple_lines(
| +++++++++++++
error: aborting due to 5 previous errors error: aborting due to 5 previous errors