|
| 1 | +use rustc_middle::mir::visit::Visitor; |
| 2 | +use rustc_middle::mir::{Body, Location, Operand, Terminator, TerminatorKind}; |
| 3 | +use rustc_middle::ty::{TyCtxt, UintTy}; |
| 4 | +use rustc_session::lint::builtin::REDUNDANT_TRANSMUTATION; |
| 5 | +use rustc_span::source_map::Spanned; |
| 6 | +use rustc_span::{Span, sym}; |
| 7 | +use rustc_type_ir::TyKind::*; |
| 8 | + |
| 9 | +use crate::errors::RedundantTransmute as Error; |
| 10 | + |
| 11 | +/// Check for transmutes that overlap with stdlib methods. |
| 12 | +/// For example, transmuting `[u8; 4]` to `u32`. |
| 13 | +pub(super) struct CheckRedundantTransmutes; |
| 14 | + |
| 15 | +impl<'tcx> crate::MirLint<'tcx> for CheckRedundantTransmutes { |
| 16 | + fn run_lint(&self, tcx: TyCtxt<'tcx>, body: &Body<'tcx>) { |
| 17 | + let mut checker = RedundantTransmutesChecker { body, tcx }; |
| 18 | + checker.visit_body(body); |
| 19 | + } |
| 20 | +} |
| 21 | + |
| 22 | +struct RedundantTransmutesChecker<'a, 'tcx> { |
| 23 | + body: &'a Body<'tcx>, |
| 24 | + tcx: TyCtxt<'tcx>, |
| 25 | +} |
| 26 | + |
| 27 | +impl<'a, 'tcx> RedundantTransmutesChecker<'a, 'tcx> { |
| 28 | + fn is_redundant_transmute( |
| 29 | + &self, |
| 30 | + function: &Operand<'tcx>, |
| 31 | + arg: String, |
| 32 | + span: Span, |
| 33 | + ) -> Option<Error> { |
| 34 | + let fn_sig = function.ty(self.body, self.tcx).fn_sig(self.tcx).skip_binder(); |
| 35 | + let [input] = fn_sig.inputs() else { return None }; |
| 36 | + |
| 37 | + let err = |sugg| Error { span, sugg, help: None }; |
| 38 | + |
| 39 | + Some(match (input.kind(), fn_sig.output().kind()) { |
| 40 | + // dont check the length; transmute does that for us. |
| 41 | + // [u8; _] => primitive |
| 42 | + (Array(t, _), Uint(_) | Float(_) | Int(_)) if *t.kind() == Uint(UintTy::U8) => Error { |
| 43 | + sugg: format!("{}::from_ne_bytes({arg})", fn_sig.output()), |
| 44 | + help: Some( |
| 45 | + "there's also `from_le_bytes` and `from_ne_bytes` if you expect a particular byte order", |
| 46 | + ), |
| 47 | + span, |
| 48 | + }, |
| 49 | + // primitive => [u8; _] |
| 50 | + (Uint(_) | Float(_) | Int(_), Array(t, _)) if *t.kind() == Uint(UintTy::U8) => Error { |
| 51 | + sugg: format!("{input}::to_ne_bytes({arg})"), |
| 52 | + help: Some( |
| 53 | + "there's also `to_le_bytes` and `to_ne_bytes` if you expect a particular byte order", |
| 54 | + ), |
| 55 | + span, |
| 56 | + }, |
| 57 | + // char → u32 |
| 58 | + (Char, Uint(UintTy::U32)) => err(format!("({arg}) as u32")), |
| 59 | + // u32 → char |
| 60 | + (Uint(UintTy::U32), Char) => Error { |
| 61 | + sugg: format!("char::from_u32_unchecked({arg})"), |
| 62 | + help: Some("consider `char::from_u32(…).unwrap()`"), |
| 63 | + span, |
| 64 | + }, |
| 65 | + // uNN → iNN |
| 66 | + (Uint(ty), Int(_)) => err(format!("{}::cast_signed({arg})", ty.name_str())), |
| 67 | + // iNN → uNN |
| 68 | + (Int(ty), Uint(_)) => err(format!("{}::cast_unsigned({arg})", ty.name_str())), |
| 69 | + // fNN → uNN |
| 70 | + (Float(ty), Uint(..)) => err(format!("{}::to_bits({arg})", ty.name_str())), |
| 71 | + // uNN → fNN |
| 72 | + (Uint(_), Float(ty)) => err(format!("{}::from_bits({arg})", ty.name_str())), |
| 73 | + // bool → { x8 } |
| 74 | + (Bool, Int(..) | Uint(..)) => err(format!("({arg}) as {}", fn_sig.output())), |
| 75 | + // u8 → bool |
| 76 | + (Uint(_), Bool) => err(format!("({arg} == 1)")), |
| 77 | + _ => return None, |
| 78 | + }) |
| 79 | + } |
| 80 | +} |
| 81 | + |
| 82 | +impl<'tcx> Visitor<'tcx> for RedundantTransmutesChecker<'_, 'tcx> { |
| 83 | + // Check each block's terminator for calls to pointer to integer transmutes |
| 84 | + // in const functions or associated constants and emit a lint. |
| 85 | + fn visit_terminator(&mut self, terminator: &Terminator<'tcx>, location: Location) { |
| 86 | + if let TerminatorKind::Call { func, args, .. } = &terminator.kind |
| 87 | + && let [Spanned { span: arg, .. }] = **args |
| 88 | + && let Some((func_def_id, _)) = func.const_fn_def() |
| 89 | + && self.tcx.is_intrinsic(func_def_id, sym::transmute) |
| 90 | + && let span = self.body.source_info(location).span |
| 91 | + && let Some(lint) = self.is_redundant_transmute( |
| 92 | + func, |
| 93 | + self.tcx.sess.source_map().span_to_snippet(arg).expect("ok"), |
| 94 | + span, |
| 95 | + ) |
| 96 | + && let Some(call_id) = self.body.source.def_id().as_local() |
| 97 | + { |
| 98 | + let hir_id = self.tcx.local_def_id_to_hir_id(call_id); |
| 99 | + |
| 100 | + self.tcx.emit_node_span_lint(REDUNDANT_TRANSMUTATION, hir_id, span, lint); |
| 101 | + } |
| 102 | + } |
| 103 | +} |
0 commit comments