use hir::db::ExpandDatabase; use hir::HirFileIdExt; use ide_db::{assists::Assist, source_change::SourceChange}; use syntax::{ast, SyntaxNode}; use syntax::{match_ast, AstNode}; use text_edit::TextEdit; use crate::{fix, Diagnostic, DiagnosticCode, DiagnosticsContext}; // Diagnostic: missing-unsafe // // This diagnostic is triggered if an operation marked as `unsafe` is used outside of an `unsafe` function or block. pub(crate) fn missing_unsafe(ctx: &DiagnosticsContext<'_>, d: &hir::MissingUnsafe) -> Diagnostic { let code = if d.only_lint { DiagnosticCode::RustcLint("unsafe_op_in_unsafe_fn") } else { DiagnosticCode::RustcHardError("E0133") }; Diagnostic::new_with_syntax_node_ptr( ctx, code, "this operation is unsafe and requires an unsafe function or block", d.expr.map(|it| it.into()), ) .with_fixes(fixes(ctx, d)) } fn fixes(ctx: &DiagnosticsContext<'_>, d: &hir::MissingUnsafe) -> Option> { // The fixit will not work correctly for macro expansions, so we don't offer it in that case. if d.expr.file_id.is_macro() { return None; } let root = ctx.sema.db.parse_or_expand(d.expr.file_id); let expr = d.expr.value.to_node(&root); let node_to_add_unsafe_block = pick_best_node_to_add_unsafe_block(&expr)?; let replacement = format!("unsafe {{ {} }}", node_to_add_unsafe_block.text()); let edit = TextEdit::replace(node_to_add_unsafe_block.text_range(), replacement); let source_change = SourceChange::from_text_edit(d.expr.file_id.original_file(ctx.sema.db), edit); Some(vec![fix("add_unsafe", "Add unsafe block", source_change, expr.syntax().text_range())]) } // Pick the first ancestor expression of the unsafe `expr` that is not a // receiver of a method call, a field access, the left-hand side of an // assignment, or a reference. As all of those cases would incur a forced move // if wrapped which might not be wanted. That is: // - `unsafe_expr.foo` -> `unsafe { unsafe_expr.foo }` // - `unsafe_expr.foo.bar` -> `unsafe { unsafe_expr.foo.bar }` // - `unsafe_expr.foo()` -> `unsafe { unsafe_expr.foo() }` // - `unsafe_expr.foo.bar()` -> `unsafe { unsafe_expr.foo.bar() }` // - `unsafe_expr += 1` -> `unsafe { unsafe_expr += 1 }` // - `&unsafe_expr` -> `unsafe { &unsafe_expr }` // - `&&unsafe_expr` -> `unsafe { &&unsafe_expr }` fn pick_best_node_to_add_unsafe_block(unsafe_expr: &ast::Expr) -> Option { // The `unsafe_expr` might be: // - `ast::CallExpr`: call an unsafe function // - `ast::MethodCallExpr`: call an unsafe method // - `ast::PrefixExpr`: dereference a raw pointer // - `ast::PathExpr`: access a static mut variable for (node, parent) in unsafe_expr.syntax().ancestors().zip(unsafe_expr.syntax().ancestors().skip(1)) { match_ast! { match parent { // If the `parent` is a `MethodCallExpr`, that means the `node` // is the receiver of the method call, because only the receiver // can be a direct child of a method call. The method name // itself is not an expression but a `NameRef`, and an argument // is a direct child of an `ArgList`. ast::MethodCallExpr(_) => continue, ast::FieldExpr(_) => continue, ast::RefExpr(_) => continue, ast::BinExpr(it) => { // Check if the `node` is the left-hand side of an // assignment, if so, we don't want to wrap it in an unsafe // block, e.g. `unsafe_expr += 1` let is_left_hand_side_of_assignment = { if let Some(ast::BinaryOp::Assignment { .. }) = it.op_kind() { it.lhs().map(|lhs| lhs.syntax().text_range().contains_range(node.text_range())).unwrap_or(false) } else { false } }; if !is_left_hand_side_of_assignment { return Some(node); } }, _ => { return Some(node); } } } } None } #[cfg(test)] mod tests { use crate::tests::{check_diagnostics, check_fix, check_no_fix}; #[test] fn missing_unsafe_diagnostic_with_raw_ptr() { check_diagnostics( r#" //- minicore: sized fn main() { let x = &5_usize as *const usize; unsafe { let _y = *x; } let _z = *x; } //^^💡 error: this operation is unsafe and requires an unsafe function or block "#, ) } #[test] fn missing_unsafe_diagnostic_with_unsafe_call() { check_diagnostics( r#" //- minicore: sized struct HasUnsafe; impl HasUnsafe { unsafe fn unsafe_fn(&self) { let x = &5_usize as *const usize; let _y = *x; } } unsafe fn unsafe_fn() { let x = &5_usize as *const usize; let _y = *x; } fn main() { unsafe_fn(); //^^^^^^^^^^^💡 error: this operation is unsafe and requires an unsafe function or block HasUnsafe.unsafe_fn(); //^^^^^^^^^^^^^^^^^^^^^💡 error: this operation is unsafe and requires an unsafe function or block unsafe { unsafe_fn(); HasUnsafe.unsafe_fn(); } } "#, ); } #[test] fn missing_unsafe_diagnostic_with_static_mut() { check_diagnostics( r#" //- minicore: copy struct Ty { a: u8, } static mut STATIC_MUT: Ty = Ty { a: 0 }; fn main() { let _x = STATIC_MUT.a; //^^^^^^^^^^💡 error: this operation is unsafe and requires an unsafe function or block unsafe { let _x = STATIC_MUT.a; } } "#, ); } #[test] fn missing_unsafe_diagnostic_with_extern_static() { check_diagnostics( r#" //- minicore: copy extern "C" { static EXTERN: i32; static mut EXTERN_MUT: i32; } fn main() { let _x = EXTERN; //^^^^^^💡 error: this operation is unsafe and requires an unsafe function or block let _x = EXTERN_MUT; //^^^^^^^^^^💡 error: this operation is unsafe and requires an unsafe function or block unsafe { let _x = EXTERN; let _x = EXTERN_MUT; } } "#, ); } #[test] fn no_unsafe_diagnostic_with_addr_of_static() { check_diagnostics( r#" //- minicore: copy, addr_of use core::ptr::{addr_of, addr_of_mut}; extern "C" { static EXTERN: i32; static mut EXTERN_MUT: i32; } static mut STATIC_MUT: i32 = 0; fn main() { let _x = addr_of!(EXTERN); let _x = addr_of!(EXTERN_MUT); let _x = addr_of!(STATIC_MUT); let _x = addr_of_mut!(EXTERN_MUT); let _x = addr_of_mut!(STATIC_MUT); } "#, ); } #[test] fn no_missing_unsafe_diagnostic_with_safe_intrinsic() { check_diagnostics( r#" extern "rust-intrinsic" { #[rustc_safe_intrinsic] pub fn bitreverse(x: u32) -> u32; // Safe intrinsic pub fn floorf32(x: f32) -> f32; // Unsafe intrinsic } fn main() { let _ = bitreverse(12); let _ = floorf32(12.0); //^^^^^^^^^^^^^^💡 error: this operation is unsafe and requires an unsafe function or block } "#, ); } #[test] fn no_missing_unsafe_diagnostic_with_deprecated_safe_2024() { check_diagnostics( r#" #[rustc_deprecated_safe_2024] fn set_var() {} fn main() { set_var(); } "#, ); } #[test] fn add_unsafe_block_when_dereferencing_a_raw_pointer() { check_fix( r#" //- minicore: sized fn main() { let x = &5_usize as *const usize; let _z = *x$0; } "#, r#" fn main() { let x = &5_usize as *const usize; let _z = unsafe { *x }; } "#, ); } #[test] fn add_unsafe_block_when_calling_unsafe_function() { check_fix( r#" //- minicore: sized unsafe fn func() { let x = &5_usize as *const usize; let z = *x; } fn main() { func$0(); } "#, r#" unsafe fn func() { let x = &5_usize as *const usize; let z = *x; } fn main() { unsafe { func() }; } "#, ) } #[test] fn add_unsafe_block_when_calling_unsafe_method() { check_fix( r#" //- minicore: sized struct S(usize); impl S { unsafe fn func(&self) { let x = &self.0 as *const usize; let _z = *x; } } fn main() { let s = S(5); s.func$0(); } "#, r#" struct S(usize); impl S { unsafe fn func(&self) { let x = &self.0 as *const usize; let _z = *x; } } fn main() { let s = S(5); unsafe { s.func() }; } "#, ) } #[test] fn add_unsafe_block_when_accessing_mutable_static() { check_fix( r#" //- minicore: copy struct Ty { a: u8, } static mut STATIC_MUT: Ty = Ty { a: 0 }; fn main() { let _x = STATIC_MUT$0.a; } "#, r#" struct Ty { a: u8, } static mut STATIC_MUT: Ty = Ty { a: 0 }; fn main() { let _x = unsafe { STATIC_MUT.a }; } "#, ) } #[test] fn add_unsafe_block_when_calling_unsafe_intrinsic() { check_fix( r#" extern "rust-intrinsic" { pub fn floorf32(x: f32) -> f32; } fn main() { let _ = floorf32$0(12.0); } "#, r#" extern "rust-intrinsic" { pub fn floorf32(x: f32) -> f32; } fn main() { let _ = unsafe { floorf32(12.0) }; } "#, ) } #[test] fn unsafe_expr_as_a_receiver_of_a_method_call() { check_fix( r#" unsafe fn foo() -> String { "string".to_string() } fn main() { foo$0().len(); } "#, r#" unsafe fn foo() -> String { "string".to_string() } fn main() { unsafe { foo().len() }; } "#, ) } #[test] fn unsafe_expr_as_an_argument_of_a_method_call() { check_fix( r#" static mut STATIC_MUT: u8 = 0; fn main() { let mut v = vec![]; v.push(STATIC_MUT$0); } "#, r#" static mut STATIC_MUT: u8 = 0; fn main() { let mut v = vec![]; v.push(unsafe { STATIC_MUT }); } "#, ) } #[test] fn unsafe_expr_as_left_hand_side_of_assignment() { check_fix( r#" static mut STATIC_MUT: u8 = 0; fn main() { STATIC_MUT$0 = 1; } "#, r#" static mut STATIC_MUT: u8 = 0; fn main() { unsafe { STATIC_MUT = 1 }; } "#, ) } #[test] fn unsafe_expr_as_right_hand_side_of_assignment() { check_fix( r#" //- minicore: copy static mut STATIC_MUT: u8 = 0; fn main() { let _x; _x = STATIC_MUT$0; } "#, r#" static mut STATIC_MUT: u8 = 0; fn main() { let _x; _x = unsafe { STATIC_MUT }; } "#, ) } #[test] fn unsafe_expr_in_binary_plus() { check_fix( r#" //- minicore: copy static mut STATIC_MUT: u8 = 0; fn main() { let _x = STATIC_MUT$0 + 1; } "#, r#" static mut STATIC_MUT: u8 = 0; fn main() { let _x = unsafe { STATIC_MUT } + 1; } "#, ) } #[test] fn ref_to_unsafe_expr() { check_fix( r#" static mut STATIC_MUT: u8 = 0; fn main() { let _x = &STATIC_MUT$0; } "#, r#" static mut STATIC_MUT: u8 = 0; fn main() { let _x = unsafe { &STATIC_MUT }; } "#, ) } #[test] fn ref_ref_to_unsafe_expr() { check_fix( r#" static mut STATIC_MUT: u8 = 0; fn main() { let _x = &&STATIC_MUT$0; } "#, r#" static mut STATIC_MUT: u8 = 0; fn main() { let _x = unsafe { &&STATIC_MUT }; } "#, ) } #[test] fn unsafe_expr_in_macro_call() { check_no_fix( r#" unsafe fn foo() -> u8 { 0 } fn main() { let x = format!("foo: {}", foo$0()); } "#, ) } #[test] fn rustc_deprecated_safe_2024() { check_diagnostics( r#" //- /ed2021.rs crate:ed2021 edition:2021 #[rustc_deprecated_safe_2024] unsafe fn safe_fn() -> u8 { 0 } //- /ed2024.rs crate:ed2024 edition:2024 #[rustc_deprecated_safe_2024] unsafe fn not_safe() -> u8 { 0 } //- /main.rs crate:main deps:ed2021,ed2024 fn main() { ed2021::safe_fn(); ed2024::not_safe(); //^^^^^^^^^^^^^^^^^^💡 error: this operation is unsafe and requires an unsafe function or block } "#, ) } #[test] fn unsafe_op_in_unsafe_fn_allowed_by_default() { check_diagnostics( r#" unsafe fn foo(p: *mut i32) { *p = 123; } "#, ) } #[test] fn unsafe_op_in_unsafe_fn() { check_diagnostics( r#" #![warn(unsafe_op_in_unsafe_fn)] unsafe fn foo(p: *mut i32) { *p = 123; //^^💡 warn: this operation is unsafe and requires an unsafe function or block } "#, ) } #[test] fn no_unsafe_diagnostic_with_safe_kw() { check_diagnostics( r#" unsafe extern { pub safe fn f(); pub unsafe fn g(); pub fn h(); pub safe static S1: i32; pub unsafe static S2: i32; pub static S3: i32; } fn main() { f(); g(); //^^^💡 error: this operation is unsafe and requires an unsafe function or block h(); //^^^💡 error: this operation is unsafe and requires an unsafe function or block let _ = S1; let _ = S2; //^^💡 error: this operation is unsafe and requires an unsafe function or block let _ = S3; //^^💡 error: this operation is unsafe and requires an unsafe function or block } "#, ); } }